Method: collectionstatuses.list

  • Lists the statuses of the collections in your Merchant Center account.

  • Uses the GET method and requires the Merchant Center account ID as a path parameter.

  • Allows optional pagination using pageSize and pageToken query parameters.

  • Returns a list of collection statuses and a token for retrieving subsequent pages, if available.

  • Requires authorization with the https://www.googleapis.com/auth/content scope.

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

HTTP request

GET https://shoppingcontent.googleapis.com/content/v2.1/{merchantId}/collectionstatuses

Path parameters

Parameters
merchantId

string (int64 format)

Required. The ID of the account that contains the collection. This account cannot be a multi-client account.

Query parameters

Parameters
pageSize

integer

The maximum number of collection statuses to return in the response, used for paging. Defaults to 50; values above 1000 will be coerced to 1000.
pageToken

string

Token (if provided) to retrieve the subsequent page. All other parameters must match the original call that provided the page token.

Request body

The request body must be empty.

Response body

Response message for the collectionstatuses.list method.

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

JSON representation 
{
  "resources": [
    {
      object (CollectionStatus)
    }
  ],
  "nextPageToken": string
}
Fields
resources[]

object (CollectionStatus)

The collectionstatuses listed.
nextPageToken

string

A token, which can be sent as pageToken to retrieve the next page. If this field is omitted, there are no subsequent pages.

Authorization scopes

Requires one of the following OAuth scopes:

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

For more information, see the OAuth 2.0 Overview.