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 informations sur le lieu s'afficheront dans la langue préférée, si disponible. Si le code de langue n'est pas spécifié ou n'est pas reconnu, des détails sur le lieu peuvent s'afficher dans n'importe quelle langue, en privilégiant l'anglais, le cas échéant.

Liste des langues actuellement disponibles: https://developers.google.com/maps/faq#languagesupport
regionCode

string

Code pays/région Unicode (CLDR) de l'emplacement d'origine de la requête. Ce paramètre permet d'afficher les détails du lieu, comme le nom du lieu spécifique à la région, si disponible. Ce paramètre peut avoir un impact 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. Compatible uniquement avec un type inclus.
openNow

boolean

Permet de limiter la recherche aux lieux qui sont ouverts. La valeur par défaut est "false" (inactif).
minRating

number

Filtrez les résultats dont la note moyenne par les utilisateurs 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 au chiffre 0,5 le plus proche(plafond). 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 pouvant être renvoyés par page. Si le nombre de résultats disponibles est supérieur à maxResultCount, une valeur nextPageToken est renvoyée. Elle peut être transmise à 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 est 20. La valeur maximale est 20. les valeurs supérieures à 20 sont forcées à 20. Les valeurs négatives renverront une erreur INVALID_ARGUMENT.

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

integer

Facultatif. Nombre maximal de résultats pouvant être renvoyés par page. Si le nombre de résultats disponibles est supérieur à pageSize, une valeur nextPageToken est renvoyée. Elle peut être transmise à 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 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 tous les deux spécifiés, maxResultCount sera ignoré.
pageToken

string

Facultatif. Jeton de page reçu 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)

Permet de limiter la recherche aux lieux correspondant à certains niveaux de prix. Les utilisateurs peuvent choisir n'importe quelle combinaison de niveaux de prix. Par défaut, tous les niveaux de prix sont sélectionnés.
strictTypeFiltering

boolean

Utilisé pour définir un filtrage par type strict pour "includedType". Si cette règle 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. Cet emplacement sert de biais, ce qui signifie que les résultats à proximité d'un lieu donné peuvent s'afficher. Ne peut pas être défini avec locationRestriction.
locationRestriction

object (LocationRestriction)

Région dans laquelle effectuer la recherche. Cet établissement constitue une restriction, ce qui signifie qu'aucun résultat ne s'affiche en dehors de celui-ci. Ne peut pas être défini avec locationBias.
evOptions

object (EVOptions)

Facultatif. Définissez les options de VE dans l'index de recherche 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 de texte de l'utilisateur.
contextualContents[]

object (ContextualContent)

Fonctionnalité 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 laquelle chaque entrée s'associe au lieu correspondant dans le même index dans le champ "Places". Il est préférable d'utiliser des contenus pertinents pour textQuery dans la requête. Si le contenu contextuel n'est pas disponible pour l'un des lieux, il affichera du contenu non contextuel. Ce champ ne sera vide que lorsque le contenu ne sera pas disponible pour ce lieu. Si vous y êtes invité, cette liste doit contenir autant d'entrées que la liste de lieux.
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", la valeur PERTINENTE 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 en fonction de la distance.
RELEVANCE Classe les résultats par pertinence. Ordre de tri déterminé par la pile de classement normale.

LocationBias

Région dans laquelle effectuer la recherche. Cet emplacement sert de biais, ce qui signifie que les résultats à proximité d'un lieu donné peuvent s'afficher.

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 les angles nord-est et sud-ouest rectangle.high() doit se trouver au 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(). Vous obtiendrez une plage de latitude vide. Une fenêtre d'affichage rectangulaire ne peut pas avoir une largeur supérieure à 180 degrés.
circle

object (Circle)

Cercle défini par un point central et un rayon.

LocationRestriction

Région dans laquelle effectuer la recherche. Cet établissement constitue une restriction, ce qui signifie qu'aucun résultat ne s'affiche en dehors de celui-ci.

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 les angles nord-est et sud-ouest rectangle.high() doit se trouver au 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(). Vous obtiendrez une plage de latitude vide. Une fenêtre d'affichage rectangulaire ne peut pas avoir une largeur supérieure à 180 degrés.

EVOptions

Options de recherche de VE d'une requête de recherche de lieu.

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

number

Facultatif. Vitesse de recharge minimale requise en kilowatts. Les lieux dont le taux de facturation est inférieur au taux spécifié sont filtrés.
connectorTypes[]

enum (EVConnectorType)

Facultatif. Liste des types de connecteurs VE recommandés. Tout emplacement qui n'accepte aucun des types de connecteurs répertoriés est filtré.

ContextualContent

Fonctionnalité 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 des avis sur ce lieu, en lien avec la requête de lieu.
photos[]

object (Photo)

Informations (y compris les références) sur les photos de ce lieu, contexuelles par rapport à la requête de lieu.
justifications[]

object (Justification)

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

Justifications relatives au lieu.

Justification

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

Justifications relatives au lieu. Les justifications permettent 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)

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

object (BusinessAvailabilityAttributesJustification)

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

ReviewJustification

Fonctionnalité 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 d'utilisateur qui pourrait intéresser un utilisateur final. Par exemple, si la requête de recherche est "pizza bois pour feu", la justification de l'avis met en surbrillance le texte correspondant à la requête.

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

object (HighlightedText)
review

object (Review)

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

HighlightedText

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

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

string
highlightedTextRanges[]

object (HighlightedTextRange)

Liste des plages du texte en surbrillance.

HighlightedTextRange

Plage de texte en surbrillance.

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

integer
endIndex

integer

BusinessAvailabilityAttributesJustification

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

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

boolean

Si un établissement propose des plats à emporter.
delivery

boolean

Indique si un établissement propose la livraison.
dineIn

boolean

Si un établissement propose des repas sur place.