Content API for Shopping . datafeedstatuses

Instance Methods

close()

Close httplib2 connections.

custombatch(body=None, x__xgafv=None)

Gets multiple Merchant Center datafeed statuses in a single request.

get(merchantId, datafeedId, country=None, language=None, x__xgafv=None)

Retrieves the status of a datafeed from your Merchant Center account.

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

Lists the statuses of the datafeeds 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 multiple Merchant Center datafeed statuses 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 datafeedstatuses request.
      "batchId": 42, # An entry ID, unique within the batch request.
      "country": "A String", # The country for which to get the datafeed status. If this parameter is provided then language must also be provided. Note that for multi-target datafeeds this parameter is required.
      "datafeedId": "A String", # The ID of the data feed to get.
      "language": "A String", # The language for which to get the datafeed status. If this parameter is provided then country must also be provided. Note that for multi-target datafeeds this parameter is required.
      "merchantId": "A String", # The ID of the managing account.
      "method": "A String", # The method of the batch entry. Acceptable values are: - "`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 datafeedstatuses response.
      "batchId": 42, # The ID of the request entry this entry responds to.
      "datafeedStatus": { # The status of a datafeed, i.e., the result of the last retrieval of the datafeed computed asynchronously when the feed processing is finished. # The requested data feed status. Defined if and only if the request was successful.
        "country": "A String", # The country for which the status is reported, represented as a CLDR territory code.
        "datafeedId": "A String", # The ID of the feed for which the status is reported.
        "errors": [ # The list of errors occurring in the feed.
          { # An error occurring in the feed, like "invalid price".
            "code": "A String", # The code of the error, e.g., "validation/invalid_value".
            "count": "A String", # The number of occurrences of the error in the feed.
            "examples": [ # A list of example occurrences of the error, grouped by product.
              { # An example occurrence for a particular error.
                "itemId": "A String", # The ID of the example item.
                "lineNumber": "A String", # Line number in the data feed where the example is found.
                "value": "A String", # The problematic value.
              },
            ],
            "message": "A String", # The error message, e.g., "Invalid price".
          },
        ],
        "itemsTotal": "A String", # The number of items in the feed that were processed.
        "itemsValid": "A String", # The number of items in the feed that were valid.
        "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "`content#datafeedStatus`"
        "language": "A String", # The two-letter ISO 639-1 language for which the status is reported.
        "lastUploadDate": "A String", # The last date at which the feed was uploaded.
        "processingStatus": "A String", # The processing status of the feed. Acceptable values are: - "`"`failure`": The feed could not be processed or all items had errors.`" - "`in progress`": The feed is being processed. - "`none`": The feed has not yet been processed. For example, a feed that has never been uploaded will have this processing status. - "`success`": The feed was processed successfully, though some items might have had errors.
        "warnings": [ # The list of errors occurring in the feed.
          { # An error occurring in the feed, like "invalid price".
            "code": "A String", # The code of the error, e.g., "validation/invalid_value".
            "count": "A String", # The number of occurrences of the error in the feed.
            "examples": [ # A list of example occurrences of the error, grouped by product.
              { # An example occurrence for a particular error.
                "itemId": "A String", # The ID of the example item.
                "lineNumber": "A String", # Line number in the data feed where the example is found.
                "value": "A String", # The problematic value.
              },
            ],
            "message": "A String", # The error message, e.g., "Invalid price".
          },
        ],
      },
      "errors": { # A list of errors returned by a failed batch entry. # A list of errors defined if and only if the request failed.
        "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#datafeedstatusesCustomBatchResponse".
}
get(merchantId, datafeedId, country=None, language=None, x__xgafv=None)
Retrieves the status of a datafeed from your Merchant Center account.

