- Requête HTTP
- Corps de la requête
- Corps de la réponse
- LocationBias
- LocationRestriction
- Suggestion
- PlacePrediction
- FormattableText
- StringRange
- StructuredFormat
- QueryPrediction
Renvoie des prédictions pour l'entrée donnée.
Requête HTTP
POST https://places.googleapis.com/v1/places:autocomplete
L'URL utilise la syntaxe de transcodage gRPC.
Corps de la requête
Le corps de la requête contient des données présentant la structure suivante :
Représentation JSON |
---|
{ "input": string, "locationBias": { object ( |
Champs | |
---|---|
input |
Obligatoire. Chaîne de texte sur laquelle doit porter la recherche. |
locationBias |
Facultatif. Limiter les résultats à un emplacement spécifié. Vous ne pouvez définir qu'un seul des éléments |
locationRestriction |
Facultatif. Limiter les résultats à un lieu spécifié. Vous ne pouvez définir qu'un seul des éléments |
includedPrimaryTypes[] |
Facultatif. Type de lieu principal inclus (par exemple, "restaurant" ou "gas_station") de https://developers.google.com/maps/documentation/places/web-service/place-types. 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 lieu sont renvoyés. |
includedRegionCodes[] |
Facultatif. Incluez uniquement les résultats des régions spécifiées, sous la forme de 15 codes régionaux CLDR à deux caractères maximum. Un ensemble vide ne limitera pas les résultats. Si les champs |
languageCode |
Facultatif. Langue dans laquelle les résultats doivent être renvoyés. La valeur par défaut est "en-US". Les résultats peuvent s'afficher dans plusieurs langues si la langue utilisée dans |
regionCode |
Facultatif. Code régional, spécifié sous forme de code CLDR à deux caractères. Cela affecte le format des adresses et le classement des résultats, et peut influencer les résultats renvoyés. Cela ne limite pas les résultats à la région spécifiée. Pour limiter les résultats à une région, utilisez |
origin |
Facultatif. Point de départ à partir duquel calculer la distance géodésique jusqu'à la destination (renvoyée en tant que |
inputOffset |
Facultatif. Décalage de caractères Unicode basé sur zéro de Si ce champ est vide, la valeur par défaut est la longueur de |
includeQueryPredictions |
Facultatif. Si la valeur est "true", la réponse inclura à la fois les prédictions de lieu et de requête. Sinon, la réponse ne renverra que des prédictions de lieu. |
sessionToken |
Facultatif. Chaîne qui identifie une session de saisie semi-automatique à des fins de facturation. Il doit s'agir d'une chaîne en base64 avec nom de fichier et URL ne dépassant pas 36 caractères ASCII. Sinon, une erreur INVALID_ARGUMENT est renvoyée. La session commence lorsque l'utilisateur commence à saisir une requête et se termine lorsqu'il sélectionne un lieu et qu'un appel à Place Details ou à Address Validation est effectué. Chaque session peut comporter plusieurs requêtes, suivies d'une requête Place Details ou Address Validation. Les identifiants utilisés pour chaque requête au cours d'une session doivent appartenir au même projet de la console Google Cloud. 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 le paramètre Nous vous recommandons de respecter les consignes suivantes:
|
Corps de la réponse
Fichier proto de réponse pour places.complete
Si la requête aboutit, le corps de la réponse contient des données qui ont la structure suivante :
Représentation JSON |
---|
{
"suggestions": [
{
object ( |
Champs | |
---|---|
suggestions[] |
Contient une liste de suggestions, classées par ordre décroissant de pertinence. |
LocationBias
Région dans laquelle effectuer la recherche. Les résultats peuvent être pondérés selon la région spécifiée.
Représentation JSON |
---|
{ // Union field |
Champs | |
---|---|
Champ d'union
|
|
rectangle |
Fenêtre d'affichage définie par un angle nord-est et sud-ouest |
circle |
Cercle défini par un point central et un rayon. |
LocationRestriction
Région dans laquelle effectuer la recherche. Les résultats sont limités à la région spécifiée.
Représentation JSON |
---|
{ // Union field |
Champs | |
---|---|
Champ d'union
|
|
rectangle |
Fenêtre d'affichage définie par un angle nord-est et sud-ouest |
circle |
Cercle défini par un point central et un rayon. |
Suggestion
Résultat de la suggestion de saisie semi-automatique.
Représentation JSON |
---|
{ // Union field |
Champs | |
---|---|
Champ d'union
|
|
placePrediction |
Prédiction d'un lieu. |
queryPrediction |
Prédiction d'une requête. |
PlacePrediction
Résultats d'une prédiction Place Autocomplete.
Représentation JSON |
---|
{ "place": string, "placeId": string, "text": { object ( |
Champs | |
---|---|
place |
Nom de ressource du lieu suggéré. Ce nom peut être utilisé dans d'autres API qui acceptent les noms de lieu. |
placeId |
Identifiant unique du lieu suggéré. Cet identifiant peut être utilisé dans d'autres API qui acceptent les ID de lieu. |
text |
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.
Ce texte peut être différent du Peut être dans plusieurs langues si les requêtes |
structuredFormat |
Décomposition de la prédiction de lieu sous la forme d'un texte principal contenant le nom du lieu et d'un texte secondaire contenant d'autres éléments permettant de faire la distinction (une ville ou une région, par exemple).
|
types[] |
Liste des types qui s'appliquent à ce lieu à partir du tableau A ou du tableau B dans le tableau https://developers.google.com/maps/documentation/places/web-service/place-types. Un type est une catégorisation d'un lieu. Les lieux partageant des types partagés partagent des caractéristiques similaires. |
distanceMeters |
Longueur de la géodésique en mètres à partir de |
FormattableText
Texte représentant une prédiction de lieu ou de requête. Le texte peut être utilisé tel quel ou mis en forme.
Représentation JSON |
---|
{
"text": string,
"matches": [
{
object ( |
Champs | |
---|---|
text |
Texte pouvant être utilisé tel quel ou mis en forme avec |
matches[] |
Liste de plages de chaînes identifiant la correspondance entre la requête d'entrée et Ces valeurs sont des décalages de caractères Unicode de |
StringRange
Identifie une sous-chaîne dans un texte donné.
Représentation JSON |
---|
{ "startOffset": integer, "endOffset": integer } |
Champs | |
---|---|
startOffset |
Décalage basé sur zéro du premier caractère Unicode de la chaîne (inclus). |
endOffset |
Décalage basé sur zéro du dernier caractère Unicode (exclusif). |
StructuredFormat
Contient une répartition des prédictions de lieu ou de requête en texte principal et texte secondaire.
Pour les prédictions de lieu, le texte principal contient le nom spécifique du lieu. Pour les prédictions de requête, le texte principal contient la requête.
Le texte secondaire contient d'autres éléments géographiques permettant de faire la distinction (comme une ville ou une région) permettant d'identifier plus précisément le lieu ou d'affiner la requête.
Représentation JSON |
---|
{ "mainText": { object ( |
Champs | |
---|---|
mainText |
Représente le nom du lieu ou de la requête. |
secondaryText |
Représente d'autres éléments géographiques permettant de faire la distinction (comme une ville ou une région) permettant d'identifier plus précisément le lieu ou d'affiner la requête. |
QueryPrediction
Résultats d'une prédiction Query Autocomplete.
Représentation JSON |
---|
{ "text": { object ( |
Champs | |
---|---|
text |
Texte prédit. Ce texte ne représente pas un lieu, mais plutôt une requête textuelle pouvant être utilisée dans un point de terminaison de recherche (par exemple, Text Search).
Peut être dans plusieurs langues si les requêtes |
structuredFormat |
Décomposition de la prédiction de requête sous la forme d'un texte principal contenant la requête et d'un texte secondaire contenant d'autres caractéristiques permettant de faire la distinction (une ville ou une région, par exemple).
|