From bc2028b10e008f2b61ea792f2403eb8a2ef7b0bc Mon Sep 17 00:00:00 2001 From: googlemaps-bot Date: Mon, 3 Feb 2025 22:37:28 +0000 Subject: [PATCH] chore: publish docs --- classes/Client.html | 6 +- enums/AspectRatingType.html | 4 +- enums/DirectionsReponseStatus.html | 22 ++-- enums/DirectionsResponseStatus.html | 22 ++-- enums/GeocodedWaypointStatus.html | 6 +- enums/GeocodingAddressComponentType.html | 24 ++-- enums/GeolocateErrorReason.html | 12 +- enums/Language.html | 124 +++++++++--------- enums/LocationType.html | 10 +- enums/Maneuver.html | 4 +- enums/PlaceAutocompleteType.html | 12 +- enums/PlaceIdScope.html | 6 +- enums/PlaceInputType.html | 4 +- enums/PlaceType1.html | 8 +- enums/PlaceType2.html | 36 ++--- enums/PlacesNearbyRanking.html | 6 +- enums/RadioType.html | 4 +- enums/ReverseGeocodingLocationType.html | 10 +- enums/Status.html | 22 ++-- enums/TrafficModel.html | 8 +- enums/TransitMode.html | 12 +- enums/TransitRoutingPreference.html | 6 +- enums/TravelMode.html | 10 +- enums/TravelRestriction.html | 10 +- enums/UnitSystem.html | 6 +- enums/VehicleType.html | 36 ++--- functions/defaultAxiosInstance.html | 2 +- interfaces/AddressComponent.html | 8 +- interfaces/AddressDescriptor.html | 4 +- interfaces/AddressGeometry.html | 10 +- interfaces/AlternativePlaceId.html | 6 +- interfaces/ApiKeyParams.html | 4 +- interfaces/AspectRating.html | 6 +- interfaces/CellTower.html | 16 +-- interfaces/ClientOptions.html | 6 +- interfaces/DirectionsRequest.html | 4 +- interfaces/DirectionsResponse.html | 4 +- interfaces/DirectionsResponseData.html | 16 +-- interfaces/DirectionsRoute.html | 20 +-- interfaces/DirectionsStep.html | 22 ++-- interfaces/Distance.html | 6 +- interfaces/DistanceMatrixRequest.html | 4 +- interfaces/DistanceMatrixResponse.html | 4 +- interfaces/DistanceMatrixResponseData.html | 14 +- interfaces/DistanceMatrixRow.html | 4 +- interfaces/DistanceMatrixRowElement.html | 12 +- interfaces/Duration.html | 6 +- interfaces/ElevationRequest.html | 4 +- interfaces/ElevationResponse.html | 4 +- interfaces/ElevationResponseData.html | 12 +- interfaces/FindPlaceFromTextRequest.html | 4 +- interfaces/FindPlaceFromTextResponse.html | 4 +- interfaces/FindPlaceFromTextResponseData.html | 12 +- interfaces/GeocodeComponents.html | 12 +- interfaces/GeocodeRequest.html | 4 +- interfaces/GeocodeResponse.html | 4 +- interfaces/GeocodeResponseData.html | 12 +- interfaces/GeocodeResult.html | 18 +-- interfaces/GeocodedWaypoint.html | 10 +- interfaces/GeolocateRequest.html | 4 +- interfaces/GeolocateResponseData.html | 14 +- interfaces/GeolocateResponseError.html | 4 +- interfaces/GeolocateResponseSuccess.html | 4 +- interfaces/LatLngBounds.html | 4 +- interfaces/LatLngLiteral.html | 4 +- interfaces/LatLngLiteralVerbose.html | 4 +- interfaces/NearestRoadsRequest.html | 4 +- interfaces/NearestRoadsResponse.html | 4 +- interfaces/OpeningHours.html | 8 +- interfaces/OpeningHoursTime.html | 6 +- interfaces/OpeningPeriod.html | 6 +- interfaces/PlaceAutocompleteRequest.html | 4 +- interfaces/PlaceAutocompleteResponse.html | 4 +- interfaces/PlaceAutocompleteResponseData.html | 12 +- interfaces/PlaceAutocompleteResult.html | 16 +-- interfaces/PlaceData.html | 54 ++++---- interfaces/PlaceDetailsRequest.html | 4 +- interfaces/PlaceDetailsResponse.html | 4 +- interfaces/PlaceDetailsResponseData.html | 10 +- interfaces/PlaceEditorialSummary.html | 6 +- interfaces/PlacePhoto.html | 10 +- interfaces/PlacePhotoRequest.html | 4 +- interfaces/PlacePhotoResponse.html | 2 +- .../PlaceQueryAutocompletePrediction.html | 8 +- interfaces/PlaceQueryAutocompleteRequest.html | 4 +- .../PlaceQueryAutocompleteResponse.html | 4 +- .../PlaceQueryAutocompleteResponseData.html | 12 +- interfaces/PlaceReview.html | 18 +-- interfaces/PlacesNearbyRequest.html | 4 +- interfaces/PlacesNearbyResponse.html | 4 +- interfaces/PlacesNearbyResponseData.html | 10 +- interfaces/PlusCode.html | 6 +- interfaces/PositionalElevationParams.html | 4 +- interfaces/PredictionSubstring.html | 6 +- interfaces/PredictionTerm.html | 6 +- interfaces/PremiumPlanParams.html | 6 +- interfaces/ResponseData.html | 10 +- interfaces/ReverseGeocodeRequest.html | 4 +- interfaces/ReverseGeocodeResponse.html | 4 +- interfaces/ReverseGeocodeResponseData.html | 14 +- interfaces/RouteLeg.html | 22 ++-- interfaces/SampledPathElevationParams.html | 6 +- interfaces/SnapToRoadsRequest.html | 4 +- interfaces/SnapToRoadsResponse.html | 4 +- interfaces/SnappedPoint.html | 8 +- interfaces/StructuredFormatting.html | 10 +- interfaces/TextSearchRequest.html | 4 +- interfaces/TextSearchResponse.html | 4 +- interfaces/TextSearchResponseData.html | 10 +- interfaces/Time.html | 8 +- interfaces/TimeZoneRequest.html | 4 +- interfaces/TimeZoneResponse.html | 4 +- interfaces/TimeZoneResponseData.html | 18 +-- interfaces/TransitAgency.html | 8 +- interfaces/TransitDetails.html | 18 +-- interfaces/TransitFare.html | 8 +- interfaces/TransitLine.html | 18 +-- interfaces/TransitStop.html | 6 +- interfaces/TransitVehicle.html | 10 +- interfaces/WifiAccessPoint.html | 12 +- types/AddressType.html | 2 +- types/Config.html | 2 +- types/GeolocateResponse.html | 2 +- types/LatLng.html | 2 +- types/LatLngArray.html | 2 +- types/LatLngString.html | 2 +- types/Place.html | 2 +- types/RequestParams.html | 2 +- variables/AddressType-1.html | 2 +- variables/X_GOOG_MAPS_EXPERIENCE_ID.html | 2 +- variables/acceptEncoding.html | 2 +- variables/defaultHttpsAgent.html | 2 +- variables/defaultTimeout.html | 2 +- variables/userAgent.html | 2 +- variables/version.html | 2 +- 135 files changed, 622 insertions(+), 622 deletions(-) diff --git a/classes/Client.html b/classes/Client.html index 4b82ed73d1..fb4fd3cb2e 100644 --- a/classes/Client.html +++ b/classes/Client.html @@ -9,7 +9,7 @@

Instantiate with axiosInstance Advanced

const axiosInstance = axios.create(config)
const client = Client({axiosInstance})
-

Constructors

constructor +

Constructors

constructor

Methods

clearExperienceId directions distancematrix @@ -29,8 +29,8 @@ snapToRoads textSearch timezone -

Constructors

constructor

Methods

clearExperienceId

directions

distancematrix

elevation

findPlaceFromText

geocode

Constructors

constructor

Methods

clearExperienceId

directions

distancematrix

elevation

findPlaceFromText

geocode

  • geocode(request: GeocodeRequest): Promise<GeocodeResponse>

  • An example use of this function.

    import { Client } from '@googlemaps/google-maps-services-js';

    const args = {
      params: {
        key: '<your-api-key>',
        address: 'Perth 4WD & Commercial Centre',
      }
    };
    const client = new Client();
    client.geocode(args).then(gcResponse => {
      const str = JSON.stringify(gcResponse.data.results[0]);
      console.log(`First result is: ${str}`);
    });
    -

    Parameters

    Returns Promise<GeocodeResponse>

geolocate

getExperienceId

nearestRoads

placeAutocomplete

placeDetails

placePhoto

placeQueryAutocomplete

placesNearby

reverseGeocode

setExperienceId

  • setExperienceId(...ids: string[]): void

  • Parameters

    • ...ids: string[]

    Returns void

snapToRoads

textSearch

timezone

Settings

Member Visibility

On This Page

Instantiate with defaultsInstantiate with configInstantiate with axiosInstance Advanced
Constructors
Methods
+

Parameters

Returns Promise<GeocodeResponse>

geolocate

getExperienceId

nearestRoads

placeAutocomplete

placeDetails

placePhoto

placeQueryAutocomplete

placesNearby

reverseGeocode

setExperienceId

snapToRoads

textSearch

timezone

Settings

Member Visibility

On This Page

Instantiate with defaultsInstantiate with configInstantiate with axiosInstance Advanced
Constructors
Methods
diff --git a/enums/AspectRatingType.html b/enums/AspectRatingType.html index eed0f95318..07c078ef0e 100644 --- a/enums/AspectRatingType.html +++ b/enums/AspectRatingType.html @@ -1,4 +1,4 @@ -AspectRatingType | Google Maps Services Node Client

Enumeration AspectRatingType

Enumeration Members

appeal +AspectRatingType | Google Maps Services Node Client

Enumeration AspectRatingType

Enumeration Members

appeal atmosphere decor facilities @@ -6,4 +6,4 @@ overall quality service -

Enumeration Members

appeal

appeal: "appeal"

atmosphere

atmosphere: "atmosphere"

decor

decor: "decor"

facilities

facilities: "facilities"

food

food: "food"

overall

overall: "overall"

quality

quality: "quality"

service

service: "service"

Settings

Member Visibility

On This Page

Enumeration Members
+

Enumeration Members

appeal

appeal: "appeal"

atmosphere

atmosphere: "atmosphere"

decor

decor: "decor"

facilities

facilities: "facilities"

food

food: "food"

overall

overall: "overall"

quality

quality: "quality"

service

service: "service"

Settings

Member Visibility

On This Page

Enumeration Members
diff --git a/enums/DirectionsReponseStatus.html b/enums/DirectionsReponseStatus.html index 0cb41bec30..524d02bf8e 100644 --- a/enums/DirectionsReponseStatus.html +++ b/enums/DirectionsReponseStatus.html @@ -1,6 +1,6 @@ DirectionsReponseStatus | Google Maps Services Node Client

Enumeration DirectionsReponseStatus

The status field within the Directions response object contains the status of the request, and may contain debugging information to help you track down why the Directions service failed.

-

Deprecated

Enumeration Members

INVALID_REQUEST +

Deprecated

Enumeration Members

INVALID_REQUEST MAX_ROUTE_LENGTH_EXCEEDED MAX_WAYPOINTS_EXCEEDED NOT_FOUND @@ -11,15 +11,15 @@ UNKNOWN_ERROR ZERO_RESULTS

Enumeration Members

INVALID_REQUEST

INVALID_REQUEST: "INVALID_REQUEST"

indicates that the provided request was invalid. Common causes of this status include an invalid parameter or parameter value.

-

MAX_ROUTE_LENGTH_EXCEEDED

MAX_ROUTE_LENGTH_EXCEEDED: "MAX_ROUTE_LENGTH_EXCEEDED"

indicates the requested route is too long and cannot be processed. +

MAX_ROUTE_LENGTH_EXCEEDED

MAX_ROUTE_LENGTH_EXCEEDED: "MAX_ROUTE_LENGTH_EXCEEDED"

indicates the requested route is too long and cannot be processed. This error occurs when more complex directions are returned. Try reducing the number of waypoints, turns, or instructions.

-

MAX_WAYPOINTS_EXCEEDED

MAX_WAYPOINTS_EXCEEDED: "MAX_WAYPOINTS_EXCEEDED"

indicates that too many waypoints were provided in the request. For applications using the Directions API as a web service, +

MAX_WAYPOINTS_EXCEEDED

MAX_WAYPOINTS_EXCEEDED: "MAX_WAYPOINTS_EXCEEDED"

indicates that too many waypoints were provided in the request. For applications using the Directions API as a web service, or the directions service in the Maps JavaScript API, the maximum allowed number of waypoints is 23, plus the origin and destination.

-

NOT_FOUND

NOT_FOUND: "NOT_FOUND"

indicates at least one of the locations specified in the request's origin, destination, or waypoints could not be geocoded.

-

OK

OK: "OK"

indicates the response contains a valid result.

-

OVER_DAILY_LIMIT

OVER_DAILY_LIMIT: "OVER_DAILY_LIMIT"

indicates any of the following:

+

NOT_FOUND

NOT_FOUND: "NOT_FOUND"

indicates at least one of the locations specified in the request's origin, destination, or waypoints could not be geocoded.

+

OK

OK: "OK"

indicates the response contains a valid result.

+

OVER_DAILY_LIMIT

OVER_DAILY_LIMIT: "OVER_DAILY_LIMIT"

indicates any of the following:

  • The API key is missing or invalid.
  • Billing has not been enabled on your account.
    • @@ -27,8 +27,8 @@
  • The provided method of payment is no longer valid (for example, a credit card has expired). See the Maps FAQ to learn how to fix this.
-

OVER_QUERY_LIMIT

OVER_QUERY_LIMIT: "OVER_QUERY_LIMIT"

indicates the service has received too many requests from your application within the allowed time period.

-

REQUEST_DENIED

REQUEST_DENIED: "REQUEST_DENIED"

indicates that the service denied use of the directions service by your application.

-

UNKNOWN_ERROR

UNKNOWN_ERROR: "UNKNOWN_ERROR"

indicates a directions request could not be processed due to a server error. The request may succeed if you try again.

-

ZERO_RESULTS

ZERO_RESULTS: "ZERO_RESULTS"

indicates no route could be found between the origin and destination.

-

Settings

Member Visibility

On This Page

Enumeration Members
+

OVER_QUERY_LIMIT

OVER_QUERY_LIMIT: "OVER_QUERY_LIMIT"

indicates the service has received too many requests from your application within the allowed time period.

+

REQUEST_DENIED

REQUEST_DENIED: "REQUEST_DENIED"

indicates that the service denied use of the directions service by your application.

+

UNKNOWN_ERROR

UNKNOWN_ERROR: "UNKNOWN_ERROR"

indicates a directions request could not be processed due to a server error. The request may succeed if you try again.

+

ZERO_RESULTS

ZERO_RESULTS: "ZERO_RESULTS"

indicates no route could be found between the origin and destination.

+

Settings

Member Visibility

On This Page

Enumeration Members
diff --git a/enums/DirectionsResponseStatus.html b/enums/DirectionsResponseStatus.html index 07873c151b..2e94bf6d8f 100644 --- a/enums/DirectionsResponseStatus.html +++ b/enums/DirectionsResponseStatus.html @@ -1,6 +1,6 @@ DirectionsResponseStatus | Google Maps Services Node Client

Enumeration DirectionsResponseStatus

The status field within the Directions response object contains the status of the request, and may contain debugging information to help you track down why the Directions service failed.

-

Enumeration Members

INVALID_REQUEST +

Enumeration Members

INVALID_REQUEST MAX_ROUTE_LENGTH_EXCEEDED MAX_WAYPOINTS_EXCEEDED NOT_FOUND @@ -11,15 +11,15 @@ UNKNOWN_ERROR ZERO_RESULTS

Enumeration Members

INVALID_REQUEST

INVALID_REQUEST: "INVALID_REQUEST"

indicates that the provided request was invalid. Common causes of this status include an invalid parameter or parameter value.

-

MAX_ROUTE_LENGTH_EXCEEDED

MAX_ROUTE_LENGTH_EXCEEDED: "MAX_ROUTE_LENGTH_EXCEEDED"

indicates the requested route is too long and cannot be processed. +

MAX_ROUTE_LENGTH_EXCEEDED

MAX_ROUTE_LENGTH_EXCEEDED: "MAX_ROUTE_LENGTH_EXCEEDED"

indicates the requested route is too long and cannot be processed. This error occurs when more complex directions are returned. Try reducing the number of waypoints, turns, or instructions.

-

MAX_WAYPOINTS_EXCEEDED

MAX_WAYPOINTS_EXCEEDED: "MAX_WAYPOINTS_EXCEEDED"

indicates that too many waypoints were provided in the request. For applications using the Directions API as a web service, +

MAX_WAYPOINTS_EXCEEDED

MAX_WAYPOINTS_EXCEEDED: "MAX_WAYPOINTS_EXCEEDED"

indicates that too many waypoints were provided in the request. For applications using the Directions API as a web service, or the directions service in the Maps JavaScript API, the maximum allowed number of waypoints is 23, plus the origin and destination.

-

NOT_FOUND

NOT_FOUND: "NOT_FOUND"

indicates at least one of the locations specified in the request's origin, destination, or waypoints could not be geocoded.

-

OK

OK: "OK"

indicates the response contains a valid result.

-

OVER_DAILY_LIMIT

OVER_DAILY_LIMIT: "OVER_DAILY_LIMIT"

indicates any of the following:

+

NOT_FOUND

NOT_FOUND: "NOT_FOUND"

indicates at least one of the locations specified in the request's origin, destination, or waypoints could not be geocoded.

+

OK

OK: "OK"

indicates the response contains a valid result.

+

OVER_DAILY_LIMIT

OVER_DAILY_LIMIT: "OVER_DAILY_LIMIT"

indicates any of the following:

  • The API key is missing or invalid.
  • Billing has not been enabled on your account.
    • @@ -27,8 +27,8 @@
  • The provided method of payment is no longer valid (for example, a credit card has expired). See the Maps FAQ to learn how to fix this.
-

OVER_QUERY_LIMIT

OVER_QUERY_LIMIT: "OVER_QUERY_LIMIT"

indicates the service has received too many requests from your application within the allowed time period.

-

REQUEST_DENIED

REQUEST_DENIED: "REQUEST_DENIED"

indicates that the service denied use of the directions service by your application.

-

UNKNOWN_ERROR

UNKNOWN_ERROR: "UNKNOWN_ERROR"

indicates a directions request could not be processed due to a server error. The request may succeed if you try again.

-

ZERO_RESULTS

ZERO_RESULTS: "ZERO_RESULTS"

indicates no route could be found between the origin and destination.

-

Settings

Member Visibility

On This Page

Enumeration Members
+

OVER_QUERY_LIMIT

OVER_QUERY_LIMIT: "OVER_QUERY_LIMIT"

indicates the service has received too many requests from your application within the allowed time period.

+

REQUEST_DENIED

REQUEST_DENIED: "REQUEST_DENIED"

indicates that the service denied use of the directions service by your application.

+

UNKNOWN_ERROR

UNKNOWN_ERROR: "UNKNOWN_ERROR"

indicates a directions request could not be processed due to a server error. The request may succeed if you try again.

+

ZERO_RESULTS

ZERO_RESULTS: "ZERO_RESULTS"

indicates no route could be found between the origin and destination.

+

Settings

Member Visibility

On This Page

Enumeration Members
diff --git a/enums/GeocodedWaypointStatus.html b/enums/GeocodedWaypointStatus.html index 9cc7edd32e..0940d9a20c 100644 --- a/enums/GeocodedWaypointStatus.html +++ b/enums/GeocodedWaypointStatus.html @@ -1,6 +1,6 @@ -GeocodedWaypointStatus | Google Maps Services Node Client

Enumeration GeocodedWaypointStatus

Enumeration Members

OK +GeocodedWaypointStatus | Google Maps Services Node Client

Enumeration GeocodedWaypointStatus

Enumeration Members

OK ZERO_RESULTS

Enumeration Members

OK

OK: "OK"

indicates that no errors occurred; the address was successfully parsed and at least one geocode was returned.

-

ZERO_RESULTS

ZERO_RESULTS: "ZERO_RESULTS"

indicates that the geocode was successful but returned no results. +

ZERO_RESULTS

ZERO_RESULTS: "ZERO_RESULTS"

indicates that the geocode was successful but returned no results. This may occur if the geocoder was passed a non-existent address.

-

Settings

Member Visibility

On This Page

Enumeration Members
+

Settings

Member Visibility

On This Page

Enumeration Members
diff --git a/enums/GeocodingAddressComponentType.html b/enums/GeocodingAddressComponentType.html index 4d64a73a1a..0db2f2627d 100644 --- a/enums/GeocodingAddressComponentType.html +++ b/enums/GeocodingAddressComponentType.html @@ -1,4 +1,4 @@ -GeocodingAddressComponentType | Google Maps Services Node Client

Enumeration GeocodingAddressComponentType

Enumeration Members

bus_station +GeocodingAddressComponentType | Google Maps Services Node Client

Enumeration GeocodingAddressComponentType

Enumeration Members

bus_station establishment floor parking @@ -10,14 +10,14 @@ train_station transit_station

Enumeration Members

bus_station

bus_station: "bus_station"

indicate the location of a bus.

-

establishment

establishment: "establishment"

typically indicates a place that has not yet been categorized.

-

floor

floor: "floor"

indicates the floor of a building address.

-

parking

parking: "parking"

indicates a parking lot or parking structure.

-

point_of_interest

point_of_interest: "point_of_interest"

indicates a named point of interest.

-

post_box

post_box: "post_box"

indicates a specific postal box.

-

postal_town

postal_town: "postal_town"

indicates a grouping of geographic areas, such as locality and sublocality, used for mailing addresses in some countries.

-

room

room: "room"

indicates the room of a building address.

-

street_number

street_number: "street_number"

indicates the precise street number.

-

train_station

train_station: "train_station"

indicate the location of a train.

-

transit_station

transit_station: "transit_station"

indicate the location of a public transit stop.

-

Settings

Member Visibility

On This Page

Enumeration Members
+

establishment

establishment: "establishment"

typically indicates a place that has not yet been categorized.

+

floor

floor: "floor"

indicates the floor of a building address.

+

parking

parking: "parking"

indicates a parking lot or parking structure.

+

point_of_interest

point_of_interest: "point_of_interest"

indicates a named point of interest.

+

post_box

post_box: "post_box"

indicates a specific postal box.

+

postal_town

postal_town: "postal_town"

indicates a grouping of geographic areas, such as locality and sublocality, used for mailing addresses in some countries.

+

room

room: "room"

indicates the room of a building address.

+

street_number

street_number: "street_number"

indicates the precise street number.

+

train_station

train_station: "train_station"

indicate the location of a train.

+

transit_station

transit_station: "transit_station"

indicate the location of a public transit stop.

+

Settings

Member Visibility

On This Page

Enumeration Members
diff --git a/enums/GeolocateErrorReason.html b/enums/GeolocateErrorReason.html index 93a7e57786..dd42af0459 100644 --- a/enums/GeolocateErrorReason.html +++ b/enums/GeolocateErrorReason.html @@ -1,4 +1,4 @@ -GeolocateErrorReason | Google Maps Services Node Client

Enumeration GeolocateErrorReason

Enumeration Members

dailyLimitExceeded +GeolocateErrorReason | Google Maps Services Node Client

Enumeration GeolocateErrorReason

Enumeration Members

dailyLimitExceeded keyInvalid notFound parseError @@ -6,19 +6,19 @@

Enumeration Members

dailyLimitExceeded

dailyLimitExceeded: "dailyLimitExceeded"

You have exceeded your daily limit. Domain: usageLimits Code: 403

-

keyInvalid

keyInvalid: "keyInvalid"

Your API key is not valid for the Geolocate API. Please ensure that you've included the entire key, +

keyInvalid

keyInvalid: "keyInvalid"

Your API key is not valid for the Geolocate API. Please ensure that you've included the entire key, and that you've either purchased the API or have enabled billing and activated the API to obtain the free quota. Domain: usageLimits Code: 400

-

notFound

notFound: "notFound"

The request was valid, but no results were returned. +

notFound

notFound: "notFound"

The request was valid, but no results were returned. Domain: geolocation Code: 404

-

parseError

parseError: "parseError"

The request body is not valid JSON. Refer to the Request Body section for details on each field. +

parseError

parseError: "parseError"

The request body is not valid JSON. Refer to the Request Body section for details on each field. Domain: global Code: 400

-

userRateLimitExceeded

userRateLimitExceeded: "userRateLimitExceeded"

You have exceeded the requests per second per user limit that you configured in the Google Cloud Platform Console. +

userRateLimitExceeded

userRateLimitExceeded: "userRateLimitExceeded"

You have exceeded the requests per second per user limit that you configured in the Google Cloud Platform Console. This limit should be configured to prevent a single or small group of users from exhausting your daily quota, while still allowing reasonable access to all users. Domain: usageLimits Code: 403

-

Settings

Member Visibility

On This Page

Enumeration Members
+

Settings

Member Visibility

On This Page

Enumeration Members
diff --git a/enums/Language.html b/enums/Language.html index 53b5b3c5dd..604dac1a9e 100644 --- a/enums/Language.html +++ b/enums/Language.html @@ -1,7 +1,7 @@ Language | Google Maps Services Node Client

Enumeration Language

By default the API will attempt to load the most appropriate language based on the users location or browser settings. Some APIs allow you to explicitly set a language when you make a request

See

https://developers.google.com/maps/faq#languagesupport

-

Enumeration Members

ar +

Enumeration Members

ar be bg bn @@ -63,64 +63,64 @@ zh_CN zh_TW

Enumeration Members

ar

ar: "ar"

Arabic

-

be

be: "be"

Belarusian

-

bg

bg: "bg"

Bulgarian

-

bn

bn: "bn"

Bengali

-

ca

ca: "ca"

Catalan

-

cs

cs: "cs"

Czech

-

da

da: "da"

Danish

-

de

de: "de"

German

-

el

el: "el"

Greek

-

en

en: "en"

English

-

en_Au

en_Au: "en-Au"

English (Australian)

-

en_GB

en_GB: "en-GB"

English (Great Britain)

-

es

es: "es"

Spanish

-

eu

eu: "eu"

Basque

-

fa

fa: "fa"

Farsi

-

fi

fi: "fi"

Finnish

-

fil

fil: "fil"

Filipino

-

fr

fr: "fr"

French

-

gl

gl: "gl"

Galician

-

gu

gu: "gu"

Gujarati

-

hi

hi: "hi"

Hindi

-

hr

hr: "hr"

Croatian

-

hu

hu: "hu"

Hungarian

-

id

id: "id"

Indonesian

-

it

it: "it"

Italian

-

iw

iw: "iw"

Hebrew

-

ja

ja: "ja"

Japanese

-

kk

kk: "kk"

Kazakh

-

kn

kn: "kn"

Kannada

-

ko

ko: "ko"

Korean

-

ky

ky: "ky"

Kyrgyz

-

lt

lt: "lt"

Lithuanian

-

lv

lv: "lv"

Latvian

-

mk

mk: "mk"

Macedonian

-

ml

ml: "ml"

Malayalam

-

mr

mr: "mr"

Marathi

-

my

my: "my"

Burmese

-

nl

nl: "nl"

Dutch

-

no

no: "no"

Norwegian

-

pa

pa: "pa"

Punjabi

-

pl

pl: "pl"

Polish

-

pt

pt: "pt"

Portuguese

-

pt_BR

pt_BR: "pt-BR"

Portuguese (Brazil)

-

pt_PT

pt_PT: "pt-PT"

Portuguese (Portugal)

-

ro

ro: "ro"

Romanian

-

ru

ru: "ru"

Russian

-

sk

sk: "sk"

Slovak

-

sl

sl: "sl"

Slovenian

-

sq

sq: "sq"

Albanian

-

sr

sr: "sr"

Serbian

-

sv

sv: "sv"

Swedish

-

ta

ta: "ta"

Tamil

-

te

te: "te"

Telugu

-

th

th: "th"

Thai

-

tl

tl: "tl"

Tagalog

-

tr

tr: "tr"

Turkish

-

uk

uk: "uk"

Ukrainian

-

uz

uz: "uz"

Uzbek

-

vi

vi: "vi"

Vietnamese

-

zh_CN

zh_CN: "zh-CN"

Chinese (Simlified)

-

zh_TW

zh_TW: "zh-TW"

Chinese (Traditional)

-

Settings

Member Visibility

On This Page

Enumeration Members
+

be

be: "be"

Belarusian

+

bg

bg: "bg"

Bulgarian

+

bn

bn: "bn"

Bengali

+

ca

ca: "ca"

Catalan

+

cs

cs: "cs"

Czech

+

da

da: "da"

Danish

+

de

de: "de"

German

+

el

el: "el"

Greek

+

en

en: "en"

English

+

en_Au

en_Au: "en-Au"

English (Australian)

+

en_GB

en_GB: "en-GB"

English (Great Britain)

+

es

es: "es"

Spanish

+

eu

eu: "eu"

Basque

+

fa

fa: "fa"

Farsi

+

fi

fi: "fi"

Finnish

+

fil

fil: "fil"

Filipino

+

fr

fr: "fr"

French

+

gl

gl: "gl"

Galician

+

gu

gu: "gu"

Gujarati

+

hi

hi: "hi"

Hindi

+

hr

hr: "hr"

Croatian

+

hu

hu: "hu"

Hungarian

+

id

id: "id"

Indonesian

+

it

it: "it"

Italian

+

iw

iw: "iw"

Hebrew

+

ja

ja: "ja"

Japanese

+

kk

kk: "kk"

Kazakh

+

kn

kn: "kn"

Kannada

+

ko

ko: "ko"

Korean

+

ky

ky: "ky"

Kyrgyz

+

lt

lt: "lt"

Lithuanian

+

lv

lv: "lv"

Latvian

+

mk

mk: "mk"

Macedonian

+

ml

ml: "ml"

Malayalam

+

mr

mr: "mr"

Marathi

+

my

my: "my"

Burmese

+

nl

nl: "nl"

Dutch

+

no

no: "no"

Norwegian

+

pa

pa: "pa"

Punjabi

+

pl

pl: "pl"

Polish

+

pt

pt: "pt"

Portuguese

+

pt_BR

pt_BR: "pt-BR"

Portuguese (Brazil)

+

pt_PT

pt_PT: "pt-PT"

Portuguese (Portugal)

+

ro

ro: "ro"

Romanian

+

ru

ru: "ru"

Russian

+

sk

sk: "sk"

Slovak

+

sl

sl: "sl"

Slovenian

+

sq

sq: "sq"

Albanian

+

sr

sr: "sr"

Serbian

+

sv

sv: "sv"

Swedish

+

ta

ta: "ta"

Tamil

+

te

te: "te"

Telugu

+

th

th: "th"

Thai

+

tl

tl: "tl"

Tagalog

+

tr

tr: "tr"

Turkish

+

uk

uk: "uk"

Ukrainian

+

uz

uz: "uz"

Uzbek

+

vi

vi: "vi"

Vietnamese

+

zh_CN

zh_CN: "zh-CN"

Chinese (Simlified)

+

zh_TW

zh_TW: "zh-TW"

Chinese (Traditional)

+

Settings

Member Visibility

On This Page

Enumeration Members
diff --git a/enums/LocationType.html b/enums/LocationType.html index 285a582b56..5311ca66b7 100644 --- a/enums/LocationType.html +++ b/enums/LocationType.html @@ -1,12 +1,12 @@ -LocationType | Google Maps Services Node Client

Enumeration LocationType

Enumeration Members

APPROXIMATE +LocationType | Google Maps Services Node Client

Enumeration LocationType

Enumeration Members

APPROXIMATE GEOMETRIC_CENTER RANGE_INTERPOLATED ROOFTOP

Enumeration Members

APPROXIMATE

APPROXIMATE: "APPROXIMATE"

