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.
REST Resource: regions
Stay organized with collections
Save and categorize content based on your preferences.
Resource: Region
Represents a geographic region that you can use as a target with both the RegionalInventory
and ShippingSettings
services. You can define regions as collections of either postal codes or, in some countries, using predefined geotargets.
JSON representation |
{
"regionId": string,
"merchantId": string,
"displayName": string,
"postalCodeArea": {
object (PostalCodeArea )
},
"geotargetArea": {
object (GeoTargetArea )
},
"regionalInventoryEligible": boolean,
"shippingEligible": boolean
} |
Fields |
regionId |
string
Output only. Immutable. The ID uniquely identifying each region.
|
merchantId |
string (int64 format)
Output only. Immutable. Merchant that owns the region.
|
displayName |
string
The display name of the region.
|
postalCodeArea |
object (PostalCodeArea )
A list of postal codes that defines the region area.
|
geotargetArea |
object (GeoTargetArea )
A list of geotargets that defines the region area.
|
regionalInventoryEligible |
boolean
Output only. Indicates if the region is eligible to use in the Regional pos.inventory configuration.
|
shippingEligible |
boolean
Output only. Indicates if the region is eligible to use in the Shipping Services configuration.
|
PostalCodeArea
A list of postal codes that defines the region area. Note: All regions defined using postal codes are accessible via the account's ShippingSettings.postalCodeGroups
resource.
JSON representation |
{
"regionCode": string,
"postalCodes": [
{
object (PostalCodeRange )
}
]
} |
Fields |
regionCode |
string
Required. CLDR territory code or the country the postal code group applies to.
|
postalCodes[] |
object (PostalCodeRange )
Required. A range of postal codes.
|
PostalCodeRange
A range of postal codes that defines the region area.
JSON representation |
{
"begin": string,
"end": string
} |
Fields |
begin |
string
Required. A postal code or a pattern of the form prefix* denoting the inclusive lower bound of the range defining the area. Examples values: "94108", "9410*", "9*".
|
end |
string
Optional. A postal code or a pattern of the form prefix* denoting the inclusive upper bound of the range defining the area. It must have the same length as postalCodeRangeBegin: if postalCodeRangeBegin is a postal code then postalCodeRangeEnd must be a postal code too; if postalCodeRangeBegin is a pattern then postalCodeRangeEnd must be a pattern with the same prefix length. Optional: if not set, then the area is defined as being all the postal codes matching postalCodeRangeBegin.
|
GeoTargetArea
A list of geotargets that defines the region area.
JSON representation |
{
"geotargetCriteriaIds": [
string
]
} |
Fields |
geotargetCriteriaIds[] |
string (int64 format)
Required. A non-empty list of location IDs. They must all be of the same location type (e.g., state).
|
Methods |
|
Creates a region definition in your Merchant Center account. |
|
Deletes a region definition from your Merchant Center account. |
|
Retrieves a region defined in your Merchant Center account. |
|
Lists the regions in your Merchant Center account. |
|
Updates a region definition in your Merchant Center account. |
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\u003eRegions can be defined by postal codes or geotargets and are used for inventory and shipping settings.\u003c/p\u003e\n"],["\u003cp\u003e\u003ccode\u003ePostalCodeArea\u003c/code\u003e defines a region using postal code ranges within a specific country or territory.\u003c/p\u003e\n"],["\u003cp\u003e\u003ccode\u003eGeoTargetArea\u003c/code\u003e defines a region using a list of location IDs, like states, from Google Ads geotargeting.\u003c/p\u003e\n"],["\u003cp\u003eYou can manage regions through methods such as creating, deleting, retrieving, listing, and updating them.\u003c/p\u003e\n"]]],["This content defines how to manage geographic regions within a Merchant Center account. Regions can be defined using `PostalCodeArea`, which includes `PostalCodeRange` (begin/end postal codes or patterns), or `GeoTargetArea`, utilizing location IDs. Regions have properties like `regionId`, `displayName`, and eligibility for regional inventory/shipping. The actions available for managing regions are: creating, deleting, retrieving, listing, and updating. A region can be target using the `RegionalInventory` and `ShippingSettings` services.\n"],null,["# REST Resource: regions\n\n- [Resource: Region](#Region)\n - [JSON representation](#Region.SCHEMA_REPRESENTATION)\n- [PostalCodeArea](#PostalCodeArea)\n - [JSON representation](#PostalCodeArea.SCHEMA_REPRESENTATION)\n- [PostalCodeRange](#PostalCodeRange)\n - [JSON representation](#PostalCodeRange.SCHEMA_REPRESENTATION)\n- [GeoTargetArea](#GeoTargetArea)\n - [JSON representation](#GeoTargetArea.SCHEMA_REPRESENTATION)\n- [Methods](#METHODS_SUMMARY)\n\nResource: Region\n----------------\n\nRepresents a geographic region that you can use as a target with both the `RegionalInventory` and `ShippingSettings` services. You can define regions as collections of either postal codes or, in some countries, using predefined geotargets.\n\n| JSON representation |\n|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| ``` { \"regionId\": string, \"merchantId\": string, \"displayName\": string, \"postalCodeArea\": { object (/shopping-content/reference/rest/v2.1/regions#PostalCodeArea) }, \"geotargetArea\": { object (/shopping-content/reference/rest/v2.1/regions#GeoTargetArea) }, \"regionalInventoryEligible\": boolean, \"shippingEligible\": boolean } ``` |\n\n| Fields ||\n|-----------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------|\n| `regionId` | `string` Output only. Immutable. The ID uniquely identifying each region. |\n| `merchantId` | `string (`[int64](https://developers.google.com/discovery/v1/type-format)` format)` Output only. Immutable. Merchant that owns the region. |\n| `displayName` | `string` The display name of the region. |\n| `postalCodeArea` | `object (`[PostalCodeArea](/shopping-content/reference/rest/v2.1/regions#PostalCodeArea)`)` A list of postal codes that defines the region area. |\n| `geotargetArea` | `object (`[GeoTargetArea](/shopping-content/reference/rest/v2.1/regions#GeoTargetArea)`)` A list of geotargets that defines the region area. |\n| `regionalInventoryEligible` | `boolean` Output only. Indicates if the region is eligible to use in the Regional pos.inventory configuration. |\n| `shippingEligible` | `boolean` Output only. Indicates if the region is eligible to use in the Shipping Services configuration. |\n\nPostalCodeArea\n--------------\n\nA list of postal codes that defines the region area. Note: All regions defined using postal codes are accessible via the account's `ShippingSettings.postalCodeGroups` resource.\n\n| JSON representation |\n|---------------------------------------------------------------------------------------------------------------------------------|\n| ``` { \"regionCode\": string, \"postalCodes\": [ { object (/shopping-content/reference/rest/v2.1/regions#PostalCodeRange) } ] } ``` |\n\n| Fields ||\n|-----------------|----------------------------------------------------------------------------------------------------------------------------------|\n| `regionCode` | `string` Required. CLDR territory code or the country the postal code group applies to. |\n| `postalCodes[]` | `object (`[PostalCodeRange](/shopping-content/reference/rest/v2.1/regions#PostalCodeRange)`)` Required. A range of postal codes. |\n\nPostalCodeRange\n---------------\n\nA range of postal codes that defines the region area.\n\n| JSON representation |\n|--------------------------------------------|\n| ``` { \"begin\": string, \"end\": string } ``` |\n\n| Fields ||\n|---------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `begin` | `string` Required. A postal code or a pattern of the form prefix\\* denoting the inclusive lower bound of the range defining the area. Examples values: \"94108\", \"9410\\*\", \"9\\*\". |\n| `end` | `string` Optional. A postal code or a pattern of the form prefix\\* denoting the inclusive upper bound of the range defining the area. It must have the same length as postalCodeRangeBegin: if postalCodeRangeBegin is a postal code then postalCodeRangeEnd must be a postal code too; if postalCodeRangeBegin is a pattern then postalCodeRangeEnd must be a pattern with the same prefix length. Optional: if not set, then the area is defined as being all the postal codes matching postalCodeRangeBegin. |\n\nGeoTargetArea\n-------------\n\nA list of geotargets that defines the region area.\n\n| JSON representation |\n|------------------------------------------------|\n| ``` { \"geotargetCriteriaIds\": [ string ] } ``` |\n\n| Fields ||\n|--------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `geotargetCriteriaIds[]` | `string (`[int64](https://developers.google.com/discovery/v1/type-format)` format)` Required. A non-empty list of [location IDs](https://developers.google.com/adwords/api/docs/appendix/geotargeting). They must all be of the same location type (e.g., state). |\n\n| Methods ------- ||\n|--------------------------------------------------------------------|----------------------------------------------------------------|\n| ### [create](/shopping-content/reference/rest/v2.1/regions/create) | Creates a region definition in your Merchant Center account. |\n| ### [delete](/shopping-content/reference/rest/v2.1/regions/delete) | Deletes a region definition from your Merchant Center account. |\n| ### [get](/shopping-content/reference/rest/v2.1/regions/get) | Retrieves a region defined in your Merchant Center account. |\n| ### [list](/shopping-content/reference/rest/v2.1/regions/list) | Lists the regions in your Merchant Center account. |\n| ### [patch](/shopping-content/reference/rest/v2.1/regions/patch) | Updates a region definition in your Merchant Center account. |"]]