- Requête HTTP
- Corps de la requête
- Corps de la réponse
- LocationBias
<ph type="x-smartling-placeholder">
- </ph>
- Représentation JSON
- LocationRestriction
<ph type="x-smartling-placeholder">
- </ph>
- Représentation JSON
- Suggestion
<ph type="x-smartling-placeholder">
- </ph>
- Représentation JSON
- PlacePrediction
<ph type="x-smartling-placeholder">
- </ph>
- Représentation JSON
- FormattableText
<ph type="x-smartling-placeholder">
- </ph>
- Représentation JSON
- StringRange
<ph type="x-smartling-placeholder">
- </ph>
- Représentation JSON
- StructuredFormat
<ph type="x-smartling-placeholder">
- </ph>
- Représentation JSON
- QueryPrediction
<ph type="x-smartling-placeholder">
- </ph>
- Représentation JSON
Affiche 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 dans laquelle effectuer la recherche. |
locationBias |
Facultatif. Limiter les résultats à un emplacement spécifié Vous ne devez définir que |
locationRestriction |
Facultatif. Limite les résultats à un emplacement spécifié. Vous ne devez définir que |
includedPrimaryTypes[] |
Facultatif. Incluez le type de lieu principal (par exemple, "restaurant" ou "station-service") du tableau A ou du tableau B dans les types de lieux (https://developers.google.com/maps/documentation/places/web-service/place-types), ou seulement (régions) ou uniquement (villes). Un lieu n'est renvoyé que si son type principal figure 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 les résultats uniquement dans les régions spécifiées, avec un maximum de 15 codes régionaux à deux caractères CLDR. Un ensemble vide ne limite 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 être rédigés dans différentes langues si la langue utilisée dans |
regionCode |
Facultatif. Code régional, spécifié sous la forme d'un code régional CLDR à deux caractères. Cela affecte le format des adresses, 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é sous la forme |
inputOffset |
Facultatif. Décalage de caractère Unicode de base à zéro de Si ce champ est vide, la longueur par défaut est |
includeQueryPredictions |
Facultatif. Si la valeur est "true", la réponse inclut à la fois des prédictions de lieu et de requête. Sinon, la réponse ne renverra que des prédictions de lieu. |
sessionToken |
Facultatif. Chaîne identifiant une session Autocomplete à des fins de facturation. Doit être une chaîne au format base64 sans risque pour les URL et les noms de fichiers, avec une longueur maximale de 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 sein d'une session doivent appartenir au même projet dans 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
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 de pertinence décroissant. |
LocationBias
Région dans laquelle effectuer la recherche. Les résultats peuvent être faussés autour de 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 un angle sud-ouest. |
circle |
Cercle défini par un point central et un rayon. |
LocationRestriction
Région dans laquelle effectuer la recherche. Les résultats seront 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 un angle 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 pour un lieu. |
queryPrediction |
Prédiction pour 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é. Dans les résultats d'un établissement, 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 des langues mixtes si la requête |
structuredFormat |
Décomposition de la prédiction du lieu en texte principal contenant le nom du lieu et texte secondaire contenant d'autres caractéristiques spécifiques (une ville ou une région, par exemple).
|
types[] |
Liste des types qui s'appliquent à ce lieu à partir du tableau A ou B de la page https://developers.google.com/maps/documentation/places/web-service/place-types. Un type est une catégorisation d'un lieu. Les lieux avec des types partagés partageront 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 où la requête d'entrée a été mise en correspondance dans Ces valeurs sont des décalages de caractères Unicode de |
StringRange
Identifie une sous-chaîne d'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 (exclus). |
StructuredFormat
Contient la répartition d'une prédiction 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 des éléments géographiques de sélection supplémentaires (tels qu'une ville ou une région) pour identifier plus précisément le lieu ou 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 des éléments géographiques supplémentaires (tels qu'une ville ou une région) permettant d'identifier 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 des langues mixtes si la requête |
structuredFormat |
Décomposition de la prédiction de la requête en texte principal contenant la requête et texte secondaire contenant des caractéristiques de sélection supplémentaires (telles qu'une ville ou une région).
|