indicates that the returned result is approximate.

-

GEOMETRIC_CENTER

GEOMETRIC_CENTER: "GEOMETRIC_CENTER"

indicates that the returned result is the geometric center of a result such as a polyline +

GEOMETRIC_CENTER

GEOMETRIC_CENTER: "GEOMETRIC_CENTER"

indicates that the returned result is the geometric center of a result such as a polyline (for example, a street) or polygon (region).

-

RANGE_INTERPOLATED

RANGE_INTERPOLATED: "RANGE_INTERPOLATED"

indicates that the returned result reflects an approximation (usually on a road) interpolated between two precise points +

RANGE_INTERPOLATED

RANGE_INTERPOLATED: "RANGE_INTERPOLATED"

indicates that the returned result reflects an approximation (usually on a road) interpolated between two precise points (such as intersections). Interpolated results are generally returned when rooftop geocodes are unavailable for a street address.

-

ROOFTOP

ROOFTOP: "ROOFTOP"

indicates that the returned result is a precise geocode for which we have location information +

ROOFTOP

ROOFTOP: "ROOFTOP"

indicates that the returned result is a precise geocode for which we have location information accurate down to street address precision

-

Settings

Member Visibility

On This Page

Enumeration Members
+

Settings

Member Visibility

On This Page

Enumeration Members
diff --git a/enums/Maneuver.html b/enums/Maneuver.html index fd5acffce1..557c295142 100644 --- a/enums/Maneuver.html +++ b/enums/Maneuver.html @@ -1,4 +1,4 @@ -Maneuver | Google Maps Services Node Client

Enumeration Maneuver

Enumeration Members

ferry +Maneuver | Google Maps Services Node Client

Enumeration Maneuver

Enumeration Members

ferry ferry_train fork_left fork_right @@ -16,4 +16,4 @@ turn_slight_right uturn_left uturn_right -

Enumeration Members

ferry

ferry: "ferry"

ferry_train

ferry_train: "ferry-train"

fork_left

fork_left: "fork-left"

fork_right

fork_right: "fork-right"

merge

merge: "merge"

ramp_left

ramp_left: "ramp-left"

ramp_right

ramp_right: "ramp-right"

roundabout_left

roundabout_left: "roundabout-left"

roundabout_right

roundabout_right: "roundabout-right"

straight

straight: "straight"

turn_left

turn_left: "turn-left"

turn_right

turn_right: "turn-right"

turn_sharp_left

turn_sharp_left: "turn-sharp-left"

turn_sharp_right

turn_sharp_right: "turn-sharp-right"

turn_slight_left

turn_slight_left: "turn-slight-left"

turn_slight_right

turn_slight_right: "turn-slight-right"

uturn_left

uturn_left: "uturn-left"

uturn_right

uturn_right: "uturn-right"

Settings

Member Visibility

On This Page

Enumeration Members
+

Enumeration Members

ferry

ferry: "ferry"

ferry_train

ferry_train: "ferry-train"

fork_left

fork_left: "fork-left"

fork_right

fork_right: "fork-right"

merge

merge: "merge"

ramp_left

ramp_left: "ramp-left"

ramp_right

ramp_right: "ramp-right"

roundabout_left

roundabout_left: "roundabout-left"

roundabout_right

roundabout_right: "roundabout-right"

straight

straight: "straight"

turn_left

turn_left: "turn-left"

turn_right

turn_right: "turn-right"

turn_sharp_left

turn_sharp_left: "turn-sharp-left"

turn_sharp_right

turn_sharp_right: "turn-sharp-right"

turn_slight_left

turn_slight_left: "turn-slight-left"

turn_slight_right

turn_slight_right: "turn-slight-right"

uturn_left

uturn_left: "uturn-left"

uturn_right

uturn_right: "uturn-right"

Settings

Member Visibility

On This Page

Enumeration Members
diff --git a/enums/PlaceAutocompleteType.html b/enums/PlaceAutocompleteType.html index dd7a0d6b3c..3b4b4c959f 100644 --- a/enums/PlaceAutocompleteType.html +++ b/enums/PlaceAutocompleteType.html @@ -1,15 +1,15 @@ -PlaceAutocompleteType | Google Maps Services Node Client

Enumeration PlaceAutocompleteType

Enumeration Members

address +PlaceAutocompleteType | Google Maps Services Node Client

Enumeration PlaceAutocompleteType

Enumeration Members

address cities establishment geocode regions

Enumeration Members

address

address: "address"

instructs the Place Autocomplete service to return only geocoding results with a precise address. Generally, you use this request when you know the user will be looking for a fully specified address.

-

cities

cities: "(cities)"

the (cities) type collection instructs the Places service to return results that match locality or administrative_area_level_3.

-

establishment

establishment: "establishment"

instructs the Place Autocomplete service to return only business results.

-

geocode

geocode: "geocode"

instructs the Place Autocomplete service to return only geocoding results, rather than business results. +

cities

cities: "(cities)"

the (cities) type collection instructs the Places service to return results that match locality or administrative_area_level_3.

+

establishment

establishment: "establishment"

instructs the Place Autocomplete service to return only business results.

+

geocode

geocode: "geocode"

instructs the Place Autocomplete service to return only geocoding results, rather than business results. Generally, you use this request to disambiguate results where the location specified may be indeterminate.

-

regions

regions: "(regions)"

the (regions) type collection instructs the Places service to return any result matching the following types:

+

regions

regions: "(regions)"

the (regions) type collection instructs the Places service to return any result matching the following types:

  • locality
  • sublocality
    • @@ -18,4 +18,4 @@
  • administrative_area_level_1
  • administrative_area_level_2
-

Settings

Member Visibility

On This Page

Enumeration Members
+

Settings

Member Visibility

On This Page

Enumeration Members
diff --git a/enums/PlaceIdScope.html b/enums/PlaceIdScope.html index 567319d040..7f9bfe174d 100644 --- a/enums/PlaceIdScope.html +++ b/enums/PlaceIdScope.html @@ -1,6 +1,6 @@ -PlaceIdScope | Google Maps Services Node Client

Enumeration PlaceIdScope

Enumeration Members

APP +PlaceIdScope | Google Maps Services Node Client

Enumeration PlaceIdScope

Enumeration Members

APP GOOGLE

Enumeration Members

APP

APP: "APP"

The place ID is recognised by your application only. This is because your application added the place, and the place has not yet passed the moderation process.

-

GOOGLE

GOOGLE: "GOOGLE"

The place ID is available to other applications and on Google Maps.

-

Settings

Member Visibility

On This Page

Enumeration Members
+

GOOGLE

GOOGLE: "GOOGLE"

The place ID is available to other applications and on Google Maps.

+

Settings

Member Visibility

On This Page

Enumeration Members
diff --git a/enums/PlaceInputType.html b/enums/PlaceInputType.html index 6de88c9cd6..11d697b74d 100644 --- a/enums/PlaceInputType.html +++ b/enums/PlaceInputType.html @@ -1,3 +1,3 @@ -PlaceInputType | Google Maps Services Node Client

Enumeration PlaceInputType

Enumeration Members

phoneNumber +PlaceInputType | Google Maps Services Node Client

Enumeration PlaceInputType

Enumeration Members

phoneNumber textQuery -

Enumeration Members

phoneNumber

phoneNumber: "phonenumber"

textQuery

textQuery: "textquery"

Settings

Member Visibility

On This Page

Enumeration Members
+

Enumeration Members

phoneNumber

phoneNumber: "phonenumber"

textQuery

textQuery: "textquery"

Settings

Member Visibility

On This Page

Enumeration Members
diff --git a/enums/PlaceType1.html b/enums/PlaceType1.html index f90f4c01e8..9029cb58f9 100644 --- a/enums/PlaceType1.html +++ b/enums/PlaceType1.html @@ -1,7 +1,7 @@ PlaceType1 | Google Maps Services Node Client

Enumeration PlaceType1

Table 1: Types supported in place search and addition

You can use the following values in the types filter for place searches and when adding a place.

See

https://developers.google.com/places/web-service/supported_types#table1

-

Enumeration Members

accounting +

Enumeration Members

accounting airport amusement_park aquarium @@ -96,6 +96,6 @@ university veterinary_care zoo -

Enumeration Members

accounting

accounting: "accounting"

airport

airport: "airport"

indicates an airport.

-

amusement_park

amusement_park: "amusement_park"

aquarium

aquarium: "aquarium"

art_gallery

art_gallery: "art_gallery"

atm

atm: "atm"

bakery

bakery: "bakery"

bank

bank: "bank"

bar

bar: "bar"

beauty_salon

beauty_salon: "beauty_salon"

bicycle_store

bicycle_store: "bicycle_store"

book_store

book_store: "book_store"

bowling_alley

bowling_alley: "bowling_alley"

bus_station

bus_station: "bus_station"

cafe

cafe: "cafe"

campground

campground: "campground"

car_dealer

car_dealer: "car_dealer"

car_rental

car_rental: "car_rental"

car_repair

car_repair: "car_repair"

car_wash

car_wash: "car_wash"

casino

casino: "casino"

cemetery

cemetery: "cemetery"

church

church: "church"

city_hall

city_hall: "city_hall"

clothing_store

clothing_store: "clothing_store"

convenience_store

convenience_store: "convenience_store"

courthouse

courthouse: "courthouse"

dentist

dentist: "dentist"

department_store

department_store: "department_store"

doctor

doctor: "doctor"

drugstore

drugstore: "drugstore"

electrician

electrician: "electrician"

electronics_store

electronics_store: "electronics_store"

embassy

embassy: "embassy"

fire_station

fire_station: "fire_station"

florist

florist: "florist"

funeral_home

funeral_home: "funeral_home"

furniture_store

furniture_store: "furniture_store"

gas_station

gas_station: "gas_station"

gym

gym: "gym"

hair_care

hair_care: "hair_care"

hardware_store

hardware_store: "hardware_store"

hindu_temple

hindu_temple: "hindu_temple"

home_goods_store

home_goods_store: "home_goods_store"

hospital

hospital: "hospital"

insurance_agency

insurance_agency: "insurance_agency"

jewelry_store

jewelry_store: "jewelry_store"

laundry

laundry: "laundry"

lawyer

lawyer: "lawyer"

library

library: "library"

light_rail_station

light_rail_station: "light_rail_station"

liquor_store

liquor_store: "liquor_store"

local_government_office

local_government_office: "local_government_office"

locksmith

locksmith: "locksmith"

lodging

lodging: "lodging"

meal_delivery

meal_delivery: "meal_delivery"

meal_takeaway

meal_takeaway: "meal_takeaway"

mosque

mosque: "mosque"

movie_rental

movie_rental: "movie_rental"

movie_theater

movie_theater: "movie_theater"

moving_company

moving_company: "moving_company"

museum

museum: "museum"

night_club

night_club: "night_club"

painter

painter: "painter"

park

park: "park"

indicates a named park.

-

parking

parking: "parking"

pet_store

pet_store: "pet_store"

pharmacy

pharmacy: "pharmacy"

physiotherapist

physiotherapist: "physiotherapist"

plumber

plumber: "plumber"

police

police: "police"

post_office

post_office: "post_office"

real_estate_agency

real_estate_agency: "real_estate_agency"

restaurant

restaurant: "restaurant"

roofing_contractor

roofing_contractor: "roofing_contractor"

rv_park

rv_park: "rv_park"

school

school: "school"

secondary_school

secondary_school: "secondary_school"

shoe_store

shoe_store: "shoe_store"

shopping_mall

shopping_mall: "shopping_mall"

spa

spa: "spa"

stadium

stadium: "stadium"

storage

storage: "storage"

store

store: "store"

subway_station

subway_station: "subway_station"

supermarket

supermarket: "supermarket"

synagogue

synagogue: "synagogue"

taxi_stand

taxi_stand: "taxi_stand"

tourist_attraction

tourist_attraction: "tourist_attraction"

train_station

train_station: "train_station"

transit_station

transit_station: "transit_station"

travel_agency

travel_agency: "travel_agency"

university

university: "university"

veterinary_care

veterinary_care: "veterinary_care"

zoo

zoo: "zoo"

Settings

Member Visibility

On This Page

Enumeration Members
accountingairportamusement_parkaquariumart_galleryatmbakerybankbarbeauty_salonbicycle_storebook_storebowling_alleybus_stationcafecampgroundcar_dealercar_rentalcar_repaircar_washcasinocemeterychurchcity_hallclothing_storeconvenience_storecourthousedentistdepartment_storedoctordrugstoreelectricianelectronics_storeembassyfire_stationfloristfuneral_homefurniture_storegas_stationgymhair_carehardware_storehindu_templehome_goods_storehospitalinsurance_agencyjewelry_storelaundrylawyerlibrarylight_rail_stationliquor_storelocal_government_officelocksmithlodgingmeal_deliverymeal_takeawaymosquemovie_rentalmovie_theatermoving_companymuseumnight_clubpainterparkparkingpet_storepharmacyphysiotherapistplumberpolicepost_officereal_estate_agencyrestaurantroofing_contractorrv_parkschoolsecondary_schoolshoe_storeshopping_mallspastadiumstoragestoresubway_stationsupermarketsynagoguetaxi_standtourist_attractiontrain_stationtransit_stationtravel_agencyuniversityveterinary_carezoo
+

Enumeration Members

accounting

accounting: "accounting"

airport

airport: "airport"

indicates an airport.

+

amusement_park

amusement_park: "amusement_park"

aquarium

aquarium: "aquarium"

art_gallery

art_gallery: "art_gallery"

atm

atm: "atm"

bakery

bakery: "bakery"

bank

bank: "bank"

bar

bar: "bar"

beauty_salon

beauty_salon: "beauty_salon"

bicycle_store

bicycle_store: "bicycle_store"

book_store

book_store: "book_store"

bowling_alley

bowling_alley: "bowling_alley"

bus_station

bus_station: "bus_station"

cafe

cafe: "cafe"

campground

campground: "campground"

car_dealer

car_dealer: "car_dealer"

car_rental

car_rental: "car_rental"

car_repair

car_repair: "car_repair"

car_wash

car_wash: "car_wash"

casino

casino: "casino"

cemetery

cemetery: "cemetery"

church

church: "church"

city_hall

city_hall: "city_hall"

clothing_store

clothing_store: "clothing_store"

convenience_store

convenience_store: "convenience_store"

courthouse

courthouse: "courthouse"

dentist

dentist: "dentist"

department_store

department_store: "department_store"

doctor

doctor: "doctor"

drugstore

drugstore: "drugstore"

electrician

electrician: "electrician"

electronics_store

electronics_store: "electronics_store"

embassy

embassy: "embassy"

fire_station

fire_station: "fire_station"

florist

florist: "florist"

funeral_home

funeral_home: "funeral_home"

furniture_store

furniture_store: "furniture_store"

gas_station

gas_station: "gas_station"

gym

gym: "gym"

hair_care

hair_care: "hair_care"

hardware_store

hardware_store: "hardware_store"

hindu_temple

hindu_temple: "hindu_temple"

home_goods_store

home_goods_store: "home_goods_store"

hospital

hospital: "hospital"

insurance_agency

insurance_agency: "insurance_agency"

jewelry_store

jewelry_store: "jewelry_store"

laundry

laundry: "laundry"

lawyer

lawyer: "lawyer"

library

library: "library"

light_rail_station

light_rail_station: "light_rail_station"

liquor_store

liquor_store: "liquor_store"

local_government_office

local_government_office: "local_government_office"

locksmith

locksmith: "locksmith"

lodging

lodging: "lodging"

meal_delivery

meal_delivery: "meal_delivery"

meal_takeaway

meal_takeaway: "meal_takeaway"

mosque

mosque: "mosque"

movie_rental

movie_rental: "movie_rental"

movie_theater

movie_theater: "movie_theater"

moving_company

moving_company: "moving_company"

museum

museum: "museum"

night_club

night_club: "night_club"

painter

painter: "painter"

park

park: "park"

indicates a named park.

+

parking

parking: "parking"

pet_store

pet_store: "pet_store"

pharmacy

pharmacy: "pharmacy"

physiotherapist

physiotherapist: "physiotherapist"

plumber

plumber: "plumber"

police

police: "police"

post_office

post_office: "post_office"

real_estate_agency

real_estate_agency: "real_estate_agency"

restaurant

restaurant: "restaurant"

roofing_contractor

roofing_contractor: "roofing_contractor"

rv_park

rv_park: "rv_park"

school

school: "school"

secondary_school

secondary_school: "secondary_school"

shoe_store

shoe_store: "shoe_store"

shopping_mall

shopping_mall: "shopping_mall"

spa

spa: "spa"

stadium

stadium: "stadium"

storage

storage: "storage"

store

store: "store"

subway_station

subway_station: "subway_station"

supermarket

supermarket: "supermarket"

synagogue

synagogue: "synagogue"

taxi_stand

taxi_stand: "taxi_stand"

tourist_attraction

tourist_attraction: "tourist_attraction"

train_station

train_station: "train_station"

transit_station

transit_station: "transit_station"

travel_agency

travel_agency: "travel_agency"

university

university: "university"

veterinary_care

veterinary_care: "veterinary_care"

zoo

zoo: "zoo"

Settings

Member Visibility

On This Page

Enumeration Members
accountingairportamusement_parkaquariumart_galleryatmbakerybankbarbeauty_salonbicycle_storebook_storebowling_alleybus_stationcafecampgroundcar_dealercar_rentalcar_repaircar_washcasinocemeterychurchcity_hallclothing_storeconvenience_storecourthousedentistdepartment_storedoctordrugstoreelectricianelectronics_storeembassyfire_stationfloristfuneral_homefurniture_storegas_stationgymhair_carehardware_storehindu_templehome_goods_storehospitalinsurance_agencyjewelry_storelaundrylawyerlibrarylight_rail_stationliquor_storelocal_government_officelocksmithlodgingmeal_deliverymeal_takeawaymosquemovie_rentalmovie_theatermoving_companymuseumnight_clubpainterparkparkingpet_storepharmacyphysiotherapistplumberpolicepost_officereal_estate_agencyrestaurantroofing_contractorrv_parkschoolsecondary_schoolshoe_storeshopping_mallspastadiumstoragestoresubway_stationsupermarketsynagoguetaxi_standtourist_attractiontrain_stationtransit_stationtravel_agencyuniversityveterinary_carezoo
diff --git a/enums/PlaceType2.html b/enums/PlaceType2.html index a7dfe9f8fc..7bf6d818cc 100644 --- a/enums/PlaceType2.html +++ b/enums/PlaceType2.html @@ -3,7 +3,7 @@ For more details on these types, refer to Address Types in Geocoding Responses.

See

https://developers.google.com/places/web-service/supported_types#table2

-

Enumeration Members

administrative_area_level_1 +

Enumeration Members

administrative_area_level_1 administrative_area_level_2 administrative_area_level_3 administrative_area_level_4 @@ -50,27 +50,27 @@ Not all nations exhibit these administrative levels. In most cases, administrative_area_level_1 short names will closely match ISO 3166-2 subdivisions and other widely circulated lists; however this is not guaranteed as our geocoding results are based on a variety of signals and location data.

-

administrative_area_level_2

administrative_area_level_2: "administrative_area_level_2"

indicates a second-order civil entity below the country level. Within the United States, these administrative levels are counties. +

administrative_area_level_2

administrative_area_level_2: "administrative_area_level_2"

indicates a second-order civil entity below the country level. Within the United States, these administrative levels are counties. Not all nations exhibit these administrative levels.

-

administrative_area_level_3

administrative_area_level_3: "administrative_area_level_3"

indicates a third-order civil entity below the country level. This type indicates a minor civil division. +

administrative_area_level_3

administrative_area_level_3: "administrative_area_level_3"

indicates a third-order civil entity below the country level. This type indicates a minor civil division. Not all nations exhibit these administrative levels.

-

administrative_area_level_4

administrative_area_level_4: "administrative_area_level_4"

indicates a fourth-order civil entity below the country level. This type indicates a minor civil division. +

administrative_area_level_4

administrative_area_level_4: "administrative_area_level_4"

indicates a fourth-order civil entity below the country level. This type indicates a minor civil division. Not all nations exhibit these administrative levels.

-

administrative_area_level_5

administrative_area_level_5: "administrative_area_level_5"

indicates a fifth-order civil entity below the country level. This type indicates a minor civil division. +

administrative_area_level_5

administrative_area_level_5: "administrative_area_level_5"

indicates a fifth-order civil entity below the country level. This type indicates a minor civil division. Not all nations exhibit these administrative levels.

-

archipelago

archipelago: "archipelago"

colloquial_area

colloquial_area: "colloquial_area"

indicates a commonly-used alternative name for the entity.

-

continent

continent: "continent"

country

country: "country"

indicates the national political entity, and is typically the highest order type returned by the Geocoder.

-

establishment

establishment: "establishment"

finance

finance: "finance"

floor

floor: "floor"

food

food: "food"

general_contractor

general_contractor: "general_contractor"

geocode

geocode: "geocode"

health

health: "health"

intersection

intersection: "intersection"

indicates a major intersection, usually of two major roads.

-

landmark

landmark: "landmark"

locality

locality: "locality"

indicates an incorporated city or town political entity.

-

natural_feature

natural_feature: "natural_feature"

indicates a prominent natural feature.

-

neighborhood

neighborhood: "neighborhood"

indicates a named neighborhood

-

place_of_worship

place_of_worship: "place_of_worship"

plus_code

plus_code: "plus_code"

point_of_interest

point_of_interest: "point_of_interest"

political

political: "political"

indicates a political entity. Usually, this type indicates a polygon of some civil administration.

-

post_box

post_box: "post_box"

postal_code

postal_code: "postal_code"

indicates a postal code as used to address postal mail within the country.

-

postal_code_prefix

postal_code_prefix: "postal_code_prefix"

postal_code_suffix

postal_code_suffix: "postal_code_suffix"

postal_town

postal_town: "postal_town"

premise

premise: "premise"

indicates a named location, usually a building or collection of buildings with a common name

-

room

room: "room"

route

route: "route"

indicates a named route (such as "US 101").

-

street_address

street_address: "street_address"

street_number

street_number: "street_number"

sublocality

sublocality: "sublocality"

indicates a first-order civil entity below a locality. For some locations may receive one of the additional types: +

archipelago

archipelago: "archipelago"

colloquial_area

colloquial_area: "colloquial_area"

indicates a commonly-used alternative name for the entity.

+

continent

continent: "continent"

country

country: "country"

indicates the national political entity, and is typically the highest order type returned by the Geocoder.

+

establishment

establishment: "establishment"

finance

finance: "finance"

floor

floor: "floor"

food

food: "food"

general_contractor

general_contractor: "general_contractor"

geocode

geocode: "geocode"

health

health: "health"

intersection

intersection: "intersection"

indicates a major intersection, usually of two major roads.

+

landmark

landmark: "landmark"

locality

locality: "locality"

indicates an incorporated city or town political entity.

+

natural_feature

natural_feature: "natural_feature"

indicates a prominent natural feature.

+

neighborhood

neighborhood: "neighborhood"

indicates a named neighborhood

+

place_of_worship

place_of_worship: "place_of_worship"

plus_code

plus_code: "plus_code"

point_of_interest

point_of_interest: "point_of_interest"

political

political: "political"

indicates a political entity. Usually, this type indicates a polygon of some civil administration.

+

post_box

post_box: "post_box"

postal_code

postal_code: "postal_code"

indicates a postal code as used to address postal mail within the country.

+

postal_code_prefix

postal_code_prefix: "postal_code_prefix"

postal_code_suffix

postal_code_suffix: "postal_code_suffix"

postal_town

postal_town: "postal_town"

premise

premise: "premise"

indicates a named location, usually a building or collection of buildings with a common name

+

room

room: "room"

route

route: "route"

indicates a named route (such as "US 101").

+

street_address

street_address: "street_address"

street_number

street_number: "street_number"

sublocality

sublocality: "sublocality"

indicates a first-order civil entity below a locality. For some locations may receive one of the additional types: sublocality_level_1 to sublocality_level_5. Each sublocality level is a civil entity. Larger numbers indicate a smaller geographic area.

-

sublocality_level_1

sublocality_level_1: "sublocality_level_1"

sublocality_level_2

sublocality_level_2: "sublocality_level_2"

sublocality_level_3

sublocality_level_3: "sublocality_level_3"

sublocality_level_4

sublocality_level_4: "sublocality_level_4"

sublocality_level_5

sublocality_level_5: "sublocality_level_5"

subpremise

subpremise: "subpremise"

indicates a first-order entity below a named location, usually a singular building within a collection of buildings with a +

sublocality_level_1

sublocality_level_1: "sublocality_level_1"

sublocality_level_2

sublocality_level_2: "sublocality_level_2"

sublocality_level_3

sublocality_level_3: "sublocality_level_3"

sublocality_level_4

sublocality_level_4: "sublocality_level_4"

sublocality_level_5

sublocality_level_5: "sublocality_level_5"

subpremise

subpremise: "subpremise"

indicates a first-order entity below a named location, usually a singular building within a collection of buildings with a common name.

-

town_square

town_square: "town_square"

Settings

Member Visibility

On This Page

Enumeration Members
+

town_square

town_square: "town_square"

Settings

Member Visibility

On This Page

Enumeration Members
diff --git a/enums/PlacesNearbyRanking.html b/enums/PlacesNearbyRanking.html index ad38a04264..3e56ba6aa5 100644 --- a/enums/PlacesNearbyRanking.html +++ b/enums/PlacesNearbyRanking.html @@ -1,7 +1,7 @@ -PlacesNearbyRanking | Google Maps Services Node Client

Enumeration PlacesNearbyRanking

Enumeration Members

distance +PlacesNearbyRanking | Google Maps Services Node Client

Enumeration PlacesNearbyRanking

Enumeration Members

distance prominence

Enumeration Members

distance

distance: "distance"

This option biases search results in ascending order by their distance from the specified location. When distance is specified, one or more of keyword, name, or type is required.

-

prominence

prominence: "prominence"

This option sorts results based on their importance. Ranking will favor prominent places within the specified area. +

prominence

prominence: "prominence"

This option sorts results based on their importance. Ranking will favor prominent places within the specified area. Prominence can be affected by a place's ranking in Google's index, global popularity, and other factors.

-

Settings

Member Visibility

On This Page

Enumeration Members
+

Settings

Member Visibility

On This Page

Enumeration Members
diff --git a/enums/RadioType.html b/enums/RadioType.html index 49aa84a11f..aa0a9ac9ea 100644 --- a/enums/RadioType.html +++ b/enums/RadioType.html @@ -1,5 +1,5 @@ -RadioType | Google Maps Services Node Client

Enumeration RadioType

Enumeration Members

cdma +RadioType | Google Maps Services Node Client

Enumeration RadioType

Enumeration Members

cdma gsm lte wcdma -

Enumeration Members

cdma

cdma: "cdma"

gsm

gsm: "gsm"

lte

lte: "lte"

wcdma

wcdma: "wcdma"

Settings

Member Visibility

On This Page

Enumeration Members
+

Enumeration Members

cdma

cdma: "cdma"

gsm

gsm: "gsm"

lte

lte: "lte"

wcdma

wcdma: "wcdma"

Settings

Member Visibility

On This Page

Enumeration Members
diff --git a/enums/ReverseGeocodingLocationType.html b/enums/ReverseGeocodingLocationType.html index edebb97673..80be181e4e 100644 --- a/enums/ReverseGeocodingLocationType.html +++ b/enums/ReverseGeocodingLocationType.html @@ -1,12 +1,12 @@ ReverseGeocodingLocationType | Google Maps Services Node Client

Enumeration ReverseGeocodingLocationType

If both result_type and location_type filters are present then the API returns only those results that match both the result_type and the location_type values. If none of the filter values are acceptable, the API returns ZERO_RESULTS.

-

Enumeration Members

APPROXIMATE +

Enumeration Members

APPROXIMATE GEOMETRIC_CENTER RANGE_INTERPOLATED ROOFTOP

Enumeration Members

APPROXIMATE

APPROXIMATE: "APPROXIMATE"

returns only the addresses that are characterized as approximate.

-

GEOMETRIC_CENTER

GEOMETRIC_CENTER: "GEOMETRIC_CENTER"

returns only geometric centers of a location such as a polyline (for example, a street) or polygon (region).

-

RANGE_INTERPOLATED

RANGE_INTERPOLATED: "RANGE_INTERPOLATED"

returns only the addresses that reflect an approximation (usually on a road) interpolated between two precise points +

GEOMETRIC_CENTER

GEOMETRIC_CENTER: "GEOMETRIC_CENTER"

returns only geometric centers of a location such as a polyline (for example, a street) or polygon (region).

+

RANGE_INTERPOLATED

RANGE_INTERPOLATED: "RANGE_INTERPOLATED"

returns only the addresses that reflect an approximation (usually on a road) interpolated between two precise points (such as intersections). An interpolated range generally indicates that rooftop geocodes are unavailable for a street address.

-

ROOFTOP

ROOFTOP: "ROOFTOP"

returns only the addresses for which Google has location information accurate down to street address precision.

-

Settings

Member Visibility

On This Page

Enumeration Members
+

ROOFTOP

ROOFTOP: "ROOFTOP"

returns only the addresses for which Google has location information accurate down to street address precision.

+

Settings

Member Visibility

On This Page

Enumeration Members
diff --git a/enums/Status.html b/enums/Status.html index 41fb5b282a..e470f7ebd2 100644 --- a/enums/Status.html +++ b/enums/Status.html @@ -1,4 +1,4 @@ -Status | Google Maps Services Node Client

Enumeration Status

Enumeration Members

INVALID_REQUEST +Status | Google Maps Services Node Client

Enumeration Status

Enumeration Members

INVALID_REQUEST MAX_ROUTE_LENGTH_EXCEEDED MAX_WAYPOINTS_EXCEEDED NOT_FOUND @@ -9,15 +9,15 @@ UNKNOWN_ERROR ZERO_RESULTS

Enumeration Members

INVALID_REQUEST

INVALID_REQUEST: "INVALID_REQUEST"

indicates that the provided request was invalid.

-

MAX_ROUTE_LENGTH_EXCEEDED

MAX_ROUTE_LENGTH_EXCEEDED: "MAX_ROUTE_LENGTH_EXCEEDED"

indicates the requested route is too long and cannot be processed. +

MAX_ROUTE_LENGTH_EXCEEDED

MAX_ROUTE_LENGTH_EXCEEDED: "MAX_ROUTE_LENGTH_EXCEEDED"

indicates the requested route is too long and cannot be processed. This error occurs when more complex directions are returned. Try reducing the number of waypoints, turns, or instructions.

-

MAX_WAYPOINTS_EXCEEDED

MAX_WAYPOINTS_EXCEEDED: "MAX_WAYPOINTS_EXCEEDED"

indicates that too many waypoints were provided in the request. For applications using the Directions API as a web service, +

MAX_WAYPOINTS_EXCEEDED

MAX_WAYPOINTS_EXCEEDED: "MAX_WAYPOINTS_EXCEEDED"

indicates that too many waypoints were provided in the request. For applications using the Directions API as a web service, or the directions service in the Maps JavaScript API, the maximum allowed number of waypoints is 23, plus the origin and destination.

-

NOT_FOUND

NOT_FOUND: "NOT_FOUND"

indicates that the referenced location (place_id) was not found in the Places database.

-

OK

OK: "OK"

indicates the response contains a valid result.

-

OVER_DAILY_LIMIT

OVER_DAILY_LIMIT: "OVER_DAILY_LIMIT"

indicates any of the following:

+

NOT_FOUND

NOT_FOUND: "NOT_FOUND"

indicates that the referenced location (place_id) was not found in the Places database.

+

OK

OK: "OK"

indicates the response contains a valid result.

+

OVER_DAILY_LIMIT

OVER_DAILY_LIMIT: "OVER_DAILY_LIMIT"

indicates any of the following:

  • The API key is missing or invalid.
  • Billing has not been enabled on your account.
    • @@ -25,8 +25,8 @@
  • The provided method of payment is no longer valid (for example, a credit card has expired). See the Maps FAQ to learn how to fix this.
