Method: searchText

Recherchez des lieux à l'aide d'une requête textuelle.

Requête HTTP

POST https://mapstools.googleapis.com/v1:searchText

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
{
  "textQuery": string,
  "languageCode": string,
  "regionCode": string,
  "pageSize": integer,
  "includeExtendedDetails": boolean,
  "locationBias": {
    object (LocationBias)
  }
}
Champs
textQuery

string

Obligatoire. Requête textuelle.

languageCode

string

Facultatif. Langue dans laquelle le résumé doit être renvoyé. Si le code de langue n'est pas spécifié ou n'est pas reconnu, le résumé sera renvoyé en anglais.

Par exemple, "en" pour l'anglais.

Liste actuelle des langues acceptées : https://developers.google.com/maps/faq#languagesupport.

regionCode

string

Facultatif. Code Unicode de pays/région (CLDR) de l'emplacement d'où provient la requête. Ce paramètre permet d'afficher les détails du lieu, comme le nom du lieu spécifique à la région, s'il est disponible. Le paramètre peut affecter les résultats en fonction de la législation applicable.

Par exemple, "US" pour les États-Unis.

Pour en savoir plus, consultez https://www.unicode.org/cldr/charts/latest/supplemental/territory_language_information.html.

Notez que les codes régionaux à trois chiffres ne sont pas acceptés pour le moment.

pageSize

integer

Facultatif. Nombre maximal de lieux à renvoyer (jusqu'à 10). Le service peut renvoyer un nombre inférieur à cette valeur. La valeur par défaut est 5.

Si vous demandez plus de cinq lieux, le niveau Pro sera déclenché, ce qui entraînera des coûts de facturation et une latence plus élevés.

includeExtendedDetails

boolean

Facultatif. Inclut des détails étendus sur le lieu dans la réponse.

Définissez ce champ sur true lorsque la requête de l'utilisateur nécessite des insights qualitatifs enrichis, une dynamique en temps réel ou des attributs d'entité spécialisés : avis qualitatifs, sentiment des clients et commentaires. - Offres spécifiques telles que des éléments de menu, des plats, des spécialités culinaires, des boissons ou des points forts de l'établissement. - Atmosphère, décoration intérieure, esthétique, ambiance ou humeur qualitative. - Données en temps réel et spécifications des établissements spécialisés, règles/conseils pour les visiteurs, temps d'attente.

Laissez false (par défaut) pour les recherches standards (par exemple, cuisines, types de magasins), les recherches de lieux/adresses, les coordonnées, les horaires d'ouverture et les métadonnées/services standards.

Si vous activez ce champ, le niveau Pro sera déclenché, ce qui entraînera des coûts de facturation et une latence plus élevés.

locationBias

object (LocationBias)

Région facultative pour orienter les résultats de recherche. Si un emplacement explicite est défini dans textQuery, il sera utilisé pour biaiser les résultats de recherche au lieu de ce champ.

Corps de la réponse

Si la requête aboutit, le corps de la réponse contient une instance de SearchTextResponse.

Champs d'application des autorisations

Requiert le champ d'application OAuth suivant :

  • https://www.googleapis.com/auth/maps-platform.mapstools