Content API for Shopping . 1 . productstatuses

custombatch(body=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.
        "merchantId": "A String", # The ID of the managing account.
        "batchId": 42, # An entry ID, unique within the batch request.
        "includeAttributes": True or False,
        "destinations": [ # If set, only issues for the specified destinations are returned, otherwise only issues for the Shopping destination.
          "A String",
        ],
        "method": "A String",
        "productId": "A String", # The ID of the product whose status to get.
      },
    ],
  }


Returns:
  An object of the form:

    {
    "kind": "content#productstatusesCustomBatchResponse", # Identifies what kind of resource this is. Value: the fixed string "content#productstatusesCustomBatchResponse".
    "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.
        "kind": "content#productstatusesCustomBatchResponseEntry", # Identifies what kind of resource this is. Value: the fixed string "content#productstatusesCustomBatchResponseEntry".
        "errors": { # A list of errors returned by a failed batch entry. # A list of errors, if the request failed.
          "message": "A String", # The message of the first error in errors.
          "code": 42, # The HTTP status of the first error in errors.
          "errors": [ # A list of errors.
            { # An error returned by the API.
              "reason": "A String", # The error code.
              "domain": "A String", # The domain of the error.
              "message": "A String", # A description of the error.
            },
          ],
        },
        "productStatus": { # The status of a product, i.e., information about a product computed asynchronously. # The requested product status. Only defined if the request was successful.
          "itemLevelIssues": [ # A list of all issues associated with the product.
            {
              "destination": "A String", # The destination the issue applies to.
              "description": "A String", # A short issue description in English.
              "documentation": "A String", # The URL of a web page to help with resolving this issue.
              "attributeName": "A String", # The attribute's name, if the issue is caused by a single attribute.
              "detail": "A String", # A detailed issue description in English.
              "code": "A String", # The error code of the issue.
              "servability": "A String", # How this issue affects serving of the offer.
              "resolution": "A String", # Whether the issue can be resolved by the merchant.
            },
          ],
          "destinationStatuses": [ # The intended destinations for the product.
            {
              "status": "A String",
              "destination": "A String", # The name of the destination
            },
          ],
          "title": "A String", # The title of the product.
          "googleExpirationDate": "A String", # Date on which the item expires in Google Shopping, in ISO 8601 format.
          "lastUpdateDate": "A String", # Date on which the item has been last updated, in ISO 8601 format.
          "link": "A String", # The link to the product.
          "creationDate": "A String", # Date on which the item has been created, in ISO 8601 format.
          "kind": "content#productStatus", # Identifies what kind of resource this is. Value: the fixed string "content#productStatus".
          "productId": "A String", # The ID of the product for which status is reported.
        },
      },
    ],
  }

get(merchantId=*, productId=*, destinations=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)

Returns:
  An object of the form:

    { # The status of a product, i.e., information about a product computed asynchronously.
    "itemLevelIssues": [ # A list of all issues associated with the product.
      {
        "destination": "A String", # The destination the issue applies to.
        "description": "A String", # A short issue description in English.
        "documentation": "A String", # The URL of a web page to help with resolving this issue.
        "attributeName": "A String", # The attribute's name, if the issue is caused by a single attribute.
        "detail": "A String", # A detailed issue description in English.
        "code": "A String", # The error code of the issue.
        "servability": "A String", # How this issue affects serving of the offer.
        "resolution": "A String", # Whether the issue can be resolved by the merchant.
      },
    ],
    "destinationStatuses": [ # The intended destinations for the product.
      {
        "status": "A String",
        "destination": "A String", # The name of the destination
      },
    ],
    "title": "A String", # The title of the product.
    "googleExpirationDate": "A String", # Date on which the item expires in Google Shopping, in ISO 8601 format.
    "lastUpdateDate": "A String", # Date on which the item has been last updated, in ISO 8601 format.
    "link": "A String", # The link to the product.
    "creationDate": "A String", # Date on which the item has been created, in ISO 8601 format.
    "kind": "content#productStatus", # Identifies what kind of resource this is. Value: the fixed string "content#productStatus".
    "productId": "A String", # The ID of the product for which status is reported.
  }

list(merchantId=*, pageToken=None, maxResults=None, destinations=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)
  pageToken: string, The token returned by the previous request.
  maxResults: integer, The maximum number of product statuses to return in the response, used for paging.
  destinations: string, If set, only issues for the specified destinations are returned, otherwise only issues for the Shopping destination. (repeated)

Returns:
  An object of the form:

    {
    "nextPageToken": "A String", # The token for the retrieval of the next page of products statuses.
    "kind": "content#productstatusesListResponse", # Identifies what kind of resource this is. Value: the fixed string "content#productstatusesListResponse".
    "resources": [
      { # The status of a product, i.e., information about a product computed asynchronously.
        "itemLevelIssues": [ # A list of all issues associated with the product.
          {
            "destination": "A String", # The destination the issue applies to.
            "description": "A String", # A short issue description in English.
            "documentation": "A String", # The URL of a web page to help with resolving this issue.
            "attributeName": "A String", # The attribute's name, if the issue is caused by a single attribute.
            "detail": "A String", # A detailed issue description in English.
            "code": "A String", # The error code of the issue.
            "servability": "A String", # How this issue affects serving of the offer.
            "resolution": "A String", # Whether the issue can be resolved by the merchant.
          },
        ],
        "destinationStatuses": [ # The intended destinations for the product.
          {
            "status": "A String",
            "destination": "A String", # The name of the destination
          },
        ],
        "title": "A String", # The title of the product.
        "googleExpirationDate": "A String", # Date on which the item expires in Google Shopping, in ISO 8601 format.
        "lastUpdateDate": "A String", # Date on which the item has been last updated, in ISO 8601 format.
        "link": "A String", # The link to the product.
        "creationDate": "A String", # Date on which the item has been created, in ISO 8601 format.
        "kind": "content#productStatus", # Identifies what kind of resource this is. Value: the fixed string "content#productStatus".
        "productId": "A String", # The ID of the product for which status is reported.
      },
    ],
  }

list_next(previous_request=*, previous_response=*)

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.