View Source GoogleApi.Content.V2.Api.Datafeeds (google_api_content v0.67.1)

API calls for all endpoints tagged Datafeeds.

Summary

Functions

content_datafeeds_custombatch(connection, optional_params \\ [], opts \\ [])

Deletes, fetches, gets, inserts and updates multiple datafeeds in a single request.

content_datafeeds_delete(connection, merchant_id, datafeed_id, optional_params \\ [], opts \\ [])

Deletes a datafeed configuration from your Merchant Center account.

content_datafeeds_fetchnow(connection, merchant_id, datafeed_id, optional_params \\ [], opts \\ [])

Invokes a fetch for the datafeed in your Merchant Center account. If you need to call this method more than once per day, we recommend you use the Products service to update your product data.

content_datafeeds_get(connection, merchant_id, datafeed_id, optional_params \\ [], opts \\ [])

Retrieves a datafeed configuration from your Merchant Center account.

content_datafeeds_insert(connection, merchant_id, optional_params \\ [], opts \\ [])

Registers a datafeed configuration with your Merchant Center account.

content_datafeeds_list(connection, merchant_id, optional_params \\ [], opts \\ [])

Lists the configurations for datafeeds in your Merchant Center account.

content_datafeeds_update(connection, merchant_id, datafeed_id, optional_params \\ [], opts \\ [])

Updates a datafeed configuration of your Merchant Center account. Any fields that are not provided are deleted from the resource.

Functions

content_datafeeds_custombatch(connection, optional_params \\ [], opts \\ [])

@spec content_datafeeds_custombatch(Tesla.Env.client(), keyword(), keyword()) ::
  {:ok, GoogleApi.Content.V2.Model.DatafeedsCustomBatchResponse.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Deletes, fetches, gets, inserts and updates multiple datafeeds in a single request.

Parameters

connection (type: GoogleApi.Content.V2.Connection.t) - Connection to server
optional_params (type: keyword()) - Optional parameters
- :"$.xgafv" (type: String.t) - V1 error format.
- :access_token (type: String.t) - OAuth access token.
- :alt (type: String.t) - Data format for response.
- :callback (type: String.t) - JSONP
- :fields (type: String.t) - Selector specifying which fields to include in a partial response.
- :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
- :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
- :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
- :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
- :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
- :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
- :dryRun (type: boolean()) - Flag to simulate a request like in a live environment. If set to true, dry-run mode checks the validity of the request and returns errors (if any).
- :body (type: GoogleApi.Content.V2.Model.DatafeedsCustomBatchRequest.t) -
opts (type: keyword()) - Call options

Returns

{:ok, %GoogleApi.Content.V2.Model.DatafeedsCustomBatchResponse{}} on success
{:error, info} on failure

content_datafeeds_delete(connection, merchant_id, datafeed_id, optional_params \\ [], opts \\ [])

@spec content_datafeeds_delete(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, nil} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}

Deletes a datafeed configuration from your Merchant Center account.

Parameters

connection (type: GoogleApi.Content.V2.Connection.t) - Connection to server
merchant_id (type: String.t) - The ID of the account that manages the datafeed. This account cannot be a multi-client account.
datafeed_id (type: String.t) - The ID of the datafeed.
optional_params (type: keyword()) - Optional parameters
- :"$.xgafv" (type: String.t) - V1 error format.
- :access_token (type: String.t) - OAuth access token.
- :alt (type: String.t) - Data format for response.
- :callback (type: String.t) - JSONP
- :fields (type: String.t) - Selector specifying which fields to include in a partial response.
- :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
- :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
- :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
- :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
- :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
- :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
- :dryRun (type: boolean()) - Flag to simulate a request like in a live environment. If set to true, dry-run mode checks the validity of the request and returns errors (if any).
opts (type: keyword()) - Call options

Returns

{:ok, %{}} on success
{:error, info} on failure

content_datafeeds_fetchnow(connection, merchant_id, datafeed_id, optional_params \\ [], opts \\ [])

