View Source GoogleApi.Manufacturers.V1.Api.Accounts (google_api_manufacturers v0.21.0)

API calls for all endpoints tagged Accounts.

Summary

Functions

manufacturers_accounts_languages_product_certifications_delete(connection, name, optional_params \\ [], opts \\ [])

Deletes a product certification by its name. This method can only be called by certification bodies.

manufacturers_accounts_languages_product_certifications_get(connection, name, optional_params \\ [], opts \\ [])

Gets a product certification by its name. This method can only be called by certification bodies.

manufacturers_accounts_languages_product_certifications_list(connection, parent, optional_params \\ [], opts \\ [])

Lists product certifications from a specified certification body. This method can only be called by certification bodies.

manufacturers_accounts_languages_product_certifications_patch(connection, name, optional_params \\ [], opts \\ [])

Updates (or creates if allow_missing = true) a product certification which links certifications with products. This method can only be called by certification bodies.

manufacturers_accounts_products_delete(connection, parent, name, optional_params \\ [], opts \\ [])

Deletes the product from a Manufacturer Center account.

manufacturers_accounts_products_get(connection, parent, name, optional_params \\ [], opts \\ [])

Gets the product from a Manufacturer Center account, including product issues. A recently updated product takes around 15 minutes to process. Changes are only visible after it has been processed. While some issues may be available once the product has been processed, other issues may take days to appear.

manufacturers_accounts_products_list(connection, parent, optional_params \\ [], opts \\ [])

Lists all the products in a Manufacturer Center account.

manufacturers_accounts_products_update(connection, parent, name, optional_params \\ [], opts \\ [])

Inserts or updates the attributes of the product in a Manufacturer Center account. Creates a product with the provided attributes. If the product already exists, then all attributes are replaced with the new ones. The checks at upload time are minimal. All required attributes need to be present for a product to be valid. Issues may show up later after the API has accepted a new upload for a product and it is possible to overwrite an existing valid product with an invalid product. To detect this, you should retrieve the product and check it for issues once the new version is available. Uploaded attributes first need to be processed before they can be retrieved. Until then, new products will be unavailable, and retrieval of previously uploaded products will return the original state of the product.

Functions

Link to this function

manufacturers_accounts_languages_product_certifications_delete(connection, name, optional_params \\ [], opts \\ [])

View Source 
@spec manufacturers_accounts_languages_product_certifications_delete(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.Manufacturers.V1.Model.Empty.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Deletes a product certification by its name. This method can only be called by certification bodies.

Parameters

  • connection (type: GoogleApi.Manufacturers.V1.Connection.t) - Connection to server
  • name (type: String.t) - Required. The name of the product certification to delete. Format: accounts/{account}/languages/{language_code}/productCertifications/{id}
  • 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.Manufacturers.V1.Model.Empty{}} on success
  • {:error, info} on failure
Link to this function

manufacturers_accounts_languages_product_certifications_get(connection, name, optional_params \\ [], opts \\ [])

View Source 
@spec manufacturers_accounts_languages_product_certifications_get(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.Manufacturers.V1.Model.ProductCertification.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Gets a product certification by its name. This method can only be called by certification bodies.

Parameters

  • connection (type: GoogleApi.Manufacturers.V1.Connection.t) - Connection to server
  • name (type: String.t) - Required. The name of the product certification to get. Format: accounts/{account}/languages/{language_code}/productCertifications/{id}
  • 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.Manufacturers.V1.Model.ProductCertification{}} on success
  • {:error, info} on failure
Link to this function

manufacturers_accounts_languages_product_certifications_list(connection, parent, optional_params \\ [], opts \\ [])

View Source 
@spec manufacturers_accounts_languages_product_certifications_list(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.Manufacturers.V1.Model.ListProductCertificationsResponse.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Lists product certifications from a specified certification body. This method can only be called by certification bodies.

Parameters

  • connection (type: GoogleApi.Manufacturers.V1.Connection.t) - Connection to server
  • parent (type: String.t) - Required. The parent, which owns this collection of product certifications. Format: accounts/{account}/languages/{language_code}
  • 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").
    • :pageSize (type: integer()) - Optional. The maximum number of product certifications to return. The service may return fewer than this value. If unspecified, at most 50 product certifications will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.
    • :pageToken (type: String.t) - Optional. A page token, received from a previous ListProductCertifications call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to ListProductCertifications must match the call that provided the page token. Required if requesting the second or higher page.
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.Manufacturers.V1.Model.ListProductCertificationsResponse{}} on success
  • {:error, info} on failure
Link to this function

manufacturers_accounts_languages_product_certifications_patch(connection, name, optional_params \\ [], opts \\ [])

