Places Autocomplete Service

Restez organisé à l'aide des collections Enregistrez et classez les contenus selon vos préférences.

Classe AutocompleteService

Classe google.maps.places.AutocompleteService

Contient des méthodes liées à la récupération des prédictions de la saisie semi-automatique.

Chargez à l'aide du paramètre d'URL &libraries=places. Consultez Bibliothèques dans l'API Maps JavaScript.

Lorsque vous utilisez v=beta, vous pouvez y accéder en appelant const {AutocompleteService} = await google.map.importLibrary("places"). Consultez Bibliothèques dans l'API Maps JavaScript.

AutocompleteService
AutocompleteService()
Paramètres : aucun
Crée une instance de AutocompleteService.
getPlacePredictions
getPlacePredictions(request[, callback])
Paramètres:
Valeur renvoyée : Promise<AutocompleteResponse>
Récupère les prédictions de saisie semi-automatique de lieux en fonction de la requête de saisie semi-automatique fournie.
getQueryPredictions
getQueryPredictions(request, callback)
Paramètres :
Valeur de retour:aucune
Récupère les prédictions de la saisie semi-automatique de requête en fonction de la requête fournie.

Interface AutocompletionRequest

google.maps.places.AutocompletionRequest interface

Une requête de saisie semi-automatique à envoyer à AutocompleteService.getPlacePredictions.

Chargez à l'aide du paramètre d'URL &libraries=places. Consultez Bibliothèques dans l'API Maps JavaScript.