-

OVER_QUERY_LIMIT

OVER_QUERY_LIMIT: "OVER_QUERY_LIMIT"

indicates the service has received too many requests from your application within the allowed time period.

-

REQUEST_DENIED

REQUEST_DENIED: "REQUEST_DENIED"

indicates that the service denied use of the Distance Matrix service by your application.

-

UNKNOWN_ERROR

UNKNOWN_ERROR: "UNKNOWN_ERROR"

indicates a Distance Matrix request could not be processed due to a server error. The request may succeed if you try again.

-

ZERO_RESULTS

ZERO_RESULTS: "ZERO_RESULTS"

indicates that the request was successful but returned no results.

-

Settings

Member Visibility

On This Page

Enumeration Members
+

OVER_QUERY_LIMIT

OVER_QUERY_LIMIT: "OVER_QUERY_LIMIT"

indicates the service has received too many requests from your application within the allowed time period.

+

REQUEST_DENIED

REQUEST_DENIED: "REQUEST_DENIED"

indicates that the service denied use of the Distance Matrix service by your application.

+

UNKNOWN_ERROR

UNKNOWN_ERROR: "UNKNOWN_ERROR"

indicates a Distance Matrix request could not be processed due to a server error. The request may succeed if you try again.

+

ZERO_RESULTS

ZERO_RESULTS: "ZERO_RESULTS"

indicates that the request was successful but returned no results.

+

Settings

Member Visibility

On This Page

Enumeration Members
diff --git a/enums/TrafficModel.html b/enums/TrafficModel.html index c01c92ee5c..75b7530bc0 100644 --- a/enums/TrafficModel.html +++ b/enums/TrafficModel.html @@ -1,10 +1,10 @@ -TrafficModel | Google Maps Services Node Client

Enumeration TrafficModel

Enumeration Members

best_guess +TrafficModel | Google Maps Services Node Client

Enumeration TrafficModel

Enumeration Members

best_guess optimistic pessimistic

Enumeration Members

best_guess

best_guess: "best_guess"

indicates that the returned duration_in_traffic should be the best estimate of travel time given what is known about both historical traffic conditions and live traffic. Live traffic becomes more important the closer the departure_time is to now.

-

optimistic

optimistic: "optimistic"

indicates that the returned duration_in_traffic should be shorter than the actual travel time on most days, +

optimistic

optimistic: "optimistic"

indicates that the returned duration_in_traffic should be shorter than the actual travel time on most days, though occasional days with particularly good traffic conditions may be faster than this value.

-

pessimistic

pessimistic: "pessimistic"

indicates that the returned duration_in_traffic should be longer than the actual travel time on most days, +

pessimistic

pessimistic: "pessimistic"

indicates that the returned duration_in_traffic should be longer than the actual travel time on most days, though occasional days with particularly bad traffic conditions may exceed this value.

-

Settings

Member Visibility

On This Page

Enumeration Members
+

Settings

Member Visibility

On This Page

Enumeration Members
diff --git a/enums/TransitMode.html b/enums/TransitMode.html index dd7269c48f..09aca6b91a 100644 --- a/enums/TransitMode.html +++ b/enums/TransitMode.html @@ -1,12 +1,12 @@ -TransitMode | Google Maps Services Node Client

Enumeration TransitMode

Enumeration Members

bus +TransitMode | Google Maps Services Node Client

Enumeration TransitMode

Enumeration Members

bus rail subway train tram

Enumeration Members

bus

bus: "bus"

indicates that the calculated route should prefer travel by bus.

-

rail

rail: "rail"

indicates that the calculated route should prefer travel by train, tram, light rail, and subway. +

rail

rail: "rail"

indicates that the calculated route should prefer travel by train, tram, light rail, and subway. This is equivalent to transit_mode=train|tram|subway

-

subway

subway: "subway"

indicates that the calculated route should prefer travel by subway.

-

train

train: "train"

indicates that the calculated route should prefer travel by train.

-

tram

tram: "tram"

indicates that the calculated route should prefer travel by tram and light rail.

-

Settings

Member Visibility

On This Page

Enumeration Members
+

subway

subway: "subway"

indicates that the calculated route should prefer travel by subway.

+

train

train: "train"

indicates that the calculated route should prefer travel by train.

+

tram

tram: "tram"

indicates that the calculated route should prefer travel by tram and light rail.

+

Settings

Member Visibility

On This Page

Enumeration Members
diff --git a/enums/TransitRoutingPreference.html b/enums/TransitRoutingPreference.html index 57749aa75e..68f1e72e6f 100644 --- a/enums/TransitRoutingPreference.html +++ b/enums/TransitRoutingPreference.html @@ -1,5 +1,5 @@ -TransitRoutingPreference | Google Maps Services Node Client

Enumeration TransitRoutingPreference

Enumeration Members

fewer_transfers +TransitRoutingPreference | Google Maps Services Node Client

Enumeration TransitRoutingPreference

Enumeration Members

fewer_transfers less_walking

Enumeration Members

fewer_transfers

fewer_transfers: "fewer_transfers"

indicates that the calculated route should prefer a limited number of transfers.

-

less_walking

less_walking: "less_walking"

indicates that the calculated route should prefer limited amounts of walking.

-

Settings

Member Visibility

On This Page

Enumeration Members
+

less_walking

less_walking: "less_walking"

indicates that the calculated route should prefer limited amounts of walking.

+

Settings

Member Visibility

On This Page

Enumeration Members
diff --git a/enums/TravelMode.html b/enums/TravelMode.html index 2ca985b486..96fce38470 100644 --- a/enums/TravelMode.html +++ b/enums/TravelMode.html @@ -2,15 +2,15 @@ By default, directions are calculated as driving directions.

Note: Both walking and bicycling directions may sometimes not include clear pedestrian or bicycling paths, so these directions will return warnings in the returned result which you must display to the user.

-

Enumeration Members

bicycling +

Enumeration Members

bicycling driving transit walking

Enumeration Members

bicycling

bicycling: "bicycling"

requests bicycling directions via bicycle paths & preferred streets (where available).

-

driving

driving: "driving"

(default) indicates standard driving directions using the road network.

-

transit

transit: "transit"

requests directions via public transit routes (where available). +

driving

driving: "driving"

(default) indicates standard driving directions using the road network.

+

transit

transit: "transit"

requests directions via public transit routes (where available). If you set the mode to transit, you can optionally specify either a departure_time or an arrival_time. If neither time is specified, the departure_time defaults to now (that is, the departure time defaults to the current time). You can also optionally include a transit_mode and/or a transit_routing_preference.

-

walking

walking: "walking"

requests walking directions via pedestrian paths & sidewalks (where available).

-

Settings

Member Visibility

On This Page

Enumeration Members
+

walking

walking: "walking"

requests walking directions via pedestrian paths & sidewalks (where available).

+

Settings

Member Visibility

On This Page

Enumeration Members
diff --git a/enums/TravelRestriction.html b/enums/TravelRestriction.html index 94acacadba..26cbd65972 100644 --- a/enums/TravelRestriction.html +++ b/enums/TravelRestriction.html @@ -1,10 +1,10 @@ -TravelRestriction | Google Maps Services Node Client

Enumeration TravelRestriction

Enumeration Members

ferries +TravelRestriction | Google Maps Services Node Client

Enumeration TravelRestriction

Enumeration Members

ferries highways indoor tolls

Enumeration Members

ferries

ferries: "ferries"

indicates that the calculated route should avoid ferries.

-

highways

highways: "highways"

indicates that the calculated route should avoid highways.

-

indoor

indoor: "indoor"

indicates that the calculated route should avoid indoor steps for walking and transit directions. +

highways

highways: "highways"

indicates that the calculated route should avoid highways.

+

indoor

indoor: "indoor"

indicates that the calculated route should avoid indoor steps for walking and transit directions. Only requests that include an API key or a Google Maps APIs Premium Plan client ID will receive indoor steps by default.

-

tolls

tolls: "tolls"

indicates that the calculated route should avoid toll roads/bridges.

-

Settings

Member Visibility

On This Page

Enumeration Members
+

tolls

tolls: "tolls"

indicates that the calculated route should avoid toll roads/bridges.

+

Settings

Member Visibility

On This Page

Enumeration Members
diff --git a/enums/UnitSystem.html b/enums/UnitSystem.html index 3cbc7b8690..302aee65b3 100644 --- a/enums/UnitSystem.html +++ b/enums/UnitSystem.html @@ -1,7 +1,7 @@ UnitSystem | Google Maps Services Node Client

Enumeration UnitSystem

Directions results contain text within distance fields that may be displayed to the user to indicate the distance of a particular "step" of the route. By default, this text uses the unit system of the origin's country or region.

-

Enumeration Members

imperial +

Enumeration Members

imperial metric

Enumeration Members

imperial

imperial: "imperial"

specifies usage of the Imperial (English) system. Textual distances are returned using miles and feet.

-

metric

metric: "metric"

specifies usage of the metric system. Textual distances are returned using kilometers and meters.

-

Settings

Member Visibility

On This Page

Enumeration Members
+

metric

metric: "metric"

specifies usage of the metric system. Textual distances are returned using kilometers and meters.

+

Settings

Member Visibility

On This Page

Enumeration Members
diff --git a/enums/VehicleType.html b/enums/VehicleType.html index 3b638ffe33..32ed902f3a 100644 --- a/enums/VehicleType.html +++ b/enums/VehicleType.html @@ -1,5 +1,5 @@ VehicleType | Google Maps Services Node Client

Enumeration VehicleType

See

https://developers.google.com/maps/documentation/directions/intro#VehicleType.

-

Enumeration Members

BUS +

Enumeration Members

BUS CABLE_CAR COMMUTER_TRAIN FERRY @@ -17,21 +17,21 @@ TRAM TROLLEYBUS

Enumeration Members

BUS

BUS: "BUS"

Bus.

-

CABLE_CAR

CABLE_CAR: "CABLE_CAR"

A vehicle that operates on a cable, usually on the ground. Aerial cable cars may be of the type GONDOLA_LIFT.

-

COMMUTER_TRAIN

COMMUTER_TRAIN: "COMMUTER_TRAIN"

Commuter rail.

-

FERRY

FERRY: "FERRY"

Ferry.

-

FUNICULAR

FUNICULAR: "FUNICULAR"

A vehicle that is pulled up a steep incline by a cable. +

CABLE_CAR

CABLE_CAR: "CABLE_CAR"

A vehicle that operates on a cable, usually on the ground. Aerial cable cars may be of the type GONDOLA_LIFT.

+

COMMUTER_TRAIN

COMMUTER_TRAIN: "COMMUTER_TRAIN"

Commuter rail.

+

FERRY

FERRY: "FERRY"

Ferry.

+

FUNICULAR

FUNICULAR: "FUNICULAR"

A vehicle that is pulled up a steep incline by a cable. A Funicular typically consists of two cars, with each car acting as a counterweight for the other.

-

GONDOLA_LIFT

GONDOLA_LIFT: "GONDOLA_LIFT"

An aerial cable car.

-

HEAVY_RAIL

HEAVY_RAIL: "HEAVY_RAIL"

Heavy rail.

-

HIGH_SPEED_TRAIN

HIGH_SPEED_TRAIN: "HIGH_SPEED_TRAIN"

High speed train.

-

INTERCITY_BUS

INTERCITY_BUS: "INTERCITY_BUS"

Intercity bus.

-

METRO_RAIL

METRO_RAIL: "METRO_RAIL"

Light rail transit.

-

MONORAIL

MONORAIL: "MONORAIL"

Monorail.

-

OTHER

OTHER: "OTHER"

All other vehicles will return this type.

-

RAIL

RAIL: "RAIL"

Rail.

-

SHARE_TAXI

SHARE_TAXI: "SHARE_TAXI"

Share taxi is a kind of bus with the ability to drop off and pick up passengers anywhere on its route.

-

SUBWAY

SUBWAY: "SUBWAY"

Underground light rail.

-

TRAM

TRAM: "TRAM"

Above ground light rail.

-

TROLLEYBUS

TROLLEYBUS: "TROLLEYBUS"

Trolleybus.

-

Settings

Member Visibility

On This Page

Enumeration Members
+

GONDOLA_LIFT

GONDOLA_LIFT: "GONDOLA_LIFT"

An aerial cable car.

+

HEAVY_RAIL

HEAVY_RAIL: "HEAVY_RAIL"

Heavy rail.

+

HIGH_SPEED_TRAIN

HIGH_SPEED_TRAIN: "HIGH_SPEED_TRAIN"

High speed train.

+

INTERCITY_BUS

INTERCITY_BUS: "INTERCITY_BUS"

Intercity bus.

+

METRO_RAIL

METRO_RAIL: "METRO_RAIL"

Light rail transit.

+

MONORAIL

MONORAIL: "MONORAIL"

Monorail.

+

OTHER

OTHER: "OTHER"

All other vehicles will return this type.

+

RAIL

RAIL: "RAIL"

Rail.

+

SHARE_TAXI

SHARE_TAXI: "SHARE_TAXI"

Share taxi is a kind of bus with the ability to drop off and pick up passengers anywhere on its route.

+

SUBWAY

SUBWAY: "SUBWAY"

Underground light rail.

+

TRAM

TRAM: "TRAM"

Above ground light rail.

+

TROLLEYBUS

TROLLEYBUS: "TROLLEYBUS"

Trolleybus.

+

Settings

Member Visibility

On This Page

Enumeration Members
diff --git a/functions/defaultAxiosInstance.html b/functions/defaultAxiosInstance.html index 3e303a190c..3a008eeb40 100644 --- a/functions/defaultAxiosInstance.html +++ b/functions/defaultAxiosInstance.html @@ -1 +1 @@ -defaultAxiosInstance | Google Maps Services Node Client

Function defaultAxiosInstance

  • defaultAxiosInstance<T = any, R = AxiosResponse<T>, D = any>(
        config: AxiosRequestConfig<D>,
    ): Promise<R>

  • Type Parameters

    • T = any
    • R = AxiosResponse<T>
    • D = any

    Parameters

    • config: AxiosRequestConfig<D>

    Returns Promise<R>

  • defaultAxiosInstance<T = any, R = AxiosResponse<T>, D = any>(
        url: string,
        config?: AxiosRequestConfig<D>,
    ): Promise<R>

  • Type Parameters

    • T = any
    • R = AxiosResponse<T>
    • D = any

    Parameters

    • url: string
    • Optionalconfig: AxiosRequestConfig<D>

    Returns Promise<R>

Settings

Member Visibility
+defaultAxiosInstance | Google Maps Services Node Client

Function defaultAxiosInstance

  • defaultAxiosInstance<T = any, R = AxiosResponse<T>, D = any>(
        config: AxiosRequestConfig<D>,
    ): Promise<R>

  • Type Parameters

    • T = any
    • R = AxiosResponse<T>
    • D = any

    Parameters

    • config: AxiosRequestConfig<D>

    Returns Promise<R>

  • defaultAxiosInstance<T = any, R = AxiosResponse<T>, D = any>(
        url: string,
        config?: AxiosRequestConfig<D>,
    ): Promise<R>

  • Type Parameters

    • T = any
    • R = AxiosResponse<T>
    • D = any

    Parameters

    • url: string
    • Optionalconfig: AxiosRequestConfig<D>

    Returns Promise<R>

Settings

Member Visibility
diff --git a/interfaces/AddressComponent.html b/interfaces/AddressComponent.html index 2757fe81b2..c72cd0e93b 100644 --- a/interfaces/AddressComponent.html +++ b/interfaces/AddressComponent.html @@ -1,9 +1,9 @@ -AddressComponent | Google Maps Services Node Client

Interface AddressComponent

interface AddressComponent {
    long_name: string;
    short_name: string;
    types: (AddressType | GeocodingAddressComponentType)[];
}

Properties

long_name +AddressComponent | Google Maps Services Node Client

Interface AddressComponent

interface AddressComponent {
    long_name: string;
    short_name: string;
    types: (AddressType | GeocodingAddressComponentType)[];
}

Properties

long_name short_name types

Properties

long_name

long_name: string

is the full text description or name of the address component as returned by the Geocoder.

-

short_name

short_name: string

is an abbreviated textual name for the address component, if available. +

short_name

short_name: string

is an abbreviated textual name for the address component, if available. For example, an address component for the state of Alaska may have a long_name of "Alaska" and a short_name of "AK" using the 2-letter postal abbreviation.

-

types

types: (AddressType | GeocodingAddressComponentType)[]

is an array indicating the type of the address component.

-

Settings

Member Visibility

On This Page

Properties
+

types

types: (AddressType | GeocodingAddressComponentType)[]

is an array indicating the type of the address component.

+

Settings

Member Visibility

On This Page

Properties
diff --git a/interfaces/AddressDescriptor.html b/interfaces/AddressDescriptor.html index 169fc76412..f1fb64c0a5 100644 --- a/interfaces/AddressDescriptor.html +++ b/interfaces/AddressDescriptor.html @@ -1,6 +1,6 @@ AddressDescriptor | Google Maps Services Node Client

Interface AddressDescriptor

Represents a descriptor of an address.

Please see Address -Descriptors for more detail.

interface AddressDescriptor {
    areas: Area[];
    landmarks: Landmark[];
}

Properties

areas +Descriptors for more detail.
interface AddressDescriptor {
    areas: Area[];
    landmarks: Landmark[];
}

Properties

areas landmarks -

Properties

areas

areas: Area[]

landmarks

landmarks: Landmark[]

Settings

Member Visibility

On This Page

Properties
+

Properties

areas

areas: Area[]

landmarks

landmarks: Landmark[]

Settings

Member Visibility

On This Page

Properties
diff --git a/interfaces/AddressGeometry.html b/interfaces/AddressGeometry.html index 7cd7f29bab..54af33253a 100644 --- a/interfaces/AddressGeometry.html +++ b/interfaces/AddressGeometry.html @@ -1,4 +1,4 @@ -AddressGeometry | Google Maps Services Node Client

Interface AddressGeometry

interface AddressGeometry {
    bounds?: LatLngBounds;
    location: LatLngLiteral;
    location_type?: LocationType;
    viewport: LatLngBounds;
}

Properties

bounds? +AddressGeometry | Google Maps Services Node Client

Interface AddressGeometry

interface AddressGeometry {
    bounds?: LatLngBounds;
    location: LatLngLiteral;
    location_type?: LocationType;
    viewport: LatLngBounds;
}

Properties

bounds? location location_type? viewport @@ -6,9 +6,9 @@ Note that these bounds may not match the recommended viewport. (For example, San Francisco includes the Farallon islands, which are technically part of the city, but probably should not be returned in the viewport.)

-

location

location: LatLngLiteral

contains the geocoded latitude, longitude value. For normal address lookups, this field is typically the most important.

-

Optionallocation_type

location_type?: LocationType

stores additional data about the specified location.

-

viewport

viewport: LatLngBounds

contains the recommended viewport for displaying the returned result, specified as two latitude, longitude values +

location

location: LatLngLiteral

contains the geocoded latitude, longitude value. For normal address lookups, this field is typically the most important.

+

Optionallocation_type

location_type?: LocationType

stores additional data about the specified location.

+

viewport

viewport: LatLngBounds

contains the recommended viewport for displaying the returned result, specified as two latitude, longitude values defining the southwest and northeast corner of the viewport bounding box. Generally the viewport is used to frame a result when displaying it to a user.

-

Settings

Member Visibility

On This Page

Properties
+

Settings

Member Visibility

On This Page

Properties
diff --git a/interfaces/AlternativePlaceId.html b/interfaces/AlternativePlaceId.html index bad4bcbeb3..9028608829 100644 --- a/interfaces/AlternativePlaceId.html +++ b/interfaces/AlternativePlaceId.html @@ -1,7 +1,7 @@ -AlternativePlaceId | Google Maps Services Node Client

Interface AlternativePlaceId

interface AlternativePlaceId {
    place_id: string;
    scope: "APP";
}

Properties

place_id +AlternativePlaceId | Google Maps Services Node Client

Interface AlternativePlaceId

interface AlternativePlaceId {
    place_id: string;
    scope: "APP";
}

Properties

place_id scope

Properties

place_id

place_id: string

The most likely reason for a place to have an alternative place ID is if your application adds a place and receives an application-scoped place ID, then later receives a Google-scoped place ID after passing the moderation process.

-

scope

scope: "APP"

The scope of an alternative place ID will always be APP, +

scope

scope: "APP"

The scope of an alternative place ID will always be APP, indicating that the alternative place ID is recognised by your application only.

-

Settings

Member Visibility

On This Page

Properties
+

Settings

Member Visibility

On This Page

Properties
diff --git a/interfaces/ApiKeyParams.html b/interfaces/ApiKeyParams.html index 9cc644f7e9..998db31acc 100644 --- a/interfaces/ApiKeyParams.html +++ b/interfaces/ApiKeyParams.html @@ -1,4 +1,4 @@ -ApiKeyParams | Google Maps Services Node Client

Interface ApiKeyParams

interface ApiKeyParams {
    key: string;
}

Properties

key +ApiKeyParams | Google Maps Services Node Client

Interface ApiKeyParams

interface ApiKeyParams {
    key: string;
}

Properties

key

Properties

key

key: string

You must include an API key with every API request. We strongly recommend that you restrict your API key. Restrictions provide added security and help ensure only authorized requests are made with your API key.

There are two restrictions. You should set both:

@@ -8,4 +8,4 @@

API restriction: Limits usage of the API key to one or more APIs or SDKs. Requests to an API or SDK associated with the API key will be processed. Requests to an API or SDK not associated with the API key will fail.

-

Settings

Member Visibility

On This Page

Properties
+

Settings

Member Visibility

On This Page

Properties
diff --git a/interfaces/AspectRating.html b/interfaces/AspectRating.html index 90b190b682..cc50ebe574 100644 --- a/interfaces/AspectRating.html +++ b/interfaces/AspectRating.html @@ -1,5 +1,5 @@ -AspectRating | Google Maps Services Node Client

Interface AspectRating

interface AspectRating {
    rating: number;
    type: AspectRatingType;
}

Properties

rating +AspectRating | Google Maps Services Node Client

Interface AspectRating

interface AspectRating {
    rating: number;
    type: AspectRatingType;
}

Properties

rating type

Properties

rating

rating: number

the user's rating for this particular aspect, from 0 to 3.

-

type

type: AspectRatingType

the name of the aspect that is being rated.

-

Settings

Member Visibility

On This Page

Properties
+

type

type: AspectRatingType

the name of the aspect that is being rated.

+

Settings

Member Visibility

On This Page

Properties
diff --git a/interfaces/CellTower.html b/interfaces/CellTower.html index c81e40757c..f8a6c6945d 100644 --- a/interfaces/CellTower.html +++ b/interfaces/CellTower.html @@ -1,4 +1,4 @@ -CellTower | Google Maps Services Node Client

Interface CellTower

interface CellTower {
    age?: number;
    cellId: number;
    locationAreaCode: number;
    mobileCountryCode: number;
    mobileNetworkCode: number;
    signalStrength?: number;
    timingAdvance?: number;
}

Properties

age? +CellTower | Google Maps Services Node Client

Interface CellTower

interface CellTower {
    age?: number;
    cellId: number;
    locationAreaCode: number;
    mobileCountryCode: number;
    mobileNetworkCode: number;
    signalStrength?: number;
    timingAdvance?: number;
}

Properties

age? cellId locationAreaCode mobileCountryCode @@ -6,14 +6,14 @@ signalStrength? timingAdvance?

Properties

Optionalage

age?: number

The number of milliseconds since this cell was primary. If age is 0, the cellId represents a current measurement.

-

cellId

cellId: number

Unique identifier of the cell. +

cellId

cellId: number

Unique identifier of the cell. On GSM, this is the Cell ID (CID); CDMA networks use the Base Station ID (BID). WCDMA networks use the UTRAN/GERAN Cell Identity (UC-Id), which is a 32-bit value concatenating the Radio Network Controller (RNC) and Cell ID. Specifying only the 16-bit Cell ID value in WCDMA networks may return inaccurate results.

-

locationAreaCode

locationAreaCode: number

The Location Area Code (LAC) for GSM and WCDMA networks. The Network ID (NID) for CDMA networks.

-

mobileCountryCode

mobileCountryCode: number

The cell tower's Mobile Country Code (MCC).

-

mobileNetworkCode

mobileNetworkCode: number

The cell tower's Mobile Network Code. This is the MNC for GSM and WCDMA; CDMA uses the System ID (SID).

-

OptionalsignalStrength

signalStrength?: number

Radio signal strength measured in dBm.

-

OptionaltimingAdvance

timingAdvance?: number

The timing advance value.

-

Settings

Member Visibility

On This Page

Properties
+

locationAreaCode

locationAreaCode: number

The Location Area Code (LAC) for GSM and WCDMA networks. The Network ID (NID) for CDMA networks.

+

mobileCountryCode

mobileCountryCode: number

The cell tower's Mobile Country Code (MCC).

+

mobileNetworkCode

mobileNetworkCode: number

The cell tower's Mobile Network Code. This is the MNC for GSM and WCDMA; CDMA uses the System ID (SID).

+

OptionalsignalStrength

signalStrength?: number

Radio signal strength measured in dBm.

+

OptionaltimingAdvance

timingAdvance?: number

The timing advance value.

+

Settings

Member Visibility

On This Page

Properties
diff --git a/interfaces/ClientOptions.html b/interfaces/ClientOptions.html index 7e1e66e9e6..8aa378fbcb 100644 --- a/interfaces/ClientOptions.html +++ b/interfaces/ClientOptions.html @@ -1,6 +1,6 @@ -ClientOptions | Google Maps Services Node Client

Interface ClientOptions

interface ClientOptions {
    axiosInstance?: AxiosInstance;
    config?: Config;
    experienceId?: string[];
}

Properties

axiosInstance? +ClientOptions | Google Maps Services Node Client

Interface ClientOptions

interface ClientOptions {
    axiosInstance?: AxiosInstance;
    config?: Config;
    experienceId?: string[];
}

Properties

axiosInstance? config? experienceId?

Properties

OptionalaxiosInstance

axiosInstance?: AxiosInstance

AxiosInstance to be used by client. Provide one of axiosInstance or config.

-

Optionalconfig

config?: Config

Config used to create AxiosInstance. Provide one of axiosInstance or config.

-

OptionalexperienceId

experienceId?: string[]

Settings

Member Visibility

On This Page

Properties
+

Optionalconfig

config?: Config

Config used to create AxiosInstance. Provide one of axiosInstance or config.

+

OptionalexperienceId

experienceId?: string[]

Settings

Member Visibility

On This Page

Properties
diff --git a/interfaces/DirectionsRequest.html b/interfaces/DirectionsRequest.html index 8d9d7058e8..264fe94e21 100644 --- a/interfaces/DirectionsRequest.html +++ b/interfaces/DirectionsRequest.html @@ -1,4 +1,4 @@ -DirectionsRequest | Google Maps Services Node Client

Interface DirectionsRequest

interface DirectionsRequest {
    params: {
        alternatives?: boolean;
        arrival_time?: number | Date;
        avoid?: TravelRestriction[];
        departure_time?: number | Date | "now";
        destination: LatLng;
        language?: Language;
        mode?: TravelMode;
        optimize?: boolean;
        origin: LatLng;
        region?: string;
        traffic_model?: TrafficModel;
        transit_mode?: TransitMode[];
        transit_routing_preference?: TransitRoutingPreference;
        units?: UnitSystem;
        waypoints?: LatLng[];
    } & RequestParams;
}

Hierarchy

  • Partial<AxiosRequestConfig>
    • DirectionsRequest

Properties

params +DirectionsRequest | Google Maps Services Node Client

Interface DirectionsRequest

interface DirectionsRequest {
    params: {
        alternatives?: boolean;
        arrival_time?: number | Date;
        avoid?: TravelRestriction[];
        departure_time?: number | Date | "now";
        destination: LatLng;
        language?: Language;
        mode?: TravelMode;
        optimize?: boolean;
        origin: LatLng;
        region?: string;
        traffic_model?: TrafficModel;
        transit_mode?: TransitMode[];
        transit_routing_preference?: TransitRoutingPreference;
        units?: UnitSystem;
        waypoints?: LatLng[];
    } & RequestParams;
}

Hierarchy

  • Partial<AxiosRequestConfig>
    • DirectionsRequest

Properties

params

Properties

params

params: {
    alternatives?: boolean;
    arrival_time?: number | Date;
    avoid?: TravelRestriction[];
    departure_time?: number | Date | "now";
    destination: LatLng;
    language?: Language;
    mode?: TravelMode;
    optimize?: boolean;
    origin: LatLng;
    region?: string;
    traffic_model?: TrafficModel;
    transit_mode?: TransitMode[];
    transit_routing_preference?: TransitRoutingPreference;
    units?: UnitSystem;
    waypoints?: LatLng[];
} & RequestParams

Type declaration

  • Optionalalternatives?: boolean

    If set to true, specifies that the Directions service may provide more than one route alternative in the response. Note that providing route alternatives may increase the response time from the server.

  • Optionalarrival_time?: number | Date

    Specifies the desired time of arrival for transit directions, in seconds since midnight, January 1, 1970 UTC. @@ -83,4 +83,4 @@ Encoded polylines must be prefixed with enc: and followed by a colon (:). Place IDs must be prefixed with place_id:. The place ID may only be specified if the request includes an API key or a Google Maps APIs Premium Plan client ID. Waypoints are only supported for driving, walking and bicycling directions.

    -

Settings

Member Visibility

On This Page

Properties
+

Settings

Member Visibility

On This Page

Properties
diff --git a/interfaces/DirectionsResponse.html b/interfaces/DirectionsResponse.html index 876cfd4e79..963a686a9f 100644 --- a/interfaces/DirectionsResponse.html +++ b/interfaces/DirectionsResponse.html @@ -1,2 +1,2 @@ -DirectionsResponse | Google Maps Services Node Client

Interface DirectionsResponse

interface DirectionsResponse {
    data: DirectionsResponseData;
}

Hierarchy

  • AxiosResponse
    • DirectionsResponse

Properties

data -

Properties

data

data: DirectionsResponseData

Settings

Member Visibility

On This Page

Properties
+DirectionsResponse | Google Maps Services Node Client

Interface DirectionsResponse

interface DirectionsResponse {
    data: DirectionsResponseData;
}

Hierarchy

  • AxiosResponse
    • DirectionsResponse

Properties

data +

Properties

data

data: DirectionsResponseData

Settings

Member Visibility

On This Page

Properties
diff --git a/interfaces/DirectionsResponseData.html b/interfaces/DirectionsResponseData.html index d8f4f287b6..be41c56ca3 100644 --- a/interfaces/DirectionsResponseData.html +++ b/interfaces/DirectionsResponseData.html @@ -1,4 +1,4 @@ -DirectionsResponseData | Google Maps Services Node Client

Interface DirectionsResponseData

interface DirectionsResponseData {
    available_travel_modes: string[];
    error_message: string;
    geocoded_waypoints: GeocodedWaypoint[];
    html_attributions?: string[];
    next_page_token?: string;
    routes: DirectionsRoute[];
    status: Status;
}

Hierarchy (View Summary)

Properties

available_travel_modes +DirectionsResponseData | Google Maps Services Node Client

Interface DirectionsResponseData

interface DirectionsResponseData {
    available_travel_modes: string[];
    error_message: string;
    geocoded_waypoints: GeocodedWaypoint[];
    html_attributions?: string[];
    next_page_token?: string;
    routes: DirectionsRoute[];
    status: Status;
}

Hierarchy (View Summary)

Properties

available_travel_modes error_message geocoded_waypoints html_attributions? @@ -8,18 +8,18 @@

Properties

available_travel_modes

available_travel_modes: string[]

contains an array of available travel modes. This field is returned when a request specifies a travel mode and gets no results. The array contains the available travel modes in the countries of the given set of waypoints. This field is not returned if one or more of the waypoints are via: waypoints.

-

error_message

error_message: string

When the top-level status code is other than OK, this field contains more detailed information +

