Method: datafeedstatuses.custombatch

  • This page details how to use the Datafeedstatuses Custom Batch API to get the status of multiple Merchant Center datafeeds in a single request.

  • The API uses a POST request to https://shoppingcontent.googleapis.com/content/v2.1/datafeedstatuses/batch and requires authorization with the https://www.googleapis.com/auth/content scope.

  • You need to provide a request body containing a DatafeedstatusesCustomBatchRequest object, which includes an array of DatafeedstatusesCustomBatchRequestEntry objects specifying the datafeeds to retrieve statuses for.

  • The response will contain a DatafeedstatusesCustomBatchResponse object with an array of DatafeedstatusesCustomBatchResponseEntry objects, each containing the status of a requested datafeed or any errors encountered.

Gets multiple Merchant Center datafeed statuses in a single request.

HTTP request

POST https://shoppingcontent.googleapis.com/content/v2.1/datafeedstatuses/batch

Request body

The request body contains an instance of DatafeedstatusesCustomBatchRequest.

Response body

If successful, the response body contains data with the following structure:

JSON representation 
{
  "entries": [
    {
      object (DatafeedstatusesCustomBatchResponseEntry)
    }
  ],
  "kind": string
}
Fields
entries[]

object (DatafeedstatusesCustomBatchResponseEntry)

The result of the execution of the batch requests.
kind

string

Identifies what kind of resource this is. Value: the fixed string "content#datafeedstatusesCustomBatchResponse".

Authorization scopes

Requires one of the following OAuth scopes:

  • https://www.googleapis.com/auth/content

For more information, see the OAuth 2.0 Overview.

DatafeedstatusesCustomBatchRequest

JSON representation 
{
  "entries": [
    {
      object (DatafeedstatusesCustomBatchRequestEntry)
    }
  ]
}
Fields
entries[]

object (DatafeedstatusesCustomBatchRequestEntry)

The request entries to be processed in the batch.

DatafeedstatusesCustomBatchRequestEntry

A batch entry encoding a single non-batch datafeedstatuses request.

JSON representation 
{
  "batchId": integer,
  "merchantId": string,
  "method": string,
  "datafeedId": string,
  "country": string,
  "feedLabel": string,
  "language": string
}
Fields
batchId

integer (uint32 format)

An entry ID, unique within the batch request.
merchantId

string

The ID of the managing account.
method

string

The method of the batch entry.

Acceptable values are:

  • "get"
datafeedId

string

The ID of the data feed to get.
country

string

Deprecated. Use feedLabel instead.

The country to get the datafeed status for. If this parameter is provided, then language must also be provided. Note that for multi-target datafeeds this parameter is required.
feedLabel

string

The feed label to get the datafeed status for. If this parameter is provided, then language must also be provided. Note that for multi-target datafeeds this parameter is required.
language

string

The language to get the datafeed status for. If this parameter is provided then country must also be provided. Note that for multi-target datafeeds this parameter is required.

DatafeedstatusesCustomBatchResponseEntry

A batch entry encoding a single non-batch datafeedstatuses response.

JSON representation 
{
  "batchId": integer,
  "datafeedStatus": {
    object (DatafeedStatus)
  },
  "errors": {
    object (Errors)
  }
}
Fields
batchId

integer (uint32 format)

The ID of the request entry this entry responds to.
datafeedStatus

object (DatafeedStatus)

The requested data feed status. Defined if and only if the request was successful.
errors

object (Errors)

A list of errors for failed custombatch entries.