google_api_content v0.2.0 GoogleApi.Content.V2.Api.Productstatuses View Source

API calls for all endpoints tagged Productstatuses.

Link to this section Summary

Functions

Gets the statuses of multiple products in a single request

Lists the statuses of the products in your Merchant Center account

Link to this section Functions

Link to this function content_productstatuses_custombatch(connection, optional_params \\ [], opts \\ []) View Source

Gets the statuses of multiple products in a single request.

Parameters

  • connection (GoogleApi.Content.V2.Connection): Connection to server
  • optional_params (KeywordList): [optional] Optional parameters

    • :alt (String.t): Data format for the response.
    • :fields (String.t): Selector specifying which fields to include in a partial 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.
    • :oauth_token (String.t): OAuth 2.0 token for the current user.
    • :prettyPrint (boolean()): Returns response with indentations and line breaks.
    • :quotaUser (String.t): An opaque string that represents a user for quota purposes. Must not exceed 40 characters.
    • :userIp (String.t): Deprecated. Please use quotaUser instead.
    • :includeAttributes (boolean()): Flag to include full product data in the results of this request. The default value is false.
    • :body (ProductstatusesCustomBatchRequest):

Returns

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

Link to this function content_productstatuses_get(connection, merchant_id, product_id, optional_params \\ [], opts \\ []) View Source

Gets the status of a product from your Merchant Center account.

Parameters

  • connection (GoogleApi.Content.V2.Connection): Connection to server
  • merchant_id (String.t): The ID of the account that contains the product. This account cannot be a multi-client account.
  • product_id (String.t): The REST id of the product.
  • optional_params (KeywordList): [optional] Optional parameters

    • :alt (String.t): Data format for the response.
    • :fields (String.t): Selector specifying which fields to include in a partial 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.
    • :oauth_token (String.t): OAuth 2.0 token for the current user.
    • :prettyPrint (boolean()): Returns response with indentations and line breaks.
    • :quotaUser (String.t): An opaque string that represents a user for quota purposes. Must not exceed 40 characters.
    • :userIp (String.t): Deprecated. Please use quotaUser instead.
    • :destinations ([String.t]): If set, only issues for the specified destinations are returned, otherwise only issues for the Shopping destination.
    • :includeAttributes (boolean()): Flag to include full product data in the result of this get request. The default value is false.

Returns

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

Link to this function content_productstatuses_list(connection, merchant_id, optional_params \\ [], opts \\ []) View Source

Lists the statuses of the products in your Merchant Center account.

Parameters

  • connection (GoogleApi.Content.V2.Connection): Connection to server
  • merchant_id (String.t): The ID of the account that contains the products. This account cannot be a multi-client account.
  • optional_params (KeywordList): [optional] Optional parameters

    • :alt (String.t): Data format for the response.
    • :fields (String.t): Selector specifying which fields to include in a partial 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.
    • :oauth_token (String.t): OAuth 2.0 token for the current user.
    • :prettyPrint (boolean()): Returns response with indentations and line breaks.
    • :quotaUser (String.t): An opaque string that represents a user for quota purposes. Must not exceed 40 characters.
    • :userIp (String.t): Deprecated. Please use quotaUser instead.
    • :destinations ([String.t]): If set, only issues for the specified destinations are returned, otherwise only issues for the Shopping destination.
    • :includeAttributes (boolean()): Flag to include full product data in the results of the list request. The default value is false.
    • :includeInvalidInsertedItems (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 (integer()): The maximum number of product statuses to return in the response, used for paging.
    • :pageToken (String.t): The token returned by the previous request.

Returns

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