input
Type : string
L'utilisateur a saisi une chaîne d'entrée.
bounds optional
Limites pour la pondération des prédictions. Les prédictions seront biaisées, sans s'y limiter, pour l'élément bounds donné. location et radius seront ignorés si bounds est défini.
componentRestrictions optional
Type : ComponentRestrictions optional
Restrictions des composants. Les restrictions du composant permettent de limiter les prédictions à celles du composant parent. Par exemple, le pays.
language optional
Type:string optional
Identifiant de la langue dans laquelle les résultats doivent être affichés, si possible. Il se peut que les résultats soient classés dans la langue sélectionnée, mais qu'ils ne soient pas limités à cette langue. Consultez la liste des langues disponibles.
location optional
Type:LatLng optional
Emplacement pour la pondération des prédictions. Les prédictions seront biaisées en fonction des location et radius indiqués. Vous pouvez également utiliser bounds.
offset optional
Type : number optional
Position du caractère dans le terme saisi où le service utilise du texte pour les prédictions (position du curseur dans le champ de saisie).
origin optional
Type : LatLng|LatLngLiteral optional
radius optional
Type:number optional
Rayon de la zone utilisée pour la pondération des prédictions. Le radius est spécifié en mètres et doit toujours être accompagné d'une propriété location. Vous pouvez également utiliser bounds.
region optional
Type : string optional
Code de région utilisé pour le formatage et le filtrage des résultats. Il ne limite pas les suggestions à ce pays. Le code de région accepte une valeur ccTLD ("domaine de premier niveau") à deux caractères. La plupart des codes ccTLD sont identiques aux codes ISO 3166-1, à quelques exceptions près. Par exemple, le ccTLD du Royaume-Uni est "uk" (.co.uk) alors que son code ISO 3166-1 est "gb" (techniquement pour l'entité "Royaume-Uni de Grande-Bretagne et d'Irlande du Nord").
sessionToken optional
Type : AutocompleteSessionToken optional
Référence unique utilisée pour regrouper les requêtes individuelles en sessions.
types optional
Type : Array<string> optional
Types de prédictions à renvoyer. Pour connaître les types compatibles, consultez le guide du développeur. Si aucun type n'est spécifié, tous les types sont renvoyés.

Interface AutocompleteResponse

google.maps.places.AutocompleteResponse interface

Une réponse Autocomplete renvoyée par l'appel de AutocompleteService.getPlacePredictions contenant une liste de AutocompletePrediction.

Chargez à l'aide du paramètre d'URL &libraries=places. Consultez Bibliothèques dans l'API Maps JavaScript.

predictions

Interface QueryAutocompletionRequest

google.maps.places.QueryAutocompletionRequest interface

Requête QueryAutocompletion à envoyer à QueryAutocompleteService.

Chargez à l'aide du paramètre d'URL &libraries=places. Consultez Bibliothèques dans l'API Maps JavaScript.

input
Type:string
L'utilisateur a saisi une chaîne d'entrée.
bounds optional
Limites pour la pondération des prédictions. Les prédictions seront biaisées, sans s'y limiter, pour l'élément bounds donné. location et radius seront ignorés si bounds est défini.
location optional
Type:LatLng optional
Emplacement pour la pondération des prédictions. Les prédictions seront biaisées en fonction des location et radius indiqués. Vous pouvez également utiliser bounds.
offset optional
Type:number optional
Position du caractère dans le terme saisi où le service utilise du texte pour les prédictions (position du curseur dans le champ de saisie).
radius optional
Type : number optional
Rayon de la zone utilisée pour la pondération des prédictions. Le radius est spécifié en mètres et doit toujours être accompagné d'une propriété location. Vous pouvez également utiliser bounds.

Classe AutocompleteSessionToken

Classe google.maps.places.AutocompleteSessionToken

Représente un jeton de session utilisé pour le suivi d'une session de saisie semi-automatique, qui peut être une série d'appels AutocompleteService.getPlacePredictions suivis d'un seul appel PlacesService.getDetails.

Chargez à l'aide du paramètre d'URL &libraries=places. Consultez Bibliothèques dans l'API Maps JavaScript.

Lorsque vous utilisez v=beta, vous pouvez y accéder en appelant const {AutocompleteSessionToken} = await google.map.importLibrary("places"). Consultez Bibliothèques dans l'API Maps JavaScript.

AutocompleteSessionToken
AutocompleteSessionToken()
Paramètres:aucun
Crée une instance de AutocompleteSessionToken.

ComponentRestrictions.

google.maps.places.ComponentRestrictions interface

Définit les restrictions de composant pouvant être utilisées avec le service de saisie semi-automatique.

Chargez à l'aide du paramètre d'URL &libraries=places. Consultez Bibliothèques dans l'API Maps JavaScript.

country optional
Type:string|Array<string> optional
Limite les prédictions au pays spécifié (code de pays ISO 3166-1 Alpha-2, non sensible à la casse). Par exemple, 'us', 'br' ou 'au'. Vous pouvez fournir une seule chaîne ou un tableau comportant jusqu'à cinq chaînes de codes pays.

Interface AutocompletePrediction

google.maps.places.AutocompletePrediction interface

Représente une seule prédiction de saisie semi-automatique.

Chargez à l'aide du paramètre d'URL &libraries=places. Consultez Bibliothèques dans l'API Maps JavaScript.

description
Type:string
Il s'agit de la version non formatée de la requête suggérée par le service Places.
matched_substrings
Ensemble de sous-chaînes dans la description du lieu correspondant aux éléments de l'entrée utilisateur, adaptés pour mettre en évidence ces sous-chaînes. Chaque sous-chaîne est identifiée par un décalage et une longueur, exprimés en caractères Unicode.
place_id
Type:string
ID de lieu pouvant être utilisé pour extraire des informations sur ce lieu à l'aide du service Place Details (voir PlacesService.getDetails).
structured_formatting
Informations structurées sur la description du lieu, divisées en texte principal et texte secondaire, y compris un tableau de sous-chaînes correspondantes issues de l'entrée de saisie semi-automatique, identifiées par un décalage et une longueur, exprimées en caractères Unicode.
terms
Informations sur les termes individuels dans la description ci-dessus, de la plus spécifique à la moins spécifique. Par exemple, "Taco Bell", "Willitis" et "CA".
types
Type : Array<string>
Tableau des types auxquels la prédiction appartient, par exemple 'establishment' ou 'geocode'.
distance_meters optional
Type : number optional
Distance en mètres du lieu à partir de AutocompletionRequest.origin.

Interface QueryAutocompletePrediction

google.maps.places.QueryAutocompletePrediction interface

Représente une prédiction de requête Autocomplete unique.

Chargez à l'aide du paramètre d'URL &libraries=places. Consultez Bibliothèques dans l'API Maps JavaScript.

description
Type:string
Il s'agit de la version non formatée de la requête suggérée par le service Places.
matched_substrings
Ensemble de sous-chaînes dans la description du lieu correspondant aux éléments de l'entrée utilisateur, adaptés pour mettre en évidence ces sous-chaînes. Chaque sous-chaîne est identifiée par un décalage et une longueur, exprimés en caractères Unicode.
terms
Informations sur les termes individuels dans la description ci-dessus. Les termes catégoriques apparaissent en premier (par exemple, "restaurant"). Les termes d'adresse apparaissent de la plus spécifique à la moins spécifique. Par exemple, "San Francisco" et "CA".
place_id optional
Type : string optional
Disponible uniquement si la prédiction est un lieu. ID de lieu pouvant être utilisé pour extraire des informations sur ce lieu à l'aide du service Place Details (voir PlacesService.getDetails).

Interface PredictionTerm

google.maps.places.PredictionTerm interface

Représente un terme de prédiction.

Chargez à l'aide du paramètre d'URL &libraries=places. Consultez Bibliothèques dans l'API Maps JavaScript.

offset
Type:number
Décalage, en caractères Unicode, du début de ce terme dans la description du lieu.
value
Type : string
Valeur de ce terme, par exemple "Taco Bell".

Interface PredictionSubstring

google.maps.places.PredictionSubstring interface

Représente une sous-chaîne de prédiction.

Chargez à l'aide du paramètre d'URL &libraries=places. Consultez Bibliothèques dans l'API Maps JavaScript.

length
Type:number
Longueur de la sous-chaîne.
offset
Type:number
Décalage vers le début de la sous-chaîne dans la chaîne de description.

Interface StructuredFormatting

google.maps.places.StructuredFormatting interface

Contient des informations structurées sur la description du lieu, séparées en un texte principal et un texte secondaire, y compris un tableau de sous-chaînes correspondantes issues de l'entrée de saisie semi-automatique, identifiées par un décalage et une longueur, exprimées en caractères Unicode.

Chargez à l'aide du paramètre d'URL &libraries=places. Consultez Bibliothèques dans l'API Maps JavaScript.

main_text
Type:string
Il s'agit de la partie principale de la description non formatée du lieu suggéré par le service Places. Il s'agit généralement du nom du lieu.
main_text_matched_substrings
Ensemble de sous-chaînes dans le texte principal correspondant aux éléments de l'entrée utilisateur, permettant de mettre en évidence ces sous-chaînes. Chaque sous-chaîne est identifiée par un décalage et une longueur, exprimés en caractères Unicode.
secondary_text
Type : string
Il s'agit du texte secondaire de la description non formatée du lieu suggéré par le service Places. Il s'agit généralement de l'emplacement du lieu.