error_message

error_message: string

When the top-level status code is other than OK, this field contains more detailed information about the reasons behind the given status code.

-

geocoded_waypoints

geocoded_waypoints: GeocodedWaypoint[]

contains an array with details about the geocoding of origin, destination and waypoints.

+

geocoded_waypoints

geocoded_waypoints: GeocodedWaypoint[]

contains an array with details about the geocoding of origin, destination and waypoints.

These details will not be present for waypoints specified as textual latitude/longitude values if the service returns no results. This is because such waypoints are only reverse geocoded to obtain their representative address after a route has been found. An empty JSON object will occupy the corresponding places in the geocoded_waypoints array.

-

Optionalhtml_attributions

html_attributions?: string[]

may contain a set of attributions about this listing which must be displayed to the user (some listings may not have attribution).

-

Optionalnext_page_token

next_page_token?: string

contains a token that can be used to return up to 20 additional results. +

Optionalhtml_attributions

html_attributions?: string[]

may contain a set of attributions about this listing which must be displayed to the user (some listings may not have attribution).

+

Optionalnext_page_token

next_page_token?: string

contains a token that can be used to return up to 20 additional results. A next_page_token will not be returned if there are no additional results to display. The maximum number of results that can be returned is 60. There is a short delay between when a next_page_token is issued, and when it will become valid.

-

routes

routes: DirectionsRoute[]

contains an array of routes from the origin to the destination.

+

routes

routes: DirectionsRoute[]

contains an array of routes from the origin to the destination.

