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:
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Missing the information I need","missingTheInformationINeed","thumb-down"],["Too complicated / too many steps","tooComplicatedTooManySteps","thumb-down"],["Out of date","outOfDate","thumb-down"],["Samples / code issue","samplesCodeIssue","thumb-down"],["Other","otherDown","thumb-down"]],["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,["- [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\nHTTP request\n\n`GET https://shoppingcontent.googleapis.com/content/v2.1/{merchantId}/regions`\n\nPath 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\nQuery 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\nRequest body\n\nThe request body must be empty.\n\nResponse body Response 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\nAuthorization 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)."]]