rocket
Meet
Merchant API
- the official successor to Content API for Shopping.
update
Get the latest
on new Merchant API features, bug fixes, and updates.
add_alert
Note: Content API for Shopping will be sunset on August 18, 2026.
Method: regions.list
Stay organized with collections
Save and categorize content based on your preferences.
Lists the regions in your Merchant Center account.
HTTP request
GET https://shoppingcontent.googleapis.com/content/v2.1/{merchantId}/regions
Path parameters
| Parameters |
merchantId |
string (int64 format)
Required. The id of the merchant for which to list region definitions.
|
Query parameters
| Parameters |
pageSize |
integer
The maximum number of regions to return. The service may return fewer than this value. If unspecified, at most 50 rules will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.
|
pageToken |
string
A page token, received from a previous regions.list call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to regions.list must match the call that provided the page token.
|
Request body
The request body must be empty.
Response body
Response message for the regions.list method.
If successful, the response body contains data with the following structure:
| JSON representation |
{
"regions": [
{
object (Region)
}
],
"nextPageToken": string
} |
| Fields |
regions[] |
object (Region)
The regions from the specified merchant.
|
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.
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2025-02-25 UTC.
[null,null,["Last updated 2025-02-25 UTC."],[[["\u003cp\u003eLists all regions defined for a given Merchant Center account.\u003c/p\u003e\n"],["\u003cp\u003eAllows pagination to retrieve large lists of regions with \u003ccode\u003epageSize\u003c/code\u003e and \u003ccode\u003epageToken\u003c/code\u003e parameters.\u003c/p\u003e\n"],["\u003cp\u003eReturns a list of \u003ccode\u003eRegion\u003c/code\u003e objects containing region information.\u003c/p\u003e\n"],["\u003cp\u003eRequires authorization with the \u003ccode\u003ehttps://www.googleapis.com/auth/content\u003c/code\u003e scope.\u003c/p\u003e\n"]]],["This document outlines the process for listing regions within a Merchant Center account using the `regions.list` method. A `GET` request is sent to `https://shoppingcontent.googleapis.com/content/v2.1/{merchantId}/regions`, with the `merchantId` as a required path parameter. Optional query parameters include `pageSize` (max 1000) and `pageToken` for pagination. The request body must be empty. A successful response will include an array of `regions` and an optional `nextPageToken` for further pagination. This method requires the OAuth scope `https://www.googleapis.com/auth/content`.\n"],null,["# Method: regions.list\n\n- [HTTP request](#body.HTTP_TEMPLATE)\n- [Path parameters](#body.PATH_PARAMETERS)\n- [Query parameters](#body.QUERY_PARAMETERS)\n- [Request body](#body.request_body)\n- [Response body](#body.response_body)\n - [JSON representation](#body.ListRegionsResponse.SCHEMA_REPRESENTATION)\n- [Authorization scopes](#body.aspect)\n- [Try it!](#try-it)\n\nLists the regions in your Merchant Center account.\n\n### HTTP request\n\n`GET https://shoppingcontent.googleapis.com/content/v2.1/{merchantId}/regions`\n\n### Path parameters\n\n| Parameters ||\n|--------------|------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `merchantId` | `string (`[int64](https://developers.google.com/discovery/v1/type-format)` format)` Required. The id of the merchant for which to list region definitions. |\n\n### Query parameters\n\n| Parameters ||\n|-------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `pageSize` | `integer` The maximum number of regions to return. The service may return fewer than this value. If unspecified, at most 50 rules will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000. |\n| `pageToken` | `string` A page token, received from a previous `regions.list` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `regions.list` must match the call that provided the page token. |\n\n### Request body\n\nThe request body must be empty.\n\n### Response body\n\nResponse message for the `regions.list` method.\n\nIf successful, the response body contains data with the following structure:\n\n| JSON representation |\n|-----------------------------------------------------------------------------------------------------------------------|\n| ``` { \"regions\": [ { object (/shopping-content/reference/rest/v2.1/regions#Region) } ], \"nextPageToken\": string } ``` |\n\n| Fields ||\n|-----------------|----------------------------------------------------------------------------------------------------------------------------------------|\n| `regions[]` | `object (`[Region](/shopping-content/reference/rest/v2.1/regions#Region)`)` The regions from the specified merchant. |\n| `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. |\n\n### Authorization scopes\n\nRequires one of the following OAuth scopes:\n\n- `https://www.googleapis.com/auth/content`\n\nFor more information, see the [OAuth 2.0 Overview](/identity/protocols/OAuth2)."]]