- Requête HTTP
- Corps de la requête
- Corps de la réponse
- LocationBias
- LocationRestriction
- Suggestion
- PlacePrediction
- FormattableText
- StringRange
- StructuredFormat
- QueryPrediction
Renvoie les 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 à rechercher. |
location |
Facultatif. Limitez les résultats à un emplacement spécifié. Vous ne devez définir que |
location |
Facultatif. Limitez les résultats à un emplacement spécifié. Vous ne devez définir qu'un seul élément |
included |
Facultatif. Incluez le type d'établissement principal (par exemple, "restaurant" ou "station_service") dans les types d'établissements (https://developers.google.com/maps/documentation/places/web-service/place-types), ou uniquement |
included |
Facultatif. Inclure uniquement les résultats dans les régions spécifiées, jusqu'à 15 codes de région CLDR à deux caractères. Un ensemble vide ne limite pas les résultats. Si les champs |
language |
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 |
region |
Facultatif. Code régional, spécifié sous forme de code régional CLDR à deux caractères. Cela affecte le formatage des adresses, le classement des résultats et peut avoir une incidence sur 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 |
input |
Facultatif. Décalage de caractère Unicode basé sur zéro de Si cet élément est vide, la longueur est définie par défaut sur |
include |
Facultatif. Si cette valeur est définie sur "true", la réponse inclut à la fois les prédictions de lieu et de requête. Sinon, la réponse ne renverra que des prédictions de lieux. |
session |
Facultatif. Chaîne qui identifie une session Autocomplete à des fins de facturation. Doit s'agir d'une chaîne base64 sécurisée pour les URL et les noms de fichiers, ne comportant pas plus 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 vous omettez le paramètre Nous vous recommandons de respecter les consignes suivantes:
|
include |
Facultatif. Inclut les établissements de services de proximité à domicile si le champ est défini sur "true". Un établissement de services de proximité à domicile est un établissement qui se rend directement chez les clients pour effectuer une prestation ou leur livrer directement des produits, mais qui n'accueille pas les clients dans ses locaux. Il peut s'agir, par exemple, d'entreprises comme les services de nettoyage ou de plomberie. Ces établissements n'ont pas d'adresse physique ni de lieu sur Google Maps. Places ne renverra pas les champs |
Corps de la réponse
Proto de réponse pour places.autocomplete
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 à rechercher. 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 suggestion de saisie semi-automatique.
Représentation JSON |
---|
{ // Union field |
Champs | |
---|---|
Champ d'union
|
|
place |
Prédiction pour un lieu. |
query |
Prédiction pour une requête. |
PlacePrediction
Résultats de prédiction pour une prédiction Place Autocomplete.
Représentation JSON |
---|
{ "place": string, "placeId": string, "text": { object ( |
Champs | |
---|---|
place |
Nom de la ressource du lieu suggéré. Ce nom peut être utilisé dans d'autres API qui acceptent des noms de lieu. |
place |
Identifiant unique du lieu suggéré. Cet identifiant peut être utilisé dans d'autres API qui acceptent les ID de lieu. |
text |
Inclut le nom lisible du résultat renvoyé. Pour les résultats d'établissement, il s'agit généralement du nom et de l'adresse de l'entreprise.
Ce texte peut différer de l' Peut être dans des langues différentes si les requêtes |
structured |
Décomposition de la prédiction de lieu en texte principal contenant le nom du lieu et texte secondaire contenant des éléments supplémentaires permettant de lever l'ambiguïté (comme une ville ou une région).
|
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 de même type présentent des caractéristiques similaires. |
distance |
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 formaté.
Représentation JSON |
---|
{
"text": string,
"matches": [
{
object ( |
Champs | |
---|---|
text |
Texte pouvant être utilisé tel quel ou mis en forme avec |
matches[] |
Liste des plages de chaînes indiquant où la requête d'entrée a correspondu dans 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 | |
---|---|
start |
Décalage basé sur zéro du premier caractère Unicode de la chaîne (inclus). |
end |
Décalage à partir de zéro du dernier caractère Unicode (exclusif). |
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êtes, 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 | |
---|---|
main |
Représente le nom du lieu ou de la requête. |
secondary |
Représente des éléments supplémentaires permettant de lever l'ambiguïté (comme une ville ou une région) pour identifier plus précisément le lieu ou affiner la requête. |
QueryPrediction
Résultats de prédiction pour une prédiction de saisie semi-automatique de requête.
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, la recherche textuelle).
Peut être dans des langues mixtes si la requête |
structured |
Répartition de la prédiction de la requête en texte principal contenant la requête et texte secondaire contenant des éléments supplémentaires permettant de lever l'ambiguïté (comme une ville ou une région).
|