View Source GoogleApi.Content.V21.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.

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

Updates an existing product in your Merchant Center account. Only updates attributes provided in the request.

Functions

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

@spec content_products_custombatch(Tesla.Env.client(), keyword(), keyword()) ::
  {:ok, GoogleApi.Content.V21.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.V21.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").
- :body (type: GoogleApi.Content.V21.Model.ProductsCustomBatchRequest.t) -
opts (type: keyword()) - Call options

Returns

{:ok, %GoogleApi.Content.V21.Model.ProductsCustomBatchResponse{}} on success
{:error, info} on failure

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

@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.V21.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").
- :feedId (type: String.t) - The Content API Supplemental Feed ID. If present then product deletion applies to the data in a supplemental feed. If absent, entire product will be deleted.
opts (type: keyword()) - Call options

Returns

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

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

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

Retrieves a product from your Merchant Center account.

Parameters

connection (type: GoogleApi.Content.V21.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.V21.Model.Product{}} on success
{:error, info} on failure

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

@spec content_products_insert(Tesla.Env.client(), String.t(), keyword(), keyword()) ::
  {:ok, GoogleApi.Content.V21.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.V21.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").
- :feedId (type: String.t) - The Content API Supplemental Feed ID. If present then product insertion applies to the data in a supplemental feed.
- :body (type: GoogleApi.Content.V21.Model.Product.t) -
opts (type: keyword()) - Call options

Returns

{:ok, %GoogleApi.Content.V21.Model.Product{}} on success
{:error, info} on failure

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

@spec content_products_list(Tesla.Env.client(), String.t(), keyword(), keyword()) ::
  {:ok, GoogleApi.Content.V21.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.V21.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").
- :maxResults (type: integer()) - The maximum number of products to return in the response, used for paging. The default value is 25. The maximum value is 250.
- :pageToken (type: String.t) - The token returned by the previous request.
opts (type: keyword()) - Call options

Returns

{:ok, %GoogleApi.Content.V21.Model.ProductsListResponse{}} on success
{:error, info} on failure

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

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

Updates an existing product in your Merchant Center account. Only updates attributes provided in the request.

Parameters

connection (type: GoogleApi.Content.V21.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 for which to update.
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").
- :updateMask (type: String.t) - The comma-separated list of product attributes to be updated. Example: "title,salePrice". Attributes specified in the update mask without a value specified in the body will be deleted from the product. You must specify the update mask to delete attributes. Only top-level product attributes can be updated. If not defined, product attributes with set values will be updated and other attributes will stay unchanged.
- :body (type: GoogleApi.Content.V21.Model.Product.t) -
opts (type: keyword()) - Call options

Returns

{:ok, %GoogleApi.Content.V21.Model.Product{}} on success
{:error, info} on failure