google_api_manufacturers v0.1.0 GoogleApi.Manufacturers.V1.Api.Accounts View Source

API calls for all endpoints tagged Accounts.

Link to this section Summary

Functions

Deletes the product from a Manufacturer Center account

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

Lists all the products in a Manufacturer Center account

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

Link to this section Functions

Link to this function manufacturers_accounts_products_delete(connection, parent, name, opts \\ []) View Source
manufacturers_accounts_products_delete(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  keyword()
) :: {:ok, GoogleApi.Manufacturers.V1.Model.Empty.t()} | {:error, Tesla.Env.t()}

Deletes the product from a Manufacturer Center account.

Parameters

  • connection (GoogleApi.Manufacturers.V1.Connection): Connection to server
  • parent (String.t): Parent ID in the format `accounts/{account_id}`. `account_id` - The ID of the Manufacturer Center account.
  • name (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.
  • opts (KeywordList): [optional] Optional parameters

    • :uploadType (String.t): Legacy upload protocol for media (e.g. "media", "multipart").
    • :fields (String.t): Selector specifying which fields to include in a partial response.
    • :callback (String.t): JSONP
    • :oauth_token (String.t): OAuth 2.0 token for the current user.
    • :$.xgafv (String.t): V1 error format.
    • :alt (String.t): Data format for response.
    • :key (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.
    • :access_token (String.t): OAuth access token.
    • :upload_protocol (String.t): Upload protocol for media (e.g. "raw", "multipart").
    • :quotaUser (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.
    • :prettyPrint (boolean()): Returns response with indentations and line breaks.

Returns

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

Link to this function manufacturers_accounts_products_get(connection, parent, name, opts \\ []) View Source
manufacturers_accounts_products_get(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  keyword()
) ::
  {:ok, GoogleApi.Manufacturers.V1.Model.Product.t()} | {:error, Tesla.Env.t()}

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 (GoogleApi.Manufacturers.V1.Connection): Connection to server
  • parent (String.t): Parent ID in the format `accounts/{account_id}`. `account_id` - The ID of the Manufacturer Center account.
  • name (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.
  • opts (KeywordList): [optional] Optional parameters

    • :uploadType (String.t): Legacy upload protocol for media (e.g. "media", "multipart").
    • :fields (String.t): Selector specifying which fields to include in a partial response.
    • :callback (String.t): JSONP
    • :oauth_token (String.t): OAuth 2.0 token for the current user.
    • :$.xgafv (String.t): V1 error format.
    • :alt (String.t): Data format for response.
    • :key (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.
    • :access_token (String.t): OAuth access token.
    • :upload_protocol (String.t): Upload protocol for media (e.g. "raw", "multipart").
    • :quotaUser (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.
    • :prettyPrint (boolean()): Returns response with indentations and line breaks.
    • :include ([String.t]): The information to be included in the response. Only sections listed here will be returned. If this parameter is not specified, ATTRIBUTES and ISSUES are returned. This behavior is temporary and will be removed once all clients are ready or at the latest end of July 2018. After that no sections will be returned.

Returns

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

Link to this function manufacturers_accounts_products_list(connection, parent, opts \\ []) View Source
manufacturers_accounts_products_list(Tesla.Env.client(), String.t(), keyword()) ::
  {:ok, GoogleApi.Manufacturers.V1.Model.ListProductsResponse.t()}
  | {:error, Tesla.Env.t()}

Lists all the products in a Manufacturer Center account.

Parameters

  • connection (GoogleApi.Manufacturers.V1.Connection): Connection to server
  • parent (String.t): Parent ID in the format `accounts/{account_id}`. `account_id` - The ID of the Manufacturer Center account.
  • opts (KeywordList): [optional] Optional parameters

    • :uploadType (String.t): Legacy upload protocol for media (e.g. "media", "multipart").
    • :fields (String.t): Selector specifying which fields to include in a partial response.
    • :callback (String.t): JSONP
    • :oauth_token (String.t): OAuth 2.0 token for the current user.
    • :$.xgafv (String.t): V1 error format.
    • :alt (String.t): Data format for response.
    • :key (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.
    • :access_token (String.t): OAuth access token.
    • :upload_protocol (String.t): Upload protocol for media (e.g. "raw", "multipart").
    • :quotaUser (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.
    • :prettyPrint (boolean()): Returns response with indentations and line breaks.
    • :pageToken (String.t): The token returned by the previous request.
    • :pageSize (integer()): Maximum number of product statuses to return in the response, used for paging.
    • :include ([String.t]): The information to be included in the response. Only sections listed here will be returned. If this parameter is not specified, ATTRIBUTES and ISSUES are returned. This behavior is temporary and will be removed once all clients are ready or at the latest end of July 2018. After that no sections will be returned.

Returns

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

Link to this function manufacturers_accounts_products_update(connection, parent, name, opts \\ []) View Source
manufacturers_accounts_products_update(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  keyword()
) :: {:ok, GoogleApi.Manufacturers.V1.Model.Empty.t()} | {:error, Tesla.Env.t()}

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 (GoogleApi.Manufacturers.V1.Connection): Connection to server
  • parent (String.t): Parent ID in the format `accounts/{account_id}`. `account_id` - The ID of the Manufacturer Center account.
  • name (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.
  • opts (KeywordList): [optional] Optional parameters

    • :uploadType (String.t): Legacy upload protocol for media (e.g. "media", "multipart").
    • :fields (String.t): Selector specifying which fields to include in a partial response.
    • :callback (String.t): JSONP
    • :oauth_token (String.t): OAuth 2.0 token for the current user.
    • :$.xgafv (String.t): V1 error format.
    • :alt (String.t): Data format for response.
    • :key (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.
    • :access_token (String.t): OAuth access token.
    • :upload_protocol (String.t): Upload protocol for media (e.g. "raw", "multipart").
    • :quotaUser (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.
    • :prettyPrint (boolean()): Returns response with indentations and line breaks.
    • :body (Attributes):

Returns

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