Version v2 of the Content API is scheduled for sunset on September 30th, 2021. Onboarding to v2 will stop on April 30, 2021. To avoid disruptions with your integration, please migrate to v2.1 as soon as possible.

For more information, see Migrating to v2.1 and this blog post.

Method: collections.list

Lists the collections in your Merchant Center account. The response might contain fewer items than specified by pageSize. Rely on nextPageToken to determine if there are more items to be requested.

HTTP request

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

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 collections 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

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

Response message for the collections.list method.

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

object (Collection)

The collections 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.