@spec content_datafeeds_fetchnow(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.Content.V2.Model.DatafeedsFetchNowResponse.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Invokes a fetch for the datafeed in your Merchant Center account. If you need to call this method more than once per day, we recommend you use the Products service to update your product data.

Parameters

connection (type: GoogleApi.Content.V2.Connection.t) - Connection to server
merchant_id (type: String.t) - The ID of the account that manages the datafeed. This account cannot be a multi-client account.
datafeed_id (type: String.t) - The ID of the datafeed to be fetched.
optional_params (type: keyword()) - Optional parameters
- :"$.xgafv" (type: String.t) - V1 error format.
- :access_token (type: String.t) - OAuth access token.
- :alt (type: String.t) - Data format for response.
- :callback (type: String.t) - JSONP
- :fields (type: String.t) - Selector specifying which fields to include in a partial response.
- :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
- :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
- :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
- :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
- :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
- :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
- :dryRun (type: boolean()) - Flag to simulate a request like in a live environment. If set to true, dry-run mode checks the validity of the request and returns errors (if any).
opts (type: keyword()) - Call options

Returns

{:ok, %GoogleApi.Content.V2.Model.DatafeedsFetchNowResponse{}} on success
{:error, info} on failure

content_datafeeds_get(connection, merchant_id, datafeed_id, optional_params \\ [], opts \\ [])

@spec content_datafeeds_get(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.Content.V2.Model.Datafeed.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Retrieves a datafeed configuration from your Merchant Center account.

Parameters

connection (type: GoogleApi.Content.V2.Connection.t) - Connection to server
merchant_id (type: String.t) - The ID of the account that manages the datafeed. This account cannot be a multi-client account.
datafeed_id (type: String.t) - The ID of the datafeed.
optional_params (type: keyword()) - Optional parameters
- :"$.xgafv" (type: String.t) - V1 error format.
- :access_token (type: String.t) - OAuth access token.
- :alt (type: String.t) - Data format for response.
- :callback (type: String.t) - JSONP
- :fields (type: String.t) - Selector specifying which fields to include in a partial response.
- :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
- :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
- :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
- :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
- :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
- :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
opts (type: keyword()) - Call options

Returns

{:ok, %GoogleApi.Content.V2.Model.Datafeed{}} on success
{:error, info} on failure

content_datafeeds_insert(connection, merchant_id, optional_params \\ [], opts \\ [])

@spec content_datafeeds_insert(Tesla.Env.client(), String.t(), keyword(), keyword()) ::
  {:ok, GoogleApi.Content.V2.Model.Datafeed.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Registers a datafeed configuration with your Merchant Center account.

Parameters

connection (type: GoogleApi.Content.V2.Connection.t) - Connection to server
merchant_id (type: String.t) - The ID of the account that manages the datafeed. This account cannot be a multi-client account.
optional_params (type: keyword()) - Optional parameters
- :"$.xgafv" (type: String.t) - V1 error format.
- :access_token (type: String.t) - OAuth access token.
- :alt (type: String.t) - Data format for response.
- :callback (type: String.t) - JSONP
- :fields (type: String.t) - Selector specifying which fields to include in a partial response.
- :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
- :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
- :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
- :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
- :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
- :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
- :dryRun (type: boolean()) - Flag to simulate a request like in a live environment. If set to true, dry-run mode checks the validity of the request and returns errors (if any).
- :body (type: GoogleApi.Content.V2.Model.Datafeed.t) -
opts (type: keyword()) - Call options

Returns

{:ok, %GoogleApi.Content.V2.Model.Datafeed{}} on success
{:error, info} on failure

content_datafeeds_list(connection, merchant_id, optional_params \\ [], opts \\ [])

@spec content_datafeeds_list(Tesla.Env.client(), String.t(), keyword(), keyword()) ::
  {:ok, GoogleApi.Content.V2.Model.DatafeedsListResponse.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Lists the configurations for datafeeds in your Merchant Center account.

Parameters

connection (type: GoogleApi.Content.V2.Connection.t) - Connection to server
merchant_id (type: String.t) - The ID of the account that manages the datafeeds. This account cannot be a multi-client account.
optional_params (type: keyword()) - Optional parameters
- :"$.xgafv" (type: String.t) - V1 error format.
- :access_token (type: String.t) - OAuth access token.
- :alt (type: String.t) - Data format for response.
- :callback (type: String.t) - JSONP
- :fields (type: String.t) - Selector specifying which fields to include in a partial response.
- :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
- :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
- :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
- :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
- :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
- :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
- :maxResults (type: integer()) - The maximum number of products to return in the response, used for paging.
- :pageToken (type: String.t) - The token returned by the previous request.
opts (type: keyword()) - Call options

Returns

{:ok, %GoogleApi.Content.V2.Model.DatafeedsListResponse{}} on success
{:error, info} on failure

content_datafeeds_update(connection, merchant_id, datafeed_id, optional_params \\ [], opts \\ [])

@spec content_datafeeds_update(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.Content.V2.Model.Datafeed.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Updates a datafeed configuration of your Merchant Center account. Any fields that are not provided are deleted from the resource.

Parameters

connection (type: GoogleApi.Content.V2.Connection.t) - Connection to server
merchant_id (type: String.t) - The ID of the account that manages the datafeed. This account cannot be a multi-client account.
datafeed_id (type: String.t) - The ID of the datafeed.
optional_params (type: keyword()) - Optional parameters
- :"$.xgafv" (type: String.t) - V1 error format.
- :access_token (type: String.t) - OAuth access token.
- :alt (type: String.t) - Data format for response.
- :callback (type: String.t) - JSONP
- :fields (type: String.t) - Selector specifying which fields to include in a partial response.
- :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
- :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
- :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
- :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
- :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
- :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
- :dryRun (type: boolean()) - Flag to simulate a request like in a live environment. If set to true, dry-run mode checks the validity of the request and returns errors (if any).
- :body (type: GoogleApi.Content.V2.Model.Datafeed.t) -
opts (type: keyword()) - Call options

Returns

{:ok, %GoogleApi.Content.V2.Model.Datafeed{}} on success
{:error, info} on failure