REST Resource: geographicalRegions

Stay organized with collections Save and categorize content based on your preferences.

Resource: GeographicalRegion

JSON representation
{
  "name": string,
  "type": enum (Type),
  "title": string,
  "localTitle": string,
  "administrativeAreaTitle": string,
  "regionCode": string
}
Fields
name

string

The resource name of the GeographicalRegion. Format: geographicalRegions/{geographicalRegion}

type

enum (Type)

The GeographicalRegion type.

title

string

GeographicalRegion English title. Example: 'Tokyo Metropolitan Area'

localTitle

string

GeographicalRegion local language title. Example: '首都圏'

administrativeAreaTitle

string

Region's ADMINISTRATIVE_AREA.

regionCode

string

The GeographicalRegion region code. Unicode CLDR region codes (list).

Type

GeographicalRegion type. For all types other then IRIS, see Google Maps API Geocoding types for more details.

Enums
TYPE_UNSPECIFIED
COUNTRY Indicates the national political entity, and is typically the highest order type returned by GeoRegion
ADMINISTRATIVE_AREA1 Indicates a first-order civil entity below the country level. Within the United States, these administrative levels are states.
ADMINISTRATIVE_AREA2
LOCALITY Indicates an incorporated city or town political entity.
COLLOQUIAL_AREA
STATISTICAL_AREA
DESIGNATED_MARKET_AREA Geographic areas in the United States in which local television viewing is measured by Nielsen. Only available in United States. See DMA for more details.
IRIS A 9 digit ID for the socio-demographic regions published by the French government. Only available in France. See IRIS for more details.
SUBLOCALITY1 In France, INSEE regions defined as SUBLOCALITY1.
POSTAL_CODE_PREFIX
POSTAL_CODE

Methods

batchGet

Returns multiple requested GeographicalRegion resources.

get

Returns the requested GeographicalRegion.
Search all available GeographicalRegions by region_code and title.