@googlemaps/region-lookup

Index

Interfaces

Variables

Functions

Variables

Const lookupRegionUrl

lookupRegionUrl: "https://regionlookup.googleapis.com/v1alpha:lookupRegion" = "https://regionlookup.googleapis.com/v1alpha:lookupRegion"

Const searchRegionUrl

searchRegionUrl: "https://regionlookup.googleapis.com/v1alpha:searchRegion" = "https://regionlookup.googleapis.com/v1alpha:searchRegion"

Functions

lookupRegion

lookupRegion(__namedParameters: LookupRegionRequest, axiosInstance?: AxiosInstance): Promise<LookupRegionResponse>

- Defined in lookup-region.ts:171
Looks up a set of region Place IDs of types related to geographic boundaries.

The following region place types are supported for look up: postal_code, administrative_area_level_1, administrative_area_level_2, locality, neighborhood, and country.

Parameters
- __namedParameters: LookupRegionRequest
- axiosInstance: AxiosInstance = axios
Returns Promise<LookupRegionResponse>

searchRegion

searchRegion(__namedParameters: SearchRegionRequest, axiosInstance?: AxiosInstance): Promise<SearchRegionResponse>

- Defined in search-region.ts:148
Searches for a set of region Place IDs of types related to geographic boundaries.

Similar to {@link loookupRegion} RPC but instead of looking up Place IDs for the given RegionIdentifier, the API searches for Region Place IDs by considering all regions that are contained within a specified location. The RegionSearchValue is used to specify the search values.

The following region place types are supported for look up: postal_code, administrative_area_level_1, administrative_area_level_2, locality, neighborhood, and country.

Parameters
- __namedParameters: SearchRegionRequest
- axiosInstance: AxiosInstance = axios
Returns Promise<SearchRegionResponse>

Generated using TypeDoc