Interface AutocompleteRequest
Interface google.maps.places.AutocompleteRequest
Interface de requête pour AutocompleteSuggestion.fetchAutocompleteSuggestions
.
Propriétés | |
---|---|
input |
Type:
string Chaîne de texte à rechercher. |
includedPrimaryTypes optional |
Type:
Array<string> optional Inclut le type d'établissement principal (par exemple, "restaurant" ou "station_service"). Un lieu n'est renvoyé que si son type principal est inclus dans cette liste. Vous pouvez spécifier jusqu'à cinq valeurs. Si aucun type n'est spécifié, tous les types de lieux sont renvoyés. |
includedRegionCodes optional |
Type:
Array<string> optional Inclure uniquement les résultats dans les régions spécifiées, jusqu'à 15 codes de région CLDR à deux caractères. Un ensemble vide ne limite pas les résultats. Si locationRestriction et includedRegionCodes sont tous deux définis, les résultats se trouvent dans la zone d'intersection. |
inputOffset optional |
Type:
number optional Décalage de caractère Unicode basé sur zéro de input indiquant la position du curseur dans input . La position du curseur peut influencer les prédictions renvoyées. Si aucune valeur n'est spécifiée, la longueur par défaut est input . |
language optional |
Type:
string optional Langue dans laquelle les résultats doivent être renvoyés. La langue par défaut est celle définie dans les préférences linguistiques du navigateur. Les résultats peuvent être dans des langues mixtes si la langue utilisée dans input est différente de celle de language ou si le lieu renvoyé n'a pas de traduction de la langue locale vers language . |
locationBias optional |
Type:
LocationBias optional Limitez les résultats à un emplacement spécifié. Vous ne devez définir qu'un seul élément parmi locationBias ou locationRestriction . Si aucun de ces paramètres n'est défini, les résultats seront biaisés par l'adresse IP, ce qui signifie qu'elle sera mappée à un emplacement imprécis et utilisée comme signal de biais. |
locationRestriction optional |
Type:
LocationRestriction optional Limitez les résultats à un emplacement spécifié. Vous ne devez définir qu'un seul élément parmi locationBias ou locationRestriction . Si aucun de ces paramètres n'est défini, les résultats seront biaisés par l'adresse IP, ce qui signifie qu'elle sera mappée à un emplacement imprécis et utilisée comme signal de biais. |
origin optional |
Type:
LatLng|LatLngLiteral optional Point d'origine à partir duquel calculer la distance géodésique jusqu'à la destination (rendue sous la forme PlacePrediction.distanceMeters ). Si cette valeur est omise, la distance géodésique ne sera pas renvoyée. |
region optional |
Type:
string optional Code régional, spécifié sous forme de code régional CLDR à deux caractères. Cela affecte le formatage des adresses, le classement des résultats et peut avoir une incidence sur les résultats renvoyés. Cela ne limite pas les résultats à la région spécifiée. |
sessionToken optional |
Type:
AutocompleteSessionToken optional Jeton qui identifie une session Autocomplete à des fins de facturation. Générez un nouveau jeton de session via AutocompleteSessionToken . La session commence lorsque l'utilisateur commence à saisir une requête et se termine lorsqu'il sélectionne un lieu et appelle Place.fetchFields . Chaque session peut comporter plusieurs requêtes, suivies d'un appel fetchFields . Les identifiants utilisés pour chaque requête d'une session doivent appartenir au même projet Google Cloud Console. Une fois la session terminée, le jeton n'est plus valide. Votre application doit générer un nouveau jeton pour chaque session. Si vous omettez le paramètre sessionToken ou si vous réutilisez un jeton de session, la session est facturée comme si aucun jeton n'était fourni (chaque requête est facturée séparément). Nous vous recommandons de suivre les consignes suivantes:
|
Classe AutocompleteSessionToken
Classe google.maps.places.AutocompleteSessionToken
Représente un jeton de session utilisé pour suivre une session de saisie semi-automatique.
Accédez-y en appelant const {AutocompleteSessionToken} = await google.maps.importLibrary("places")
. Consultez la section Bibliothèques de l'API Maps JavaScript.
Constructeur | |
---|---|
AutocompleteSessionToken |
AutocompleteSessionToken() Paramètres:aucun
Crée une instance de AutocompleteSessionToken . |
Classe AutocompleteSuggestion
Classe google.maps.places.AutocompleteSuggestion
Résultat de suggestion de saisie semi-automatique.
Accédez-y en appelant const {AutocompleteSuggestion} = await google.maps.importLibrary("places")
. Consultez la section Bibliothèques de l'API Maps JavaScript.
Méthodes statiques | |
---|---|
fetchAutocompleteSuggestions |
fetchAutocompleteSuggestions(autocompleteRequest) Paramètres:
Valeur renvoyée:
Promise<{suggestions:Array<AutocompleteSuggestion>}> Récupère une liste de suggestions de saisie semi-automatique. |
Propriétés | |
---|---|
placePrediction |
Type:
PlacePrediction optional Inclut le nom lisible du résultat renvoyé. Pour les résultats d'établissement, il s'agit généralement du nom et de l'adresse de l'entreprise. |
Classe PlacePrediction
Classe google.maps.places.PlacePrediction
Résultats de prédiction pour une prédiction Place Autocomplete.
Accédez-y en appelant const {PlacePrediction} = await google.maps.importLibrary("places")
. Consultez la section Bibliothèques de l'API Maps JavaScript.
Propriétés | |
---|---|
distanceMeters |
Type:
number optional Longueur de la géodésique en mètres à partir de origin si origin est spécifié. |
mainText |
Type:
FormattableText optional Représente le nom du lieu. |
placeId |
Type:
string Identifiant unique du lieu suggéré. Cet identifiant peut être utilisé dans d'autres API qui acceptent les ID de lieu. |
secondaryText |
Type:
FormattableText optional Représente des éléments supplémentaires permettant de lever l'ambiguïté (comme une ville ou une région) pour identifier plus précisément le lieu. |
text |
Type:
FormattableText Inclut le nom lisible du résultat renvoyé. Pour les résultats d'établissement, il s'agit généralement du nom et de l'adresse de l'entreprise. text est recommandé pour les développeurs qui souhaitent afficher un seul élément d'interface utilisateur. Les développeurs qui souhaitent afficher deux éléments d'interface utilisateur distincts, mais liés, peuvent utiliser PlacePrediction.mainText et PlacePrediction.secondaryText à la place. |
types |
Type:
Array<string> Liste des types qui s'appliquent à ce lieu, tirée du tableau A ou du tableau B de la page https://developers.google.com/maps/documentation/places/web-service/place-types. |
Méthodes | |
---|---|
toPlace |
toPlace() Paramètres:aucun
Valeur renvoyée:
Place Renvoie une représentation de lieu de cette PlacePrediction. Un appel ultérieur à Place.fetchFields est nécessaire pour obtenir les informations complètes sur le lieu. |
Classe StringRange
Classe google.maps.places.StringRange
Identifie une sous-chaîne dans un texte donné.
Accédez-y en appelant const {StringRange} = await google.maps.importLibrary("places")
. Consultez la section Bibliothèques de l'API Maps JavaScript.
Propriétés | |
---|---|
endOffset |
Type:
number Décalage à partir de zéro du dernier caractère Unicode de la sous-chaîne (exclusif). |
startOffset |
Type:
number Décalage de base 0 du premier caractère Unicode de la sous-chaîne (inclus). |
Classe FormattableText
Classe google.maps.places.FormattableText
Texte représentant une prédiction de lieu. Le texte peut être utilisé tel quel ou formaté.
Accédez-y en appelant const {FormattableText} = await google.maps.importLibrary("places")
. Consultez la section Bibliothèques de l'API Maps JavaScript.
Propriétés | |
---|---|
matches |
Type:
Array<StringRange> Liste des plages de chaînes indiquant où la requête d'entrée a correspondu dans FormattableText.text . Les plages peuvent être utilisées pour mettre en forme des parties spécifiques de text . Les sous-chaînes ne correspondent pas nécessairement exactement à AutocompleteRequest.input si la correspondance a été déterminée par des critères autres que la correspondance de chaîne (par exemple, des corrections orthographiques ou des translittérations). Ces valeurs correspondent aux décalages de caractères Unicode de FormattableText.text . Les plages sont systématiquement triées par ordre croissant des valeurs de décalage. |
text |
Type:
string Texte pouvant être utilisé tel quel ou mis en forme avec FormattableText.matches . |