Classe AutocompleteService
Classe google.maps.places.AutocompleteService
Contient des méthodes liées à la récupération de prédictions de saisie semi-automatique.
Accédez au compte en appelant const {AutocompleteService} = await google.maps.importLibrary("places")
. Consultez Bibliothèques dans l'API Maps JavaScript.
Constructeur | |
---|---|
AutocompleteService |
AutocompleteService() Paramètres:aucun
Crée une instance d' AutocompleteService . |
Méthodes | |
---|---|
getPlacePredictions |
getPlacePredictions(request[, callback]) Paramètres:
Valeur renvoyée:
Promise<AutocompleteResponse> Récupère les prédictions de saisie semi-automatique de lieu en fonction de la requête 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 saisie semi-automatique fournie. |
Interface AutocompletionRequest
Interface google.maps.places.AutocompletionRequest
Une requête Autocomplete à envoyer à AutocompleteService.getPlacePredictions
.
Propriétés | |
---|---|
input |
Type:
string L'utilisateur a saisi une chaîne d'entrée. |
|
Type:
LatLngBounds|LatLngBoundsLiteral optional Limites pour la pondération des prédictions. Les prédictions n'auront aucune influence sur le bounds donné, sans s'y limiter. location et radius seront ignorés si bounds est défini. |
componentRestrictions optional |
Type:
ComponentRestrictions optional Restrictions appliquées aux composants. Les restrictions de 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 recevoir un meilleur classement, mais les suggestions ne sont pas limitées à cette langue. Consultez la liste des langues disponibles. |
|
Type:
LatLng optional Emplacement pour la pondération des prédictions Les prédictions seront biaisées en fonction du location et du radius donnés. Vous pouvez également utiliser bounds . |
locationBias optional |
Type:
LocationBias optional Limite ou indice doux à utiliser lorsque vous recherchez des lieux. |
locationRestriction optional |
Type:
LocationRestriction optional Permet de limiter les résultats de recherche. |
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 le AutocompletePrediction.distance_meters est calculé. |
|
Type:
number optional Rayon de la zone utilisée pour la pondération de la prédiction. Le radius est indiqué en mètres et doit toujours être accompagné d'une propriété location . Vous pouvez également utiliser bounds . |
region optional |
Type:
string optional Code régional utilisé pour la mise en forme et le filtrage des résultats. Cela ne limite pas les suggestions à ce pays. Le code de région accepte une valeur à deux caractères associée à 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" (pour l'entité "Royaume-Uni de Grande-Bretagne et d'Irlande du Nord"). |
sessionToken optional |
Type:
AutocompleteSessionToken optional Référence unique permettant de regrouper les requêtes individuelles dans des 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
Interface google.maps.places.AutocompleteResponse
Réponse Autocomplete renvoyée par l'appel de AutocompleteService.getPlacePredictions
contenant une liste de AutocompletePrediction
.
Propriétés | |
---|---|
predictions |
Type:
Array<AutocompletePrediction> Liste de AutocompletePrediction . |
Interface QueryAutocompletionRequest
Interface google.maps.places.QueryAutocompletionRequest
Requête QueryAutocomplete à envoyer à QueryAutocompleteService
.
Propriétés | |
---|---|
input |
Type:
string L'utilisateur a saisi une chaîne d'entrée. |
bounds optional |
Type:
LatLngBounds|LatLngBoundsLiteral optional Limites pour la pondération des prédictions. Les prédictions n'auront aucune influence sur le bounds donné, sans s'y limiter. 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 du location et du radius donnés. 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 de la prédiction. Le radius est indiqué 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 suivre une session Autocomplete. Il peut s'agir d'une série d'appels AutocompleteService.getPlacePredictions
suivis d'un seul appel PlacesService.getDetails
.
Accédez au compte en appelant const {AutocompleteSessionToken} = await google.maps.importLibrary("places")
. Consultez Bibliothèques dans l'API Maps JavaScript.
Constructeur | |
---|---|
AutocompleteSessionToken |
AutocompleteSessionToken() Paramètres:aucun
Crée une instance de AutocompleteSessionToken . |
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, non sensible à la casse). Exemples : 'us' , 'br' ou 'au' . Vous pouvez fournir une seule chaîne ou un tableau de cinq chaînes de code pays au maximum. |
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 correspondant aux éléments de l'entrée utilisateur. Ces sous-chaînes peuvent être mises en surbrillance dans ces sous-chaînes. Chaque sous-chaîne est identifiée par un décalage et une longueur, exprimées en caractères Unicode. |
place_id |
Type:
string ID de lieu permettant de récupérer des informations sur le 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 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 |
Type:
Array<PredictionTerm> Informations sur les termes individuels dans la description ci-dessus, de la plus spécifique à la moins spécifique. Exemples : "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 au AutocompletionRequest.origin . |
Interface QueryAutocompletePrediction
Interface google.maps.places.QueryAutocompletePrediction
Représente une seule prédiction de requête Autocomplete.
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 correspondant aux éléments de l'entrée utilisateur. Ces sous-chaînes peuvent être mises en surbrillance dans ces sous-chaînes. Chaque sous-chaîne est identifiée par un décalage et une longueur, exprimées en caractères Unicode. |
terms |
Type:
Array<PredictionTerm> 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 apparaissent de la plus spécifique à la moins spécifique. Exemples : "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 le 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 vers le début de la sous-chaîne dans la chaîne de description. |
Interface Structuredformat
Interface google.maps.places.StructuredFormatting
Contient des informations structurées sur la description du lieu, divisées en 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.
Propriétés | |
---|---|
main_text |
Type:
string Il s'agit de la partie principale 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 |
Type:
Array<PredictionSubstring> Ensemble de sous-chaînes dans le texte principal correspondant aux éléments de l'entrée utilisateur, permettant de mettre en surbrillance ces sous-chaînes. Chaque sous-chaîne est identifiée par un décalage et une longueur, exprimées en caractères Unicode. |
secondary_text |
Type:
string Il s'agit de la partie secondaire de la description non formatée du lieu, suggérée par le service Places. Il s'agit généralement de l'emplacement du lieu. |