Places Autocomplete Service

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

AutocompleteService

Classe google.maps.places.AutocompleteService

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

Nécessite le paramètre d'URL &libraries=places. Consultez la section 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 la saisie semi-automatique de lieux en fonction de la requête de saisie semi-automatique fournie.
getQueryPredictions
getQueryPredictions(request, callback)
Paramètres:
Valeur renvoyée: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 Autocomplete à envoyer à AutocompleteService.getPlacePredictions.

Nécessite le paramètre d'URL &libraries=places. Consultez la section Bibliothèques dans l'API Maps JavaScript.

input
Type:string
L'utilisateur a saisi une chaîne d'entrée.
bounds optional
Limites de pondération de la prédiction. Les prédictions seront biaisées, sans s'y limiter, pour le bounds donné. location et radius seront tous les deux ignorés si vous définissez bounds.
componentRestrictions optional
Type : ComponentRestrictions optional
Restrictions des composants. Les restrictions des composants 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 renvoyés, si possible. Les résultats dans la langue sélectionnée peuvent bénéficier d'un meilleur classement, mais les suggestions ne sont pas limitées à cette langue. Consultez la liste des langues disponibles.
location optional
Type : LatLng optional
Emplacement de la pondération de la prédiction. Les prédictions seront biaisées en fonction des valeurs location et radius données. Vous pouvez également utiliser bounds.
offset optional
Type:number optional
Position du caractère dans le terme d'entrée auquel le service utilise du texte pour les prédictions (position du curseur dans le champ de saisie).
origin optional
Type : LatLng|LatLngLiteral optional
Lieu à partir duquel AutocompletePrediction.distance_meters est calculé.
radius optional
Type : number optional
Rayon de la zone utilisée pour la pondération des prédictions. La radius est spécifiée en mètres et doit toujours être accompagnée d'une propriété location. Vous pouvez également utiliser bounds.
region optional
Type:string optional
Code de région utilisé pour la mise en forme et le filtrage des résultats. Les suggestions ne sont pas limitées à ce pays. Le code de région accepte la valeur à deux caractères correspondant à ccTLD ("domaine de premier niveau"). 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, il désigne 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 à afficher. 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

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

Nécessite le paramètre d'URL &libraries=places. Consultez la section Bibliothèques dans l'API Maps JavaScript.

predictions

Interface QueryAutocompletionRequest

google.maps.places.QueryAutocompletionRequest interface

Requête QueryAutocompletion à envoyer à QueryAutocompleteService.

Nécessite le paramètre d'URL &libraries=places. Consultez la section Bibliothèques dans l'API Maps JavaScript.

input
Type:string
L'utilisateur a saisi une chaîne d'entrée.
bounds optional
Limites de pondération de la prédiction. Les prédictions seront biaisées, sans s'y limiter, pour le bounds donné. location et radius seront tous les deux ignorés si vous définissez bounds.
location optional
Type:LatLng optional
Emplacement de la pondération de la prédiction. Les prédictions seront biaisées en fonction des valeurs location et radius données. Vous pouvez également utiliser bounds.
offset optional
Type:number optional
Position du caractère dans le terme d'entrée auquel 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. La radius est spécifiée en mètres et doit toujours être accompagnée 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. Il peut s'agir d'une série d'appels AutocompleteService.getPlacePredictions suivis d'un seul appel PlacesService.getDetails.

Nécessite le paramètre d'URL &libraries=places. Consultez la section Bibliothèques dans l'API Maps JavaScript.

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

Interface ComponentRestrictions

google.maps.places.ComponentRestrictions interface

Définit les restrictions applicables aux composants qui peuvent être utilisées avec le service de saisie semi-automatique.

Nécessite le paramètre d'URL &libraries=places. Consultez la section Bibliothèques dans l'API Maps JavaScript.

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

Interface AutocompletePrediction

google.maps.places.AutocompletePrediction interface

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

Nécessite le paramètre d'URL &libraries=places. Consultez la section Bibliothèques dans l'API Maps JavaScript.

description
Type:string
Il s'agit de la version non mise en forme de la requête suggérée par le service Places.
matched_substrings
Ensemble de sous-chaînes de la description du lieu correspondant aux éléments de l'entrée utilisateur. Il peut être utilisé pour mettre en surbrillance 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, séparées par un texte principal et un texte secondaire, y compris un tableau de sous-chaînes correspondantes issues de la 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, du plus spécifique au 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 par rapport à AutocompletionRequest.origin.

Interface QueryAutocompletePrediction

google.maps.places.QueryAutocompletePrediction interface

Représente une prédiction de saisie semi-automatique de requête.

Nécessite le paramètre d'URL &libraries=places. Consultez la section Bibliothèques dans l'API Maps JavaScript.

description
Type : string
Il s'agit de la version non mise en forme de la requête suggérée par le service Places.
matched_substrings
Ensemble de sous-chaînes de la description du lieu correspondant aux éléments de l'entrée utilisateur. Il peut être utilisé pour mettre en surbrillance 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égoriels sont placés en premier (par exemple, "restaurant"). Les termes d'adresse s'affichent du plus spécifique au 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.

Nécessite le paramètre d'URL &libraries=places. Consultez la section 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.

Nécessite le paramètre d'URL &libraries=places. Consultez la section 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 StructuredFormat

google.maps.places.StructuredFormatting interface

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

Nécessite le paramètre d'URL &libraries=places. Consultez la section Bibliothèques dans l'API Maps JavaScript.

main_text
Type:string
Il s'agit de la partie principale du texte de la description non formatée du lieu, suggérée par le service Places. Il s'agit généralement du nom du lieu.
main_text_matched_substrings
Ensemble de sous-chaînes du texte principal correspondant aux éléments de l'entrée utilisateur. Elles permettent de mettre en surbrillance 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'adresse du lieu.