When the Directions API returns results, it places them within a (JSON) routes array. Even if the service returns no results (such as if the origin and/or destination doesn't exist) it still returns an empty routes array. (XML responses consist of zero or more <route> elements.)

@@ -27,5 +27,5 @@ This route may consist of one or more legs depending on whether any waypoints were specified. As well, the route also contains copyright and warning information which must be displayed to the user in addition to the routing information.

-

status

status: Status

contains metadata on the request. See Status Codes below.

-

Settings

Member Visibility

On This Page

Properties
+

status

status: Status

contains metadata on the request. See Status Codes below.

+

Settings

Member Visibility

On This Page

Properties
diff --git a/interfaces/DirectionsRoute.html b/interfaces/DirectionsRoute.html index f8948202ba..973177140c 100644 --- a/interfaces/DirectionsRoute.html +++ b/interfaces/DirectionsRoute.html @@ -1,6 +1,6 @@ DirectionsRoute | Google Maps Services Node Client

Interface DirectionsRoute

This route may consist of one or more legs depending on whether any waypoints were specified. As well, the route also contains copyright and warning information which must be displayed to the user in addition to the routing information.

-
interface DirectionsRoute {
    bounds: LatLngBounds;
    copyrights: string;
    fare: TransitFare;
    legs: RouteLeg[];
    overview_path: LatLngLiteral[];
    overview_polyline: { points: string };
    summary: string;
    warnings: string[];
    waypoint_order: number[];
}

Properties

bounds +
interface DirectionsRoute {
    bounds: LatLngBounds;
    copyrights: string;
    fare: TransitFare;
    legs: RouteLeg[];
    overview_path: LatLngLiteral[];
    overview_polyline: { points: string };
    summary: string;
    warnings: string[];
    waypoint_order: number[];
}

Properties

bounds copyrights fare legs @@ -10,21 +10,21 @@ warnings waypoint_order

Properties

bounds

bounds: LatLngBounds

contains the viewport bounding box of the overview_polyline.

-

copyrights

copyrights: string

contains the copyrights text to be displayed for this route. You must handle and display this information yourself.

-

fare

fare: TransitFare

If present, contains the total fare (that is, the total ticket costs) on this route. +

copyrights

copyrights: string

contains the copyrights text to be displayed for this route. You must handle and display this information yourself.

+

fare

fare: TransitFare

If present, contains the total fare (that is, the total ticket costs) on this route. This property is only returned for transit requests and only for routes where fare information is available for all transit legs.

Note: The Directions API only returns fare information for requests that contain either an API key or a client ID and digital signature.

-

legs

legs: RouteLeg[]

contains an array which contains information about a leg of the route, between two locations within the given route. +

legs

legs: RouteLeg[]

contains an array which contains information about a leg of the route, between two locations within the given route. A separate leg will be present for each waypoint or destination specified. (A route with no waypoints will contain exactly one leg within the legs array.) Each leg consists of a series of steps.

-

overview_path

overview_path: LatLngLiteral[]

An array of LatLngs representing the entire course of this route. The path is simplified in order to make +

overview_path

overview_path: LatLngLiteral[]

An array of LatLngs representing the entire course of this route. The path is simplified in order to make it suitable in contexts where a small number of vertices is required (such as Static Maps API URLs).

-

overview_polyline

overview_polyline: { points: string }

contains a single points object that holds an encoded polyline representation of the route. +

overview_polyline

overview_polyline: { points: string }

contains a single points object that holds an encoded polyline representation of the route. This polyline is an approximate (smoothed) path of the resulting directions.

-

summary

summary: string

contains a short textual description for the route, suitable for naming and disambiguating the route from alternatives.

-

warnings

warnings: string[]

contains an array of warnings to be displayed when showing these directions. You must handle and display these warnings yourself.

-

waypoint_order

waypoint_order: number[]

contains an array indicating the order of any waypoints in the calculated route. +

summary

summary: string

contains a short textual description for the route, suitable for naming and disambiguating the route from alternatives.

+

warnings

warnings: string[]

contains an array of warnings to be displayed when showing these directions. You must handle and display these warnings yourself.

+

waypoint_order

waypoint_order: number[]

contains an array indicating the order of any waypoints in the calculated route. This waypoints may be reordered if the request was passed optimize:true within its waypoints parameter.

-

Settings

Member Visibility

On This Page

Properties
+

Settings

Member Visibility

On This Page

Properties
diff --git a/interfaces/DirectionsStep.html b/interfaces/DirectionsStep.html index 7467f4b92b..0ee7ecf174 100644 --- a/interfaces/DirectionsStep.html +++ b/interfaces/DirectionsStep.html @@ -7,7 +7,7 @@ driving steps in an inner steps array. For example, a walking step will include directions from the start and end locations: "Walk to Innes Ave & Fitch St". That step will include detailed walking directions for that route in the inner steps array, such as: "Head north-west", "Turn left onto Arelious Walker", and "Turn left onto Innes Ave".

-
interface DirectionsStep {
    distance: Distance;
    duration: Duration;
    end_location: LatLngLiteral;
    html_instructions: string;
    maneuver: Maneuver;
    polyline: { points: string };
    start_location: LatLngLiteral;
    steps: DirectionsStep;
    transit_details: TransitDetails;
    travel_mode: TravelMode;
}

Properties

distance +
interface DirectionsStep {
    distance: Distance;
    duration: Duration;
    end_location: LatLngLiteral;
    html_instructions: string;
    maneuver: Maneuver;
    polyline: { points: string };
    start_location: LatLngLiteral;
    steps: DirectionsStep;
    transit_details: TransitDetails;
    travel_mode: TravelMode;
}

Properties

distance duration end_location html_instructions @@ -19,18 +19,18 @@ travel_mode

Properties

distance

distance: Distance

contains the distance covered by this step until the next step. (See the discussion of this field in Directions Legs)

This field may be undefined if the distance is unknown.

-

duration

duration: Duration

contains the typical time required to perform the step, until the next step. (See the description in Directions Legs)

+

duration

duration: Duration

contains the typical time required to perform the step, until the next step. (See the description in Directions Legs)

This field may be undefined if the duration is unknown

-

end_location

end_location: LatLngLiteral

contains the location of the last point of this step, as a single set of lat and lng fields.

-

html_instructions

html_instructions: string

contains formatted instructions for this step, presented as an HTML text string.

-

maneuver

maneuver: Maneuver

contains the action to take for the current step (turn left, merge, straight, etc.). +

end_location

end_location: LatLngLiteral

contains the location of the last point of this step, as a single set of lat and lng fields.

+

html_instructions

html_instructions: string

contains formatted instructions for this step, presented as an HTML text string.

+

maneuver

maneuver: Maneuver

contains the action to take for the current step (turn left, merge, straight, etc.). This field is used to determine which icon to display.

-

polyline

polyline: { points: string }

contains a single points object that holds an encoded polyline representation of the step. +

polyline

polyline: { points: string }

contains a single points object that holds an encoded polyline representation of the step. This polyline is an approximate (smoothed) path of the step.

-

start_location

start_location: LatLngLiteral

contains the location of the starting point of this step, as a single set of lat and lng fields.

-

steps

steps: DirectionsStep

contains detailed directions for walking or driving steps in transit directions. +

start_location

start_location: LatLngLiteral

contains the location of the starting point of this step, as a single set of lat and lng fields.

+

steps

steps: DirectionsStep

contains detailed directions for walking or driving steps in transit directions. Substeps are only available when travel_mode is set to "transit". The inner steps array is of the same type as steps.

-

transit_details

transit_details: TransitDetails

contains transit specific information. This field is only returned with travel_mode is set to "transit".

-

travel_mode

travel_mode: TravelMode

contains the type of travel mode used.

-

Settings

Member Visibility

On This Page

Properties
+

transit_details

transit_details: TransitDetails

contains transit specific information. This field is only returned with travel_mode is set to "transit".

+

travel_mode

travel_mode: TravelMode

contains the type of travel mode used.

+

Settings

Member Visibility

On This Page

Properties
diff --git a/interfaces/Distance.html b/interfaces/Distance.html index 6cf53c17eb..546b1da9c9 100644 --- a/interfaces/Distance.html +++ b/interfaces/Distance.html @@ -1,7 +1,7 @@ -Distance | Google Maps Services Node Client

Interface Distance

interface Distance {
    text: string;
    value: number;
}

Properties

text +Distance | Google Maps Services Node Client

Interface Distance

interface Distance {
    text: string;
    value: number;
}

Properties

text value

Properties

text

text: string

contains a human-readable representation of the distance, displayed in units as used at the origin (or as overridden within the units parameter in the request). (For example, miles and feet will be used for any origin within the United States.)

-

value

value: number

indicates the distance in meters.

-

Settings

Member Visibility

On This Page

Properties
+

value

value: number

indicates the distance in meters.

+

Settings

Member Visibility

On This Page

Properties
diff --git a/interfaces/DistanceMatrixRequest.html b/interfaces/DistanceMatrixRequest.html index 4b2cb7cd23..247126af81 100644 --- a/interfaces/DistanceMatrixRequest.html +++ b/interfaces/DistanceMatrixRequest.html @@ -1,4 +1,4 @@ -DistanceMatrixRequest | Google Maps Services Node Client

Interface DistanceMatrixRequest

interface DistanceMatrixRequest {
    params: {
        arrival_time?: number | Date;
        avoid?: TravelRestriction[];
        departure_time?: number | Date;
        destinations: LatLng[];
        language?: string;
        mode?: TravelMode;
        origins: LatLng[];
        region?: string;
        traffic_model?: TrafficModel;
        transit_mode?: TransitMode[];
        transit_routing_preference?: TransitRoutingPreference;
        units?: UnitSystem;
    } & RequestParams;
}

Hierarchy

  • Partial<AxiosRequestConfig>
    • DistanceMatrixRequest

Properties

params +DistanceMatrixRequest | Google Maps Services Node Client

Interface DistanceMatrixRequest

interface DistanceMatrixRequest {
    params: {
        arrival_time?: number | Date;
        avoid?: TravelRestriction[];
        departure_time?: number | Date;
        destinations: LatLng[];
        language?: string;
        mode?: TravelMode;
        origins: LatLng[];
        region?: string;
        traffic_model?: TrafficModel;
        transit_mode?: TransitMode[];
        transit_routing_preference?: TransitRoutingPreference;
        units?: UnitSystem;
    } & RequestParams;
}

Hierarchy

  • Partial<AxiosRequestConfig>
    • DistanceMatrixRequest

Properties

params

Properties

params

params: {
    arrival_time?: number | Date;
    avoid?: TravelRestriction[];
    departure_time?: number | Date;
    destinations: LatLng[];
    language?: string;
    mode?: TravelMode;
    origins: LatLng[];
    region?: string;
    traffic_model?: TrafficModel;
    transit_mode?: TransitMode[];
    transit_routing_preference?: TransitRoutingPreference;
    units?: UnitSystem;
} & RequestParams

Type declaration

  • Optionalarrival_time?: number | Date

    Specifies the desired time of arrival for transit requests, in seconds since midnight, January 1, 1970 UTC. You can specify either departure_time or arrival_time, but not both. Note that arrival_time must be specified as an integer.

    @@ -93,4 +93,4 @@ rather than accepting the default best route chosen by the API. This parameter may only be specified for requests where the mode is transit.

  • Optionalunits?: UnitSystem

    Specifies the unit system to use when expressing distance as text.

    -

Settings

Member Visibility

On This Page

Properties
+

Settings

Member Visibility

On This Page

Properties
diff --git a/interfaces/DistanceMatrixResponse.html b/interfaces/DistanceMatrixResponse.html index f81616daa7..c9ff32541e 100644 --- a/interfaces/DistanceMatrixResponse.html +++ b/interfaces/DistanceMatrixResponse.html @@ -1,2 +1,2 @@ -DistanceMatrixResponse | Google Maps Services Node Client

Interface DistanceMatrixResponse

interface DistanceMatrixResponse {
    data: DistanceMatrixResponseData;
}

Hierarchy

  • AxiosResponse
    • DistanceMatrixResponse

Properties

data -

Properties

data

data: DistanceMatrixResponseData

Settings

Member Visibility

On This Page

Properties
+DistanceMatrixResponse | Google Maps Services Node Client

Interface DistanceMatrixResponse

interface DistanceMatrixResponse {
    data: DistanceMatrixResponseData;
}

Hierarchy

  • AxiosResponse
    • DistanceMatrixResponse

Properties

data +

Properties

data

data: DistanceMatrixResponseData

Settings

Member Visibility

On This Page

Properties
diff --git a/interfaces/DistanceMatrixResponseData.html b/interfaces/DistanceMatrixResponseData.html index 8ed1f443af..93851eb126 100644 --- a/interfaces/DistanceMatrixResponseData.html +++ b/interfaces/DistanceMatrixResponseData.html @@ -1,4 +1,4 @@ -DistanceMatrixResponseData | Google Maps Services Node Client

Interface DistanceMatrixResponseData

interface DistanceMatrixResponseData {
    destination_addresses: string[];
    error_message: string;
    html_attributions?: string[];
    next_page_token?: string;
    origin_addresses: string[];
    rows: DistanceMatrixRow[];
    status: Status;
}

Hierarchy (View Summary)

Properties

destination_addresses +DistanceMatrixResponseData | Google Maps Services Node Client

Interface DistanceMatrixResponseData

interface DistanceMatrixResponseData {
    destination_addresses: string[];
    error_message: string;
    html_attributions?: string[];
    next_page_token?: string;
    origin_addresses: string[];
    rows: DistanceMatrixRow[];
    status: Status;
}

Hierarchy (View Summary)

Properties

destination_addresses error_message html_attributions? next_page_token? @@ -7,13 +7,13 @@ status

Properties

destination_addresses

destination_addresses: string[]

contains an array of addresses as returned by the API from your original request. As with origin_addresses, these are localized if appropriate.

-

error_message

error_message: string

When the top-level status code is other than OK, this field contains more detailed information +

error_message

error_message: string

When the top-level status code is other than OK, this field contains more detailed information about the reasons behind the given status code.

-

Optionalhtml_attributions

html_attributions?: string[]

may contain a set of attributions about this listing which must be displayed to the user (some listings may not have attribution).

-

Optionalnext_page_token

next_page_token?: string

contains a token that can be used to return up to 20 additional results. +

Optionalhtml_attributions

html_attributions?: string[]

may contain a set of attributions about this listing which must be displayed to the user (some listings may not have attribution).

+

Optionalnext_page_token

next_page_token?: string

contains a token that can be used to return up to 20 additional results. A next_page_token will not be returned if there are no additional results to display. The maximum number of results that can be returned is 60. There is a short delay between when a next_page_token is issued, and when it will become valid.

-

origin_addresses

origin_addresses: string[]

rows

rows: DistanceMatrixRow[]

contains an array of elements, which in turn each contain a status, duration, and distance element.

-

status

status: Status

contains metadata on the request. See Status Codes below.

-

Settings

Member Visibility

On This Page

Properties
+

origin_addresses

origin_addresses: string[]

rows

rows: DistanceMatrixRow[]

contains an array of elements, which in turn each contain a status, duration, and distance element.

+

status

status: Status

contains metadata on the request. See Status Codes below.

+

Settings

Member Visibility

On This Page

Properties
diff --git a/interfaces/DistanceMatrixRow.html b/interfaces/DistanceMatrixRow.html index 5a936b4914..873a918d61 100644 --- a/interfaces/DistanceMatrixRow.html +++ b/interfaces/DistanceMatrixRow.html @@ -4,5 +4,5 @@

Rows are ordered according to the values in the origin parameter of the request. Each row corresponds to an origin, and each element within that row corresponds to a pairing of the origin with a destination value.

Each row array contains one or more element entries, which in turn contain the information about a single origin-destination pairing.

-
interface DistanceMatrixRow {
    elements: DistanceMatrixRowElement[];
}

Properties

elements -

Properties

elements

elements: DistanceMatrixRowElement[]

Settings

Member Visibility

On This Page

Properties
+
interface DistanceMatrixRow {
    elements: DistanceMatrixRowElement[];
}

Properties

elements +

Properties

elements

elements: DistanceMatrixRowElement[]

Settings

Member Visibility

On This Page

Properties
diff --git a/interfaces/DistanceMatrixRowElement.html b/interfaces/DistanceMatrixRowElement.html index a03dbefda4..859d95405f 100644 --- a/interfaces/DistanceMatrixRowElement.html +++ b/interfaces/DistanceMatrixRowElement.html @@ -1,14 +1,14 @@ DistanceMatrixRowElement | Google Maps Services Node Client

Interface DistanceMatrixRowElement

The information about each origin-destination pairing is returned in an element entry.

-
interface DistanceMatrixRowElement {
    distance: Distance;
    duration: Duration;
    duration_in_traffic: Duration;
    fare: TransitFare;
    status: Status;
}

Properties

distance +
interface DistanceMatrixRowElement {
    distance: Distance;
    duration: Duration;
    duration_in_traffic: Duration;
    fare: TransitFare;
    status: Status;
}

Properties

distance duration duration_in_traffic fare status

Properties

distance

distance: Distance

The total distance of this route, expressed in meters (value) and as text. The textual value uses the unit system specified with the unit parameter of the original request, or the origin's region.

-

duration

duration: Duration

The length of time it takes to travel this route, expressed in seconds (the value field) and as text. +

duration

duration: Duration

The length of time it takes to travel this route, expressed in seconds (the value field) and as text. The textual representation is localized according to the query's language parameter.

-

duration_in_traffic

duration_in_traffic: Duration

The length of time it takes to travel this route, based on current and historical traffic conditions. +

duration_in_traffic

duration_in_traffic: Duration

The length of time it takes to travel this route, based on current and historical traffic conditions. See the traffic_model request parameter for the options you can use to request that the returned value is optimistic, pessimistic, or a best-guess estimate. The duration is expressed in seconds (the value field) and as text. The textual representation is localized according to the query's language parameter. @@ -19,7 +19,7 @@

  • Traffic conditions are available for the requested route.
  • The mode parameter is set to driving.
    • -

    fare

    fare: TransitFare

    If present, contains the total fare (that is, the total ticket costs) on this route. +

    fare

    fare: TransitFare

    If present, contains the total fare (that is, the total ticket costs) on this route. This property is only returned for transit requests and only for transit providers where fare information is available.

    -

    status

    status: Status

    possible status codes

    -

    Settings

    Member Visibility

    On This Page

    Properties
    +

    status

    status: Status

    possible status codes

    +

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/interfaces/Duration.html b/interfaces/Duration.html index dbc7ecdee3..70ed55afae 100644 --- a/interfaces/Duration.html +++ b/interfaces/Duration.html @@ -1,5 +1,5 @@ -Duration | Google Maps Services Node Client

    Interface Duration

    interface Duration {
        text: string;
        value: number;
    }

    Properties

    text +Duration | Google Maps Services Node Client

    Interface Duration

    interface Duration {
        text: string;
        value: number;
    }

    Properties

    text value

    Properties

    text

    text: string

    contains a human-readable representation of the duration.

    -

    value

    value: number

    indicates the duration in seconds.

    -

    Settings

    Member Visibility

    On This Page

    Properties
    +

    value

    value: number

    indicates the duration in seconds.

    +

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/interfaces/ElevationRequest.html b/interfaces/ElevationRequest.html index a8103ad17c..6ee363f5eb 100644 --- a/interfaces/ElevationRequest.html +++ b/interfaces/ElevationRequest.html @@ -1,2 +1,2 @@ -ElevationRequest | Google Maps Services Node Client

    Interface ElevationRequest

    interface ElevationRequest {
        params: (PositionalElevationParams | SampledPathElevationParams) & RequestParams;
    }

    Hierarchy

    • Partial<AxiosRequestConfig>
      • ElevationRequest

    Properties

    params -

    Properties

    params

    params: (PositionalElevationParams | SampledPathElevationParams) & RequestParams

    Settings

    Member Visibility

    On This Page

    Properties
    +ElevationRequest | Google Maps Services Node Client

    Interface ElevationRequest

    interface ElevationRequest {
        params: (PositionalElevationParams | SampledPathElevationParams) & RequestParams;
    }

    Hierarchy

    • Partial<AxiosRequestConfig>
      • ElevationRequest

    Properties

    params +

    Properties

    params

    params: (PositionalElevationParams | SampledPathElevationParams) & RequestParams

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/interfaces/ElevationResponse.html b/interfaces/ElevationResponse.html index 629b080bfc..9eb93e9473 100644 --- a/interfaces/ElevationResponse.html +++ b/interfaces/ElevationResponse.html @@ -1,2 +1,2 @@ -ElevationResponse | Google Maps Services Node Client

    Interface ElevationResponse

    interface ElevationResponse {
        data: ElevationResponseData;
    }

    Hierarchy

    • AxiosResponse
      • ElevationResponse

    Properties

    data -

    Properties

    data

    data: ElevationResponseData

    Settings

    Member Visibility

    On This Page

    Properties
    +ElevationResponse | Google Maps Services Node Client

    Interface ElevationResponse

    interface ElevationResponse {
        data: ElevationResponseData;
    }

    Hierarchy

    • AxiosResponse
      • ElevationResponse

    Properties

    data +

    Properties

    data

    data: ElevationResponseData

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/interfaces/ElevationResponseData.html b/interfaces/ElevationResponseData.html index b2a8ce1e85..87fbbc7f09 100644 --- a/interfaces/ElevationResponseData.html +++ b/interfaces/ElevationResponseData.html @@ -1,21 +1,21 @@ -ElevationResponseData | Google Maps Services Node Client

    Interface ElevationResponseData

    interface ElevationResponseData {
        error_message: string;
        html_attributions?: string[];
        next_page_token?: string;
        results: { elevation: number; location: LatLngLiteral; resolution: number }[];
        status: Status;
    }

    Hierarchy (View Summary)

    Properties

    error_message +ElevationResponseData | Google Maps Services Node Client

    Interface ElevationResponseData

    interface ElevationResponseData {
        error_message: string;
        html_attributions?: string[];
        next_page_token?: string;
        results: { elevation: number; location: LatLngLiteral; resolution: number }[];
        status: Status;
    }

    Hierarchy (View Summary)

    Properties

    error_message html_attributions? next_page_token? results status

    Properties

    error_message

    error_message: string

    When the top-level status code is other than OK, this field contains more detailed information about the reasons behind the given status code.

    -

    Optionalhtml_attributions

    html_attributions?: string[]

    may contain a set of attributions about this listing which must be displayed to the user (some listings may not have attribution).

    -

    Optionalnext_page_token

    next_page_token?: string

    contains a token that can be used to return up to 20 additional results. +

    Optionalhtml_attributions

    html_attributions?: string[]

    may contain a set of attributions about this listing which must be displayed to the user (some listings may not have attribution).

    +

    Optionalnext_page_token

    next_page_token?: string

    contains a token that can be used to return up to 20 additional results. A next_page_token will not be returned if there are no additional results to display. The maximum number of results that can be returned is 60. There is a short delay between when a next_page_token is issued, and when it will become valid.

    -

    results

    results: { elevation: number; location: LatLngLiteral; resolution: number }[]

    Type declaration

    results

    results: { elevation: number; location: LatLngLiteral; resolution: number }[]

    Type declaration

    • elevation: number

      An elevation element indicating the elevation of the location in meters.

    • location: LatLngLiteral

      A location element (containing lat and lng elements) of the position for which elevation data is being computed. Note that for path requests, the set of location elements will contain the sampled points along the path.

    • resolution: number

      A resolution value, indicating the maximum distance between data points from which the elevation was interpolated, in meters. This property will be missing if the resolution is not known. Note that elevation data becomes more coarse (larger resolution values) when multiple points are passed. To obtain the most accurate elevation value for a point, it should be queried independently.

      -

    status

    status: Status

    contains metadata on the request. See Status Codes below.

    -

    Settings

    Member Visibility

    On This Page

    Properties
    +

    status

    status: Status

    contains metadata on the request. See Status Codes below.

    +

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/interfaces/FindPlaceFromTextRequest.html b/interfaces/FindPlaceFromTextRequest.html index 0a74f882e4..3c1f7aea04 100644 --- a/interfaces/FindPlaceFromTextRequest.html +++ b/interfaces/FindPlaceFromTextRequest.html @@ -1,4 +1,4 @@ -FindPlaceFromTextRequest | Google Maps Services Node Client

    Interface FindPlaceFromTextRequest

    interface FindPlaceFromTextRequest {
        params: {
            fields?: string[];
            input: string;
            inputtype: PlaceInputType;
            language?: Language;
            locationbias?: string;
        } & RequestParams;
    }

    Hierarchy

    • Partial<AxiosRequestConfig>
      • FindPlaceFromTextRequest

    Properties

    params +FindPlaceFromTextRequest | Google Maps Services Node Client

    Interface FindPlaceFromTextRequest

    interface FindPlaceFromTextRequest {
        params: {
            fields?: string[];
            input: string;
            inputtype: PlaceInputType;
            language?: Language;
            locationbias?: string;
        } & RequestParams;
    }

    Hierarchy

    • Partial<AxiosRequestConfig>
      • FindPlaceFromTextRequest

    Properties

    params

    Properties

    params

    params: {
        fields?: string[];
        input: string;
        inputtype: PlaceInputType;
        language?: Language;
        locationbias?: string;
    } & RequestParams

    Type declaration

    • Optionalfields?: string[]

      The fields specifying the types of place data to return.

      Note: If you omit the fields parameter from a Find Place request, only the place_id for the result will be returned.

    • input: string

      The text input specifying which place to search for (for example, a name, address, or phone number).

      @@ -7,4 +7,4 @@ Searches are also biased to the selected language; results in the selected language may be given a higher ranking

    • Optionallocationbias?: string

      Prefer results in a specified area, by specifying either a radius plus lat/lng, or two lat/lng pairs representing the points of a rectangle. If this parameter is not specified, the API uses IP address biasing by default.

      -

    Settings

    Member Visibility

    On This Page

    Properties
    +

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/interfaces/FindPlaceFromTextResponse.html b/interfaces/FindPlaceFromTextResponse.html index eaa1b7473a..ccd3bb5aa6 100644 --- a/interfaces/FindPlaceFromTextResponse.html +++ b/interfaces/FindPlaceFromTextResponse.html @@ -1,2 +1,2 @@ -FindPlaceFromTextResponse | Google Maps Services Node Client

    Interface FindPlaceFromTextResponse

    interface FindPlaceFromTextResponse {
        data: FindPlaceFromTextResponseData;
    }

    Hierarchy

    • AxiosResponse
      • FindPlaceFromTextResponse

    Properties

    data -

    Properties

    data

    data: FindPlaceFromTextResponseData

    Settings

    Member Visibility

    On This Page

    Properties
    +FindPlaceFromTextResponse | Google Maps Services Node Client

    Interface FindPlaceFromTextResponse

    interface FindPlaceFromTextResponse {
        data: FindPlaceFromTextResponseData;
    }

    Hierarchy

    • AxiosResponse
      • FindPlaceFromTextResponse

    Properties

    data +

    Properties

    data

    data: FindPlaceFromTextResponseData

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/interfaces/FindPlaceFromTextResponseData.html b/interfaces/FindPlaceFromTextResponseData.html index 6367733183..d6b435948b 100644 --- a/interfaces/FindPlaceFromTextResponseData.html +++ b/interfaces/FindPlaceFromTextResponseData.html @@ -1,14 +1,14 @@ -FindPlaceFromTextResponseData | Google Maps Services Node Client

    Interface FindPlaceFromTextResponseData

    interface FindPlaceFromTextResponseData {
        candidates: Partial<PlaceData>[];
        error_message: string;
        html_attributions?: string[];
        next_page_token?: string;
        status: Status;
    }

    Hierarchy (View Summary)

    Properties

    candidates +FindPlaceFromTextResponseData | Google Maps Services Node Client

    Interface FindPlaceFromTextResponseData

    interface FindPlaceFromTextResponseData {
        candidates: Partial<PlaceData>[];
        error_message: string;
        html_attributions?: string[];
        next_page_token?: string;
        status: Status;
    }

    Hierarchy (View Summary)

    Properties

    candidates error_message html_attributions? next_page_token? status -

    Properties

    candidates

    candidates: Partial<PlaceData>[]

    error_message

    error_message: string

    When the top-level status code is other than OK, this field contains more detailed information +

    Properties

    candidates

    candidates: Partial<PlaceData>[]

    error_message

    error_message: string

    When the top-level status code is other than OK, this field contains more detailed information about the reasons behind the given status code.

    -

    Optionalhtml_attributions

    html_attributions?: string[]

    may contain a set of attributions about this listing which must be displayed to the user (some listings may not have attribution).

    -

    Optionalnext_page_token

    next_page_token?: string

    contains a token that can be used to return up to 20 additional results. +

    Optionalhtml_attributions

    html_attributions?: string[]

    may contain a set of attributions about this listing which must be displayed to the user (some listings may not have attribution).

    +

    Optionalnext_page_token

    next_page_token?: string

    contains a token that can be used to return up to 20 additional results. A next_page_token will not be returned if there are no additional results to display. The maximum number of results that can be returned is 60. There is a short delay between when a next_page_token is issued, and when it will become valid.

    -

    status

    status: Status

    contains metadata on the request. See Status Codes below.

    -

    Settings

    Member Visibility

    On This Page

    Properties
    +

    status

    status: Status

    contains metadata on the request. See Status Codes below.

    +

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/interfaces/GeocodeComponents.html b/interfaces/GeocodeComponents.html index fd2222ba13..db71e9e5ff 100644 --- a/interfaces/GeocodeComponents.html +++ b/interfaces/GeocodeComponents.html @@ -1,13 +1,13 @@ -GeocodeComponents | Google Maps Services Node Client

    Interface GeocodeComponents

    interface GeocodeComponents {
        administrative_area?: string;
        country?: string;
        locality?: string;
        postal_code?: string;
        route?: string;
    }

    Properties

    administrative_area? +GeocodeComponents | Google Maps Services Node Client

    Interface GeocodeComponents

    interface GeocodeComponents {
        administrative_area?: string;
        country?: string;
        locality?: string;
        postal_code?: string;
        route?: string;
    }

    Properties

    administrative_area? country? locality? postal_code? route?

    Properties

    Optionaladministrative_area

    administrative_area?: string

    matches all the administrative_area levels.

    -

    Optionalcountry

    country?: string

    matches a country name or a two letter ISO 3166-1 country code. +

    Optionalcountry

    country?: string

    matches a country name or a two letter ISO 3166-1 country code. Note: The API follows the ISO standard for defining countries, and the filtering works best when using the corresponding ISO code of the country

    -

    Optionallocality

    locality?: string

    matches against locality and sublocality types.

    -

    Optionalpostal_code

    postal_code?: string

    matches postal_code and postal_code_prefix.

    -

    Optionalroute

    route?: string

    matches the long or short name of a route.

    -

    Settings

    Member Visibility

    On This Page

    Properties
    +

    Optionallocality

    locality?: string

    matches against locality and sublocality types.

    +

    Optionalpostal_code

    postal_code?: string

    matches postal_code and postal_code_prefix.

    +

    Optionalroute

    route?: string

    matches the long or short name of a route.

    +

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/interfaces/GeocodeRequest.html b/interfaces/GeocodeRequest.html index 3c5aec1843..d565f9f8ba 100644 --- a/interfaces/GeocodeRequest.html +++ b/interfaces/GeocodeRequest.html @@ -1,4 +1,4 @@ -GeocodeRequest | Google Maps Services Node Client

    Interface GeocodeRequest

    interface GeocodeRequest {
        params: {
            address?: string;
            bounds?: string | LatLngBounds;
            components?: string | GeocodeComponents;
            language?: string;
            place_id?: string;
            region?: string;
        } & RequestParams;
    }

    Hierarchy

    • Partial<AxiosRequestConfig>
      • GeocodeRequest

    Properties

    params +GeocodeRequest | Google Maps Services Node Client

    Interface GeocodeRequest

    interface GeocodeRequest {
        params: {
            address?: string;
            bounds?: string | LatLngBounds;
            components?: string | GeocodeComponents;
            language?: string;
            place_id?: string;
            region?: string;
        } & RequestParams;
    }

    Hierarchy

    • Partial<AxiosRequestConfig>
      • GeocodeRequest

    Properties

    params

    Properties

    params

    params: {
        address?: string;
        bounds?: string | LatLngBounds;
        components?: string | GeocodeComponents;
        language?: string;
        place_id?: string;
        region?: string;
    } & RequestParams

    Type declaration

    • Optionaladdress?: string

      The street address that you want to geocode, in the format used by the national postal service of the country concerned. Additional address elements such as business names and unit, suite or floor numbers should be avoided.

    • Optionalbounds?: string | LatLngBounds

      The bounding box of the viewport within which to bias geocode results more prominently. @@ -23,4 +23,4 @@

    • Optionalplace_id?: string

      The place_id that you want to geocode. You can retrieve this information from Places API for example.

    • Optionalregion?: string

      The region code, specified as a ccTLD ("top-level domain") two-character value. This parameter will only influence, not fully restrict, results from the geocoder.

      -

    Settings

    Member Visibility

    On This Page

    Properties
    +

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/interfaces/GeocodeResponse.html b/interfaces/GeocodeResponse.html index 162b8434f8..9aca318074 100644 --- a/interfaces/GeocodeResponse.html +++ b/interfaces/GeocodeResponse.html @@ -1,2 +1,2 @@ -GeocodeResponse | Google Maps Services Node Client

    Interface GeocodeResponse

    interface GeocodeResponse {
        data: GeocodeResponseData;
    }

    Hierarchy

    • AxiosResponse
      • GeocodeResponse

    Properties

    data -

    Properties

    data

    data: GeocodeResponseData

    Settings

    Member Visibility

    On This Page

    Properties
    +GeocodeResponse | Google Maps Services Node Client

    Interface GeocodeResponse

    interface GeocodeResponse {
        data: GeocodeResponseData;
    }

    Hierarchy

    • AxiosResponse
      • GeocodeResponse

    Properties

    data +

    Properties

    data

    data: GeocodeResponseData

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/interfaces/GeocodeResponseData.html b/interfaces/GeocodeResponseData.html index a8a713897e..4726d03a19 100644 --- a/interfaces/GeocodeResponseData.html +++ b/interfaces/GeocodeResponseData.html @@ -1,17 +1,17 @@ -GeocodeResponseData | Google Maps Services Node Client

    Interface GeocodeResponseData

    interface GeocodeResponseData {
        error_message: string;
        html_attributions?: string[];
        next_page_token?: string;
        results: GeocodeResult[];
        status: Status;
    }

    Hierarchy (View Summary)

    Properties

    error_message +GeocodeResponseData | Google Maps Services Node Client

    Interface GeocodeResponseData

    interface GeocodeResponseData {
        error_message: string;
        html_attributions?: string[];
        next_page_token?: string;
        results: GeocodeResult[];
        status: Status;
    }

    Hierarchy (View Summary)

    Properties

    error_message html_attributions? next_page_token? results status

    Properties

    error_message

    error_message: string

    When the top-level status code is other than OK, this field contains more detailed information about the reasons behind the given status code.

    -

    Optionalhtml_attributions

    html_attributions?: string[]

    may contain a set of attributions about this listing which must be displayed to the user (some listings may not have attribution).

    -

    Optionalnext_page_token

    next_page_token?: string

    contains a token that can be used to return up to 20 additional results. +

    Optionalhtml_attributions

    html_attributions?: string[]

    may contain a set of attributions about this listing which must be displayed to the user (some listings may not have attribution).

    +

    Optionalnext_page_token

    next_page_token?: string

    contains a token that can be used to return up to 20 additional results. A next_page_token will not be returned if there are no additional results to display. The maximum number of results that can be returned is 60. There is a short delay between when a next_page_token is issued, and when it will become valid.

    -

    results

    results: GeocodeResult[]

    contains an array of geocoded address information and geometry information.

    +

    results

    results: GeocodeResult[]

    contains an array of geocoded address information and geometry information.

    Generally, only one entry in the "results" array is returned for address lookups,though the geocoder may return several results when address queries are ambiguous.

    -

    status

    status: Status

    contains metadata on the request. See Status Codes below.

    -

    Settings

    Member Visibility

    On This Page

    Properties
    +

    status

    status: Status

    contains metadata on the request. See Status Codes below.

    +

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/interfaces/GeocodeResult.html b/interfaces/GeocodeResult.html index bf035f54a9..8c4a7c4a64 100644 --- a/interfaces/GeocodeResult.html +++ b/interfaces/GeocodeResult.html @@ -1,4 +1,4 @@ -GeocodeResult | Google Maps Services Node Client

    Interface GeocodeResult

    interface GeocodeResult {
        address_components: AddressComponent[];
        formatted_address: string;
        geometry: AddressGeometry;
        partial_match: boolean;
        place_id: string;
        plus_code: PlusCode;
        postcode_localities: string[];
        types: AddressType[];
    }

    Properties

    address_components +GeocodeResult | Google Maps Services Node Client

    Interface GeocodeResult

    interface GeocodeResult {
        address_components: AddressComponent[];
        formatted_address: string;
        geometry: AddressGeometry;
        partial_match: boolean;
        place_id: string;
        plus_code: PlusCode;
        postcode_localities: string[];
        types: AddressType[];
    }

    Properties

    address_components formatted_address geometry partial_match @@ -18,7 +18,7 @@ over time for the same address. A component can change position in the array. The type of the component can change. A particular component may be missing in a later response. -

    formatted_address

    formatted_address: string

    is a string containing the human-readable address of this location.

    +

    formatted_address

    formatted_address: string

    is a string containing the human-readable address of this location.

    Often this address is equivalent to the postal address. Note that some countries, such as the United Kingdom, do not allow distribution of true postal addresses due to licensing restrictions.

    The formatted address is logically composed of one or more address components. @@ -26,8 +26,8 @@ "8th Avenue" (the route), "New York" (the city) and "NY" (the US state).

    Do not parse the formatted address programmatically. Instead you should use the individual address components, which the API response includes in addition to the formatted address field.

    -

    geometry

    geometry: AddressGeometry

    address geometry.

    -

    partial_match

    partial_match: boolean

    indicates that the geocoder did not return an exact match for the original request, +

    geometry

    geometry: AddressGeometry

    address geometry.

    +

    partial_match

    partial_match: boolean

    indicates that the geocoder did not return an exact match for the original request, though it was able to match part of the requested address. You may wish to examine the original request for misspellings and/or an incomplete address.

    Partial matches most often occur for street addresses that do not exist within the locality you pass in the request. @@ -35,8 +35,8 @@ For example, "21 Henr St, Bristol, UK" will return a partial match for both Henry Street and Henrietta Street. Note that if a request includes a misspelled address component, the geocoding service may suggest an alternative address. Suggestions triggered in this way will also be marked as a partial match.

    -

    place_id

    place_id: string

    is a unique identifier that can be used with other Google APIs.

    -

    plus_code

    plus_code: PlusCode

    is an encoded location reference, derived from latitude and longitude coordinates, +

    place_id

    place_id: string

    is a unique identifier that can be used with other Google APIs.

    +

    plus_code

    plus_code: PlusCode

    is an encoded location reference, derived from latitude and longitude coordinates, that represents an area: 1/8000th of a degree by 1/8000th of a degree (about 14m x 14m at the equator) or smaller. Plus codes can be used as a replacement for street addresses in places where they do not exist (where buildings are not numbered or streets are not named).

    @@ -51,10 +51,10 @@
  • Open Location Code
  • plus codes
    • -

    postcode_localities

    postcode_localities: string[]

    is an array denoting all the localities contained in a postal code. +

    postcode_localities

    postcode_localities: string[]

    is an array denoting all the localities contained in a postal code. This is only present when the result is a postal code that contains multiple localities.

    -

    types

    types: AddressType[]

    array indicates the type of the returned result. +

    types

    types: AddressType[]

    array indicates the type of the returned result. This array contains a set of zero or more tags identifying the type of feature returned in the result. For example, a geocode of "Chicago" returns "locality" which indicates that "Chicago" is a city, and also returns "political" which indicates it is a political entity.

    -

    Settings

    Member Visibility

    On This Page

    Properties
    +

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/interfaces/GeocodedWaypoint.html b/interfaces/GeocodedWaypoint.html index 17b2fd2370..eac9326bf1 100644 --- a/interfaces/GeocodedWaypoint.html +++ b/interfaces/GeocodedWaypoint.html @@ -1,18 +1,18 @@ GeocodedWaypoint | Google Maps Services Node Client

    Interface GeocodedWaypoint

    Elements in the geocoded_waypoints array correspond, by their zero-based position, to the origin, the waypoints in the order they are specified, and the destination.

    -
    interface GeocodedWaypoint {
        geocoder_status: GeocodedWaypointStatus;
        partial_match: boolean;
        place_id: string;
        types: AddressType[];
    }

    Properties

    geocoder_status +
    interface GeocodedWaypoint {
        geocoder_status: GeocodedWaypointStatus;
        partial_match: boolean;
        place_id: string;
        types: AddressType[];
    }

    Properties

    geocoder_status partial_match place_id types

    Properties

    geocoder_status

    geocoder_status: GeocodedWaypointStatus

    indicates the status code resulting from the geocoding operation.

    -

    partial_match

    partial_match: boolean

    indicates that the geocoder did not return an exact match for the original request, though it was able to match part of the +

    partial_match

    partial_match: boolean

    indicates that the geocoder did not return an exact match for the original request, though it was able to match part of the requested address. You may wish to examine the original request for misspellings and/or an incomplete address.

    Partial matches most often occur for street addresses that do not exist within the locality you pass in the request. Partial matches may also be returned when a request matches two or more locations in the same locality. For example, "21 Henr St, Bristol, UK" will return a partial match for both Henry Street and Henrietta Street. Note that if a request includes a misspelled address component, the geocoding service may suggest an alternative address. Suggestions triggered in this way will also be marked as a partial match.

    -

    place_id

    place_id: string

    unique identifier that can be used with other Google APIs.

    -

    types

    types: AddressType[]

    indicates the address type of the geocoding result used for calculating directions.

    +

    place_id

    place_id: string

    unique identifier that can be used with other Google APIs.

    +

    types

    types: AddressType[]

    indicates the address type of the geocoding result used for calculating directions.

    An empty list of types indicates there are no known types for the particular address component, for example, Lieu-dit in France.

    -

    Settings

    Member Visibility

    On This Page

    Properties
    +

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/interfaces/GeolocateRequest.html b/interfaces/GeolocateRequest.html index 39655d557b..284e31cd46 100644 --- a/interfaces/GeolocateRequest.html +++ b/interfaces/GeolocateRequest.html @@ -1,4 +1,4 @@ -GeolocateRequest | Google Maps Services Node Client

    Interface GeolocateRequest

    interface GeolocateRequest {
        data: {
            carrier?: string;
            cellTowers?: CellTower[];
            considerIp?: boolean;
            homeMobileCountryCode?: number;
            homeMobileNetworkCode?: number;
            radioType?: RadioType;
            wifiAccessPoints?: WifiAccessPoint[];
        };
        params: RequestParams;
    }

    Hierarchy

    • Partial<AxiosRequestConfig>
      • GeolocateRequest

    Properties

    data +GeolocateRequest | Google Maps Services Node Client

    Interface GeolocateRequest

    interface GeolocateRequest {
        data: {
            carrier?: string;
            cellTowers?: CellTower[];
            considerIp?: boolean;
            homeMobileCountryCode?: number;
            homeMobileNetworkCode?: number;
            radioType?: RadioType;
            wifiAccessPoints?: WifiAccessPoint[];
        };
        params: RequestParams;
    }

    Hierarchy

    • Partial<AxiosRequestConfig>
      • GeolocateRequest

    Properties

    data params

    Properties

    data

    data: {
        carrier?: string;
        cellTowers?: CellTower[];
        considerIp?: boolean;
        homeMobileCountryCode?: number;
        homeMobileNetworkCode?: number;
        radioType?: RadioType;
        wifiAccessPoints?: WifiAccessPoint[];
    }

    Type declaration

    • Optionalcarrier?: string

      The carrier name.

    • OptionalcellTowers?: CellTower[]

      An array of cell tower objects.

      @@ -8,4 +8,4 @@
    • OptionalhomeMobileNetworkCode?: number

      The mobile network code (MNC) for the device's home network.

    • OptionalradioType?: RadioType

      The mobile radio type. While this field is optional, it should be included if a value is available, for more accurate results.

    • OptionalwifiAccessPoints?: WifiAccessPoint[]

      An array of WiFi access point objects.

      -

    params

    params: RequestParams

    Settings

    Member Visibility

    On This Page

    Properties
    +

    params

    params: RequestParams

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/interfaces/GeolocateResponseData.html b/interfaces/GeolocateResponseData.html index cd8a31c97f..2fc6d0723f 100644 --- a/interfaces/GeolocateResponseData.html +++ b/interfaces/GeolocateResponseData.html @@ -1,17 +1,17 @@ -GeolocateResponseData | Google Maps Services Node Client

    Interface GeolocateResponseData

    interface GeolocateResponseData {
        accuracy: number;
        error_message: string;
        html_attributions?: string[];
        location: LatLngLiteral;
        next_page_token?: string;
        status: Status;
    }

    Hierarchy (View Summary)

    Properties

    accuracy +GeolocateResponseData | Google Maps Services Node Client

    Interface GeolocateResponseData

    interface GeolocateResponseData {
        accuracy: number;
        error_message: string;
        html_attributions?: string[];
        location: LatLngLiteral;
        next_page_token?: string;
        status: Status;
    }

    Hierarchy (View Summary)

    Properties

    accuracy error_message html_attributions? location next_page_token? status

    Properties

    accuracy

    accuracy: number

    The accuracy of the estimated location, in meters. This represents the radius of a circle around the given location.

    -

    error_message

    error_message: string

    When the top-level status code is other than OK, this field contains more detailed information +

    error_message

    error_message: string

    When the top-level status code is other than OK, this field contains more detailed information about the reasons behind the given status code.

    -

    Optionalhtml_attributions

    html_attributions?: string[]

    may contain a set of attributions about this listing which must be displayed to the user (some listings may not have attribution).

    -

    location

    location: LatLngLiteral

    The user's estimated latitude and longitude, in degrees. Contains one lat and one lng subfield.

    -

    Optionalnext_page_token

    next_page_token?: string

    contains a token that can be used to return up to 20 additional results. +

    Optionalhtml_attributions

    html_attributions?: string[]

    may contain a set of attributions about this listing which must be displayed to the user (some listings may not have attribution).

    +

    location

    location: LatLngLiteral

    The user's estimated latitude and longitude, in degrees. Contains one lat and one lng subfield.

    +

    Optionalnext_page_token

    next_page_token?: string

    contains a token that can be used to return up to 20 additional results. A next_page_token will not be returned if there are no additional results to display. The maximum number of results that can be returned is 60. There is a short delay between when a next_page_token is issued, and when it will become valid.

    -

    status

    status: Status

    contains metadata on the request. See Status Codes below.

    -

    Settings

    Member Visibility

    On This Page

    Properties
    +

    status

    status: Status

    contains metadata on the request. See Status Codes below.

    +

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/interfaces/GeolocateResponseError.html b/interfaces/GeolocateResponseError.html index 8e0e277b68..eaee33a7c9 100644 --- a/interfaces/GeolocateResponseError.html +++ b/interfaces/GeolocateResponseError.html @@ -1,4 +1,4 @@ GeolocateResponseError | Google Maps Services Node Client

    Interface GeolocateResponseError

    In the case of an error, a standard format error response body will be returned and the HTTP status code will be set to an error status.

    -
    interface GeolocateResponseError {
        data: {
            error: {
                code: number;
                errors: { domain: string; message: string; reason: GeolocateErrorReason }[];
                message: string;
            };
        };
    }

    Hierarchy

    • AxiosResponse
      • GeolocateResponseError

    Properties

    data -

    Properties

    data

    data: {
        error: {
            code: number;
            errors: { domain: string; message: string; reason: GeolocateErrorReason }[];
            message: string;
        };
    }

    Settings

    Member Visibility

    On This Page

    Properties
    +
    interface GeolocateResponseError {
        data: {
            error: {
                code: number;
                errors: { domain: string; message: string; reason: GeolocateErrorReason }[];
                message: string;
            };
        };
    }

    Hierarchy

    Properties

    data +

    Properties

    data

    data: {
        error: {
            code: number;
            errors: { domain: string; message: string; reason: GeolocateErrorReason }[];
            message: string;
        };
    }

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/interfaces/GeolocateResponseSuccess.html b/interfaces/GeolocateResponseSuccess.html index 5503f83275..f2191bd3af 100644 --- a/interfaces/GeolocateResponseSuccess.html +++ b/interfaces/GeolocateResponseSuccess.html @@ -1,2 +1,2 @@ -GeolocateResponseSuccess | Google Maps Services Node Client

    Interface GeolocateResponseSuccess

    interface GeolocateResponseSuccess {
        data: GeolocateResponseData;
    }

    Hierarchy

    • AxiosResponse
      • GeolocateResponseSuccess

    Properties

    data -

    Properties

    data

    data: GeolocateResponseData

    Settings

    Member Visibility

    On This Page

    Properties
    +GeolocateResponseSuccess | Google Maps Services Node Client

    Interface GeolocateResponseSuccess

    interface GeolocateResponseSuccess {
        data: GeolocateResponseData;
    }

    Hierarchy

    • AxiosResponse
      • GeolocateResponseSuccess

    Properties

    data +

    Properties

    data

    data: GeolocateResponseData

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/interfaces/LatLngBounds.html b/interfaces/LatLngBounds.html index 691b0051d5..68353f8717 100644 --- a/interfaces/LatLngBounds.html +++ b/interfaces/LatLngBounds.html @@ -1,4 +1,4 @@ LatLngBounds | Google Maps Services Node Client

    Interface LatLngBounds

    The bounds parameter defines the latitude/longitude coordinates of the southwest and northeast corners of this bounding box.

    -
    interface LatLngBounds {
        northeast: LatLngLiteral;
        southwest: LatLngLiteral;
    }

    Properties

    northeast +
    interface LatLngBounds {
        northeast: LatLngLiteral;
        southwest: LatLngLiteral;
    }

    Properties

    northeast southwest -

    Properties

    northeast

    northeast: LatLngLiteral

    southwest

    southwest: LatLngLiteral

    Settings

    Member Visibility

    On This Page

    Properties
    +

    Properties

    northeast

    northeast: LatLngLiteral

    southwest

    southwest: LatLngLiteral

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/interfaces/LatLngLiteral.html b/interfaces/LatLngLiteral.html index 4871fb0b5d..a65a2c6307 100644 --- a/interfaces/LatLngLiteral.html +++ b/interfaces/LatLngLiteral.html @@ -1,3 +1,3 @@ -LatLngLiteral | Google Maps Services Node Client

    Interface LatLngLiteral

    interface LatLngLiteral {
        lat: number;
        lng: number;
    }

    Properties

    lat +LatLngLiteral | Google Maps Services Node Client

    Interface LatLngLiteral

    interface LatLngLiteral {
        lat: number;
        lng: number;
    }

    Properties

    lat lng -

    Properties

    lat

    lat: number

    lng

    lng: number

    Settings

    Member Visibility

    On This Page

    Properties
    +

    Properties

    lat

    lat: number

    lng

    lng: number

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/interfaces/LatLngLiteralVerbose.html b/interfaces/LatLngLiteralVerbose.html index 9cad95743f..befe9bfedc 100644 --- a/interfaces/LatLngLiteralVerbose.html +++ b/interfaces/LatLngLiteralVerbose.html @@ -1,3 +1,3 @@ -LatLngLiteralVerbose | Google Maps Services Node Client

    Interface LatLngLiteralVerbose

    interface LatLngLiteralVerbose {
        latitude: number;
        longitude: number;
    }

    Properties

    latitude +LatLngLiteralVerbose | Google Maps Services Node Client

    Interface LatLngLiteralVerbose

    interface LatLngLiteralVerbose {
        latitude: number;
        longitude: number;
    }

    Properties

    latitude longitude -

    Properties

    latitude

    latitude: number

    longitude

    longitude: number

    Settings

    Member Visibility

    On This Page

    Properties
    +

    Properties

    latitude

    latitude: number

    longitude

    longitude: number

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/interfaces/NearestRoadsRequest.html b/interfaces/NearestRoadsRequest.html index 19119d36af..11d047202f 100644 --- a/interfaces/NearestRoadsRequest.html +++ b/interfaces/NearestRoadsRequest.html @@ -1,5 +1,5 @@ -NearestRoadsRequest | Google Maps Services Node Client

    Interface NearestRoadsRequest

    interface NearestRoadsRequest {
        params: { points: LatLng[] } & RequestParams;
    }

    Hierarchy

    • Partial<AxiosRequestConfig>
      • NearestRoadsRequest

    Properties

    params +NearestRoadsRequest | Google Maps Services Node Client

    Interface NearestRoadsRequest

    interface NearestRoadsRequest {
        params: { points: LatLng[] } & RequestParams;
    }

    Hierarchy

    • Partial<AxiosRequestConfig>
      • NearestRoadsRequest

    Properties

    params

    Properties

    params

    params: { points: LatLng[] } & RequestParams

    Type declaration

    • points: LatLng[]

      A list of latitude/longitude pairs. Latitude and longitude values should be separated by commas. Coordinates should be separated by the pipe character: "|". For example: points=60.170880,24.942795|60.170879,24.942796|60.170877,24.942796.

      -

    Settings

    Member Visibility

    On This Page

    Properties
    +

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/interfaces/NearestRoadsResponse.html b/interfaces/NearestRoadsResponse.html index 08692e87fe..9301502407 100644 --- a/interfaces/NearestRoadsResponse.html +++ b/interfaces/NearestRoadsResponse.html @@ -1,3 +1,3 @@ -NearestRoadsResponse | Google Maps Services Node Client

    Interface NearestRoadsResponse

    interface NearestRoadsResponse {
        data: { snappedPoints: SnappedPoint[] };
    }

    Hierarchy

    • AxiosResponse
      • NearestRoadsResponse

    Properties

    data +NearestRoadsResponse | Google Maps Services Node Client

    Interface NearestRoadsResponse

    interface NearestRoadsResponse {
        data: { snappedPoints: SnappedPoint[] };
    }

    Hierarchy

    • AxiosResponse
      • NearestRoadsResponse

    Properties

    data

    Properties

    data

    data: { snappedPoints: SnappedPoint[] }

    Type declaration

    Settings

    Member Visibility

    On This Page

    Properties
    +

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/interfaces/OpeningHours.html b/interfaces/OpeningHours.html index 21953deb63..ae8badfac6 100644 --- a/interfaces/OpeningHours.html +++ b/interfaces/OpeningHours.html @@ -1,10 +1,10 @@ -OpeningHours | Google Maps Services Node Client

    Interface OpeningHours

    interface OpeningHours {
        open_now: boolean;
        periods: OpeningPeriod[];
        weekday_text: string[];
    }

    Properties

    open_now +OpeningHours | Google Maps Services Node Client

    Interface OpeningHours

    interface OpeningHours {
        open_now: boolean;
        periods: OpeningPeriod[];
        weekday_text: string[];
    }

    Properties

    open_now periods weekday_text

    Properties

    open_now

    open_now: boolean

    is a boolean value indicating if the place is open at the current time.

    -

    periods

    periods: OpeningPeriod[]

    is an array of opening periods covering seven days, starting from Sunday, in chronological order.

    -

    weekday_text

    weekday_text: string[]

    is an array of seven strings representing the formatted opening hours for each day of the week. +

    periods

    periods: OpeningPeriod[]

    is an array of opening periods covering seven days, starting from Sunday, in chronological order.

    +

    weekday_text

    weekday_text: string[]

    is an array of seven strings representing the formatted opening hours for each day of the week. If a language parameter was specified in the Place Details request, the Places Service will format and localize the opening hours appropriately for that language. The ordering of the elements in this array depends on the language parameter. Some languages start the week on Monday while others start on Sunday.

    -

    Settings

    Member Visibility

    On This Page

    Properties
    +

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/interfaces/OpeningHoursTime.html b/interfaces/OpeningHoursTime.html index 9210314d61..24bd83d4e7 100644 --- a/interfaces/OpeningHoursTime.html +++ b/interfaces/OpeningHoursTime.html @@ -1,6 +1,6 @@ -OpeningHoursTime | Google Maps Services Node Client

    Interface OpeningHoursTime

    interface OpeningHoursTime {
        day: number;
        time?: string;
    }

    Properties

    day +OpeningHoursTime | Google Maps Services Node Client

    Interface OpeningHoursTime

    interface OpeningHoursTime {
        day: number;
        time?: string;
    }

    Properties

    day time?

    Properties

    day

    day: number

    a number from 0–6, corresponding to the days of the week, starting on Sunday. For example, 2 means Tuesday.

    -

    Optionaltime

    time?: string

    may contain a time of day in 24-hour hhmm format. Values are in the range 0000–2359. The time +

    Optionaltime

    time?: string

    may contain a time of day in 24-hour hhmm format. Values are in the range 0000–2359. The time will be reported in the place's time zone.

    -

    Settings

    Member Visibility

    On This Page

    Properties
    +

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/interfaces/OpeningPeriod.html b/interfaces/OpeningPeriod.html index 86d6bf18e6..d796a7635f 100644 --- a/interfaces/OpeningPeriod.html +++ b/interfaces/OpeningPeriod.html @@ -1,8 +1,8 @@ -OpeningPeriod | Google Maps Services Node Client

    Interface OpeningPeriod

    interface OpeningPeriod {
        close?: OpeningHoursTime;
        open: OpeningHoursTime;
    }

    Properties

    close? +OpeningPeriod | Google Maps Services Node Client

    Interface OpeningPeriod

    interface OpeningPeriod {
        close?: OpeningHoursTime;
        open: OpeningHoursTime;
    }

    Properties

    close? open

    Properties

    Optionalclose

    close?: OpeningHoursTime

    may contain a pair of day and time objects describing when the place closes. Note: If a place is always open, the close section will be missing from the response. Clients can rely on always-open being represented as an open period containing day with value 0 and time with value 0000, and no close.

    -

    open

    open: OpeningHoursTime

    contains a pair of day and time objects describing when the place opens.

    -

    Settings

    Member Visibility

    On This Page

    Properties
    +

    open

    open: OpeningHoursTime

    contains a pair of day and time objects describing when the place opens.

    +

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/interfaces/PlaceAutocompleteRequest.html b/interfaces/PlaceAutocompleteRequest.html index 993737be8b..7d1c4b4039 100644 --- a/interfaces/PlaceAutocompleteRequest.html +++ b/interfaces/PlaceAutocompleteRequest.html @@ -1,4 +1,4 @@ -PlaceAutocompleteRequest | Google Maps Services Node Client

    Interface PlaceAutocompleteRequest

    interface PlaceAutocompleteRequest {
        params: {
            components?: string[];
            input: string;
            language?: string;
            location?: LatLng;
            offset?: number;
            origin?: LatLng;
            radius?: number;
            sessiontoken?: string;
            strictbounds?: boolean;
            types?: PlaceAutocompleteType;
        } & RequestParams;
    }

    Hierarchy

    • Partial<AxiosRequestConfig>
      • PlaceAutocompleteRequest

    Properties

    params +PlaceAutocompleteRequest | Google Maps Services Node Client

    Interface PlaceAutocompleteRequest

    interface PlaceAutocompleteRequest {
        params: {
            components?: string[];
            input: string;
            language?: string;
            location?: LatLng;
            offset?: number;
            origin?: LatLng;
            radius?: number;
            sessiontoken?: string;
            strictbounds?: boolean;
            types?: PlaceAutocompleteType;
        } & RequestParams;
    }

    Hierarchy

    • Partial<AxiosRequestConfig>
      • PlaceAutocompleteRequest

    Properties

    params

    Properties

    params

    params: {
        components?: string[];
        input: string;
        language?: string;
        location?: LatLng;
        offset?: number;
        origin?: LatLng;
        radius?: number;
        sessiontoken?: string;
        strictbounds?: boolean;
        types?: PlaceAutocompleteType;
    } & RequestParams

    Type declaration

    • Optionalcomponents?: string[]

      A grouping of places to which you would like to restrict your results. Currently, you can use components to filter by up to 5 countries. Countries must be passed as a two character, ISO 3166-1 Alpha-2 compatible country code. @@ -32,4 +32,4 @@ This is a restriction, rather than a bias, meaning that results outside this region will not be returned even if they match the user input.

    • Optionaltypes?: PlaceAutocompleteType

      The types of place results to return.

      -

    Settings

    Member Visibility

    On This Page

    Properties
    +

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/interfaces/PlaceAutocompleteResponse.html b/interfaces/PlaceAutocompleteResponse.html index 104e5631b2..21d5732599 100644 --- a/interfaces/PlaceAutocompleteResponse.html +++ b/interfaces/PlaceAutocompleteResponse.html @@ -1,2 +1,2 @@ -PlaceAutocompleteResponse | Google Maps Services Node Client

    Interface PlaceAutocompleteResponse

    interface PlaceAutocompleteResponse {
        data: PlaceAutocompleteResponseData;
    }

    Hierarchy

    • AxiosResponse
      • PlaceAutocompleteResponse

    Properties

    data -

    Properties

    data

    data: PlaceAutocompleteResponseData

    Settings

    Member Visibility

    On This Page

    Properties
    +PlaceAutocompleteResponse | Google Maps Services Node Client

    Interface PlaceAutocompleteResponse

    interface PlaceAutocompleteResponse {
        data: PlaceAutocompleteResponseData;
    }

    Hierarchy

    • AxiosResponse
      • PlaceAutocompleteResponse

    Properties

    data +

    Properties

    data

    data: PlaceAutocompleteResponseData

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/interfaces/PlaceAutocompleteResponseData.html b/interfaces/PlaceAutocompleteResponseData.html index b8301bd2b7..e3b6eceab1 100644 --- a/interfaces/PlaceAutocompleteResponseData.html +++ b/interfaces/PlaceAutocompleteResponseData.html @@ -1,17 +1,17 @@ -PlaceAutocompleteResponseData | Google Maps Services Node Client

    Interface PlaceAutocompleteResponseData

    interface PlaceAutocompleteResponseData {
        error_message: string;
        html_attributions?: string[];
        next_page_token?: string;
        predictions: PlaceAutocompleteResult[];
        status: Status;
    }

    Hierarchy (View Summary)

    Properties

    error_message +PlaceAutocompleteResponseData | Google Maps Services Node Client

    Interface PlaceAutocompleteResponseData

    interface PlaceAutocompleteResponseData {
        error_message: string;
        html_attributions?: string[];
        next_page_token?: string;
        predictions: PlaceAutocompleteResult[];
        status: Status;
    }

    Hierarchy (View Summary)

    Properties

    error_message html_attributions? next_page_token? predictions status

    Properties

    error_message

    error_message: string

    When the top-level status code is other than OK, this field contains more detailed information about the reasons behind the given status code.

    -

    Optionalhtml_attributions

    html_attributions?: string[]

    may contain a set of attributions about this listing which must be displayed to the user (some listings may not have attribution).

    -

    Optionalnext_page_token

    next_page_token?: string

    contains a token that can be used to return up to 20 additional results. +

    Optionalhtml_attributions

    html_attributions?: string[]

    may contain a set of attributions about this listing which must be displayed to the user (some listings may not have attribution).

    +

    Optionalnext_page_token

    next_page_token?: string

    contains a token that can be used to return up to 20 additional results. A next_page_token will not be returned if there are no additional results to display. The maximum number of results that can be returned is 60. There is a short delay between when a next_page_token is issued, and when it will become valid.

    -

    predictions

    predictions: PlaceAutocompleteResult[]

    contains an array of places, with information about the place. +

    predictions

    predictions: PlaceAutocompleteResult[]

    contains an array of places, with information about the place. See Place Autocomplete Results for information about these results. The Places API returns up to 5 results.

    -

    status

    status: Status

    contains metadata on the request. See Status Codes below.

    -

    Settings

    Member Visibility

    On This Page

    Properties
    +

    status

    status: Status

    contains metadata on the request. See Status Codes below.

    +

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/interfaces/PlaceAutocompleteResult.html b/interfaces/PlaceAutocompleteResult.html index 991b7c692e..ef37f07a82 100644 --- a/interfaces/PlaceAutocompleteResult.html +++ b/interfaces/PlaceAutocompleteResult.html @@ -1,4 +1,4 @@ -PlaceAutocompleteResult | Google Maps Services Node Client

    Interface PlaceAutocompleteResult

    interface PlaceAutocompleteResult {
        description: string;
        distance_meters?: number;
        matched_substrings: PredictionSubstring[];
        place_id: string;
        structured_formatting: StructuredFormatting;
        terms: PredictionTerm[];
        types: AddressType[];
    }

    Properties

    description +PlaceAutocompleteResult | Google Maps Services Node Client

    Interface PlaceAutocompleteResult

    interface PlaceAutocompleteResult {
        description: string;
        distance_meters?: number;
        matched_substrings: PredictionSubstring[];
        place_id: string;
        structured_formatting: StructuredFormatting;
        terms: PredictionTerm[];
        types: AddressType[];
    }

    Properties

    description distance_meters? matched_substrings place_id @@ -7,16 +7,16 @@ types

    Properties

    description

    description: string

    contains the human-readable name for the returned result. For establishment results, this is usually the business name.

    -

    Optionaldistance_meters

    distance_meters?: number

    contains an integer indicating the straight-line distance between the predicted place, and the specified origin point, in meters. +

    Optionaldistance_meters

    distance_meters?: number

    contains an integer indicating the straight-line distance between the predicted place, and the specified origin point, in meters. This field is only returned when the origin point is specified in the request. This field is not returned in predictions of type route.

    -

    matched_substrings

    matched_substrings: PredictionSubstring[]

    contains an array with offset value and length. These describe the location of +

    matched_substrings

    matched_substrings: PredictionSubstring[]

    contains an array with offset value and length. These describe the location of the entered term in the prediction result text, so that the term can be highlighted if desired.

    -

    place_id

    place_id: string

    is a textual identifier that uniquely identifies a place. +

    place_id

    place_id: string

    is a textual identifier that uniquely identifies a place. To retrieve information about the place, pass this identifier in the placeId field of a Places API request.

    -

    structured_formatting

    structured_formatting: StructuredFormatting

    contains details on the prediction.

    -

    terms

    terms: PredictionTerm[]

    contains an array of terms identifying each section of the returned description +

    structured_formatting

    structured_formatting: StructuredFormatting

    contains details on the prediction.

    +

    terms

    terms: PredictionTerm[]

    contains an array of terms identifying each section of the returned description (a section of the description is generally terminated with a comma).

    -

    types

    types: AddressType[]

    contains an array of types that apply to this place. +

    types

    types: AddressType[]

    contains an array of types that apply to this place. For example: [ "political", "locality" ] or [ "establishment", "geocode" ].

    -

    Settings

    Member Visibility

    On This Page

    Properties
    +

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/interfaces/PlaceData.html b/interfaces/PlaceData.html index 72f9990ea8..d79193ea2e 100644 --- a/interfaces/PlaceData.html +++ b/interfaces/PlaceData.html @@ -1,4 +1,4 @@ -PlaceData | Google Maps Services Node Client

    Interface PlaceData

    interface PlaceData {
        address_components: AddressComponent[];
        adr_address: string;
        business_status: string;
        editorial_summary: PlaceEditorialSummary;
        formatted_address: string;
        formatted_phone_number: string;
        geometry: AddressGeometry;
        icon: string;
        icon_background_color: string;
        icon_mask_base_uri: string;
        international_phone_number: string;
        name: string;
        opening_hours: OpeningHours;
        permanently_closed: boolean;
        photos: PlacePhoto[];
        place_id: string;
        plus_code: PlusCode;
        price_level: number;
        rating: number;
        reviews: PlaceReview[];
        types: AddressType[];
        url: string;
        user_ratings_total: number;
        utc_offset: number;
        vicinity: string;
        website: string;
    }

    Properties

    address_components +PlaceData | Google Maps Services Node Client

    Interface PlaceData

    interface PlaceData {
        address_components: AddressComponent[];
        adr_address: string;
        business_status: string;
        editorial_summary: PlaceEditorialSummary;
        formatted_address: string;
        formatted_phone_number: string;
        geometry: AddressGeometry;
        icon: string;
        icon_background_color: string;
        icon_mask_base_uri: string;
        international_phone_number: string;
        name: string;
        opening_hours: OpeningHours;
        permanently_closed: boolean;
        photos: PlacePhoto[];
        place_id: string;
        plus_code: PlusCode;
        price_level: number;
        rating: number;
        reviews: PlaceReview[];
        types: AddressType[];
        url: string;
        user_ratings_total: number;
        utc_offset: number;
        vicinity: string;
        website: string;
    }

    Properties

    address_components adr_address business_status editorial_summary @@ -37,11 +37,11 @@ and can change over time for the same address. A component can change position in the array. The type of the component can change. A particular component may be missing in a later response. -

    adr_address

    adr_address: string

    is a representation of the place's address in the adr microformat.

    -

    business_status

    business_status: string

    is a string indicating the operational status of the place, if it is a business.

    -

    editorial_summary

    editorial_summary: PlaceEditorialSummary

    Contains a summary of the place. A summary is comprised of a textual overview, and also includes the language code +

    adr_address

    adr_address: string

    is a representation of the place's address in the adr microformat.

    +

    business_status

    business_status: string

    is a string indicating the operational status of the place, if it is a business.

    +

    editorial_summary

    editorial_summary: PlaceEditorialSummary

    Contains a summary of the place. A summary is comprised of a textual overview, and also includes the language code for these if applicable. Summary text must be presented as-is and can not be modified or altered.

    -

    formatted_address

    formatted_address: string

    is a string containing the human-readable address of this place.

    +

    formatted_address

    formatted_address: string

    is a string containing the human-readable address of this place.

    Often this address is equivalent to the postal address. Note that some countries, such as the United Kingdom, do not allow distribution of true postal addresses due to licensing restrictions.

    The formatted address is logically composed of one or more address components. @@ -49,32 +49,32 @@ (the street number), "8th Avenue" (the route), "New York" (the city) and "NY" (the US state).

    Do not parse the formatted address programmatically. Instead you should use the individual address components, which the API response includes in addition to the formatted address field.

    -

    formatted_phone_number

    formatted_phone_number: string

    contains the place's phone number in its local format. +

    formatted_phone_number

    formatted_phone_number: string

    contains the place's phone number in its local format. For example, the formatted_phone_number for Google's Sydney, Australia office is (02) 9374 4000.

    -

    geometry

    geometry: AddressGeometry

    contains the following information:

    +

    geometry

    geometry: AddressGeometry

    contains the following information:

    • location: contains the geocoded latitude,longitude value for this place.
    • viewport: contains the preferred viewport when displaying this place on a map as a LatLngBounds if it is known.
    -

    icon

    icon: string

    contains the URL of a suggested icon which may be displayed to the user when indicating this result on a map.

    -

    icon_background_color

    icon_background_color: string

    The default HEX color code for the place's category.

    +

    icon

    icon: string

    contains the URL of a suggested icon which may be displayed to the user when indicating this result on a map.

    +

    icon_background_color

    icon_background_color: string

    The default HEX color code for the place's category.

    See

    https://developers.google.com/maps/documentation/places/web-service/icons

    -

    icon_mask_base_uri

    icon_mask_base_uri: string

    The base URL for a non-colored icon, minus the file type extension (append .svg or .png).

    +

    icon_mask_base_uri

    icon_mask_base_uri: string

    The base URL for a non-colored icon, minus the file type extension (append .svg or .png).

    See

    https://developers.google.com/maps/documentation/places/web-service/icons

    -

    international_phone_number

    international_phone_number: string

    contains the place's phone number in international format. +

    international_phone_number

    international_phone_number: string

    contains the place's phone number in international format. International format includes the country code, and is prefixed with the plus (+) sign. For example, the international_phone_number for Google's Sydney, Australia office is +61 2 9374 4000.

    -

    name

    name: string

    contains the human-readable name for the returned result. +

    name

    name: string

    contains the human-readable name for the returned result. For establishment results, this is usually the canonicalized business name.

    -

    opening_hours

    opening_hours: OpeningHours

    place opening hours.

    -

    permanently_closed

    permanently_closed: boolean

    is a boolean flag indicating whether the place has permanently shut down (value true). +

    opening_hours

    opening_hours: OpeningHours

    place opening hours.

    +

    permanently_closed

    permanently_closed: boolean

    is a boolean flag indicating whether the place has permanently shut down (value true). If the place is not permanently closed, the flag is absent from the response. This field is deprecated in favor of business_status.

    -

    photos

    photos: PlacePhoto[]

    an array of photo objects, each containing a reference to an image. +

    photos

    photos: PlacePhoto[]

    an array of photo objects, each containing a reference to an image. A Place Details request may return up to ten photos. More information about place photos and how you can use the images in your application can be found in the Place Photos documentation.

    -

    place_id

    place_id: string

    A textual identifier that uniquely identifies a place. +

    place_id

    place_id: string

    A textual identifier that uniquely identifies a place. To retrieve information about the place, pass this identifier in the placeId field of a Places API request.

    -

    plus_code

    plus_code: PlusCode

    is an encoded location reference, derived from latitude and longitude coordinates, that represents an area: +

    plus_code

    plus_code: PlusCode

    is an encoded location reference, derived from latitude and longitude coordinates, that represents an area: 1/8000th of a degree by 1/8000th of a degree (about 14m x 14m at the equator) or smaller. Plus codes can be used as a replacement for street addresses in places where they do not exist (where buildings are not numbered or streets are not named).

    @@ -89,7 +89,7 @@
  • Open Location Code
  • plus codes
    • -

    price_level

    price_level: number

    The price level of the place, on a scale of 0 to 4. +

    price_level

    price_level: number

    The price level of the place, on a scale of 0 to 4. The exact amount indicated by a specific value will vary from region to region.

    Price levels are interpreted as follows:

      @@ -99,20 +99,20 @@
    • 3: Expensive
    • 4: Very Expensive
    -

    rating

    rating: number

    contains the place's rating, from 1.0 to 5.0, based on aggregated user reviews.

    -

    reviews

    reviews: PlaceReview[]

    a JSON array of up to five reviews. If a language parameter was specified in the Place Details request, +

    rating

    rating: number

    contains the place's rating, from 1.0 to 5.0, based on aggregated user reviews.

    +

    reviews

    reviews: PlaceReview[]

    a JSON array of up to five reviews. If a language parameter was specified in the Place Details request, the Places Service will bias the results to prefer reviews written in that language.

    -

    types

    types: AddressType[]

    contains an array of feature types describing the given result. +

    types

    types: AddressType[]

    contains an array of feature types describing the given result. XML responses include multiple <type> elements if more than one type is assigned to the result.

    -

    url

    url: string

    contains the URL of the official Google page for this place. +

    url

    url: string

    contains the URL of the official Google page for this place. This will be the Google-owned page that contains the best available information about the place. Applications must link to or embed this page on any screen that shows detailed results about the place to the user.

    -

    user_ratings_total

    user_ratings_total: number

    The total number of ratings from users

    -

    utc_offset

    utc_offset: number

    contains the number of minutes this place’s current timezone is offset from UTC. +

    user_ratings_total

    user_ratings_total: number

    The total number of ratings from users

    +

    utc_offset

    utc_offset: number

    contains the number of minutes this place’s current timezone is offset from UTC. For example, for places in Sydney, Australia during daylight saving time this would be 660 (+11 hours from UTC), and for places in California outside of daylight saving time this would be -480 (-8 hours from UTC).

    -

    vicinity

    vicinity: string

    lists a simplified address for the place, including the street name, street number, and locality, +

    vicinity

    vicinity: string

    lists a simplified address for the place, including the street name, street number, and locality, but not the province/state, postal code, or country. For example, Google's Sydney, Australia office has a vicinity value of 48 Pirrama Road, Pyrmont.

    -

    website

    website: string

    lists the authoritative website for this place, such as a business' homepage.

    -

    Settings

    Member Visibility

    On This Page

    Properties
    +

    website

    website: string

    lists the authoritative website for this place, such as a business' homepage.

    +

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/interfaces/PlaceDetailsRequest.html b/interfaces/PlaceDetailsRequest.html index b30436e8d3..209739432b 100644 --- a/interfaces/PlaceDetailsRequest.html +++ b/interfaces/PlaceDetailsRequest.html @@ -1,4 +1,4 @@ -PlaceDetailsRequest | Google Maps Services Node Client

    Interface PlaceDetailsRequest

    interface PlaceDetailsRequest {
        params: {
            fields?: string[];
            language?: Language;
            place_id: string;
            region?: string;
            sessiontoken?: string;
        } & RequestParams;
    }

    Hierarchy

    • Partial<AxiosRequestConfig>
      • PlaceDetailsRequest

    Properties

    params +PlaceDetailsRequest | Google Maps Services Node Client

    Interface PlaceDetailsRequest

    interface PlaceDetailsRequest {
        params: {
            fields?: string[];
            language?: Language;
            place_id: string;
            region?: string;
            sessiontoken?: string;
        } & RequestParams;
    }

    Hierarchy

    • Partial<AxiosRequestConfig>
      • PlaceDetailsRequest

    Properties

    params

    Properties

    params

    params: {
        fields?: string[];
        language?: Language;
        place_id: string;
        region?: string;
        sessiontoken?: string;
    } & RequestParams

    Type declaration

    • Optionalfields?: string[]

      One or more fields, specifying the types of place data to return, separated by a comma.

      **Warning: If you do not specify at least one field with a request, or if you omit the fields parameter from a request, ALL possible fields will be returned, and you will be billed accordingly. @@ -15,4 +15,4 @@ for results in the specified region.

    • Optionalsessiontoken?: string

      A random string which identifies an autocomplete session for billing purposes. Use this for Place Details requests that are called following an autocomplete request in the same user session

      -

    Settings

    Member Visibility

    On This Page

    Properties
    +

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/interfaces/PlaceDetailsResponse.html b/interfaces/PlaceDetailsResponse.html index f0b3e91db8..5362f6c7d1 100644 --- a/interfaces/PlaceDetailsResponse.html +++ b/interfaces/PlaceDetailsResponse.html @@ -1,2 +1,2 @@ -PlaceDetailsResponse | Google Maps Services Node Client

    Interface PlaceDetailsResponse

    interface PlaceDetailsResponse {
        data: PlaceDetailsResponseData;
    }

    Hierarchy

    • AxiosResponse
      • PlaceDetailsResponse

    Properties

    data -

    Properties

    data

    data: PlaceDetailsResponseData

    Settings

    Member Visibility

    On This Page

    Properties
    +PlaceDetailsResponse | Google Maps Services Node Client

    Interface PlaceDetailsResponse

    interface PlaceDetailsResponse {
        data: PlaceDetailsResponseData;
    }

    Hierarchy

    • AxiosResponse
      • PlaceDetailsResponse

    Properties

    data +

    Properties

    data

    data: PlaceDetailsResponseData

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/interfaces/PlaceDetailsResponseData.html b/interfaces/PlaceDetailsResponseData.html index 7c9ff273af..811651c15b 100644 --- a/interfaces/PlaceDetailsResponseData.html +++ b/interfaces/PlaceDetailsResponseData.html @@ -1,14 +1,14 @@ -PlaceDetailsResponseData | Google Maps Services Node Client

    Interface PlaceDetailsResponseData

    interface PlaceDetailsResponseData {
        error_message: string;
        html_attributions: string[];
        next_page_token?: string;
        result: Partial<PlaceData>;
        status: Status;
    }

    Hierarchy (View Summary)

    Properties

    error_message +PlaceDetailsResponseData | Google Maps Services Node Client

    Interface PlaceDetailsResponseData

    interface PlaceDetailsResponseData {
        error_message: string;
        html_attributions: string[];
        next_page_token?: string;
        result: Partial<PlaceData>;
        status: Status;
    }

    Hierarchy (View Summary)

    Properties

    error_message html_attributions next_page_token? result status

    Properties

    error_message

    error_message: string

    When the top-level status code is other than OK, this field contains more detailed information about the reasons behind the given status code.

    -

    html_attributions

    html_attributions: string[]

    contains a set of attributions about this listing which must be displayed to the user.

    -

    Optionalnext_page_token

    next_page_token?: string

    contains a token that can be used to return up to 20 additional results. +

    html_attributions

    html_attributions: string[]

    contains a set of attributions about this listing which must be displayed to the user.

    +

    Optionalnext_page_token

    next_page_token?: string

    contains a token that can be used to return up to 20 additional results. A next_page_token will not be returned if there are no additional results to display. The maximum number of results that can be returned is 60. There is a short delay between when a next_page_token is issued, and when it will become valid.

    -

    result

    result: Partial<PlaceData>

    status

    status: Status

    contains metadata on the request. See Status Codes below.

    -

    Settings

    Member Visibility

    On This Page

    Properties
    +

    result

    result: Partial<PlaceData>

    status

    status: Status

    contains metadata on the request. See Status Codes below.

    +

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/interfaces/PlaceEditorialSummary.html b/interfaces/PlaceEditorialSummary.html index 91508845a6..ca09743120 100644 --- a/interfaces/PlaceEditorialSummary.html +++ b/interfaces/PlaceEditorialSummary.html @@ -1,5 +1,5 @@ -PlaceEditorialSummary | Google Maps Services Node Client

    Interface PlaceEditorialSummary

    interface PlaceEditorialSummary {
        language?: string;
        overview?: string;
    }

    Properties

    language? +PlaceEditorialSummary | Google Maps Services Node Client

    Interface PlaceEditorialSummary

    interface PlaceEditorialSummary {
        language?: string;
        overview?: string;
    }

    Properties

    language? overview?

    Properties

    Optionallanguage

    language?: string

    The language of the previous fields. May not always be present.

    -

    Optionaloverview

    overview?: string

    A medium-length textual summary of the place.

    -

    Settings

    Member Visibility

    On This Page

    Properties
    +

    Optionaloverview

    overview?: string

    A medium-length textual summary of the place.

    +

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/interfaces/PlacePhoto.html b/interfaces/PlacePhoto.html index 45f5379d6b..ad6fdf915b 100644 --- a/interfaces/PlacePhoto.html +++ b/interfaces/PlacePhoto.html @@ -1,9 +1,9 @@ -PlacePhoto | Google Maps Services Node Client

    Interface PlacePhoto

    interface PlacePhoto {
        height: number;
        html_attributions: string[];
        photo_reference: string;
        width: number;
    }

    Properties

    height +PlacePhoto | Google Maps Services Node Client

    Interface PlacePhoto

    interface PlacePhoto {
        height: number;
        html_attributions: string[];
        photo_reference: string;
        width: number;
    }

    Properties

    height html_attributions photo_reference width

    Properties

    height

    height: number

    the maximum height of the image.

    -

    html_attributions

    html_attributions: string[]

    contains any required attributions. This field will always be present, but may be empty.

    -

    photo_reference

    photo_reference: string

    a string used to identify the photo when you perform a Photo request.

    -

    width

    width: number

    the maximum width of the image.

    -

    Settings

    Member Visibility

    On This Page

    Properties
    +

    html_attributions

    html_attributions: string[]

    contains any required attributions. This field will always be present, but may be empty.

    +

    photo_reference

    photo_reference: string

    a string used to identify the photo when you perform a Photo request.

    +

    width

    width: number

    the maximum width of the image.

    +

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/interfaces/PlacePhotoRequest.html b/interfaces/PlacePhotoRequest.html index 180e837764..c83029c5ec 100644 --- a/interfaces/PlacePhotoRequest.html +++ b/interfaces/PlacePhotoRequest.html @@ -1,4 +1,4 @@ -PlacePhotoRequest | Google Maps Services Node Client

    Interface PlacePhotoRequest

    interface PlacePhotoRequest {
        params: {
            maxheight?: number;
            maxwidth?: number;
            photoreference: string;
        } & RequestParams;
        responseType: "stream"
        | "arraybuffer"
        | "blob";
    }

    Hierarchy

    • Partial<AxiosRequestConfig>
      • PlacePhotoRequest

    Properties

    params +PlacePhotoRequest | Google Maps Services Node Client

    Interface PlacePhotoRequest

    interface PlacePhotoRequest {
        params: {
            maxheight?: number;
            maxwidth?: number;
            photoreference: string;
        } & RequestParams;
        responseType: "stream"
        | "arraybuffer"
        | "blob";
    }

    Hierarchy

    • Partial<AxiosRequestConfig>
      • PlacePhotoRequest

    Properties

    params responseType

    Properties

    params

    params: { maxheight?: number; maxwidth?: number; photoreference: string } & RequestParams

    Type declaration

    • Optionalmaxheight?: number

      Specifies the maximum desired height or width, in pixels, of the image returned by the Place Photos service. If the image is smaller than the values specified, the original image will be returned. @@ -10,4 +10,4 @@ restricted to its original aspect ratio. Both the maxheight and maxwidth properties accept an integer between 1 and 1600.

    • photoreference: string

      string identifier that uniquely identifies a photo. Photo references are returned from either a Place Search or Place Details request.

      -

    responseType

    responseType: "stream" | "arraybuffer" | "blob"

    Settings

    Member Visibility

    On This Page

    Properties
    +

    responseType

    responseType: "stream" | "arraybuffer" | "blob"

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/interfaces/PlacePhotoResponse.html b/interfaces/PlacePhotoResponse.html index 2d49b24f44..52d4d8407f 100644 --- a/interfaces/PlacePhotoResponse.html +++ b/interfaces/PlacePhotoResponse.html @@ -7,4 +7,4 @@
  • The submitted photo reference was incorrectly specified.
  • Your request did not include either a maxwidth or maxheight parameter.
    • -

    Hierarchy

    Settings

    Member Visibility
    +

    Hierarchy

    Settings

    Member Visibility
    diff --git a/interfaces/PlaceQueryAutocompletePrediction.html b/interfaces/PlaceQueryAutocompletePrediction.html index 31e48387da..4f8e3e8af2 100644 --- a/interfaces/PlaceQueryAutocompletePrediction.html +++ b/interfaces/PlaceQueryAutocompletePrediction.html @@ -1,12 +1,12 @@ -PlaceQueryAutocompletePrediction | Google Maps Services Node Client

    Interface PlaceQueryAutocompletePrediction

    interface PlaceQueryAutocompletePrediction {
        description: string;
        matched_substrings: PredictionSubstring[];
        place_id?: string;
        structured_formatting?: StructuredFormatting[];
        terms: PredictionTerm[];
        types?: string[];
    }

    Properties

    description +PlaceQueryAutocompletePrediction | Google Maps Services Node Client

    Interface PlaceQueryAutocompletePrediction

    interface PlaceQueryAutocompletePrediction {
        description: string;
        matched_substrings: PredictionSubstring[];
        place_id?: string;
        structured_formatting?: StructuredFormatting[];
        terms: PredictionTerm[];
        types?: string[];
    }

    Properties

    description matched_substrings place_id? structured_formatting? terms types?

    Properties

    description

    description: string

    contains the human-readable name for the returned result. For establishment results, this is usually the business name.

    -

    matched_substrings

    matched_substrings: PredictionSubstring[]

    contains an offset value and a length. +

    matched_substrings

    matched_substrings: PredictionSubstring[]

    contains an offset value and a length. These describe the location of the entered term in the prediction result text, so that the term can be highlighted if desired.

    -

    Optionalplace_id

    place_id?: string

    Optionalstructured_formatting

    structured_formatting?: StructuredFormatting[]

    terms

    terms: PredictionTerm[]

    contains an array of terms identifying each section of the returned description +

    Optionalplace_id

    place_id?: string

    Optionalstructured_formatting

    structured_formatting?: StructuredFormatting[]

    terms

    terms: PredictionTerm[]

    contains an array of terms identifying each section of the returned description (a section of the description is generally terminated with a comma).

    -

    Optionaltypes

    types?: string[]

    Settings

    Member Visibility

    On This Page

    Properties
    +

    Optionaltypes

    types?: string[]

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/interfaces/PlaceQueryAutocompleteRequest.html b/interfaces/PlaceQueryAutocompleteRequest.html index 9a826931ad..2d03b82a93 100644 --- a/interfaces/PlaceQueryAutocompleteRequest.html +++ b/interfaces/PlaceQueryAutocompleteRequest.html @@ -1,4 +1,4 @@ -PlaceQueryAutocompleteRequest | Google Maps Services Node Client

    Interface PlaceQueryAutocompleteRequest

    interface PlaceQueryAutocompleteRequest {
        params: {
            input: string;
            language?: Language;
            location?: LatLng;
            offset?: number;
            radius?: number;
        } & RequestParams;
    }

    Hierarchy

    • Partial<AxiosRequestConfig>
      • PlaceQueryAutocompleteRequest

    Properties

    params +PlaceQueryAutocompleteRequest | Google Maps Services Node Client

    Interface PlaceQueryAutocompleteRequest

    interface PlaceQueryAutocompleteRequest {
        params: {
            input: string;
            language?: Language;
            location?: LatLng;
            offset?: number;
            radius?: number;
        } & RequestParams;
    }

    Hierarchy

    • Partial<AxiosRequestConfig>
      • PlaceQueryAutocompleteRequest

    Properties

    params

    Properties

    params

    params: {
        input: string;
        language?: Language;
        location?: LatLng;
        offset?: number;
        radius?: number;
    } & RequestParams

    Type declaration

    • input: string

      The text string on which to search. The Places service will return candidate matches based on this string and order results based on their perceived relevance.

    • Optionallanguage?: Language

      The language code, indicating in which language the results should be returned, if possible. @@ -11,4 +11,4 @@ If no offset is supplied, the service will use the entire term.

    • Optionalradius?: number

      The distance (in meters) within which to return place results. Note that setting a radius biases results to the indicated area, but may not fully restrict results to the specified area.

      -

    Settings

    Member Visibility

    On This Page

    Properties
    +

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/interfaces/PlaceQueryAutocompleteResponse.html b/interfaces/PlaceQueryAutocompleteResponse.html index 18a54a204f..263fb3db40 100644 --- a/interfaces/PlaceQueryAutocompleteResponse.html +++ b/interfaces/PlaceQueryAutocompleteResponse.html @@ -1,2 +1,2 @@ -PlaceQueryAutocompleteResponse | Google Maps Services Node Client

    Interface PlaceQueryAutocompleteResponse

    interface PlaceQueryAutocompleteResponse {
        data: PlaceQueryAutocompleteResponseData;
    }

    Hierarchy

    • AxiosResponse
      • PlaceQueryAutocompleteResponse

    Properties

    data -

    Properties

    data

    data: PlaceQueryAutocompleteResponseData

    Settings

    Member Visibility

    On This Page

    Properties
    +PlaceQueryAutocompleteResponse | Google Maps Services Node Client

    Interface PlaceQueryAutocompleteResponse

    interface PlaceQueryAutocompleteResponse {
        data: PlaceQueryAutocompleteResponseData;
    }

    Hierarchy

    • AxiosResponse
      • PlaceQueryAutocompleteResponse

    Properties

    data +

    Properties

    data

    data: PlaceQueryAutocompleteResponseData

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/interfaces/PlaceQueryAutocompleteResponseData.html b/interfaces/PlaceQueryAutocompleteResponseData.html index 5ce3ed4ace..6f917d7eae 100644 --- a/interfaces/PlaceQueryAutocompleteResponseData.html +++ b/interfaces/PlaceQueryAutocompleteResponseData.html @@ -1,17 +1,17 @@ -PlaceQueryAutocompleteResponseData | Google Maps Services Node Client

    Interface PlaceQueryAutocompleteResponseData

    interface PlaceQueryAutocompleteResponseData {
        error_message: string;
        html_attributions?: string[];
        next_page_token?: string;
        predictions: PlaceQueryAutocompletePrediction[];
        status: Status;
    }

    Hierarchy (View Summary)

    Properties

    error_message +PlaceQueryAutocompleteResponseData | Google Maps Services Node Client

    Interface PlaceQueryAutocompleteResponseData

    interface PlaceQueryAutocompleteResponseData {
        error_message: string;
        html_attributions?: string[];
        next_page_token?: string;
        predictions: PlaceQueryAutocompletePrediction[];
        status: Status;
    }

    Hierarchy (View Summary)

    Properties

    error_message html_attributions? next_page_token? predictions status

    Properties

    error_message

    error_message: string

    When the top-level status code is other than OK, this field contains more detailed information about the reasons behind the given status code.

    -

    Optionalhtml_attributions

    html_attributions?: string[]

    may contain a set of attributions about this listing which must be displayed to the user (some listings may not have attribution).

    -

    Optionalnext_page_token

    next_page_token?: string

    contains a token that can be used to return up to 20 additional results. +

    Optionalhtml_attributions

    html_attributions?: string[]

    may contain a set of attributions about this listing which must be displayed to the user (some listings may not have attribution).

    +

    Optionalnext_page_token

    next_page_token?: string

    contains a token that can be used to return up to 20 additional results. A next_page_token will not be returned if there are no additional results to display. The maximum number of results that can be returned is 60. There is a short delay between when a next_page_token is issued, and when it will become valid.

    -

    predictions

    predictions: PlaceQueryAutocompletePrediction[]

    contains an array of places, with information about the place. +

    predictions

    predictions: PlaceQueryAutocompletePrediction[]

    contains an array of places, with information about the place. See Place Autocomplete Results for information about these results. The Places API returns up to 5 results.

    -

    status

    status: Status

    contains metadata on the request. See Status Codes below.

    -

    Settings

    Member Visibility

    On This Page

    Properties
    +

    status

    status: Status

    contains metadata on the request. See Status Codes below.

    +

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/interfaces/PlaceReview.html b/interfaces/PlaceReview.html index f7c6471c4f..14b856396a 100644 --- a/interfaces/PlaceReview.html +++ b/interfaces/PlaceReview.html @@ -1,4 +1,4 @@ -PlaceReview | Google Maps Services Node Client

    Interface PlaceReview

    interface PlaceReview {
        aspects: AspectRating[];
        author_name: string;
        author_url?: string;
        language: string;
        profile_photo_url: string;
        rating: number;
        relative_time_description: string;
        text: string;
        time: string;
    }

    Properties

    aspects +PlaceReview | Google Maps Services Node Client

    Interface PlaceReview

    interface PlaceReview {
        aspects: AspectRating[];
        author_name: string;
        author_url?: string;
        language: string;
        profile_photo_url: string;
        rating: number;
        relative_time_description: string;
        text: string;
        time: string;
    }

    Properties

    aspects author_name author_url? language @@ -9,15 +9,15 @@ time

    Properties

    aspects

    aspects: AspectRating[]

    contains a collection of AspectRating objects, each of which provides a rating of a single attribute of the establishment. The first object in the collection is considered the primary aspect.

    -

    author_name

    author_name: string

    the name of the user who submitted the review. Anonymous reviews are attributed to "A Google user".

    -

    Optionalauthor_url

    author_url?: string

    the URL to the user's Google Maps Local Guides profile, if available.

    -

    language

    language: string

    an IETF language code indicating the language used in the user's review. +

    author_name

    author_name: string

    the name of the user who submitted the review. Anonymous reviews are attributed to "A Google user".

    +

    Optionalauthor_url

    author_url?: string

    the URL to the user's Google Maps Local Guides profile, if available.

    +

    language

    language: string

    an IETF language code indicating the language used in the user's review. This field contains the main language tag only, and not the secondary tag indicating country or region. For example, all the English reviews are tagged as 'en', and not 'en-AU' or 'en-UK' and so on.

    -

    profile_photo_url

    profile_photo_url: string

    the URL to the user's profile photo, if available.

    -

    rating

    rating: number

    the user's overall rating for this place. This is a whole number, ranging from 1 to 5.

    -

    relative_time_description

    relative_time_description: string

    text

    text: string

    the user's review. When reviewing a location with Google Places, text reviews are considered optional. +

    profile_photo_url

    profile_photo_url: string

    the URL to the user's profile photo, if available.

    +

    rating

    rating: number

    the user's overall rating for this place. This is a whole number, ranging from 1 to 5.

    +

    relative_time_description

    relative_time_description: string

    text

    text: string

    the user's review. When reviewing a location with Google Places, text reviews are considered optional. Therefore, this field may by empty. Note that this field may include simple HTML markup. For example, the entity reference &amp; may represent an ampersand character.

    -

    time

    time: string

    the time that the review was submitted, measured in the number of seconds since since midnight, January 1, 1970 UTC.

    -

    Settings

    Member Visibility

    On This Page

    Properties
    +

    time

    time: string

    the time that the review was submitted, measured in the number of seconds since since midnight, January 1, 1970 UTC.

    +

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/interfaces/PlacesNearbyRequest.html b/interfaces/PlacesNearbyRequest.html index 07267ab7ee..c72e749e3d 100644 --- a/interfaces/PlacesNearbyRequest.html +++ b/interfaces/PlacesNearbyRequest.html @@ -1,4 +1,4 @@ -PlacesNearbyRequest | Google Maps Services Node Client

    Interface PlacesNearbyRequest

    interface PlacesNearbyRequest {
        params: {
            keyword?: string;
            language?: Language;
            location: LatLng;
            maxprice?: number;
            minprice?: number;
            name?: string;
            opennow?: boolean;
            pagetoken?: string;
            radius?: number;
            rankby?: PlacesNearbyRanking;
            type?: string;
        } & RequestParams;
    }

    Hierarchy

    • Partial<AxiosRequestConfig>
      • PlacesNearbyRequest

    Properties

    params +PlacesNearbyRequest | Google Maps Services Node Client

    Interface PlacesNearbyRequest

    interface PlacesNearbyRequest {
        params: {
            keyword?: string;
            language?: Language;
            location: LatLng;
            maxprice?: number;
            minprice?: number;
            name?: string;
            opennow?: boolean;
            pagetoken?: string;
            radius?: number;
            rankby?: PlacesNearbyRanking;
            type?: string;
        } & RequestParams;
    }

    Hierarchy

    • Partial<AxiosRequestConfig>
      • PlacesNearbyRequest

    Properties

    params

    Properties

    params

    params: {
        keyword?: string;
        language?: Language;
        location: LatLng;
        maxprice?: number;
        minprice?: number;
        name?: string;
        opennow?: boolean;
        pagetoken?: string;
        radius?: number;
        rankby?: PlacesNearbyRanking;
        type?: string;
    } & RequestParams

    Type declaration

    • Optionalkeyword?: string

      A term to be matched against all content that Google has indexed for this place, including but not limited to name, type, and address, as well as customer reviews and other third-party content.

    • Optionallanguage?: Language

      The language code, indicating in which language the results should be returned, if possible. @@ -29,4 +29,4 @@

  • Optionaltype?: string

    Restricts the results to places matching the specified type. Only one type may be specified (if more than one type is provided, all types following the first entry are ignored).

    -

    • Settings

    Member Visibility

    On This Page

    Properties
    +

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/interfaces/PlacesNearbyResponse.html b/interfaces/PlacesNearbyResponse.html index 7bb379d6a2..54113f22c1 100644 --- a/interfaces/PlacesNearbyResponse.html +++ b/interfaces/PlacesNearbyResponse.html @@ -1,2 +1,2 @@ -PlacesNearbyResponse | Google Maps Services Node Client

    Interface PlacesNearbyResponse

    interface PlacesNearbyResponse {
        data: PlacesNearbyResponseData;
    }

    Hierarchy

    • AxiosResponse
      • PlacesNearbyResponse

    Properties

    data -

    Properties

    data

    data: PlacesNearbyResponseData

    Settings

    Member Visibility

    On This Page

    Properties
    +PlacesNearbyResponse | Google Maps Services Node Client

    Interface PlacesNearbyResponse

    interface PlacesNearbyResponse {
        data: PlacesNearbyResponseData;
    }

    Hierarchy

    • AxiosResponse
      • PlacesNearbyResponse

    Properties

    data +

    Properties

    data

    data: PlacesNearbyResponseData

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/interfaces/PlacesNearbyResponseData.html b/interfaces/PlacesNearbyResponseData.html index bf947a988b..8582e05ae7 100644 --- a/interfaces/PlacesNearbyResponseData.html +++ b/interfaces/PlacesNearbyResponseData.html @@ -1,14 +1,14 @@ -PlacesNearbyResponseData | Google Maps Services Node Client

    Interface PlacesNearbyResponseData

    interface PlacesNearbyResponseData {
        error_message: string;
        html_attributions?: string[];
        next_page_token?: string;
        results: Partial<PlaceData>[];
        status: Status;
    }

    Hierarchy (View Summary)

    Properties

    error_message +PlacesNearbyResponseData | Google Maps Services Node Client

    Interface PlacesNearbyResponseData

    interface PlacesNearbyResponseData {
        error_message: string;
        html_attributions?: string[];
        next_page_token?: string;
        results: Partial<PlaceData>[];
        status: Status;
    }

    Hierarchy (View Summary)

    Properties

    error_message html_attributions? next_page_token? results status

    Properties

    error_message

    error_message: string

    When the top-level status code is other than OK, this field contains more detailed information about the reasons behind the given status code.

    -

    Optionalhtml_attributions

    html_attributions?: string[]

    may contain a set of attributions about this listing which must be displayed to the user (some listings may not have attribution).

    -

    Optionalnext_page_token

    next_page_token?: string

    contains a token that can be used to return up to 20 additional results. +

    Optionalhtml_attributions

    html_attributions?: string[]

    may contain a set of attributions about this listing which must be displayed to the user (some listings may not have attribution).

    +

    Optionalnext_page_token

    next_page_token?: string

    contains a token that can be used to return up to 20 additional results. A next_page_token will not be returned if there are no additional results to display. The maximum number of results that can be returned is 60. There is a short delay between when a next_page_token is issued, and when it will become valid.

    -

    results

    results: Partial<PlaceData>[]

    status

    status: Status

    contains metadata on the request. See Status Codes below.

    -

    Settings

    Member Visibility

    On This Page

    Properties
    +

    results

    results: Partial<PlaceData>[]

    status

    status: Status

    contains metadata on the request. See Status Codes below.

    +

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/interfaces/PlusCode.html b/interfaces/PlusCode.html index ea3c397d2d..25f0a7b222 100644 --- a/interfaces/PlusCode.html +++ b/interfaces/PlusCode.html @@ -1,5 +1,5 @@ -PlusCode | Google Maps Services Node Client

    Interface PlusCode

    interface PlusCode {
        compound_code: string;
        global_code: string;
    }

    Properties

    compound_code +PlusCode | Google Maps Services Node Client

    Interface PlusCode

    interface PlusCode {
        compound_code: string;
        global_code: string;
    }

    Properties

    compound_code global_code

    Properties

    compound_code

    compound_code: string

    is a 6 character or longer local code with an explicit location (CWC8+R9, Mountain View, CA, USA).

    -

    global_code

    global_code: string

    is a 4 character area code and 6 character or longer local code (849VCWC8+R9).

    -

    Settings

    Member Visibility

    On This Page

    Properties
    +

    global_code

    global_code: string

    is a 4 character area code and 6 character or longer local code (849VCWC8+R9).

    +

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/interfaces/PositionalElevationParams.html b/interfaces/PositionalElevationParams.html index bf6ea53726..ef025333a1 100644 --- a/interfaces/PositionalElevationParams.html +++ b/interfaces/PositionalElevationParams.html @@ -1,5 +1,5 @@ -PositionalElevationParams | Google Maps Services Node Client

    Interface PositionalElevationParams

    interface PositionalElevationParams {
        locations: LatLng[];
    }

    Properties

    locations +PositionalElevationParams | Google Maps Services Node Client

    Interface PositionalElevationParams

    interface PositionalElevationParams {
        locations: LatLng[];
    }

    Properties

    locations

    Properties

    locations

    locations: LatLng[]

    defines the location(s) on the earth from which to return elevation data. This parameter takes either a single location as a comma-separated {latitude,longitude} pair (e.g. "40.714728,-73.998672") or multiple latitude/longitude pairs passed as an array or as an encoded polyline.

    -

    Settings

    Member Visibility

    On This Page

    Properties
    +

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/interfaces/PredictionSubstring.html b/interfaces/PredictionSubstring.html index 1f4a7d7a11..e58892ed53 100644 --- a/interfaces/PredictionSubstring.html +++ b/interfaces/PredictionSubstring.html @@ -1,5 +1,5 @@ -PredictionSubstring | Google Maps Services Node Client

    Interface PredictionSubstring

    interface PredictionSubstring {
        length: number;
        offset: number;
    }

    Properties

    length +PredictionSubstring | Google Maps Services Node Client

    Interface PredictionSubstring

    interface PredictionSubstring {
        length: number;
        offset: number;
    }

    Properties

    length offset

    Properties

    length

    length: number

    length of the entered term.

    -

    offset

    offset: number

    location of the entered term.

    -

    Settings

    Member Visibility

    On This Page

    Properties
    +

    offset

    offset: number

    location of the entered term.

    +

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/interfaces/PredictionTerm.html b/interfaces/PredictionTerm.html index 69328b2a7d..b50e8c6b5c 100644 --- a/interfaces/PredictionTerm.html +++ b/interfaces/PredictionTerm.html @@ -1,5 +1,5 @@ -PredictionTerm | Google Maps Services Node Client

    Interface PredictionTerm

    interface PredictionTerm {
        offset: number;
        value: string;
    }

    Properties

    offset +PredictionTerm | Google Maps Services Node Client

    Interface PredictionTerm

    interface PredictionTerm {
        offset: number;
        value: string;
    }

    Properties

    offset value

    Properties

    offset

    offset: number

    start position of this term in the description, measured in Unicode characters.

    -

    value

    value: string

    containing the text of the term.

    -

    Settings

    Member Visibility

    On This Page

    Properties
    +

    value

    value: string

    containing the text of the term.

    +

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/interfaces/PremiumPlanParams.html b/interfaces/PremiumPlanParams.html index 970fc26995..78f8e41eee 100644 --- a/interfaces/PremiumPlanParams.html +++ b/interfaces/PremiumPlanParams.html @@ -1,8 +1,8 @@ PremiumPlanParams | Google Maps Services Node Client

    Interface PremiumPlanParams

    The Google Maps Platform Premium Plan is no longer available for sign up or new customers. This option is only provided for maintaining existing legacy applications that use client IDs. For new applications, please use API keys.

    -

    Deprecated

    interface PremiumPlanParams {
        client_id: string;
        client_secret: string;
    }

    Properties

    client_id +

    Deprecated

    interface PremiumPlanParams {
        client_id: string;
        client_secret: string;
    }

    Properties

    client_id client_secret

    Properties

    client_id

    client_id: string

    project client ID

    -

    client_secret

    client_secret: string

    project URL signing secret. Used to create the request signature

    -

    Settings

    Member Visibility

    On This Page

    Properties
    +

    client_secret

    client_secret: string

    project URL signing secret. Used to create the request signature

    +

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/interfaces/ResponseData.html b/interfaces/ResponseData.html index 14b5738a8a..049013204c 100644 --- a/interfaces/ResponseData.html +++ b/interfaces/ResponseData.html @@ -1,13 +1,13 @@ -ResponseData | Google Maps Services Node Client

    Interface ResponseData

    interface ResponseData {
        error_message: string;
        html_attributions?: string[];
        next_page_token?: string;
        status: Status;
    }

    Hierarchy (View Summary)

    Properties

    error_message +ResponseData | Google Maps Services Node Client

    Interface ResponseData

    interface ResponseData {
        error_message: string;
        html_attributions?: string[];
        next_page_token?: string;
        status: Status;
    }

    Hierarchy (View Summary)

    Properties

    error_message html_attributions? next_page_token? status

    Properties

    error_message

    error_message: string

    When the top-level status code is other than OK, this field contains more detailed information about the reasons behind the given status code.

    -

    Optionalhtml_attributions

    html_attributions?: string[]

    may contain a set of attributions about this listing which must be displayed to the user (some listings may not have attribution).

    -

    Optionalnext_page_token

    next_page_token?: string

    contains a token that can be used to return up to 20 additional results. +

    Optionalhtml_attributions

    html_attributions?: string[]

    may contain a set of attributions about this listing which must be displayed to the user (some listings may not have attribution).

    +

    Optionalnext_page_token

    next_page_token?: string

    contains a token that can be used to return up to 20 additional results. A next_page_token will not be returned if there are no additional results to display. The maximum number of results that can be returned is 60. There is a short delay between when a next_page_token is issued, and when it will become valid.

    -

    status

    status: Status

    contains metadata on the request. See Status Codes below.

    -

    Settings

    Member Visibility

    On This Page

    Properties
    +

    status

    status: Status

    contains metadata on the request. See Status Codes below.

    +

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/interfaces/ReverseGeocodeRequest.html b/interfaces/ReverseGeocodeRequest.html index e7be1fcdf4..41a2f2d92b 100644 --- a/interfaces/ReverseGeocodeRequest.html +++ b/interfaces/ReverseGeocodeRequest.html @@ -1,4 +1,4 @@ -ReverseGeocodeRequest | Google Maps Services Node Client

    Interface ReverseGeocodeRequest

    interface ReverseGeocodeRequest {
        params: {
            enable_address_descriptor?: boolean;
            language?: Language;
            latlng?: LatLng;
            location_type?: ReverseGeocodingLocationType[];
            place_id?: string;
            result_type?: AddressType[];
        } & RequestParams;
    }

    Hierarchy

    • Partial<AxiosRequestConfig>
      • ReverseGeocodeRequest

    Properties

    params +ReverseGeocodeRequest | Google Maps Services Node Client

    Interface ReverseGeocodeRequest

    interface ReverseGeocodeRequest {
        params: {
            enable_address_descriptor?: boolean;
            language?: Language;
            latlng?: LatLng;
            location_type?: ReverseGeocodingLocationType[];
            place_id?: string;
            result_type?: AddressType[];
        } & RequestParams;
    }

    Hierarchy

    • Partial<AxiosRequestConfig>
      • ReverseGeocodeRequest

    Properties

    params

    Properties

    params

    params: {
        enable_address_descriptor?: boolean;
        language?: Language;
        latlng?: LatLng;
        location_type?: ReverseGeocodingLocationType[];
        place_id?: string;
        result_type?: AddressType[];
    } & RequestParams

    Type declaration

    • Optionalenable_address_descriptor?: boolean

      Determines whether the address descriptor is returned in the response.

    • Optionallanguage?: Language

      The language in which to return results.

        @@ -28,4 +28,4 @@ Rather, the result_type acts as a post-search filter: the API fetches all results for the specified latlng, then discards those results that do not match the specified address type(s). Note: This parameter is available only for requests that include an API key or a client ID.

        -

    Settings

    Member Visibility

    On This Page

    Properties
    +

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/interfaces/ReverseGeocodeResponse.html b/interfaces/ReverseGeocodeResponse.html index 425dda37cc..b4020449ee 100644 --- a/interfaces/ReverseGeocodeResponse.html +++ b/interfaces/ReverseGeocodeResponse.html @@ -1,2 +1,2 @@ -ReverseGeocodeResponse | Google Maps Services Node Client

    Interface ReverseGeocodeResponse

    interface ReverseGeocodeResponse {
        data: ReverseGeocodeResponseData;
    }

    Hierarchy

    • AxiosResponse
      • ReverseGeocodeResponse

    Properties

    data -

    Properties

    data

    data: ReverseGeocodeResponseData

    Settings

    Member Visibility

    On This Page

    Properties
    +ReverseGeocodeResponse | Google Maps Services Node Client

    Interface ReverseGeocodeResponse

    interface ReverseGeocodeResponse {
        data: ReverseGeocodeResponseData;
    }

    Hierarchy

    • AxiosResponse
      • ReverseGeocodeResponse

    Properties

    data +

    Properties

    data

    data: ReverseGeocodeResponseData

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/interfaces/ReverseGeocodeResponseData.html b/interfaces/ReverseGeocodeResponseData.html index 9d3906f3db..0b85d35900 100644 --- a/interfaces/ReverseGeocodeResponseData.html +++ b/interfaces/ReverseGeocodeResponseData.html @@ -1,19 +1,19 @@ -ReverseGeocodeResponseData | Google Maps Services Node Client

    Interface ReverseGeocodeResponseData

    interface ReverseGeocodeResponseData {
        address_descriptor: AddressDescriptor;
        error_message: string;
        html_attributions?: string[];
        next_page_token?: string;
        results: GeocodeResult[];
        status: Status;
    }

    Hierarchy (View Summary)

    Properties

    address_descriptor +ReverseGeocodeResponseData | Google Maps Services Node Client

    Interface ReverseGeocodeResponseData

    interface ReverseGeocodeResponseData {
        address_descriptor: AddressDescriptor;
        error_message: string;
        html_attributions?: string[];
        next_page_token?: string;
        results: GeocodeResult[];
        status: Status;
    }

    Hierarchy (View Summary)

    Properties

    address_descriptor error_message html_attributions? next_page_token? results status

    Properties

    address_descriptor

    address_descriptor: AddressDescriptor

    The Address Descriptor for the target.

    -

    error_message

    error_message: string

    When the top-level status code is other than OK, this field contains more detailed information +

    error_message

    error_message: string

    When the top-level status code is other than OK, this field contains more detailed information about the reasons behind the given status code.

    -

    Optionalhtml_attributions

    html_attributions?: string[]

    may contain a set of attributions about this listing which must be displayed to the user (some listings may not have attribution).

    -

    Optionalnext_page_token

    next_page_token?: string

    contains a token that can be used to return up to 20 additional results. +

    Optionalhtml_attributions

    html_attributions?: string[]

    may contain a set of attributions about this listing which must be displayed to the user (some listings may not have attribution).

    +

    Optionalnext_page_token

    next_page_token?: string

    contains a token that can be used to return up to 20 additional results. A next_page_token will not be returned if there are no additional results to display. The maximum number of results that can be returned is 60. There is a short delay between when a next_page_token is issued, and when it will become valid.

    -

    results

    results: GeocodeResult[]

    contains an array of geocoded address information and geometry information.

    +

    results

    results: GeocodeResult[]

    contains an array of geocoded address information and geometry information.

    Generally, only one entry in the "results" array is returned for address lookups,though the geocoder may return several results when address queries are ambiguous.

    -

    status

    status: Status

    contains metadata on the request. See Status Codes below.

    -

    Settings

    Member Visibility

    On This Page

    Properties
    +

    status

    status: Status

    contains metadata on the request. See Status Codes below.

    +

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/interfaces/RouteLeg.html b/interfaces/RouteLeg.html index c36dfc493c..8f9e6e0d05 100644 --- a/interfaces/RouteLeg.html +++ b/interfaces/RouteLeg.html @@ -1,7 +1,7 @@ RouteLeg | Google Maps Services Node Client

    Interface RouteLeg

    A single leg of the journey from the origin to the destination in the calculated route. For routes that contain no waypoints, the route will consist of a single "leg," but for routes that define one or more waypoints, the route will consist of one or more legs, corresponding to the specific legs of the journey.

    -
    interface RouteLeg {
        arrival_time: Time;
        departure_time: Time;
        distance: Distance;
        duration: Duration;
        duration_in_traffic?: Duration;
        end_address: string;
        end_location: LatLngLiteral;
        start_address: string;
        start_location: LatLngLiteral;
        steps: DirectionsStep[];
    }

    Properties

    arrival_time +
    interface RouteLeg {
        arrival_time: Time;
        departure_time: Time;
        distance: Distance;
        duration: Duration;
        duration_in_traffic?: Duration;
        end_address: string;
        end_location: LatLngLiteral;
        start_address: string;
        start_location: LatLngLiteral;
        steps: DirectionsStep[];
    }

    Properties

    arrival_time departure_time distance duration @@ -12,13 +12,13 @@ start_location steps

    Properties

    arrival_time

    arrival_time: Time

    contains the estimated time of arrival for this leg. This property is only returned for transit directions.

    -

    departure_time

    departure_time: Time

    contains the estimated time of departure for this leg, specified as a Time object. +

    departure_time

    departure_time: Time

    contains the estimated time of departure for this leg, specified as a Time object. The departure_time is only available for transit directions.

    -

    distance

    distance: Distance

    indicates the total distance covered by this leg, as a field with the following elements.

    +

    distance

    distance: Distance

    indicates the total distance covered by this leg, as a field with the following elements.

    This field may be absent if the distance is unknown.

    -

    duration

    duration: Duration

    indicates the total duration of this leg.

    +

    duration

    duration: Duration

    indicates the total duration of this leg.

    This field may be absent if the duration is unknown.

    -

    Optionalduration_in_traffic

    duration_in_traffic?: Duration

    indicates the total duration of this leg. +

    Optionalduration_in_traffic

    duration_in_traffic?: Duration

    indicates the total duration of this leg. This value is an estimate of the time in traffic based on current and historical traffic conditions. See the traffic_model request parameter for the options you can use to request that the returned value is optimistic, pessimistic, or a best-guess estimate. The duration in traffic is returned only if all of the following are true:

    @@ -30,15 +30,15 @@
  • The request includes a departure_time parameter.
  • Traffic conditions are available for the requested route.
    • -

    end_address

    end_address: string

    contains the human-readable address (typically a street address) from reverse geocoding the end_location of this leg.

    -

    end_location

    end_location: LatLngLiteral

    contains the latitude/longitude coordinates of the given destination of this leg. +

    end_address

    end_address: string

    contains the human-readable address (typically a street address) from reverse geocoding the end_location of this leg.

    +

    end_location

    end_location: LatLngLiteral

    contains the latitude/longitude coordinates of the given destination of this leg. Because the Directions API calculates directions between locations by using the nearest transportation option (usually a road) at the start and end points, end_location may be different than the provided destination of this leg if, for example, a road is not near the destination.

    -

    start_address

    start_address: string

    contains the human-readable address (typically a street address) resulting from reverse geocoding the start_location of this leg.

    -

    start_location

    start_location: LatLngLiteral

    contains the latitude/longitude coordinates of the origin of this leg. +

    start_address

    start_address: string

    contains the human-readable address (typically a street address) resulting from reverse geocoding the start_location of this leg.

    +

    start_location

    start_location: LatLngLiteral

    contains the latitude/longitude coordinates of the origin of this leg. Because the Directions API calculates directions between locations by using the nearest transportation option (usually a road) at the start and end points, start_location may be different than the provided origin of this leg if, for example, a road is not near the origin.

    -

    steps

    steps: DirectionsStep[]

    contains an array of steps denoting information about each separate step of the leg of the journey.

    -

    Settings

    Member Visibility

    On This Page

    Properties
    +

    steps

    steps: DirectionsStep[]

    contains an array of steps denoting information about each separate step of the leg of the journey.

    +

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/interfaces/SampledPathElevationParams.html b/interfaces/SampledPathElevationParams.html index 329f8fe6ab..7fe4290e20 100644 --- a/interfaces/SampledPathElevationParams.html +++ b/interfaces/SampledPathElevationParams.html @@ -1,9 +1,9 @@ -SampledPathElevationParams | Google Maps Services Node Client

    Interface SampledPathElevationParams

    interface SampledPathElevationParams {
        path: LatLng[];
        samples: number;
    }

    Properties

    path +SampledPathElevationParams | Google Maps Services Node Client

    Interface SampledPathElevationParams

    interface SampledPathElevationParams {
        path: LatLng[];
        samples: number;
    }

    Properties

    path samples

    Properties

    path

    path: LatLng[]

    defines a path on the earth for which to return elevation data. This parameter defines a set of two or more ordered pairs defining a path along the surface of the earth. This parameter must be used in conjunction with the samples parameter described below.

    -

    samples

    samples: number

    specifies the number of sample points along a path for which to return elevation data. +

    samples

    samples: number

    specifies the number of sample points along a path for which to return elevation data. The samples parameter divides the given path into an ordered set of equidistant points along the path.

    -

    Settings

    Member Visibility

    On This Page

    Properties
    +

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/interfaces/SnapToRoadsRequest.html b/interfaces/SnapToRoadsRequest.html index ad90e9fe9d..efe86c704f 100644 --- a/interfaces/SnapToRoadsRequest.html +++ b/interfaces/SnapToRoadsRequest.html @@ -1,4 +1,4 @@ -SnapToRoadsRequest | Google Maps Services Node Client

    Interface SnapToRoadsRequest

    interface SnapToRoadsRequest {
        params: { interpolate?: boolean; path: LatLng[] } & RequestParams;
    }

    Hierarchy

    • Partial<AxiosRequestConfig>
      • SnapToRoadsRequest

    Properties

    params +SnapToRoadsRequest | Google Maps Services Node Client

    Interface SnapToRoadsRequest

    interface SnapToRoadsRequest {
        params: { interpolate?: boolean; path: LatLng[] } & RequestParams;
    }

    Hierarchy

    • Partial<AxiosRequestConfig>
      • SnapToRoadsRequest

    Properties

    params

    Properties

    params

    params: { interpolate?: boolean; path: LatLng[] } & RequestParams

    Type declaration

    • Optionalinterpolate?: boolean

      Whether to interpolate a path to include all points forming the full road-geometry. When true, additional interpolated points will also be returned, resulting in a path that smoothly follows the geometry of the road, even around corners and through tunnels. @@ -14,4 +14,4 @@ To ensure the best snap-to-road quality, you should aim to provide paths on which consecutive pairs of points are within 300m of each other. This will also help in handling any isolated, long jumps between consecutive points caused by GPS signal loss, or noise.

      -

    Settings

    Member Visibility

    On This Page

    Properties
    +

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/interfaces/SnapToRoadsResponse.html b/interfaces/SnapToRoadsResponse.html index 1b2773f30c..aac19b452a 100644 --- a/interfaces/SnapToRoadsResponse.html +++ b/interfaces/SnapToRoadsResponse.html @@ -1,3 +1,3 @@ -SnapToRoadsResponse | Google Maps Services Node Client

    Interface SnapToRoadsResponse

    interface SnapToRoadsResponse {
        data: { snappedPoints: SnappedPoint[] };
    }

    Hierarchy

    • AxiosResponse
      • SnapToRoadsResponse

    Properties

    data +SnapToRoadsResponse | Google Maps Services Node Client

    Interface SnapToRoadsResponse

    interface SnapToRoadsResponse {
        data: { snappedPoints: SnappedPoint[] };
    }

    Hierarchy

    • AxiosResponse
      • SnapToRoadsResponse

    Properties

    data

    Properties

    data

    data: { snappedPoints: SnappedPoint[] }

    Type declaration

    Settings

    Member Visibility

    On This Page

    Properties
    +

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/interfaces/SnappedPoint.html b/interfaces/SnappedPoint.html index 0f105abf59..0fc3e4bee6 100644 --- a/interfaces/SnappedPoint.html +++ b/interfaces/SnappedPoint.html @@ -1,17 +1,17 @@ -SnappedPoint | Google Maps Services Node Client

    Interface SnappedPoint

    interface SnappedPoint {
        location: LatLngLiteralVerbose;
        originalIndex: number;
        placeId: string;
    }

    Properties

    location +SnappedPoint | Google Maps Services Node Client

    Interface SnappedPoint

    interface SnappedPoint {
        location: LatLngLiteralVerbose;
        originalIndex: number;
        placeId: string;
    }

    Properties

    location originalIndex placeId

    Properties

    location

    location: LatLngLiteralVerbose

    Contains a latitude and longitude value.

    -

    originalIndex

    originalIndex: number

    An integer that indicates the corresponding value in the original request. +

    originalIndex

    originalIndex: number

    An integer that indicates the corresponding value in the original request. Each point in the request maps to at most two segmentsin the response:

    • If there are no nearby roads, no segment is returned.
    • If the nearest road is one-way, one segment is returned.
    • If the nearest road is bidirectional, two segments are returned.
    -

    placeId

    placeId: string

    A unique identifier for a place. All place IDs returned by the Roads API correspond to road segments. +

    placeId

    placeId: string

    A unique identifier for a place. All place IDs returned by the Roads API correspond to road segments. Place IDs can be used with other Google APIs, including the Places SDK and the Maps JavaScript API. For example, if you need to get road names for the snapped points returned by the Roads API, you can pass the placeId to the Places SDK or the Geocoding API. Within the Roads API, you can pass the placeId in a speed limits request to determine the speed limit along that road segment.

    -

    Settings

    Member Visibility

    On This Page

    Properties
    +

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/interfaces/StructuredFormatting.html b/interfaces/StructuredFormatting.html index 8e6b9810e5..7afb4f754a 100644 --- a/interfaces/StructuredFormatting.html +++ b/interfaces/StructuredFormatting.html @@ -1,11 +1,11 @@ -StructuredFormatting | Google Maps Services Node Client

    Interface StructuredFormatting

    interface StructuredFormatting {
        main_text: string;
        main_text_matched_substrings: PredictionSubstring[];
        secondary_text: string;
        secondary_text_matched_substrings: PredictionSubstring[];
    }

    Properties

    main_text +StructuredFormatting | Google Maps Services Node Client

    Interface StructuredFormatting

    interface StructuredFormatting {
        main_text: string;
        main_text_matched_substrings: PredictionSubstring[];
        secondary_text: string;
        secondary_text_matched_substrings: PredictionSubstring[];
    }

    Properties

    main_text main_text_matched_substrings secondary_text secondary_text_matched_substrings

    Properties

    main_text

    main_text: string

    contains the main text of a prediction, usually the name of the place.

    -

    main_text_matched_substrings

    main_text_matched_substrings: PredictionSubstring[]

    contains an array with offset value and length. These describe the location of +

    main_text_matched_substrings

    main_text_matched_substrings: PredictionSubstring[]

    contains an array with offset value and length. These describe the location of the entered term in the prediction result text, so that the term can be highlighted if desired.

    -

    secondary_text

    secondary_text: string

    contains the secondary text of a prediction, usually the location of the place.

    -

    secondary_text_matched_substrings

    secondary_text_matched_substrings: PredictionSubstring[]

    contains an array with offset value and length. These describe the location of +

    secondary_text

    secondary_text: string

    contains the secondary text of a prediction, usually the location of the place.

    +

    secondary_text_matched_substrings

    secondary_text_matched_substrings: PredictionSubstring[]

    contains an array with offset value and length. These describe the location of the entered term in the prediction result secondary text, so that the term can be highlighted if desired.

    -

    Settings

    Member Visibility

    On This Page

    Properties
    +

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/interfaces/TextSearchRequest.html b/interfaces/TextSearchRequest.html index f225ccc006..382d4fcd07 100644 --- a/interfaces/TextSearchRequest.html +++ b/interfaces/TextSearchRequest.html @@ -1,4 +1,4 @@ -TextSearchRequest | Google Maps Services Node Client

    Interface TextSearchRequest

    interface TextSearchRequest {
        params: {
            language?: Language;
            location?: LatLng;
            maxprice?: number;
            minprice?: number;
            opennow?: boolean;
            pagetoken?: string;
            query: string;
            radius?: number;
            region?: string;
            type?: PlaceType1;
        } & RequestParams;
    }

    Hierarchy

    • Partial<AxiosRequestConfig>
      • TextSearchRequest

    Properties

    params +TextSearchRequest | Google Maps Services Node Client

    Interface TextSearchRequest

    interface TextSearchRequest {
        params: {
            language?: Language;
            location?: LatLng;
            maxprice?: number;
            minprice?: number;
            opennow?: boolean;
            pagetoken?: string;
            query: string;
            radius?: number;
            region?: string;
            type?: PlaceType1;
        } & RequestParams;
    }

    Hierarchy

    • Partial<AxiosRequestConfig>
      • TextSearchRequest

    Properties

    params

    Properties

    params

    params: {
        language?: Language;
        location?: LatLng;
        maxprice?: number;
        minprice?: number;
        opennow?: boolean;
        pagetoken?: string;
        query: string;
        radius?: number;
        region?: string;
        type?: PlaceType1;
    } & RequestParams

    Type declaration

    • Optionallanguage?: Language

      The language code, indicating in which language the results should be returned, if possible. Note that we often update supported languages so this list may not be exhaustive

    • Optionallocation?: LatLng

      The latitude/longitude around which to retrieve place information. @@ -32,4 +32,4 @@ for results in the specified region.

    • Optionaltype?: PlaceType1

      Restricts the results to places matching the specified type. Only one type may be specified (if more than one type is provided, all types following the first entry are ignored).

      -

    Settings

    Member Visibility

    On This Page

    Properties
    +

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/interfaces/TextSearchResponse.html b/interfaces/TextSearchResponse.html index ba172c2d8c..f675cdb6ea 100644 --- a/interfaces/TextSearchResponse.html +++ b/interfaces/TextSearchResponse.html @@ -1,2 +1,2 @@ -TextSearchResponse | Google Maps Services Node Client

    Interface TextSearchResponse

    interface TextSearchResponse {
        data: TextSearchResponseData;
    }

    Hierarchy

    • AxiosResponse
      • TextSearchResponse

    Properties

    data -

    Properties

    data

    data: TextSearchResponseData

    Settings

    Member Visibility

    On This Page

    Properties
    +TextSearchResponse | Google Maps Services Node Client

    Interface TextSearchResponse

    interface TextSearchResponse {
        data: TextSearchResponseData;
    }

    Hierarchy

    • AxiosResponse
      • TextSearchResponse

    Properties

    data +

    Properties

    data

    data: TextSearchResponseData

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/interfaces/TextSearchResponseData.html b/interfaces/TextSearchResponseData.html index ed2bbe6206..61e157de96 100644 --- a/interfaces/TextSearchResponseData.html +++ b/interfaces/TextSearchResponseData.html @@ -1,14 +1,14 @@ -TextSearchResponseData | Google Maps Services Node Client

    Interface TextSearchResponseData

    interface TextSearchResponseData {
        error_message: string;
        html_attributions?: string[];
        next_page_token?: string;
        results: Partial<PlaceData>[];
        status: Status;
    }

    Hierarchy (View Summary)

    Properties

    error_message +TextSearchResponseData | Google Maps Services Node Client

    Interface TextSearchResponseData

    interface TextSearchResponseData {
        error_message: string;
        html_attributions?: string[];
        next_page_token?: string;
        results: Partial<PlaceData>[];
        status: Status;
    }

    Hierarchy (View Summary)

    Properties

    error_message html_attributions? next_page_token? results status

    Properties

    error_message

    error_message: string

    When the top-level status code is other than OK, this field contains more detailed information about the reasons behind the given status code.

    -

    Optionalhtml_attributions

    html_attributions?: string[]

    may contain a set of attributions about this listing which must be displayed to the user (some listings may not have attribution).

    -

    Optionalnext_page_token

    next_page_token?: string

    contains a token that can be used to return up to 20 additional results. +

    Optionalhtml_attributions

    html_attributions?: string[]

    may contain a set of attributions about this listing which must be displayed to the user (some listings may not have attribution).

    +

    Optionalnext_page_token

    next_page_token?: string

    contains a token that can be used to return up to 20 additional results. A next_page_token will not be returned if there are no additional results to display. The maximum number of results that can be returned is 60. There is a short delay between when a next_page_token is issued, and when it will become valid.

    -

    results

    results: Partial<PlaceData>[]

    status

    status: Status

    contains metadata on the request. See Status Codes below.

    -

    Settings

    Member Visibility

    On This Page

    Properties
    +

    results

    results: Partial<PlaceData>[]

    status

    status: Status

    contains metadata on the request. See Status Codes below.

    +

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/interfaces/Time.html b/interfaces/Time.html index 427382b04e..9691291f67 100644 --- a/interfaces/Time.html +++ b/interfaces/Time.html @@ -1,8 +1,8 @@ -Time | Google Maps Services Node Client

    Interface Time

    interface Time {
        text: string;
        time_zone: string;
        value: Date;
    }

    Properties

    text +Time | Google Maps Services Node Client

    Interface Time

    interface Time {
        text: string;
        time_zone: string;
        value: Date;
    }

    Properties

    text time_zone value

    Properties

    text

    text: string

    the time specified as a string. The time is displayed in the time zone of the transit stop.

    -

    time_zone

    time_zone: string

    contains the time zone of this station. The value is the name of the time zone as defined in the +

    time_zone

    time_zone: string

    contains the time zone of this station. The value is the name of the time zone as defined in the IANA Time Zone Database, e.g. "America/New_York".

    -

    value

    value: Date

    the time specified as a JavaScript Date object.

    -

    Settings

    Member Visibility

    On This Page

    Properties
    +

    value

    value: Date

    the time specified as a JavaScript Date object.

    +

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/interfaces/TimeZoneRequest.html b/interfaces/TimeZoneRequest.html index a7634491b6..3cd8cbbaac 100644 --- a/interfaces/TimeZoneRequest.html +++ b/interfaces/TimeZoneRequest.html @@ -1,4 +1,4 @@ -TimeZoneRequest | Google Maps Services Node Client

    Interface TimeZoneRequest

    interface TimeZoneRequest {
        params: {
            language?: Language;
            location: LatLng;
            timestamp: number | Date;
        } & RequestParams;
    }

    Hierarchy

    • Partial<AxiosRequestConfig>
      • TimeZoneRequest

    Properties

    params +TimeZoneRequest | Google Maps Services Node Client

    Interface TimeZoneRequest

    interface TimeZoneRequest {
        params: {
            language?: Language;
            location: LatLng;
            timestamp: number | Date;
        } & RequestParams;
    }

    Hierarchy

    • Partial<AxiosRequestConfig>
      • TimeZoneRequest

    Properties

    params

    Properties

    params

    params: { language?: Language; location: LatLng; timestamp: number | Date } & RequestParams

    Type declaration

    • Optionallanguage?: Language

      The language in which to return results. Note that we often update supported languages so this list may not be exhaustive.

      Default

      Language.English
@@ -10,4 +10,4 @@
 based on the time zone of the location. Note that the API does not take historical time zones into account.
 That is, if you specify a past timestamp, the API does not take into account the possibility that
 the location was previously in a different time zone.
      
-

    Settings

    Member Visibility

    On This Page

    Properties
    +

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/interfaces/TimeZoneResponse.html b/interfaces/TimeZoneResponse.html index 39cbb5f8c3..cbc1c8db63 100644 --- a/interfaces/TimeZoneResponse.html +++ b/interfaces/TimeZoneResponse.html @@ -1,2 +1,2 @@ -TimeZoneResponse | Google Maps Services Node Client

    Interface TimeZoneResponse

    interface TimeZoneResponse {
        data: TimeZoneResponseData;
    }

    Hierarchy

    • AxiosResponse
      • TimeZoneResponse

    Properties

    data -

    Properties

    data

    data: TimeZoneResponseData

    Settings

    Member Visibility

    On This Page

    Properties
    +TimeZoneResponse | Google Maps Services Node Client

    Interface TimeZoneResponse

    interface TimeZoneResponse {
        data: TimeZoneResponseData;
    }

    Hierarchy

    • AxiosResponse
      • TimeZoneResponse

    Properties

    data +

    Properties

    data

    data: TimeZoneResponseData

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/interfaces/TimeZoneResponseData.html b/interfaces/TimeZoneResponseData.html index 58603a4091..cac2d1c42e 100644 --- a/interfaces/TimeZoneResponseData.html +++ b/interfaces/TimeZoneResponseData.html @@ -1,4 +1,4 @@ -TimeZoneResponseData | Google Maps Services Node Client

    Interface TimeZoneResponseData

    interface TimeZoneResponseData {
        dstOffset: number;
        error_message: string;
        html_attributions?: string[];
        next_page_token?: string;
        rawOffset: number;
        status: Status;
        timeZoneId: string;
        timeZoneName: string;
    }

    Hierarchy (View Summary)

    Properties

    dstOffset +TimeZoneResponseData | Google Maps Services Node Client

    Interface TimeZoneResponseData

    interface TimeZoneResponseData {
        dstOffset: number;
        error_message: string;
        html_attributions?: string[];
        next_page_token?: string;
        rawOffset: number;
        status: Status;
        timeZoneId: string;
        timeZoneName: string;
    }

    Hierarchy (View Summary)

    Properties

    dstOffset error_message html_attributions? next_page_token? @@ -8,21 +8,21 @@ timeZoneName

    Properties

    dstOffset

    dstOffset: number

    the offset for daylight-savings time in seconds. This will be zero if the time zone is not in Daylight Savings Time during the specified timestamp.

    -

    error_message

    error_message: string

    When the top-level status code is other than OK, this field contains more detailed information +

    error_message

    error_message: string

    When the top-level status code is other than OK, this field contains more detailed information about the reasons behind the given status code.

    -

    Optionalhtml_attributions

    html_attributions?: string[]

    may contain a set of attributions about this listing which must be displayed to the user (some listings may not have attribution).

    -

    Optionalnext_page_token

    next_page_token?: string

    contains a token that can be used to return up to 20 additional results. +

    Optionalhtml_attributions

    html_attributions?: string[]

    may contain a set of attributions about this listing which must be displayed to the user (some listings may not have attribution).

    +

    Optionalnext_page_token

    next_page_token?: string

    contains a token that can be used to return up to 20 additional results. A next_page_token will not be returned if there are no additional results to display. The maximum number of results that can be returned is 60. There is a short delay between when a next_page_token is issued, and when it will become valid.

    -

    rawOffset

    rawOffset: number

    the offset from UTC (in seconds) for the given location. This does not take into effect daylight savings.

    -

    status

    status: Status

    contains metadata on the request. See Status Codes below.

    -

    timeZoneId

    timeZoneId: string

    a string containing the ID of the time zone, such as "America/Los_Angeles" or "Australia/Sydney". +

    rawOffset

    rawOffset: number

    the offset from UTC (in seconds) for the given location. This does not take into effect daylight savings.

    +

    status

    status: Status

    contains metadata on the request. See Status Codes below.

    +

    timeZoneId

    timeZoneId: string

    a string containing the ID of the time zone, such as "America/Los_Angeles" or "Australia/Sydney". These IDs are defined by Unicode Common Locale Data Repository (CLDR) project, and currently available in file timezone.xml. When a timezone has several IDs, the canonical one is returned. In timezone.xml, this is the first alias of each timezone. For example, "Asia/Calcutta" is returned, not "Asia/Kolkata".

    -

    timeZoneName

    timeZoneName: string

    a string containing the long form name of the time zone. +

    timeZoneName

    timeZoneName: string

    a string containing the long form name of the time zone. This field will be localized if the language parameter is set. eg. "Pacific Daylight Time" or "Australian Eastern Daylight Time"

    -

    Settings

    Member Visibility

    On This Page

    Properties
    +

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/interfaces/TransitAgency.html b/interfaces/TransitAgency.html index c48beb16b9..988f3c3e2d 100644 --- a/interfaces/TransitAgency.html +++ b/interfaces/TransitAgency.html @@ -1,8 +1,8 @@ TransitAgency | Google Maps Services Node Client

    Interface TransitAgency

    You must display the names and URLs of the transit agencies servicing the trip results.

    -
    interface TransitAgency {
        name: string;
        phone: string;
        url: string;
    }

    Properties

    name +
    interface TransitAgency {
        name: string;
        phone: string;
        url: string;
    }

    Properties

    name phone url

    Properties

    name

    name: string

    contains the name of the transit agency.

    -

    phone

    phone: string

    contains the phone number of the transit agency.

    -

    url

    url: string

    contains the URL for the transit agency.

    -

    Settings

    Member Visibility

    On This Page

    Properties
    +

    phone

    phone: string

    contains the phone number of the transit agency.

    +

    url

    url: string

    contains the URL for the transit agency.

    +

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/interfaces/TransitDetails.html b/interfaces/TransitDetails.html index 945cb79fe0..20eef24a73 100644 --- a/interfaces/TransitDetails.html +++ b/interfaces/TransitDetails.html @@ -1,7 +1,7 @@ TransitDetails | Google Maps Services Node Client

    Interface TransitDetails

    Transit directions return additional information that is not relevant for other modes of transportation. These additional properties are exposed through the transit_details object, returned as a field of an element in the steps[] array. From the TransitDetails object you can access additional information about the transit stop, transit line and transit agency

    -
    interface TransitDetails {
        arrival_stop: TransitStop;
        arrival_time: Time;
        departure_stop: TransitStop;
        departure_time: Time;
        headsign: string;
        headway: number;
        line: TransitLine;
        num_stops: number;
    }

    Properties

    arrival_stop +
    interface TransitDetails {
        arrival_stop: TransitStop;
        arrival_time: Time;
        departure_stop: TransitStop;
        departure_time: Time;
        headsign: string;
        headway: number;
        line: TransitLine;
        num_stops: number;
    }

    Properties

    arrival_stop arrival_time departure_stop departure_time @@ -10,15 +10,15 @@ line num_stops

    Properties

    arrival_stop

    arrival_stop: TransitStop

    contains information about the stop for this part of the trip.

    -

    arrival_time

    arrival_time: Time

    contain the arrival time for this leg of the journey.

    -

    departure_stop

    departure_stop: TransitStop

    contains information about the station for this part of the trip.

    -

    departure_time

    departure_time: Time

    contain the departure time for this leg of the journey.

    -

    headsign

    headsign: string

    specifies the direction in which to travel on this line, as it is marked on the vehicle or at the departure stop. +

    arrival_time

    arrival_time: Time

    contain the arrival time for this leg of the journey.

    +

    departure_stop

    departure_stop: TransitStop

    contains information about the station for this part of the trip.

    +

    departure_time

    departure_time: Time

    contain the departure time for this leg of the journey.

    +

    headsign

    headsign: string

    specifies the direction in which to travel on this line, as it is marked on the vehicle or at the departure stop. This will often be the terminus station.

    -

    headway

    headway: number

    specifies the expected number of seconds between departures from the same stop at this time. +

    headway

    headway: number

    specifies the expected number of seconds between departures from the same stop at this time. For example, with a headway value of 600, you would expect a ten minute wait if you should miss your bus.

    -

    line

    line: TransitLine

    contains information about the transit line used in this step.

    -

    num_stops

    num_stops: number

    contains the number of stops in this step, counting the arrival stop, but not the departure stop. +

    line

    line: TransitLine

    contains information about the transit line used in this step.

    +

    num_stops

    num_stops: number

    contains the number of stops in this step, counting the arrival stop, but not the departure stop. For example, if your directions involve leaving from Stop A, passing through stops B and C, and arriving at stop D, num_stops will return 3.

    -

    Settings

    Member Visibility

    On This Page

    Properties
    +

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/interfaces/TransitFare.html b/interfaces/TransitFare.html index 32bb595840..d5a90488c4 100644 --- a/interfaces/TransitFare.html +++ b/interfaces/TransitFare.html @@ -1,7 +1,7 @@ -TransitFare | Google Maps Services Node Client

    Interface TransitFare

    interface TransitFare {
        currency: string;
        text: string;
        value: number;
    }

    Properties

    currency +TransitFare | Google Maps Services Node Client

    Interface TransitFare

    interface TransitFare {
        currency: string;
        text: string;
        value: number;
    }

    Properties

    currency text value

    Properties

    currency

    currency: string

    An ISO 4217 currency code indicating the currency that the amount is expressed in.

    -

    text

    text: string

    The total fare amount, formatted in the requested language.

    -

    value

    value: number

    The total fare amount, in the currency specified above.

    -

    Settings

    Member Visibility

    On This Page

    Properties
    +

    text

    text: string

    The total fare amount, formatted in the requested language.

    +

    value

    value: number

    The total fare amount, in the currency specified above.

    +

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/interfaces/TransitLine.html b/interfaces/TransitLine.html index 996b2006b0..0b47850f7b 100644 --- a/interfaces/TransitLine.html +++ b/interfaces/TransitLine.html @@ -1,4 +1,4 @@ -TransitLine | Google Maps Services Node Client

    Interface TransitLine

    interface TransitLine {
        agencies: TransitAgency[];
        color: string;
        icon: string;
        name: string;
        short_name: string;
        text_color: string;
        url: string;
        vehicle: TransitVehicle;
    }

    Properties

    agencies +TransitLine | Google Maps Services Node Client

    Interface TransitLine

    interface TransitLine {
        agencies: TransitAgency[];
        color: string;
        icon: string;
        name: string;
        short_name: string;
        text_color: string;
        url: string;
        vehicle: TransitVehicle;
    }

    Properties

    agencies color icon name @@ -8,11 +8,11 @@ vehicle

    Properties

    agencies

    agencies: TransitAgency[]

    is an array containing a single TransitAgency object. The TransitAgency object provides information about the operator of the line

    -

    color

    color: string

    contains the color commonly used in signage for this transit line. The color will be specified as a hex string such as: #FF0033.

    -

    icon

    icon: string

    contains the URL for the icon associated with this line.

    -

    name

    name: string

    contains the full name of this transit line. eg. "7 Avenue Express".

    -

    short_name

    short_name: string

    contains the short name of this transit line. This will normally be a line number, such as "M7" or "355".

    -

    text_color

    text_color: string

    contains the color of text commonly used for signage of this line. The color will be specified as a hex string.

    -

    url

    url: string

    contains the URL for this transit line as provided by the transit agency.

    -

    vehicle

    vehicle: TransitVehicle

    contains the type of vehicle used on this line.

    -

    Settings

    Member Visibility

    On This Page

    Properties
    +

    color

    color: string

    contains the color commonly used in signage for this transit line. The color will be specified as a hex string such as: #FF0033.

    +

    icon

    icon: string

    contains the URL for the icon associated with this line.

    +

    name

    name: string

    contains the full name of this transit line. eg. "7 Avenue Express".

    +

    short_name

    short_name: string

    contains the short name of this transit line. This will normally be a line number, such as "M7" or "355".

    +

    text_color

    text_color: string

    contains the color of text commonly used for signage of this line. The color will be specified as a hex string.

    +

    url

    url: string

    contains the URL for this transit line as provided by the transit agency.

    +

    vehicle

    vehicle: TransitVehicle

    contains the type of vehicle used on this line.

    +

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/interfaces/TransitStop.html b/interfaces/TransitStop.html index fdbb75d283..785b96b10c 100644 --- a/interfaces/TransitStop.html +++ b/interfaces/TransitStop.html @@ -1,5 +1,5 @@ -TransitStop | Google Maps Services Node Client

    Interface TransitStop

    interface TransitStop {
        location: LatLngLiteral;
        name: string;
    }

    Properties

    location +TransitStop | Google Maps Services Node Client

    Interface TransitStop

    interface TransitStop {
        location: LatLngLiteral;
        name: string;
    }

    Properties

    location name

    Properties

    location

    location: LatLngLiteral

    the location of the transit station/stop, represented as a lat and lng field.

    -

    name

    name: string

    the name of the transit station/stop. eg. "Union Square".

    -

    Settings

    Member Visibility

    On This Page

    Properties
    +

    name

    name: string

    the name of the transit station/stop. eg. "Union Square".

    +

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/interfaces/TransitVehicle.html b/interfaces/TransitVehicle.html index 356837f632..db612a197f 100644 --- a/interfaces/TransitVehicle.html +++ b/interfaces/TransitVehicle.html @@ -1,9 +1,9 @@ -TransitVehicle | Google Maps Services Node Client

    Interface TransitVehicle

    interface TransitVehicle {
        icon: string;
        local_icon: string;
        name: string;
        type: VehicleType;
    }

    Properties

    icon +TransitVehicle | Google Maps Services Node Client

    Interface TransitVehicle

    interface TransitVehicle {
        icon: string;
        local_icon: string;
        name: string;
        type: VehicleType;
    }

    Properties

    icon local_icon name type

    Properties

    icon

    icon: string

    contains the URL for an icon associated with this vehicle type.

    -

    local_icon

    local_icon: string

    contains the URL for the icon associated with this vehicle type, based on the local transport signage.

    -

    name

    name: string

    contains the name of the vehicle on this line. eg. "Subway.".

    -

    type

    type: VehicleType

    contains the type of vehicle that runs on this line.

    -

    Settings

    Member Visibility

    On This Page

    Properties
    +

    local_icon

    local_icon: string

    contains the URL for the icon associated with this vehicle type, based on the local transport signage.

    +

    name

    name: string

    contains the name of the vehicle on this line. eg. "Subway.".

    +

    type

    type: VehicleType

    contains the type of vehicle that runs on this line.

    +

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/interfaces/WifiAccessPoint.html b/interfaces/WifiAccessPoint.html index 44ad5600d3..4cb046b86f 100644 --- a/interfaces/WifiAccessPoint.html +++ b/interfaces/WifiAccessPoint.html @@ -1,11 +1,11 @@ -WifiAccessPoint | Google Maps Services Node Client

    Interface WifiAccessPoint

    interface WifiAccessPoint {
        age?: number;
        channel?: number;
        macAddress: string;
        signalStrength?: number;
        signalToNoiseRatio?: number;
    }

    Properties

    age? +WifiAccessPoint | Google Maps Services Node Client

    Interface WifiAccessPoint

    interface WifiAccessPoint {
        age?: number;
        channel?: number;
        macAddress: string;
        signalStrength?: number;
        signalToNoiseRatio?: number;
    }

    Properties

    age? channel? macAddress signalStrength? signalToNoiseRatio?

    Properties

    Optionalage

    age?: number

    The number of milliseconds since this access point was detected.

    -

    Optionalchannel

    channel?: number

    The channel over which the client is communicating with the acces.

    -

    macAddress

    macAddress: string

    The MAC address of the WiFi node. It's typically called a BSS, BSSID or MAC address. Separators must be : (colon).

    -

    OptionalsignalStrength

    signalStrength?: number

    The current signal strength measured in dBm.

    -

    OptionalsignalToNoiseRatio

    signalToNoiseRatio?: number

    The current signal to noise ratio measured in dB.

    -

    Settings

    Member Visibility

    On This Page

    Properties
    +

    Optionalchannel

    channel?: number

    The channel over which the client is communicating with the acces.

    +

    macAddress

    macAddress: string

    The MAC address of the WiFi node. It's typically called a BSS, BSSID or MAC address. Separators must be : (colon).

    +

    OptionalsignalStrength

    signalStrength?: number

    The current signal strength measured in dBm.

    +

    OptionalsignalToNoiseRatio

    signalToNoiseRatio?: number

    The current signal to noise ratio measured in dB.

    +

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/types/AddressType.html b/types/AddressType.html index 3ecb4c9811..69eac0e367 100644 --- a/types/AddressType.html +++ b/types/AddressType.html @@ -1 +1 @@ -AddressType | Google Maps Services Node Client

    Type Alias AddressType

    AddressType: PlaceType1 | PlaceType2

    Settings

    Member Visibility
    +AddressType | Google Maps Services Node Client

    Type Alias AddressType

    AddressType: PlaceType1 | PlaceType2

    Settings

    Member Visibility
    diff --git a/types/Config.html b/types/Config.html index f67214ad11..d010d0a1d1 100644 --- a/types/Config.html +++ b/types/Config.html @@ -1 +1 @@ -Config | Google Maps Services Node Client

    Type Alias Config

    Config: { raxConfig?: rax.RetryConfig } & AxiosRequestConfig

    Settings

    Member Visibility
    +Config | Google Maps Services Node Client

    Type Alias Config

    Config: { raxConfig?: rax.RetryConfig } & AxiosRequestConfig

    Settings

    Member Visibility
    diff --git a/types/GeolocateResponse.html b/types/GeolocateResponse.html index 76f8ce6deb..ee245f8b91 100644 --- a/types/GeolocateResponse.html +++ b/types/GeolocateResponse.html @@ -1 +1 @@ -GeolocateResponse | Google Maps Services Node Client

    Type Alias GeolocateResponse

    GeolocateResponse: GeolocateResponseSuccess | GeolocateResponseError

    Settings

    Member Visibility
    +GeolocateResponse | Google Maps Services Node Client

    Type Alias GeolocateResponse

    GeolocateResponse: GeolocateResponseSuccess | GeolocateResponseError

    Settings

    Member Visibility
    diff --git a/types/LatLng.html b/types/LatLng.html index d2e716ad5a..a6fadd9409 100644 --- a/types/LatLng.html +++ b/types/LatLng.html @@ -5,4 +5,4 @@
  • an object with 'lat', 'lng' properties; or
  • an object with 'latitude', 'longitude' properties.
    • -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/types/LatLngArray.html b/types/LatLngArray.html index ad61437aa7..e9fe60497c 100644 --- a/types/LatLngArray.html +++ b/types/LatLngArray.html @@ -1 +1 @@ -LatLngArray | Google Maps Services Node Client

    Type Alias LatLngArray

    LatLngArray: [number, number]

    Settings

    Member Visibility
    +LatLngArray | Google Maps Services Node Client

    Type Alias LatLngArray

    LatLngArray: [number, number]

    Settings

    Member Visibility
    diff --git a/types/LatLngString.html b/types/LatLngString.html index a6d87dc5b3..ac6bd484cd 100644 --- a/types/LatLngString.html +++ b/types/LatLngString.html @@ -1 +1 @@ -LatLngString | Google Maps Services Node Client

    Type Alias LatLngString

    LatLngString: string

    Settings

    Member Visibility
    +LatLngString | Google Maps Services Node Client

    Type Alias LatLngString

    LatLngString: string

    Settings

    Member Visibility
    diff --git a/types/Place.html b/types/Place.html index 876f3adc03..0a22e6b8a3 100644 --- a/types/Place.html +++ b/types/Place.html @@ -1 +1 @@ -Place | Google Maps Services Node Client

    Type Alias Place

    Place: Partial<PlaceData>

    Settings

    Member Visibility
    +Place | Google Maps Services Node Client

    Type Alias Place

    Place: Partial<PlaceData>

    Settings

    Member Visibility
    diff --git a/types/RequestParams.html b/types/RequestParams.html index 3a7b5b5b92..0b944516f9 100644 --- a/types/RequestParams.html +++ b/types/RequestParams.html @@ -9,4 +9,4 @@ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

    -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/variables/AddressType-1.html b/variables/AddressType-1.html index c128bbefcd..bc912c9cb4 100644 --- a/variables/AddressType-1.html +++ b/variables/AddressType-1.html @@ -1 +1 @@ -AddressType | Google Maps Services Node Client

    Variable AddressTypeConst

    AddressType: typeof PlaceType1 & typeof PlaceType2 = ...

    Settings

    Member Visibility
    +AddressType | Google Maps Services Node Client

    Variable AddressTypeConst

    AddressType: typeof PlaceType1 & typeof PlaceType2 = ...

    Settings

    Member Visibility
    diff --git a/variables/X_GOOG_MAPS_EXPERIENCE_ID.html b/variables/X_GOOG_MAPS_EXPERIENCE_ID.html index 9825e9f139..7a755529e8 100644 --- a/variables/X_GOOG_MAPS_EXPERIENCE_ID.html +++ b/variables/X_GOOG_MAPS_EXPERIENCE_ID.html @@ -1 +1 @@ -X_GOOG_MAPS_EXPERIENCE_ID | Google Maps Services Node Client

    Variable X_GOOG_MAPS_EXPERIENCE_IDConst

    X_GOOG_MAPS_EXPERIENCE_ID: "X-GOOG-MAPS-EXPERIENCE-ID"

    Settings

    Member Visibility
    +X_GOOG_MAPS_EXPERIENCE_ID | Google Maps Services Node Client

    Variable X_GOOG_MAPS_EXPERIENCE_IDConst

    X_GOOG_MAPS_EXPERIENCE_ID: "X-GOOG-MAPS-EXPERIENCE-ID"

    Settings

    Member Visibility
    diff --git a/variables/acceptEncoding.html b/variables/acceptEncoding.html index eec068b2c6..ffac14a79f 100644 --- a/variables/acceptEncoding.html +++ b/variables/acceptEncoding.html @@ -1 +1 @@ -acceptEncoding | Google Maps Services Node Client

    Variable acceptEncodingConst

    acceptEncoding: "gzip"

    Settings

    Member Visibility
    +acceptEncoding | Google Maps Services Node Client

    Variable acceptEncodingConst

    acceptEncoding: "gzip"

    Settings

    Member Visibility
    diff --git a/variables/defaultHttpsAgent.html b/variables/defaultHttpsAgent.html index b59c9a8be4..5e48c1c1fb 100644 --- a/variables/defaultHttpsAgent.html +++ b/variables/defaultHttpsAgent.html @@ -1 +1 @@ -defaultHttpsAgent | Google Maps Services Node Client

    Variable defaultHttpsAgentConst

    defaultHttpsAgent: HttpsAgent = ...

    Settings

    Member Visibility
    +defaultHttpsAgent | Google Maps Services Node Client

    Variable defaultHttpsAgentConst

    defaultHttpsAgent: HttpsAgent = ...

    Settings

    Member Visibility
    diff --git a/variables/defaultTimeout.html b/variables/defaultTimeout.html index d6387856ec..0058ea0341 100644 --- a/variables/defaultTimeout.html +++ b/variables/defaultTimeout.html @@ -1 +1 @@ -defaultTimeout | Google Maps Services Node Client

    Variable defaultTimeoutConst

    defaultTimeout: 10000

    Settings

    Member Visibility
    +defaultTimeout | Google Maps Services Node Client

    Variable defaultTimeoutConst

    defaultTimeout: 10000

    Settings

    Member Visibility
    diff --git a/variables/userAgent.html b/variables/userAgent.html index cfca86d19e..8fa92a2dca 100644 --- a/variables/userAgent.html +++ b/variables/userAgent.html @@ -1 +1 @@ -userAgent | Google Maps Services Node Client

    Variable userAgentConst

    userAgent: string = ...

    Settings

    Member Visibility
    +userAgent | Google Maps Services Node Client

    Variable userAgentConst

    userAgent: string = ...

    Settings

    Member Visibility
    diff --git a/variables/version.html b/variables/version.html index 4bc72bb04e..9886d1ba5a 100644 --- a/variables/version.html +++ b/variables/version.html @@ -1 +1 @@ -version | Google Maps Services Node Client

    Variable versionConst

    version: any = ...

    Settings

    Member Visibility
    +version | Google Maps Services Node Client

    Variable versionConst

    version: any = ...

    Settings

    Member Visibility