Args:
  merchantId: string, The ID of the account that manages the datafeed. This account cannot be a multi-client account. (required)
  datafeedId: string, The ID of the datafeed. (required)
  country: string, The country for which to get the datafeed status. If this parameter is provided then language must also be provided. Note that this parameter is required for feeds targeting multiple countries and languages, since a feed may have a different status for each target.
  language: string, The language for which to get the datafeed status. If this parameter is provided then country must also be provided. Note that this parameter is required for feeds targeting multiple countries and languages, since a feed may have a different status for each target.
  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 datafeed, i.e., the result of the last retrieval of the datafeed computed asynchronously when the feed processing is finished.
  "country": "A String", # The country for which the status is reported, represented as a CLDR territory code.
  "datafeedId": "A String", # The ID of the feed for which the status is reported.
  "errors": [ # The list of errors occurring in the feed.
    { # An error occurring in the feed, like "invalid price".
      "code": "A String", # The code of the error, e.g., "validation/invalid_value".
      "count": "A String", # The number of occurrences of the error in the feed.
      "examples": [ # A list of example occurrences of the error, grouped by product.
        { # An example occurrence for a particular error.
          "itemId": "A String", # The ID of the example item.
          "lineNumber": "A String", # Line number in the data feed where the example is found.
          "value": "A String", # The problematic value.
        },
      ],
      "message": "A String", # The error message, e.g., "Invalid price".
    },
  ],
  "itemsTotal": "A String", # The number of items in the feed that were processed.
  "itemsValid": "A String", # The number of items in the feed that were valid.
  "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "`content#datafeedStatus`"
  "language": "A String", # The two-letter ISO 639-1 language for which the status is reported.
  "lastUploadDate": "A String", # The last date at which the feed was uploaded.
  "processingStatus": "A String", # The processing status of the feed. Acceptable values are: - "`"`failure`": The feed could not be processed or all items had errors.`" - "`in progress`": The feed is being processed. - "`none`": The feed has not yet been processed. For example, a feed that has never been uploaded will have this processing status. - "`success`": The feed was processed successfully, though some items might have had errors.
  "warnings": [ # The list of errors occurring in the feed.
    { # An error occurring in the feed, like "invalid price".
      "code": "A String", # The code of the error, e.g., "validation/invalid_value".
      "count": "A String", # The number of occurrences of the error in the feed.
      "examples": [ # A list of example occurrences of the error, grouped by product.
        { # An example occurrence for a particular error.
          "itemId": "A String", # The ID of the example item.
          "lineNumber": "A String", # Line number in the data feed where the example is found.
          "value": "A String", # The problematic value.
        },
      ],
      "message": "A String", # The error message, e.g., "Invalid price".
    },
  ],
}
list(merchantId, maxResults=None, pageToken=None, x__xgafv=None)
Lists the statuses of the datafeeds in your Merchant Center account.

Args:
  merchantId: string, The ID of the account that manages the datafeeds. This account cannot be a multi-client account. (required)
  maxResults: integer, The maximum number of products to return in the response, used for paging.
  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#datafeedstatusesListResponse".
  "nextPageToken": "A String", # The token for the retrieval of the next page of datafeed statuses.
  "resources": [
    { # The status of a datafeed, i.e., the result of the last retrieval of the datafeed computed asynchronously when the feed processing is finished.
      "country": "A String", # The country for which the status is reported, represented as a CLDR territory code.
      "datafeedId": "A String", # The ID of the feed for which the status is reported.
      "errors": [ # The list of errors occurring in the feed.
        { # An error occurring in the feed, like "invalid price".
          "code": "A String", # The code of the error, e.g., "validation/invalid_value".
          "count": "A String", # The number of occurrences of the error in the feed.
          "examples": [ # A list of example occurrences of the error, grouped by product.
            { # An example occurrence for a particular error.
              "itemId": "A String", # The ID of the example item.
              "lineNumber": "A String", # Line number in the data feed where the example is found.
              "value": "A String", # The problematic value.
            },
          ],
          "message": "A String", # The error message, e.g., "Invalid price".
        },
      ],
      "itemsTotal": "A String", # The number of items in the feed that were processed.
      "itemsValid": "A String", # The number of items in the feed that were valid.
      "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "`content#datafeedStatus`"
      "language": "A String", # The two-letter ISO 639-1 language for which the status is reported.
      "lastUploadDate": "A String", # The last date at which the feed was uploaded.
      "processingStatus": "A String", # The processing status of the feed. Acceptable values are: - "`"`failure`": The feed could not be processed or all items had errors.`" - "`in progress`": The feed is being processed. - "`none`": The feed has not yet been processed. For example, a feed that has never been uploaded will have this processing status. - "`success`": The feed was processed successfully, though some items might have had errors.
      "warnings": [ # The list of errors occurring in the feed.
        { # An error occurring in the feed, like "invalid price".
          "code": "A String", # The code of the error, e.g., "validation/invalid_value".
          "count": "A String", # The number of occurrences of the error in the feed.
          "examples": [ # A list of example occurrences of the error, grouped by product.
            { # An example occurrence for a particular error.
              "itemId": "A String", # The ID of the example item.
              "lineNumber": "A String", # Line number in the data feed where the example is found.
              "value": "A String", # The problematic value.
            },
          ],
          "message": "A String", # The error message, e.g., "Invalid price".
        },
      ],
    },
  ],
}
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.