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,
  "pageSize": integer,
  "pageToken": string,
  "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
(deprecated)

integer

Obsolète: utilisez plutôt pageSize.

Nombre maximal de résultats par page pouvant être renvoyés. Si le nombre de résultats disponibles est supérieur à maxResultCount, un nextPageToken est renvoyé. Il peut être transmis à pageToken pour obtenir la page de résultats suivante dans les requêtes suivantes. Si aucune valeur n'est spécifiée, la valeur par défaut utilisée est 20. La valeur maximale est 20 ; les valeurs supérieures seront forcées à 20. Les valeurs négatives renverront une erreur INVALID_ARGUMENT.

Si maxResultCount et pageSize sont spécifiés, maxResultCount sera ignoré.
pageSize

integer

Facultatif. Nombre maximal de résultats par page pouvant être renvoyés. Si le nombre de résultats disponibles est supérieur à pageSize, un nextPageToken est renvoyé. Il peut être transmis à pageToken pour obtenir la page de résultats suivante dans les requêtes suivantes. Si aucune valeur n'est spécifiée, la valeur par défaut utilisée est 20. La valeur maximale est 20. Les valeurs supérieures à 20 sont définies sur 20. Les valeurs négatives renverront une erreur INVALID_ARGUMENT.

Si maxResultCount et pageSize sont spécifiés, maxResultCount sera ignoré.
pageToken

string

Facultatif. Jeton de page, reçu lors d'un appel TextSearch précédent. Fournissez-le pour récupérer la page suivante.

Lors de la pagination, tous les paramètres autres que pageToken, pageSize et maxResultCount fournis à TextSearch doivent correspondre à l'appel initial qui a fourni le jeton de page. Sinon, 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)
    }
  ],
  "contextualContents": [
    {
      object (ContextualContent)
    }
  ],
  "nextPageToken": string
}
Champs
places[]

object (Place)

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

object (ContextualContent)

Version expérimentale: consultez la page https://developers.google.com/maps/documentation/places/web-service/experimental/places-generative pour en savoir plus.

Liste de contenus contextuels dans lesquels chaque entrée est associée au lieu correspondant dans le même index dans le champ "Lieux". Il est préférable d'utiliser les contenus pertinents pour textQuery dans la requête. Si le contenu contextuel n'est pas disponible pour l'un de ces emplacements, il renvoie du contenu non contextuel. Elle n'est vide que si le contenu n'est pas disponible pour ce lieu. Cette liste doit comporter autant d'entrées que la liste de lieux, si nécessaire.
nextPageToken

string

Jeton pouvant être envoyé en tant que pageToken pour récupérer la page suivante. Si ce champ est omis ou vide, il n'y a pas de pages suivantes.

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.

ContextualContent

Version expérimentale: consultez la page https://developers.google.com/maps/documentation/places/web-service/experimental/places-generative pour en savoir plus.

Contenu contextuel par rapport à la requête de lieu.

Représentation JSON 
{
  "reviews": [
    {
      object (Review)
    }
  ],
  "photos": [
    {
      object (Photo)
    }
  ],
  "justifications": [
    {
      object (Justification)
    }
  ]
}
Champs
reviews[]

object (Review)

Liste d'avis sur ce lieu, consignés par rapport à la requête relative à ce lieu.
photos[]

object (Photo)

Informations (y compris des références) sur les photos de ce lieu, contenues dans la requête concernant le lieu.
justifications[]

object (Justification)

Version expérimentale: consultez la page https://developers.google.com/maps/documentation/places/web-service/experimental/places-generative pour en savoir plus.

Justifications concernant le lieu.

Justification

Version expérimentale: consultez la page https://developers.google.com/maps/documentation/places/web-service/experimental/places-generative pour en savoir plus.

Justifications concernant le lieu. Les justifications répondent à la question de savoir pourquoi un lieu pourrait intéresser un utilisateur final.

Représentation JSON 
{

  // Union field justification can be only one of the following:
  "reviewJustification": {
    object (ReviewJustification)
  },
  "businessAvailabilityAttributesJustification": {
    object (BusinessAvailabilityAttributesJustification)
  }
  // End of list of possible types for union field justification.
}
Champs

Champ d'union justification.

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

object (ReviewJustification)

Version expérimentale: consultez la page https://developers.google.com/maps/documentation/places/web-service/experimental/places-generative pour en savoir plus.
businessAvailabilityAttributesJustification

object (BusinessAvailabilityAttributesJustification)

Version expérimentale: consultez la page https://developers.google.com/maps/documentation/places/web-service/experimental/places-generative pour en savoir plus.

ReviewJustification

Version expérimentale: consultez la page https://developers.google.com/maps/documentation/places/web-service/experimental/places-generative pour en savoir plus.

Justifications des avis d'utilisateurs. Cela met en évidence une section de l'avis de l'utilisateur qui pourrait l'intéresser. Par exemple, si la requête de recherche est "pizza au feu de bois", le texte correspondant à la requête de recherche est mis en surbrillance dans la justification.

Représentation JSON 
{
  "highlightedText": {
    object (HighlightedText)
  },
  "review": {
    object (Review)
  }
}
Champs
highlightedText

object (HighlightedText)
review

object (Review)

Avis à partir duquel le texte en surbrillance est généré.

HighlightedText

Texte surligné par la justification. Il s'agit d'un sous-ensemble de l'avis lui-même. Le mot exact à mettre en surbrillance est marqué par HighlightedTextRange. Le texte mis en surbrillance peut contenir plusieurs mots.

Représentation JSON 
{
  "text": string,
  "highlightedTextRanges": [
    {
      object (HighlightedTextRange)
    }
  ]
}
Champs
text

string
highlightedTextRanges[]

object (HighlightedTextRange)

Liste des plages du texte en surbrillance.

HighlightedTextRange

Plage du texte en surbrillance.

Représentation JSON 
{
  "startIndex": integer,
  "endIndex": integer
}
Champs
startIndex

integer
endIndex

integer

BusinessAvailabilityAttributesJustification

Version expérimentale: consultez la page https://developers.google.com/maps/documentation/places/web-service/experimental/places-generative pour en savoir plus. Justifications de BusinessAvailabilityAttributes. Il présente certains attributs d'une entreprise qui pourraient intéresser un utilisateur final.

Représentation JSON 
{
  "takeout": boolean,
  "delivery": boolean,
  "dineIn": boolean
}
Champs
takeout

boolean

L'établissement propose des plats à emporter.
delivery

boolean

Si un établissement propose la livraison.
dineIn

boolean

Si un établissement propose des repas sur place.