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)
  },
  "routingParameters": {
    object (RoutingParameters)
  },
  "searchAlongRouteParameters": {
    object (SearchAlongRouteParameters)
  },
  "includePureServiceAreaBusinesses": boolean
}
Champs
textQuery

string

Obligatoire. Requête textuelle pour la recherche textuelle.
languageCode

string

Les informations sur le lieu s'affichent 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 dans n'importe quelle langue peuvent être renvoyées, en privilégiant l'anglais si de telles informations existent.

Liste actuelle des langues 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, 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 de région à trois chiffres ne sont pas acceptés pour le moment.
rankPreference

enum (RankPreference)

Méthode 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 qui sont ouverts. La valeur par défaut est "false" (inactif).
minRating

number

Filtrez les résultats dont la note moyenne 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 pageSize à la place.

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é et peut être transmis à pageToken pour obtenir la page de résultats suivante dans les requêtes ultérieures. Si la valeur 0 est fournie ou si aucune valeur n'est fournie, la valeur par défaut est 20. La valeur maximale est 20. Les valeurs supérieures sont réduites à 20. Les valeurs négatives renverront une erreur INVALID_ARGUMENT.

Si les options maxResultCount et pageSize sont spécifiées, maxResultCount est ignorée.
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, 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 la valeur 0 est fournie ou si aucune valeur n'est fournie, la valeur par défaut est 20. La valeur maximale est 20. Les valeurs supérieures à 20 seront définies sur 20. Les valeurs négatives renvoient une erreur INVALID_ARGUMENT.

Si les options maxResultCount et pageSize sont spécifiées, maxResultCount est ignorée.
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 établissements associés à 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

Permet de définir un filtrage strict du type 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 à rechercher. Cet emplacement sert de biais, ce qui signifie que des résultats autour de cet emplacement peuvent être renvoyés. Ne peut pas être défini avec "locationRestriction".
locationRestriction

object (LocationRestriction)

Région à rechercher. Cet emplacement sert de restriction, ce qui signifie que les résultats en dehors de l'emplacement donné ne seront pas renvoyés. Ne peut pas être défini avec locationBias.
evOptions

object (EVOptions)

Facultatif. Définissez les options de recherche EV d'une requête de recherche de lieu.
routingParameters

object (RoutingParameters)

Facultatif. Paramètres supplémentaires pour le routage vers les résultats.
searchAlongRouteParameters

object (SearchAlongRouteParameters)

Facultatif. Proto de paramètres supplémentaires pour la recherche sur un trajet.
includePureServiceAreaBusinesses

boolean

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'un établissement proposant des services de nettoyage ou de plomberie. Ces établissements n'ont pas d'adresse physique ni de lieu sur Google Maps. Places ne renvoie pas de champs incluant location et plusCode, ni d'autres champs liés à la localisation pour ces établissements.

Corps de la réponse

Protocole 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)
    }
  ],
  "routingSummaries": [
    {
      object (RoutingSummary)
    }
  ],
  "contextualContents": [
    {
      object (ContextualContent)
    }
  ],
  "nextPageToken": string,
  "searchUri": string
}
Champs
places[]

object (Place)

Liste des lieux qui répondent aux critères de recherche textuelle de l'utilisateur.
routingSummaries[]

object (RoutingSummary)

Liste de résumés de routage où chaque entrée s'associe au lieu correspondant dans le même index dans le champ places. Si le résumé du calcul d'itinéraire n'est pas disponible pour l'un des lieux, il contient une entrée vide. Si vous le souhaitez, cette liste comportera autant d'entrées que la liste des lieux.
contextualContents[]

object (ContextualContent)

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

Liste de contenus contextuels dans laquelle chaque entrée s'associe au lieu correspondant dans le même index dans le champ "Places". Les contenus pertinents pour l'textQuery de la requête sont privilégiés. Si le contenu contextuel n'est pas disponible pour l'un des lieux, un contenu non contextuel est renvoyé. Il ne sera vide que lorsque le contenu n'est pas disponible pour cet emplacement. Si vous le souhaitez, cette liste comportera autant d'entrées que la liste des 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, aucune page suivante n'existe.
searchUri

string

Un lien permet à l'utilisateur de rechercher avec la même requête textuelle que celle spécifiée dans la requête sur Google Maps.

RankPreference

Méthode de classement des résultats dans la réponse.

