Method: places.searchText

Recherche de lieux basée sur une requête textuelle.

Requête HTTP

POST https://places.googleapis.com/v1/places: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,
  "rankPreference": enum (RankPreference),
  "includedType": string,
  "openNow": boolean,
  "minRating": number,
  "maxResultCount": integer,
  "priceLevels": [
    enum (PriceLevel)
  ],
  "strictTypeFiltering": boolean,
  "locationBias": {
    object (LocationBias)
  },
  "locationRestriction": {
    object (LocationRestriction)
  },
  "evOptions": {
    object (EVOptions)
  }
}
Champs
textQuery

string

Obligatoire. Requête textuelle pour la recherche textuelle.

languageCode

string

Les détails du lieu s'afficheront dans la langue préférée, le cas échéant. Si le code de langue n'est pas spécifié ou n'est pas reconnu, des informations sur le lieu peuvent s'afficher pour n'importe quelle langue, en préférant l'anglais si ces informations existent.

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

regionCode

string

Le code pays/région Unicode (CLDR) de l'emplacement d'où provient la requête. Ce paramètre permet d'afficher des détails sur le lieu, comme son nom spécifique à une région, le cas échéant. Le paramètre peut avoir une incidence sur les résultats en fonction de la législation applicable.

Pour en savoir plus, consultez la page 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.

rankPreference

enum (RankPreference)

Mode de classement des résultats dans la réponse.

includedType

string

Type de lieu demandé. Liste complète des types compatibles: https://developers.google.com/maps/documentation/places/web-service/place-types. N'accepte qu'un seul type inclus.

openNow

boolean

Permet de limiter la recherche aux lieux actuellement ouverts. La valeur par défaut est "false".

minRating

number

Filtrez les résultats dont la note moyenne des visiteurs est strictement inférieure à cette limite. Une valeur valide doit être un nombre décimal compris entre 0 et 5 (inclus) à une cadence de 0,5, c'est-à-dire [0, 0,5, 1,0, ..., 5,0] (inclus). La valeur d'entrée est arrondie à la valeur 0,5(plafond) la plus proche. Par exemple, une note de 0,6 élimine tous les résultats inférieurs à 1,0.

maxResultCount

integer

Nombre maximal de résultats sur une page. Elle doit être comprise entre 1 et 20 inclus. La valeur par défaut est 20. Si ce nombre n'est pas défini, la limite supérieure est rétablie. Si le nombre est défini sur négatif ou dépasse la limite supérieure, une erreur INVALID_ARGUMENT est renvoyée.

priceLevels[]

enum (PriceLevel)

Utilisé pour limiter la recherche aux lieux signalés comme étant associés à certains niveaux de prix. Les utilisateurs peuvent choisir n'importe quelle combinaison de niveaux de prix. Sélectionnez par défaut tous les niveaux de prix.

strictTypeFiltering

boolean

Permet de définir un filtrage strict des types pour includeType. Si elle est définie sur "true", seuls les résultats du même type sont renvoyés. La valeur par défaut est "false".

locationBias

object (LocationBias)

Région dans laquelle effectuer la recherche. Cette position sert de biais, ce qui signifie que des résultats situés à proximité d'un lieu donné peuvent être renvoyés. Ne peut pas être défini avec locationRestriction.

locationRestriction

object (LocationRestriction)

Région dans laquelle effectuer la recherche. Cette zone géographique fait office de restriction, ce qui signifie que les résultats situés en dehors de la zone géographique indiquée ne seront pas renvoyés. Ne peut pas être défini avec locationBias.

evOptions

object (EVOptions)

Facultatif. Définissez les options de VE dans le cadre d'une requête de recherche de lieu.

Corps de la réponse

Proto de réponse pour places.searchText.

Si la requête aboutit, le corps de la réponse contient des données qui ont la structure suivante :

Représentation JSON
{
  "places": [
    {
      object (Place)
    }
  ]
}
Champs
places[]

object (Place)

Liste des lieux qui correspondent aux critères de recherche textuelle de l'utilisateur.

RankPreference

Mode de classement des résultats dans la réponse.

Enums
RANK_PREFERENCE_UNSPECIFIED Pour une requête catégorielle telle que "Restaurants à New York", RELEVANCE est la valeur par défaut. Pour les requêtes non catégorielles telles que "Mountain View, CA", nous vous recommandons de ne pas définir RankPreference.
DISTANCE Classe les résultats par distance.
RELEVANCE Il classe les résultats par pertinence. L'ordre de tri est déterminé par la pile de classement normale.

LocationBias

Région dans laquelle effectuer la recherche. Cette position sert de biais, ce qui signifie que des résultats situés à proximité d'un lieu donné peuvent être renvoyés.

Représentation JSON
{

  // Union field type can be only one of the following:
  "rectangle": {
    object (Viewport)
  },
  "circle": {
    object (Circle)
  }
  // End of list of possible types for union field type.
}
Champs

Champ d'union type.

type ne peut être qu'un des éléments suivants :

rectangle

object (Viewport)

Rectangle défini par un angle nord-est et sud-ouest rectangle.high() doit être le point nord-est de la fenêtre d'affichage rectangulaire. rectangle.low() doit être le point sud-ouest de la fenêtre d'affichage rectangulaire. rectangle.low().latitude() ne peut pas être supérieur à rectangle.high().latitude(). La plage de latitudes est donc vide. Une fenêtre d'affichage rectangulaire ne peut pas dépasser 180 degrés.

circle

object (Circle)

Cercle défini par un point central et un rayon

LocationRestriction

Région dans laquelle effectuer la recherche. Cette zone géographique fait office de restriction, ce qui signifie que les résultats situés en dehors de la zone géographique indiquée ne seront pas renvoyés.

Représentation JSON
{

  // Union field type can be only one of the following:
  "rectangle": {
    object (Viewport)
  }
  // End of list of possible types for union field type.
}
Champs

Champ d'union type.

type ne peut être qu'un des éléments suivants :

rectangle

object (Viewport)

Rectangle défini par un angle nord-est et sud-ouest rectangle.high() doit être le point nord-est de la fenêtre d'affichage rectangulaire. rectangle.low() doit être le point sud-ouest de la fenêtre d'affichage rectangulaire. rectangle.low().latitude() ne peut pas être supérieur à rectangle.high().latitude(). La plage de latitudes est donc vide. Une fenêtre d'affichage rectangulaire ne peut pas dépasser 180 degrés.

EVOptions

Options de VE dans une requête de recherche de lieu

Représentation JSON
{
  "minimumChargingRateKw": number,
  "connectorTypes": [
    enum (EVConnectorType)
  ]
}
Champs
minimumChargingRateKw

number

Facultatif. Taux de recharge minimal requis en kilowatts. Un lieu dont le taux de facturation est inférieur au tarif spécifié est exclu.

connectorTypes[]

enum (EVConnectorType)

Facultatif. Liste des types de connecteurs de VE préférés. Un emplacement qui n'est compatible avec aucun des types de connecteurs listés est exclu.