View Source 
@spec manufacturers_accounts_languages_product_certifications_patch(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.Manufacturers.V1.Model.ProductCertification.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Updates (or creates if allow_missing = true) a product certification which links certifications with products. This method can only be called by certification bodies.

Parameters

  • connection (type: GoogleApi.Manufacturers.V1.Connection.t) - Connection to server
  • name (type: String.t) - Required. The unique name identifier of a product certification Format: accounts/{account}/languages/{language_code}/productCertifications/{id} Where id is a some unique identifier and language_code is a 2-letter ISO 639-1 code of a Shopping supported language according to https://support.google.com/merchants/answer/160637.
  • 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) - Optional. The list of fields to update according to aip.dev/134. However, only full update is supported as of right now. Therefore, it can be either ignored or set to "*". Setting any other values will returns UNIMPLEMENTED error.
    • :body (type: GoogleApi.Manufacturers.V1.Model.ProductCertification.t) -
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.Manufacturers.V1.Model.ProductCertification{}} on success
  • {:error, info} on failure
Link to this function

manufacturers_accounts_products_delete(connection, parent, name, optional_params \\ [], opts \\ [])

View Source 
@spec manufacturers_accounts_products_delete(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.Manufacturers.V1.Model.Empty.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Deletes the product from a Manufacturer Center account.

Parameters

  • connection (type: GoogleApi.Manufacturers.V1.Connection.t) - Connection to server
  • parent (type: String.t) - Parent ID in the format accounts/{account_id}. account_id - The ID of the Manufacturer Center account.
  • name (type: String.t) - Name in the format {target_country}:{content_language}:{product_id}. target_country - The target country of the product as a CLDR territory code (for example, US). content_language - The content language of the product as a two-letter ISO 639-1 language code (for example, en). product_id - The ID of the product. For more information, see https://support.google.com/manufacturers/answer/6124116#id.
  • 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.Manufacturers.V1.Model.Empty{}} on success
  • {:error, info} on failure
Link to this function

manufacturers_accounts_products_get(connection, parent, name, optional_params \\ [], opts \\ [])

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

Gets the product from a Manufacturer Center account, including product issues. A recently updated product takes around 15 minutes to process. Changes are only visible after it has been processed. While some issues may be available once the product has been processed, other issues may take days to appear.

Parameters

  • connection (type: GoogleApi.Manufacturers.V1.Connection.t) - Connection to server
  • parent (type: String.t) - Parent ID in the format accounts/{account_id}. account_id - The ID of the Manufacturer Center account.
  • name (type: String.t) - Name in the format {target_country}:{content_language}:{product_id}. target_country - The target country of the product as a CLDR territory code (for example, US). content_language - The content language of the product as a two-letter ISO 639-1 language code (for example, en). product_id - The ID of the product. For more information, see https://support.google.com/manufacturers/answer/6124116#id.
  • 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").
    • :include (type: list(String.t)) - The information to be included in the response. Only sections listed here will be returned.
  • opts (type: keyword()) - Call options

Returns

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

manufacturers_accounts_products_list(connection, parent, optional_params \\ [], opts \\ [])

View Source 
@spec manufacturers_accounts_products_list(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.Manufacturers.V1.Model.ListProductsResponse.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Lists all the products in a Manufacturer Center account.

Parameters

  • connection (type: GoogleApi.Manufacturers.V1.Connection.t) - Connection to server
  • parent (type: String.t) - Parent ID in the format accounts/{account_id}. account_id - The ID of the Manufacturer Center 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").
    • :include (type: list(String.t)) - The information to be included in the response. Only sections listed here will be returned.
    • :pageSize (type: integer()) - Maximum number of product statuses 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.Manufacturers.V1.Model.ListProductsResponse{}} on success
  • {:error, info} on failure
Link to this function

manufacturers_accounts_products_update(connection, parent, name, optional_params \\ [], opts \\ [])

View Source 
@spec manufacturers_accounts_products_update(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.Manufacturers.V1.Model.Empty.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Inserts or updates the attributes of the product in a Manufacturer Center account. Creates a product with the provided attributes. If the product already exists, then all attributes are replaced with the new ones. The checks at upload time are minimal. All required attributes need to be present for a product to be valid. Issues may show up later after the API has accepted a new upload for a product and it is possible to overwrite an existing valid product with an invalid product. To detect this, you should retrieve the product and check it for issues once the new version is available. Uploaded attributes first need to be processed before they can be retrieved. Until then, new products will be unavailable, and retrieval of previously uploaded products will return the original state of the product.

Parameters

  • connection (type: GoogleApi.Manufacturers.V1.Connection.t) - Connection to server
  • parent (type: String.t) - Parent ID in the format accounts/{account_id}. account_id - The ID of the Manufacturer Center account.
  • name (type: String.t) - Name in the format {target_country}:{content_language}:{product_id}. target_country - The target country of the product as a CLDR territory code (for example, US). content_language - The content language of the product as a two-letter ISO 639-1 language code (for example, en). product_id - The ID of the product. For more information, see https://support.google.com/manufacturers/answer/6124116#id.
  • 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.Manufacturers.V1.Model.Attributes.t) -
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.Manufacturers.V1.Model.Empty{}} on success
  • {:error, info} on failure