Classe AutocompleteSuggestion
Classe google.maps.places.AutocompleteSuggestion
Résultat de suggestion de saisie semi-automatique.
Accédez-y en appelant le const {AutocompleteSuggestion} = await google.maps.importLibrary("places")
.
Consultez 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 d'AutocompleteSuggestions. Si un AutocompleteRequest.sessionToken est fourni dans la requête, ce jeton de session sera automatiquement inclus lors du premier appel de Place.fetchFields , sur chaque Place renvoyé par PlacePrediction.toPlace sur les PlacePrediction résultants. |
Propriétés | |
---|---|
placePrediction |
Type :
PlacePrediction optional Contient le nom lisible du résultat renvoyé. Pour les résultats d'établissements, il s'agit généralement du nom et de l'adresse de l'établissement. Si un AutocompleteRequest.sessionToken a été fourni dans l'AutocompleteRequest utilisé pour extraire cet AutocompleteSuggestion, le même jeton sera automatiquement inclus lors du premier appel de Place.fetchFields sur le Place renvoyé par un appel à PlacePrediction.toPlace . |
Interface AutocompleteRequest
Interface google.maps.places.AutocompleteRequest
Interface de requête pour AutocompleteSuggestion.fetchAutocompleteSuggestions
.
Propriétés | |
---|---|
input |
Type :
string Chaîne de texte sur laquelle effectuer la recherche. |
includedPrimaryTypes optional |
Type :
Array<string> optional Type de lieu principal inclus (par exemple, "restaurant" ou "gas_station"). 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 Incluez uniquement les résultats dans les régions spécifiées, sous forme de 15 codes de région CLDR à deux caractères maximum. Un ensemble vide ne limitera pas les résultats. Si locationRestriction et includedRegionCodes sont tous les deux définis, les résultats se trouveront dans la zone d'intersection. |
inputOffset optional |
Type :
number optional Décalage de caractère Unicode basé sur zéro ( 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 valeur par défaut est la longueur de input . |
language optional |
Type :
string optional Langue dans laquelle renvoyer les résultats. La langue par défaut sera celle définie dans les préférences du navigateur. Les résultats peuvent être dans plusieurs langues si la langue utilisée dans input est différente de language , ou si le lieu renvoyé n'a pas de traduction de la langue locale vers language . |
locationBias optional |
Type :
LocationBias optional Limiter les résultats à un lieu spécifié. Au maximum, une seule des valeurs locationBias ou locationRestriction doit être définie. Si aucun n'est défini, les résultats seront biaisés par l'adresse IP, ce qui signifie que l'adresse IP sera associée à un emplacement imprécis et utilisée comme signal de pondération. |
locationRestriction optional |
Type :
LocationRestriction optional Limiter les résultats à un emplacement spécifié Au maximum, une seule des valeurs locationBias ou locationRestriction doit être définie. Si aucun n'est défini, les résultats seront biaisés par l'adresse IP, ce qui signifie que l'adresse IP sera associée à un emplacement imprécis et utilisée comme signal de pondération. |
origin optional |
Type :
LatLng|LatLngLiteral optional Point d'origine à partir duquel calculer la distance géodésique jusqu'à la destination (renvoyée 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 CLDR à deux caractères. Cela affecte la mise en forme des adresses et 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 jeton de session à l'aide de 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 de la console Google Cloud. Lorsque la session prend fin, 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). Lorsqu'un jeton de session est fourni dans la requête à AutocompleteSuggestion.fetchAutocompleteSuggestions , le même jeton est automatiquement inclus dans le premier appel à fetchFields sur un Place renvoyé en appelant PlacePrediction.toPlace sur l'un des AutocompleteSuggestion résultants. 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 le const {AutocompleteSessionToken} = await google.maps.importLibrary("places")
.
Consultez Bibliothèques de l'API Maps JavaScript.
Constructeur | |
---|---|
AutocompleteSessionToken |
AutocompleteSessionToken() Paramètres : aucun
Crée une instance de AutocompleteSessionToken . |
Classe PlacePrediction
Classe google.maps.places.PlacePrediction
Résultats de prédiction pour une prédiction Place Autocomplete.
Accédez-y en appelant le const {PlacePrediction} = await google.maps.importLibrary("places")
.
Consultez 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 caractéristiques de clarification supplémentaires (telles qu'une ville ou une région) pour identifier davantage le lieu. |
text |
Type :
FormattableText Contient le nom lisible du résultat renvoyé. Pour les résultats d'établissements, il s'agit généralement du nom et de l'adresse de l'établissement. 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'UI 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 à partir du tableau A ou du tableau B de la page https://developers.google.com/maps/documentation/places/web-service/place-types. |
Méthodes | |
---|---|
|
fetchAddressValidation(request) Paramètres :
Valeur renvoyée : aucune
Envoie une requête Address Validation associée à cette session Autocomplete (en remplissant en interne la requête avec le jeton de session Autocomplete). Aucune information sur le lieu de PlacePrediction n'est incluse automatiquement. Il s'agit d'une méthode pratique pour faciliter la gestion des sessions Autocomplete. |
toPlace |
toPlace() Paramètres : aucun
Valeur renvoyée :
Place Renvoie une représentation Place de cette PlacePrediction. Un appel ultérieur à Place.fetchFields est nécessaire pour obtenir tous les détails du lieu. Si un AutocompleteRequest.sessionToken a été fourni dans le AutocompleteRequest utilisé pour récupérer cette PlacePrediction, le même jeton sera automatiquement inclus lors de l'appel de fetchFields. Vous pouvez également utiliser PlaceAutocompleteElement . Dans ce cas, le premier appel à Place.fetchFields sur un Place renvoyé par PlacePrediction.toPlace inclura automatiquement le jeton de session. |
Classe StringRange
Classe google.maps.places.StringRange
Identifie une sous-chaîne dans un texte donné.
Accédez-y en appelant le const {StringRange} = await google.maps.importLibrary("places")
.
Consultez Bibliothèques de l'API Maps JavaScript.
Propriétés | |
---|---|
endOffset |
Type :
number Décalage de base zéro du dernier caractère Unicode de la sous-chaîne (exclusif). |
startOffset |
Type :
number Décalage basé sur zéro 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 mis en forme.
Accédez-y en appelant le const {FormattableText} = await google.maps.importLibrary("places")
.
Consultez Bibliothèques de l'API Maps JavaScript.
Propriétés | |
---|---|
matches |
Type :
Array<StringRange> Liste des plages de chaînes identifiant les correspondances de la requête d'entrée 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 forcément exactement à AutocompleteRequest.input si la correspondance a été déterminée par des critères autres que la correspondance de chaînes (par exemple, des corrections orthographiques ou des translittérations). Ces valeurs sont des décalages de caractères Unicode de FormattableText.text . Les plages sont garanties d'être classées par ordre croissant des valeurs de décalage. |
text |
Type :
string Texte qui peut être utilisé tel quel ou mis en forme avec FormattableText.matches . |