New pricing changes went into effect on July 16, 2018. For more information, check out the Guide for Existing Users.

Places Autocomplete Service

AutocompleteService class

google.maps.places.AutocompleteService class

Contains methods related to retrieving Autocomplete predictions.

Library

places

Constructor
AutocompleteService
AutocompleteService()
Parameters:  None
Creates a new instance of the AutocompleteService.
Methods
getPlacePredictions
getPlacePredictions(request, callback)
Parameters: 
Return Value:  None
Retrieves place autocomplete predictions based on the supplied autocomplete request.
getQueryPredictions
getQueryPredictions(request, callback)
Parameters: 
Return Value:  None
Retrieves query autocomplete predictions based on the supplied query autocomplete request.

AutocompletionRequest interface

google.maps.places.AutocompletionRequest interface

An Autocompletion request to be sent to AutocompleteService.getPlacePredictions.

Library

places

Properties
bounds
Bounds for prediction biasing. Predictions will be biased towards, but not restricted to, the given bounds. Both location and radius will be ignored if bounds is set.
componentRestrictions
The component restrictions. Component restrictions are used to restrict predictions to only those within the parent component. For example, the country.
input
Type:  string
The user entered input string.
location
Type:  LatLng
Location for prediction biasing. Predictions will be biased towards the given location and radius. Alternatively, bounds can be used.
offset
Type:  number
The character position in the input term at which the service uses text for predictions (the position of the cursor in the input field).
radius
Type:  number
The radius of the area used for prediction biasing. The radius is specified in meters, and must always be accompanied by a location property. Alternatively, bounds can be used.
sessionToken
Unique reference used to bundle individual requests into sessions.
types
Type:  Array<string>
The types of predictions to be returned. For a list of supported types, see the developer's guide. If nothing is specified, all types are returned. In general only a single type is allowed. The exception is that you can safely mix the 'geocode' and 'establishment' types, but note that this will have the same effect as specifying no types.

QueryAutocompletionRequest interface

google.maps.places.QueryAutocompletionRequest interface

An QueryAutocompletion request to be sent to the QueryAutocompleteService.

Library

places

Properties
bounds
Bounds for prediction biasing. Predictions will be biased towards, but not restricted to, the given bounds. Both location and radius will be ignored if bounds is set.
input
Type:  string
The user entered input string.
location
Type:  LatLng
Location for prediction biasing. Predictions will be biased towards the given location and radius. Alternatively, bounds can be used.
offset
Type:  number
The character position in the input term at which the service uses text for predictions (the position of the cursor in the input field).
radius
Type:  number
The radius of the area used for prediction biasing. The radius is specified in meters, and must always be accompanied by a location property. Alternatively, bounds can be used.

AutocompleteSessionToken class

google.maps.places.AutocompleteSessionToken class

Represents a session token used for tracking an autocomplete session, which can be a series of AutocompleteService.getPlacePredictions calls followed by a single PlacesService.getDetails call.

Library

places

Constructor
AutocompleteSessionToken
AutocompleteSessionToken()
Parameters:  None
Creates a new instance of AutocompleteSessionToken.

ComponentRestrictions interface

google.maps.places.ComponentRestrictions interface

Defines the component restrictions that can be used with the autocomplete service.

Library

places

Properties
country
Type:  string|Array<string>
Restricts predictions to the specified country (ISO 3166-1 Alpha-2 country code, case insensitive). For example, 'us', 'br', or 'au'. You can provide a single one, or an array of up to five country code strings.

AutocompletePrediction interface

google.maps.places.AutocompletePrediction interface

Represents a single autocomplete prediction.

Library

places

Properties
description
Type:  string
This is the unformatted version of the query suggested by the Places service.
matched_substrings
Type:  Array<PredictionSubstring>
A set of substrings in the place's description that match elements in the user's input, suitable for use in highlighting those substrings. Each substring is identified by an offset and a length, expressed in unicode characters.
place_id
Type:  string
A place ID that can be used to retrieve details about this place using the place details service (see PlacesService.getDetails).
structured_formatting
Structured information about the place's description, divided into a main text and a secondary text, including an array of matched substrings from the autocomplete input, identified by an offset and a length, expressed in unicode characters.
terms
Type:  Array<PredictionTerm>
Information about individual terms in the above description, from most to least specific. For example, "Taco Bell", "Willitis", and "CA".
types
Type:  Array<string>
An array of types that the prediction belongs to, for example 'establishment' or 'geocode'.

QueryAutocompletePrediction interface

google.maps.places.QueryAutocompletePrediction interface

Represents a single Query Autocomplete prediction.

Library

places

Properties
description
Type:  string
This is the unformatted version of the query suggested by the Places service.
matched_substrings
Type:  Array<PredictionSubstring>
A set of substrings in the place's description that match elements in the user's input, suitable for use in highlighting those substrings. Each substring is identified by an offset and a length, expressed in unicode characters.
place_id
Type:  string
Only available if prediction is a place. A place ID that can be used to retrieve details about this place using the place details service (see PlacesService.getDetails).
terms
Type:  Array<PredictionTerm>
Information about individual terms in the above description. Categorical terms come first (for example, "restaurant"). Address terms appear from most to least specific. For example, "San Francisco", and "CA".

PredictionTerm interface

google.maps.places.PredictionTerm interface

Represents a prediction term.

Library

places

Properties
offset
Type:  number
The offset, in unicode characters, of the start of this term in the description of the place.
value
Type:  string
The value of this term, for example, "Taco Bell".

PredictionSubstring interface

google.maps.places.PredictionSubstring interface

Represents a prediction substring.

Library

places

Properties
length
Type:  number
The length of the substring.
offset
Type:  number
The offset to the substring's start within the description string.

StructuredFormatting interface

google.maps.places.StructuredFormatting interface

Contains structured information about the place's description, divided into a main text and a secondary text, including an array of matched substrings from the autocomplete input, identified by an offset and a length, expressed in unicode characters.

Library

places

Properties
main_text
Type:  string
This is the main text part of the unformatted description of the place suggested by the Places service. Usually the name of the place.
main_text_matched_substrings
Type:  Array<PredictionSubstring>
A set of substrings in the main text that match elements in the user's input, suitable for use in highlighting those substrings. Each substring is identified by an offset and a length, expressed in unicode characters.
secondary_text
Type:  string
This is the secondary text part of the unformatted description of the place suggested by the Places service. Usually the location of the place.

Send feedback about...

Maps JavaScript API
Need help? Visit our support page.