# REST Resource: accounts.regions

- [Resource: Region](https://developers.google.com/merchant/api/reference/rest/accounts_v1/accounts.regions#Region)
  - [JSON representation](https://developers.google.com/merchant/api/reference/rest/accounts_v1/accounts.regions#Region.SCHEMA_REPRESENTATION)
- [PostalCodeArea](https://developers.google.com/merchant/api/reference/rest/accounts_v1/accounts.regions#PostalCodeArea)
  - [JSON representation](https://developers.google.com/merchant/api/reference/rest/accounts_v1/accounts.regions#PostalCodeArea.SCHEMA_REPRESENTATION)
- [PostalCodeRange](https://developers.google.com/merchant/api/reference/rest/accounts_v1/accounts.regions#PostalCodeRange)
  - [JSON representation](https://developers.google.com/merchant/api/reference/rest/accounts_v1/accounts.regions#PostalCodeRange.SCHEMA_REPRESENTATION)
- [GeoTargetArea](https://developers.google.com/merchant/api/reference/rest/accounts_v1/accounts.regions#GeoTargetArea)
  - [JSON representation](https://developers.google.com/merchant/api/reference/rest/accounts_v1/accounts.regions#GeoTargetArea.SCHEMA_REPRESENTATION)
- [RadiusArea](https://developers.google.com/merchant/api/reference/rest/accounts_v1/accounts.regions#RadiusArea)
  - [JSON representation](https://developers.google.com/merchant/api/reference/rest/accounts_v1/accounts.regions#RadiusArea.SCHEMA_REPRESENTATION)
- [RadiusUnits](https://developers.google.com/merchant/api/reference/rest/accounts_v1/accounts.regions#RadiusUnits)
- [Methods](https://developers.google.com/merchant/api/reference/rest/accounts_v1/accounts.regions#METHODS_SUMMARY)

## 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, radius areas or, in some countries, using predefined geotargets.

A region must be defined by specifying exactly one of `postalCodeArea`, `geotargetArea`, or `radiusArea`.

For more information, see [Set up regions](https://support.google.com/merchants/answer/7410946#zippy=%2Ccreate-a-new-region) for more information.

| JSON representation |
|---|
| ``` { "name": string, "postalCodeArea": { object (`https://developers.google.com/merchant/api/reference/rest/accounts_v1/accounts.regions#PostalCodeArea`) }, "geotargetArea": { object (`https://developers.google.com/merchant/api/reference/rest/accounts_v1/accounts.regions#GeoTargetArea`) }, "regionalInventoryEligible": boolean, "shippingEligible": boolean, "radiusArea": { object (`https://developers.google.com/merchant/api/reference/rest/accounts_v1/accounts.regions#RadiusArea`) }, "displayName": string } ``` |

| Fields ||
|---|---|
| `name` | `string` Identifier. The resource name of the region. Format: `accounts/{account}/regions/{region}` |
| `postalCodeArea` | ``object (`https://developers.google.com/merchant/api/reference/rest/accounts_v1/accounts.regions#PostalCodeArea`)`` Optional. A list of postal codes that defines the region area. |
| `geotargetArea` | ``object (`https://developers.google.com/merchant/api/reference/rest/accounts_v1/accounts.regions#GeoTargetArea`)`` Optional. A list of geotargets that defines the region area. |
| `regionalInventoryEligible` | `boolean` Output only. Indicates if the region is eligible for use in the Regional Inventory configuration. |
| `shippingEligible` | `boolean` Output only. Indicates if the region is eligible for use in the Shipping Services configuration. |
| `radiusArea` | ``object (`https://developers.google.com/merchant/api/reference/rest/accounts_v1/accounts.regions#RadiusArea`)`` Optional. A radius area that defines the region area. |
| `displayName` | `string` Optional. The display name of the region. |

## PostalCodeArea

A list of postal codes that defines the region area. Note: All regions defined using postal codes are accessible through the account's `ShippingSettings.postalCodeGroups` resource.

| JSON representation |
|---|
| ``` { "regionCode": string, "postalCodes": [ { object (`https://developers.google.com/merchant/api/reference/rest/accounts_v1/accounts.regions#PostalCodeRange`) } ] } ``` |

| Fields ||
|---|---|
| `regionCode` | `string` Required. [CLDR territory code](http://www.unicode.org/repos/cldr/tags/latest/common/main/en.xml) or the country the postal code group applies to. |
| `postalCodes[]` | ``object (`https://developers.google.com/merchant/api/reference/rest/accounts_v1/accounts.regions#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 (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 (for example, state). |

## RadiusArea

A radius area that defines the region area.

| JSON representation |
|---|
| ``` { "regionCode": string, "latLng": { object (`https://developers.google.com/merchant/api/reference/rest/Shared.Types/LatLng`) }, "radius": number, "radiusUnits": enum (`https://developers.google.com/merchant/api/reference/rest/accounts_v1/accounts.regions#RadiusUnits`) } ``` |

| Fields ||
|---|---|
| `regionCode` | `string` Required. [CLDR territory code](http://www.unicode.org/repos/cldr/tags/latest/common/main/en.xml) or the country the radius area applies to. |
| `latLng` | ``object (`https://developers.google.com/merchant/api/reference/rest/Shared.Types/LatLng`)`` Required. The center of the radius area. It represents a latitude/longitude pair in decimal degrees format. |
| `radius` | `number` Required. The radius distance of the area. |
| `radiusUnits` | ``enum (`https://developers.google.com/merchant/api/reference/rest/accounts_v1/accounts.regions#RadiusUnits`)`` Optional. The unit of the radius. |

## RadiusUnits

The unit of measurement of the radius. Default is KILOMETERS.

| Enums ||
|---|---|
| `RADIUS_UNITS_UNSPECIFIED` | Unused default value |
| `MILES` | The distance is measured in miles. |
| `KILOMETERS` | The distance is measured in kilometers. |

| ## Methods ||
|---|---|
| ### `https://developers.google.com/merchant/api/reference/rest/accounts_v1/accounts.regions/batchCreate` | Creates one or more regions in your Merchant Center account. |
| ### `https://developers.google.com/merchant/api/reference/rest/accounts_v1/accounts.regions/batchDelete` | Deletes multiple regions by name from your Merchant Center account. |
| ### `https://developers.google.com/merchant/api/reference/rest/accounts_v1/accounts.regions/batchUpdate` | Updates one or more regions in your Merchant Center account. |
| ### `https://developers.google.com/merchant/api/reference/rest/accounts_v1/accounts.regions/create` | Creates a region definition in your Merchant Center account. |
| ### `https://developers.google.com/merchant/api/reference/rest/accounts_v1/accounts.regions/delete` | Deletes a region definition from your Merchant Center account. |
| ### `https://developers.google.com/merchant/api/reference/rest/accounts_v1/accounts.regions/get` | Retrieves a region defined in your Merchant Center account. |
| ### `https://developers.google.com/merchant/api/reference/rest/accounts_v1/accounts.regions/list` | Lists the regions in your Merchant Center account. |
| ### `https://developers.google.com/merchant/api/reference/rest/accounts_v1/accounts.regions/patch` | Updates a region definition in your Merchant Center account. |