Classe AutocompleteService
Classe google.maps.places.AutocompleteService
Contient des méthodes liées à la récupération des prédictions de saisie semi-automatique.
Accédez-y en appelant const {AutocompleteService} = await google.maps.importLibrary("places")
. Consultez la section Bibliothèques de l'API Maps JavaScript.
Constructeur | |
---|---|
AutocompleteService |
AutocompleteService() Paramètres:aucun
Crée une instance de AutocompleteService . |
Méthodes | |
---|---|
getPlacePredictions |
getPlacePredictions(request[, callback]) Paramètres:
Valeur renvoyée:
Promise<AutocompleteResponse> Récupère les prédictions de saisie semi-automatique pour les 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 saisie semi-automatique pour les requêtes en fonction de la requête de saisie semi-automatique fournie. |
Interface AutocompletionRequest
Interface google.maps.places.AutocompletionRequest
Demande d'autocomplétion à envoyer à AutocompleteService.getPlacePredictions
.
Propriétés | |
---|---|
input |
Type:
string L'utilisateur a saisi la chaîne d'entrée. |
|
Type:
LatLngBounds|LatLngBoundsLiteral optional Limites pour le biais de prédiction. Les prédictions seront orientées vers l' bounds donné, mais n'y seront pas limitées. location et radius sont ignorés si bounds est défini. |
componentRestrictions optional |
Type:
ComponentRestrictions optional Les restrictions du composant. Les restrictions de 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 renvoyés, si possible. Les résultats dans la langue sélectionnée peuvent être mieux classés, mais les suggestions ne sont pas limitées à cette langue. Consultez la liste des langues disponibles. |
|
Type:
LatLng optional Emplacement du biais de prédiction. Les prédictions seront biaisées vers les location et radius donnés. Vous pouvez également utiliser bounds . |
locationBias optional |
Type:
LocationBias optional Limite ou indice à utiliser lors de la recherche de lieux. |
locationRestriction optional |
Type:
LocationRestriction optional Limites pour limiter les résultats de recherche. |
offset optional |
Type:
number optional Position du caractère dans le terme saisi à laquelle le service utilise le texte pour les prédictions (position du curseur dans le champ de saisie). |
origin optional |
Type:
LatLng|LatLngLiteral optional Emplacement à partir duquel AutocompletePrediction.distance_meters est calculé. |
|
Type:
number optional Rayon de la zone utilisée pour le biais de prédiction. 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. Les suggestions ne sont pas limitées à ce pays. Le code régional 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 ), tandis 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 des requêtes individuelles dans des sessions. |
types optional |
Type:
Array<string> optional Types de prédictions à renvoyer. Pour connaître les types acceptés, consultez le guide du développeur. Si aucun type n'est spécifié, tous les types sont renvoyés. |
Interface AutocompleteResponse
Interface google.maps.places.AutocompleteResponse
Réponse de saisie semi-automatique renvoyée par l'appel de AutocompleteService.getPlacePredictions
contenant une liste de AutocompletePrediction
.
Propriétés | |
---|---|
predictions |
Type:
Array<AutocompletePrediction> Liste des AutocompletePrediction . |
Interface QueryAutocompletionRequest
Interface google.maps.places.QueryAutocompletionRequest
Requête QueryAutocompletion à envoyer à QueryAutocompleteService
.
Propriétés | |
---|---|
input |
Type:
string L'utilisateur a saisi la chaîne d'entrée. |
bounds optional |
Type:
LatLngBounds|LatLngBoundsLiteral optional Limites pour le biais de prédiction. Les prédictions seront orientées vers l' bounds donné, mais n'y seront pas limitées. location et radius sont ignorés si bounds est défini. |
location optional |
Type:
LatLng optional Emplacement du biais de prédiction. Les prédictions seront biaisées vers les location et radius donnés. Vous pouvez également utiliser bounds . |
offset optional |
Type:
number optional Position du caractère dans le terme saisi à laquelle le service utilise le 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 le biais de prédiction. radius est spécifié en mètres et doit toujours être accompagné d'une propriété location . Vous pouvez également utiliser bounds . |
Interface ComponentRestrictions
Interface google.maps.places.ComponentRestrictions
Définit les restrictions de composant pouvant être utilisées avec le service de saisie semi-automatique.
Propriétés | |
---|---|
country optional |
Type:
string|Array<string> optional Limite les prédictions au pays spécifié (code pays ISO 3166-1 Alpha-2, insensible à la casse). Par exemple, 'us' , 'br' ou 'au' . Vous pouvez en fournir un seul ou un tableau de chaînes de code pays pouvant comporter jusqu'à cinq éléments. |
Interface AutocompletePrediction
Interface google.maps.places.AutocompletePrediction
Représente une seule prédiction de saisie semi-automatique.
Propriétés | |
---|---|
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 |
Type:
Array<PredictionSubstring> Ensemble de sous-chaînes dans la description du lieu qui correspondent aux éléments de l'entrée utilisateur, à utiliser 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 permettant de récupérer des informations sur ce lieu à l'aide du service Place Details (voir PlacesService.getDetails ). |
structured_formatting |
Type:
StructuredFormatting 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 de la saisie semi-automatique, identifiées par un décalage et une longueur, exprimés en caractères Unicode. |
terms |
Type:
Array<PredictionTerm> Informations sur les termes individuels de la description ci-dessus, de la plus à 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 du AutocompletionRequest.origin . |
Interface QueryAutocompletePrediction
Interface google.maps.places.QueryAutocompletePrediction
Représente une seule prédiction de saisie semi-automatique pour les requêtes.
Propriétés | |
---|---|
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 |
Type:
Array<PredictionSubstring> Ensemble de sous-chaînes dans la description du lieu qui correspondent aux éléments de l'entrée utilisateur, à utiliser 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 |
Type:
Array<PredictionTerm> Informations sur les termes individuels de la description ci-dessus. Les termes catégoriels viennent en premier (par exemple, "restaurant"). Les termes de l'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 permettant de récupérer des informations sur ce lieu à l'aide du service Place Details (voir PlacesService.getDetails ). |
Interface PredictionTerm
Interface google.maps.places.PredictionTerm
Représente un terme de prédiction.
Propriétés | |
---|---|
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
Interface google.maps.places.PredictionSubstring
Représente une sous-chaîne de prédiction.
Propriétés | |
---|---|
length |
Type:
number Longueur de la sous-chaîne. |
offset |
Type:
number Décalage par rapport au début de la sous-chaîne dans la chaîne de description. |
Interface StructuredFormatting
Interface google.maps.places.StructuredFormatting
Contient des 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 de la saisie semi-automatique, identifiées par un décalage et une longueur, exprimés en caractères Unicode.
Propriétés | |
---|---|
main_text |
Type:
string Il s'agit de la partie principale du texte 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 |
Type:
Array<PredictionSubstring> Ensemble de sous-chaînes dans le texte principal qui correspondent aux éléments de l'entrée utilisateur, à utiliser 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. |
secondary_text |
Type:
string Il s'agit de la partie textuelle 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. |