Classe AutocompleteService
Classe google.maps.places.AutocompleteService
library "places"
Contient des méthodes liées à la récupération des prédictions de saisie semi-automatique.
const {AutocompleteService} = await google.maps.importLibrary("places");
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 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 saisie semi-automatique de requête en fonction de la requête de saisie semi-automatique fournie. |
Interface AutocompletionRequest
google.maps.places.AutocompletionRequest
interface
Requête de saisie semi-automatique à envoyer à AutocompleteService.getPlacePredictions.
Propriétés | |
|---|---|
input |
Type :
stringChaîne d'entrée saisie par l'utilisateur. |
facultatif |
Type :
LatLngBounds|LatLngBoundsLiteral optionalLimites pour le biais de prédiction. Les prédictions seront pondérées en faveur de la bounds donnée, mais ne s'y limiteront pas. location et radius seront ignorés si bounds est défini. |
componentRestrictions
facultatif |
Type :
ComponentRestrictions optionalRestrictions liées aux composants. Les restrictions de composants permettent de limiter les prédictions à celles du composant parent. Par exemple, le pays. |
language
facultatif |
Type :
string optionalIdentifiant 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. |
facultatif |
Type :
LatLng optionalEmplacement pour le biais de prédiction. Les prédictions seront biaisées en faveur des location et radius donnés. Vous pouvez également utiliser bounds. |
locationBias
facultatif |
Type :
LocationBias optionalLimite souple ou indice à utiliser lors de la recherche de lieux. |
locationRestriction
facultatif |
Type :
LocationRestriction optionalLimites pour restreindre les résultats de recherche. |
offset
facultatif |
Type :
number optionalPosition du caractère dans le terme d'entrée à laquelle le service utilise du texte pour les prédictions (position du curseur dans le champ de saisie). |
origin
facultatif |
Type :
LatLng|LatLngLiteral optionalEmplacement à partir duquel AutocompletePrediction.distance_meters est calculé. |
facultatif |
Type :
number optionalRayon de la zone utilisée pour le biais de prédiction. La propriété 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
facultatif |
Type :
string optionalCode de région utilisé pour la mise en forme et le filtrage des résultats. Elle ne limite pas les suggestions à 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
facultatif |
Type :
AutocompleteSessionToken optionalRéférence unique utilisée pour regrouper des requêtes individuelles dans des sessions. |
types
facultatif |
Type :
Array<string> optionalTypes 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 seront renvoyés. |
Interface AutocompleteResponse
google.maps.places.AutocompleteResponse
interface
Réponse de saisie semi-automatique renvoyée par l'appel à AutocompleteService.getPlacePredictions contenant une liste de AutocompletePrediction.
Propriétés | |
|---|---|
predictions |
Type :
Array<AutocompletePrediction>Liste des AutocompletePrediction. |
Interface QueryAutocompletionRequest
google.maps.places.QueryAutocompletionRequest
interface
Requête QueryAutocompletion à envoyer à QueryAutocompleteService.
Propriétés | |
|---|---|
input |
Type :
stringChaîne d'entrée saisie par l'utilisateur. |
bounds
facultatif |
Type :
LatLngBounds|LatLngBoundsLiteral optionalLimites pour le biais de prédiction. Les prédictions seront pondérées en faveur de la bounds donnée, mais ne s'y limiteront pas. location et radius seront ignorés si bounds est défini. |
location
facultatif |
Type :
LatLng optionalEmplacement pour le biais de prédiction. Les prédictions seront biaisées en faveur des location et radius donnés. Vous pouvez également utiliser bounds. |
offset
facultatif |
Type :
number optionalPosition du caractère dans le terme d'entrée à laquelle le service utilise du texte pour les prédictions (position du curseur dans le champ de saisie). |
radius
facultatif |
Type :
number optionalRayon de la zone utilisée pour le biais de prédiction. La propriété radius est spécifiée en mètres et doit toujours être accompagnée d'une propriété location. Vous pouvez également utiliser bounds. |
Interface ComponentRestrictions
google.maps.places.ComponentRestrictions
interface
Définit les restrictions de composants pouvant être utilisées avec le service de saisie semi-automatique.
Propriétés | |
|---|---|
country
facultatif |
Type :
string|Array<string> optionalLimite 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 en fournir un seul ou un tableau contenant jusqu'à cinq chaînes de code pays. |
AutocompletePrediction
google.maps.places.AutocompletePrediction
interface
Représente une seule prédiction de saisie semi-automatique.
Propriétés | |
|---|---|
description |
Type :
stringIl 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, adaptées 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 :
stringID de lieu pouvant être utilisé pour récupérer des détails sur ce lieu à l'aide du service Place Details (voir PlacesService.getDetails). |
structured_formatting |
Type :
StructuredFormattingInformations 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 de l'entrée de 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, du plus spécifique au moins spécifique. Par exemple, "Taco Bell", "Willits" et "CA". |
types |
Type :
Array<string>Tableau des types auxquels appartient la prédiction, par exemple 'establishment' ou 'geocode'. |
distance_meters
facultatif |
Type :
number optionalDistance en mètres du lieu à partir du AutocompletionRequest.origin. |
Interface QueryAutocompletePrediction
google.maps.places.QueryAutocompletePrediction
interface
Représente une seule prédiction de saisie semi-automatique pour les requêtes.
Propriétés | |
|---|---|
description |
Type :
stringIl 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, adaptées 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 sont placés en premier (par exemple, "restaurant"). Les termes de l'adresse apparaissent du plus spécifique au moins spécifique. Par exemple, "San Francisco" et "CA". |
place_id
facultatif |
Type :
string optionalDisponible uniquement si la prédiction est un lieu. ID de lieu pouvant être utilisé pour récupérer des détails 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.
Propriétés | |
|---|---|
offset |
Type :
numberDécalage, en caractères Unicode, du début de ce terme dans la description du lieu. |
value |
Type :
stringLa valeur de ce terme, par exemple "Taco Bell". |
Interface PredictionSubstring
google.maps.places.PredictionSubstring
interface
Représente une sous-chaîne de prédiction.
Propriétés | |
|---|---|
length |
Type :
numberLongueur de la sous-chaîne. |
offset |
Type :
numberDécalage par rapport au début de la sous-chaîne dans la chaîne de description. |
Interface StructuredFormatting
google.maps.places.StructuredFormatting
interface
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 de l'entrée de saisie semi-automatique, identifiées par un décalage et une longueur, exprimés en caractères Unicode.
Propriétés | |
|---|---|
main_text |
Type :
stringIl 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 du texte principal qui correspondent aux éléments de l'entrée utilisateur, adaptées 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 :
stringIl s'agit de la partie secondaire du texte 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. |