Enums
RANK_PREFERENCE_UNSPECIFIED Pour une requête de type catégoriel, comme "Restaurants à New York", la pertinence est utilisée par défaut. Pour les requêtes non catégoriques telles que "Mountain View, CA", nous vous recommandons de ne pas définir rankPreference.
DISTANCE Classifie les résultats par distance.
RELEVANCE Classement des 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. Cet emplacement sert de biais, ce qui signifie que des résultats autour de cet emplacement 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 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 correspondre au point sud-ouest du viewport du rectangle. rectangle.low().latitude() ne peut pas être supérieur à rectangle.high().latitude(). Vous obtiendrez une plage de latitude vide. La largeur d'un viewport 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 à rechercher. 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)

Cadre rectangulaire 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 correspondre au point sud-ouest du viewport du rectangle. rectangle.low().latitude() ne peut pas être supérieur à rectangle.high().latitude(). Vous obtiendrez ainsi 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 VE disponibles à rechercher 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. Les lieux dont le tarif de recharge est inférieur au tarif spécifié sont filtrés.
connectorTypes[]

enum (EVConnectorType)

Facultatif. Liste des types de connecteurs de VE privilégiés. Les lieux qui ne sont compatibles avec aucun des types de connecteurs listés sont filtrés.

SearchAlongRouteParameters

Spécifie une polyligne précalculée à partir de l'API Routes qui définit l'itinéraire à rechercher. Effectuer une recherche le long d'un itinéraire est semblable à utiliser l'option de requête locationBias ou locationRestriction pour biaiser les résultats de recherche. Toutefois, alors que les options locationBias et locationRestriction vous permettent de spécifier une région pour biaiser les résultats de recherche, cette option vous permet de biaiser les résultats sur un trajet.

Les résultats ne sont pas nécessairement situés sur l'itinéraire fourni, mais sont classés dans la zone de recherche définie par la polyligne et, éventuellement, par les locationBias ou locationRestriction en fonction des temps de déviation minimaux entre le point de départ et la destination. Les résultats peuvent se trouver sur un itinéraire bis, en particulier si la polyligne fournie ne définit pas d'itinéraire optimal entre le point de départ et la destination.

Représentation JSON 
{
  "polyline": {
    object (Polyline)
  }
}
Champs
polyline

object (Polyline)

Obligatoire. Polyligne d'itinéraire.

Polyline

Polyligne d'itinéraire. N'accepte qu'une polyligne encodée, qui peut être transmise en tant que chaîne et inclut une compression avec une perte minimale. Il s'agit de la sortie par défaut de l'API Routes.

Représentation JSON 
{

  // Union field polyline_type can be only one of the following:
  "encodedPolyline": string
  // End of list of possible types for union field polyline_type.
}
Champs
Champ d'union polyline_type. Encapsule le type de polyligne. Le résultat de l'API Routes est défini par défaut sur encoded_polyline. La polyline_type ne peut être qu'un des éléments suivants :
encodedPolyline

string

Une polyligne encodée, telle que renvoyée par l'API Routes par défaut. Consultez les outils encodeur et décodeur.

ContextualContent

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

Contenu en rapport avec 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 fonction de la requête de lieu.
photos[]

object (Photo)

Informations (y compris des références) sur les photos de ce lieu, en fonction de la requête sur le 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 du lieu

Justification

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

Justifications du lieu Les justifications répondent à la question "Pourquoi un lieu peut-il 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: pour en savoir plus, consultez la page https://developers.google.com/maps/documentation/places/web-service/experimental/places-generative.
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: pour en savoir plus, consultez la page https://developers.google.com/maps/documentation/places/web-service/experimental/places-generative.

Justifications des avis des utilisateurs Cela met en évidence une section de l'avis de l'utilisateur qui intéresserait un utilisateur final. Par exemple, si la requête de recherche est "pizza au feu de bois", la justification de l'avis met en évidence le texte pertinent pour la requête de recherche.

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

object (HighlightedText)
review

object (Review)

Avis à partir duquel le texte mis en surbrillance est 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 marqué par HighlightedTextRange. Plusieurs mots du texte peuvent être mis en surbrillance.

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

string
highlightedTextRanges[]

object (HighlightedTextRange)

Liste des plages du texte en surbrillance.

HighlightedTextRange

Intervalle de texte mis en surbrillance.

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

integer
endIndex

integer

BusinessAvailabilityAttributesJustification

Fonctionnalité expérimentale: pour en savoir plus, consultez la page https://developers.google.com/maps/documentation/places/web-service/experimental/places-generative. Justifications des attributs BusinessAvailabilityAttributes. Il s'agit d'attributs d'un établissement qui pourraient intéresser un utilisateur final.

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

boolean

Indique si un établissement propose des plats à emporter.
delivery

boolean

Indique si un établissement propose la livraison.
dineIn

boolean

Indique si un établissement propose des repas sur place.