Content API for Shopping . productstatuses

Instance Methods

close()

Close httplib2 connections.

custombatch(body=None, x__xgafv=None)

Gets the statuses of multiple products in a single request.

get(merchantId, productId, destinations=None, x__xgafv=None)

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

list(merchantId, destinations=None, maxResults=None, pageToken=None, x__xgafv=None)

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

list_next()

Retrieves the next page of results.

Method Details

close()
Close httplib2 connections.
custombatch(body=None, x__xgafv=None)
Gets the statuses of multiple products in a single request.

Args:
  body: object, The request body.
    The object takes the form of:

{
  "entries": [ # The request entries to be processed in the batch.
    { # A batch entry encoding a single non-batch productstatuses request.
      "batchId": 42, # An entry ID, unique within the batch request.
      "destinations": [ # If set, only issues for the specified destinations are returned, otherwise only issues for the Shopping destination.
        "A String",
      ],
      "includeAttributes": True or False, # Deprecated: Setting this field has no effect and attributes are never included.
      "merchantId": "A String", # The ID of the managing account.
      "method": "A String", # The method of the batch entry. Acceptable values are: - "`get`"
      "productId": "A String", # The ID of the product whose status to get.
    },
  ],
}

  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    {
  "entries": [ # The result of the execution of the batch requests.
    { # A batch entry encoding a single non-batch productstatuses response.
      "batchId": 42, # The ID of the request entry this entry responds to.
      "errors": { # A list of errors returned by a failed batch entry. # A list of errors for failed custombatch entries. *Note:* Schema errors fail the whole request.
        "code": 42, # The HTTP status of the first error in `errors`.
        "errors": [ # A list of errors.
          { # An error returned by the API.
            "domain": "A String", # The domain of the error.
            "message": "A String", # A description of the error.
            "reason": "A String", # The error code.
          },
        ],
        "message": "A String", # The message of the first error in `errors`.
      },
      "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "`content#productstatusesCustomBatchResponseEntry`"
      "productStatus": { # The status of a product, that is, information about a product computed asynchronously. # The requested product status. Only defined if the request was successful.
        "creationDate": "A String", # Date on which the item has been created, in ISO 8601 format.
        "destinationStatuses": [ # The intended destinations for the product.
          {
            "approvedCountries": [ # List of country codes (ISO 3166-1 alpha-2) where the offer is approved.
              "A String",
            ],
            "destination": "A String", # The name of the destination
            "disapprovedCountries": [ # List of country codes (ISO 3166-1 alpha-2) where the offer is disapproved.
              "A String",
            ],
            "pendingCountries": [ # List of country codes (ISO 3166-1 alpha-2) where the offer is pending approval.
              "A String",
            ],
            "status": "A String", # Deprecated. Destination approval status in `targetCountry` of the offer.
          },
        ],
        "googleExpirationDate": "A String", # Date on which the item expires in Google Shopping, in ISO 8601 format.
        "itemLevelIssues": [ # A list of all issues associated with the product.
          {
            "applicableCountries": [ # List of country codes (ISO 3166-1 alpha-2) where issue applies to the offer.
              "A String",
            ],
            "attributeName": "A String", # The attribute's name, if the issue is caused by a single attribute.
            "code": "A String", # The error code of the issue.
            "description": "A String", # A short issue description in English.
            "destination": "A String", # The destination the issue applies to.
            "detail": "A String", # A detailed issue description in English.
            "documentation": "A String", # The URL of a web page to help with resolving this issue.
            "resolution": "A String", # Whether the issue can be resolved by the merchant.
            "servability": "A String", # How this issue affects serving of the offer.
          },
        ],
        "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "`content#productStatus`"
        "lastUpdateDate": "A String", # Date on which the item has been last updated, in ISO 8601 format.
        "link": "A String", # The link to the product.
        "productId": "A String", # The ID of the product for which status is reported.
        "title": "A String", # The title of the product.
      },
    },
  ],
  "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "`content#productstatusesCustomBatchResponse`".
}
get(merchantId, productId, destinations=None, x__xgafv=None)
Gets the status of a product from your Merchant Center account.

