Method: accounts.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://merchantapi.googleapis.com/accounts/v1beta/{parent=accounts/*}/regions
The URL uses gRPC Transcoding syntax.
Path parameters
| Parameters |
parent |
string
Required. The account to list regions for. Format: accounts/{account}
|
Query parameters
| Parameters |
pageSize |
integer
Optional. The maximum number of regions to return. The service may return fewer than this value. If unspecified, at most 50 regions will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.
|
pageToken |
string
Optional. 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 business.
|
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 the following OAuth scope:
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-06-06 UTC.
[null,null,["Last updated 2025-06-06 UTC."],[[["\u003cp\u003eLists all available regions associated with a specified Merchant Center account.\u003c/p\u003e\n"],["\u003cp\u003eAllows pagination to retrieve large sets of regions using \u003ccode\u003epageSize\u003c/code\u003e and \u003ccode\u003epageToken\u003c/code\u003e parameters.\u003c/p\u003e\n"],["\u003cp\u003eThe response includes an array of regions and a token for accessing the next page if available.\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 API call retrieves a list of regions from a Merchant Center account. It uses a `GET` request to the specified URL, which includes the account ID in the path. You can control the number of regions returned via `pageSize` and navigate pages using `pageToken`. The request body must be empty. The response includes an array of regions and an optional `nextPageToken` for subsequent pages, and it requires `https://www.googleapis.com/auth/content` OAuth scope.\n"],null,["# Method: accounts.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://merchantapi.googleapis.com/accounts/v1beta/{parent=accounts/*}/regions`\n\nThe URL uses [gRPC Transcoding](https://google.aip.dev/127) syntax.\n\n### Path parameters\n\n| Parameters ||\n|----------|----------------------------------------------------------------------------------|\n| `parent` | `string` Required. The account to list regions for. Format: `accounts/{account}` |\n\n### Query parameters\n\n| Parameters ||\n|-------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `pageSize` | `integer` Optional. The maximum number of regions to return. The service may return fewer than this value. If unspecified, at most 50 regions will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000. |\n| `pageToken` | `string` Optional. 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 (/merchant/api/reference/rest/accounts_v1beta/accounts.regions#Region) } ], \"nextPageToken\": string } ``` |\n\n| Fields ||\n|-----------------|----------------------------------------------------------------------------------------------------------------------------------------|\n| `regions[]` | `object (`[Region](/merchant/api/reference/rest/accounts_v1beta/accounts.regions#Region)`)` The regions from the specified business. |\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 the following OAuth scope:\n\n- `https://www.googleapis.com/auth/content`\n\nFor more information, see the [OAuth 2.0 Overview](/identity/protocols/OAuth2)."]]
