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

API calls for all endpoints tagged Products.

Summary

Functions

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

Retrieves, inserts, and deletes multiple products in a single request.

content_products_delete(connection, merchant_id, product_id, optional_params \\ [], opts \\ [])

Deletes a product from your Merchant Center account.

content_products_get(connection, merchant_id, product_id, optional_params \\ [], opts \\ [])

Retrieves a product from your Merchant Center account.

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

Uploads a product to your Merchant Center account. If an item with the same channel, contentLanguage, offerId, and targetCountry already exists, this method updates that entry.

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

Lists the products in your Merchant Center account. The response might contain fewer items than specified by maxResults. Rely on nextPageToken to determine if there are more items to be requested.

Functions

Link to this function

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

View Source 
@spec content_products_custombatch(Tesla.Env.client(), keyword(), keyword()) ::
  {:ok, GoogleApi.Content.V2.Model.ProductsCustomBatchResponse.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Retrieves, inserts, and deletes multiple products 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.ProductsCustomBatchRequest.t) -
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.Content.V2.Model.ProductsCustomBatchResponse{}} on success
  • {:error, info} on failure
Link to this function

content_products_delete(connection, merchant_id, product_id, optional_params \\ [], opts \\ [])

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

Deletes a product 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 contains the product. This account cannot be a multi-client account.
  • product_id (type: String.t) - The REST ID of the product.
  • 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
Link to this function

content_products_get(connection, merchant_id, product_id, optional_params \\ [], opts \\ [])

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

Retrieves a product 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 contains the product. This account cannot be a multi-client account.
  • product_id (type: String.t) - The REST ID of the product.
  • 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.Product{}} on success
  • {:error, info} on failure
Link to this function

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

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

Uploads a product to your Merchant Center account. If an item with the same channel, contentLanguage, offerId, and targetCountry already exists, this method updates that entry.

Parameters

  • connection (type: GoogleApi.Content.V2.Connection.t) - Connection to server
  • merchant_id (type: String.t) - The ID of the account that contains the product. 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.Product.t) -
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.Content.V2.Model.Product{}} on success
  • {:error, info} on failure
Link to this function

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

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

Lists the products in your Merchant Center account. The response might contain fewer items than specified by maxResults. Rely on nextPageToken to determine if there are more items to be requested.

Parameters

  • connection (type: GoogleApi.Content.V2.Connection.t) - Connection to server
  • merchant_id (type: String.t) - The ID of the account that contains the products. 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").
    • :includeInvalidInsertedItems (type: boolean()) - Flag to include the invalid inserted items in the result of the list request. By default the invalid items are not shown (the default value is false).
    • :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.ProductsListResponse{}} on success
  • {:error, info} on failure