Options
All
  • Public
  • Public/Protected
  • All
Menu

The specification for a geocoding request to be sent to the Geocoder.

Hierarchy

  • GeocoderRequest

Index

Properties

Optional address

address?: null | string

Address to geocode. One, and only one, of address, location and placeId must be supplied.

Optional bounds

LatLngBounds within which to search. Optional.

Optional componentRestrictions

componentRestrictions?: null | GeocoderComponentRestrictions

Components are used to restrict results to a specific area. A filter consists of one or more of: route, locality, administrativeArea, postalCode, country. Only the results that match all the filters will be returned. Filter values support the same methods of spelling correction and partial matching as other geocoding requests. Optional.

Optional location

location?: null | LatLng | LatLngLiteral

LatLng (or LatLngLiteral) for which to search. The geocoder performs a reverse geocode. See Reverse Geocoding for more information. One, and only one, of address, location and placeId must be supplied.

Optional placeId

placeId?: null | string

The place ID associated with the location. Place IDs uniquely identify a place in the Google Places database and on Google Maps. Learn more about place IDs in the Places API developer guide. The geocoder performs a reverse geocode. See Reverse Geocoding for more information. One, and only one, of address, location and placeId must be supplied.

Optional region

region?: null | string

Country code used to bias the search, specified as a two-character (non-numeric) Unicode region subtag / CLDR identifier. Optional. See Google Maps Platform Coverage Details for supported regions.

Generated using TypeDoc