Args:
  merchantId: string, The ID of the account that contains the product. This account cannot be a multi-client account. (required)
  productId: string, The REST ID of the product. (required)
  destinations: string, If set, only issues for the specified destinations are returned, otherwise only issues for the Shopping destination. (repeated)
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # The status of a product, that is, information about a product computed asynchronously.
  "creationDate": "A String", # Date on which the item has been created, in ISO 8601 format.
  "destinationStatuses": [ # The intended destinations for the product.
    {
      "approvedCountries": [ # List of country codes (ISO 3166-1 alpha-2) where the offer is approved.
        "A String",
      ],
      "destination": "A String", # The name of the destination
      "disapprovedCountries": [ # List of country codes (ISO 3166-1 alpha-2) where the offer is disapproved.
        "A String",
      ],
      "pendingCountries": [ # List of country codes (ISO 3166-1 alpha-2) where the offer is pending approval.
        "A String",
      ],
      "status": "A String", # Deprecated. Destination approval status in `targetCountry` of the offer.
    },
  ],
  "googleExpirationDate": "A String", # Date on which the item expires in Google Shopping, in ISO 8601 format.
  "itemLevelIssues": [ # A list of all issues associated with the product.
    {
      "applicableCountries": [ # List of country codes (ISO 3166-1 alpha-2) where issue applies to the offer.
        "A String",
      ],
      "attributeName": "A String", # The attribute's name, if the issue is caused by a single attribute.
      "code": "A String", # The error code of the issue.
      "description": "A String", # A short issue description in English.
      "destination": "A String", # The destination the issue applies to.
      "detail": "A String", # A detailed issue description in English.
      "documentation": "A String", # The URL of a web page to help with resolving this issue.
      "resolution": "A String", # Whether the issue can be resolved by the merchant.
      "servability": "A String", # How this issue affects serving of the offer.
    },
  ],
  "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "`content#productStatus`"
  "lastUpdateDate": "A String", # Date on which the item has been last updated, in ISO 8601 format.
  "link": "A String", # The link to the product.
  "productId": "A String", # The ID of the product for which status is reported.
  "title": "A String", # The title of the product.
}
list(merchantId, destinations=None, maxResults=None, pageToken=None, x__xgafv=None)
Lists the statuses of the products in your Merchant Center account.

Args:
  merchantId: string, The ID of the account that contains the products. This account cannot be a multi-client account. (required)
  destinations: string, If set, only issues for the specified destinations are returned, otherwise only issues for the Shopping destination. (repeated)
  maxResults: integer, The maximum number of product statuses to return in the response, used for paging. The default value is 25. The maximum value is 250.
  pageToken: string, The token returned by the previous request.
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    {
  "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "`content#productstatusesListResponse`".
  "nextPageToken": "A String", # The token for the retrieval of the next page of products statuses.
  "resources": [
    { # The status of a product, that is, information about a product computed asynchronously.
      "creationDate": "A String", # Date on which the item has been created, in ISO 8601 format.
      "destinationStatuses": [ # The intended destinations for the product.
        {
          "approvedCountries": [ # List of country codes (ISO 3166-1 alpha-2) where the offer is approved.
            "A String",
          ],
          "destination": "A String", # The name of the destination
          "disapprovedCountries": [ # List of country codes (ISO 3166-1 alpha-2) where the offer is disapproved.
            "A String",
          ],
          "pendingCountries": [ # List of country codes (ISO 3166-1 alpha-2) where the offer is pending approval.
            "A String",
          ],
          "status": "A String", # Deprecated. Destination approval status in `targetCountry` of the offer.
        },
      ],
      "googleExpirationDate": "A String", # Date on which the item expires in Google Shopping, in ISO 8601 format.
      "itemLevelIssues": [ # A list of all issues associated with the product.
        {
          "applicableCountries": [ # List of country codes (ISO 3166-1 alpha-2) where issue applies to the offer.
            "A String",
          ],
          "attributeName": "A String", # The attribute's name, if the issue is caused by a single attribute.
          "code": "A String", # The error code of the issue.
          "description": "A String", # A short issue description in English.
          "destination": "A String", # The destination the issue applies to.
          "detail": "A String", # A detailed issue description in English.
          "documentation": "A String", # The URL of a web page to help with resolving this issue.
          "resolution": "A String", # Whether the issue can be resolved by the merchant.
          "servability": "A String", # How this issue affects serving of the offer.
        },
      ],
      "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "`content#productStatus`"
      "lastUpdateDate": "A String", # Date on which the item has been last updated, in ISO 8601 format.
      "link": "A String", # The link to the product.
      "productId": "A String", # The ID of the product for which status is reported.
      "title": "A String", # The title of the product.
    },
  ],
}
list_next()
Retrieves the next page of results.

        Args:
          previous_request: The request for the previous page. (required)
          previous_response: The response from the request for the previous page. (required)

        Returns:
          A request object that you can call 'execute()' on to request the next
          page. Returns None if there are no more items in the collection.