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,
  "includeFutureOpeningBusinesses": boolean
}
Champs
textQuery

string

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

string

Les informations sur le lieu s'affichent dans la langue de votre choix, si elle est disponible. 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, avec une préférence pour l'anglais si de telles informations existent.

Pour obtenir la liste actuelle des langues disponibles, consultez https://developers.google.com/maps/faq#languagesupport.
regionCode

string

Code de pays/région Unicode (CLDR) de l'emplacement d'où provient la demande. Ce paramètre permet d'afficher les détails du lieu, comme son nom spécifique à la région, s'il est disponible. Ce paramètre peut avoir une incidence sur les résultats en fonction de la loi applicable.

Pour en savoir plus, consultez 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)

Comment les résultats seront classés dans la réponse.
includedType

string

Type de lieu demandé. Liste complète des types acceptés : https://developers.google.com/maps/documentation/places/web-service/place-types. Ne prend en charge qu'un seul type inclus.
openNow

boolean

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

number

Filtrer les résultats dont la note moyenne des utilisateurs est strictement inférieure à cette limite. Une valeur valide doit être un nombre à virgule flottante compris entre 0 et 5 (inclus) avec une cadence de 0,5, c'est-à-dire [0, 0.5, 1.0, ..., 5.0] inclus. La note saisie est arrondie à la valeur 0,5 supérieure(plafond). Par exemple, une note de 0,6 éliminera tous les résultats dont la note est inférieure à 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, 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 ou aucune valeur n'est fournie, la valeur par défaut de 20 est utilisée. La valeur maximale est 20. Les valeurs supérieures sont réduites à 20. Les valeurs négatives renvoient une erreur INVALID_ARGUMENT.

Si les deux champs maxResultCount et pageSize sont 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, 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 ou aucune valeur n'est fournie, la valeur par défaut de 20 est utilisée. La valeur maximale est 20. Les valeurs supérieures sont définies sur 20. Les valeurs négatives renvoient une erreur INVALID_ARGUMENT.

Si les deux champs maxResultCount et pageSize sont 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 ayant fourni le jeton de page. Sinon, une erreur INVALID_ARGUMENT est renvoyée.
priceLevels[]

enum (PriceLevel)

Permet de limiter la recherche aux lieux marqués avec 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 des types pour includedType. Si la valeur est "true", seuls les résultats du même type seront 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 des résultats autour de l'emplacement indiqué peuvent être renvoyés. Ne peut pas être défini avec locationRestriction.
locationRestriction

object (LocationRestriction)

Région dans laquelle effectuer la recherche. Cet emplacement sert de restriction, ce qui signifie que les résultats en dehors de l'emplacement indiqué ne seront pas renvoyés. Ne peut pas être défini avec locationBias.
evOptions

object (EVOptions)

Facultatif. Définissez les options de VE pouvant faire l'objet d'une recherche pour une requête de recherche de lieux.
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 le long d'un itinéraire.
includePureServiceAreaBusinesses

boolean

Facultatif. Incluez les établissements de services de proximité à domicile si le champ est défini sur "true". Un établissement de services de proximité est un établissement qui se rend directement chez les clients pour effectuer une prestation ou leur livrer 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 localisation sur Google Maps. Places ne renverra pas les champs incluant location, plusCode et d'autres champs liés à la localisation pour ces établissements.
includeFutureOpeningBusinesses

boolean

Facultatif. Si la valeur est "true", incluez les établissements qui ne sont pas encore ouverts, mais qui le seront à l'avenir.

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

object (Place)

Liste des lieux correspondant aux critères de recherche textuelle de l'utilisateur.
routingSummaries[]

object (RoutingSummary)

Liste des récapitulatifs d'itinéraire où chaque entrée est associée au lieu correspondant au même index dans le champ places. Si le récapitulatif de l'itinéraire n'est pas disponible pour l'un des lieux, il contiendra une entrée vide. Cette liste comportera autant d'entrées que la liste des lieux, si elle est demandée.
contextualContents[]

object (ContextualContent)

Expérimental : pour en savoir plus, consultez https://developers.google.com/maps/documentation/places/web-service/experimental/places-generative.

Liste de contenus contextuels où chaque entrée est associée au lieu correspondant au même index dans le champ "places". Nous préférons les contenus pertinents pour le textQuery de la demande. Si le contenu contextuel n'est pas disponible pour l'un des lieux, un contenu non contextuel sera renvoyé. Il ne sera vide que si le contenu n'est pas disponible pour ce lieu. Cette liste comportera autant d'entrées que la liste des lieux, si elle est demandée.
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 d'effectuer une recherche avec la même requête textuelle que celle spécifiée dans la demande sur Google Maps.

Champs d'application des autorisations

Requiert le niveau d'accès OAuth suivant :

  • https://www.googleapis.com/auth/cloud-platform

RankPreference

Comment les résultats seront classés dans la réponse.

Enums
RANK_PREFERENCE_UNSPECIFIED Pour une requête catégorielle telle que "Restaurants à New York", la pertinence 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 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. Cet emplacement sert de biais, ce qui signifie que des résultats autour de l'emplacement indiqué 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)

Boîte rectangulaire définie par les angles nord-est et sud-ouest. rectangle.high() doit être le point nord-est de la fenêtre d'affichage du rectangle. rectangle.low() doit correspondre au point sud-ouest de la fenêtre d'affichage rectangulaire. rectangle.low().latitude() ne peut pas être supérieur à rectangle.high().latitude(). Cela entraînera une plage de latitude vide. Un rectangle de fenêtre d'affichage 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 emplacement sert de restriction, ce qui signifie que les résultats en dehors de l'emplacement indiqué 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)

Boîte rectangulaire définie par les angles nord-est et sud-ouest. rectangle.high() doit être le point nord-est de la fenêtre d'affichage du rectangle. rectangle.low() doit correspondre au point sud-ouest de la fenêtre d'affichage rectangulaire. rectangle.low().latitude() ne peut pas être supérieur à rectangle.high().latitude(). Cela entraînera une plage de latitude vide. Un rectangle de fenêtre d'affichage ne peut pas avoir une largeur supérieure à 180 degrés.

EVOptions

Options de VE pouvant être recherchées dans une requête de recherche de lieux.

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

number

Facultatif. Taux de recharge minimal requis en kilowatts. Les lieux dont le taux de recharge est inférieur à celui spécifié sont filtrés.
connectorTypes[]

enum (EVConnectorType)

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

SearchAlongRouteParameters

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

Les résultats ne sont pas garantis d'être sur l'itinéraire fourni, mais sont plutôt classés dans la zone de recherche définie par la polyligne et, éventuellement, par locationBias ou locationRestriction en fonction des temps de détour minimaux entre l'origine et la destination. Les résultats peuvent correspondre à un autre itinéraire, en particulier si la polyligne fournie ne définit pas un itinéraire optimal entre l'origine et la destination.

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

object (Polyline)

Obligatoire. Polyligne de l'itinéraire.

Polyline

Polyligne d'itinéraire. Ne prend en charge qu'une polyline encodée, qui peut être transmise sous forme de 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. La valeur par défaut de la sortie de l'API Routes est encoded_polyline. La polyline_type ne peut être qu'un des éléments suivants :
encodedPolyline

string

Une polyline encodée, telle qu'elle est renvoyée par l'API Routes par défaut. Consultez les outils Encoder et Decoder.

ContextualContent

Expérimental : pour en savoir plus, consultez https://developers.google.com/maps/documentation/places/web-service/experimental/places-generative.

Contenu contextuel à la requête sur le 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 du contexte de la requête sur le lieu.
photos[]

object (Photo)

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

object (Justification)

Expérimental : pour en savoir plus, consultez https://developers.google.com/maps/documentation/places/web-service/experimental/places-generative.

Justifications concernant le lieu.

Justification

Expérimental : pour en savoir plus, consultez https://developers.google.com/maps/documentation/places/web-service/experimental/places-generative.

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)

Expérimental : pour en savoir plus, consultez https://developers.google.com/maps/documentation/places/web-service/experimental/places-generative.
businessAvailabilityAttributesJustification

object (BusinessAvailabilityAttributesJustification)

Expérimental : pour en savoir plus, consultez https://developers.google.com/maps/documentation/places/web-service/experimental/places-generative.

ReviewJustification

Expérimental : pour en savoir plus, consultez https://developers.google.com/maps/documentation/places/web-service/experimental/places-generative.

Justifications des avis des utilisateurs. Cette section met en évidence une partie de l'avis de l'utilisateur qui pourrait intéresser un utilisateur final. Par exemple, si la requête de recherche est "pizza au 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 évidence 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. 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 mis en surbrillance.

HighlightedTextRange

Plage de texte mis en surbrillance.

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

integer
endIndex

integer

BusinessAvailabilityAttributesJustification

Expérimental : pour en savoir plus, consultez https://developers.google.com/maps/documentation/places/web-service/experimental/places-generative. Justifications des attributs de disponibilité de l'établissement. Cela montre certains attributs d'un établissement qui pourraient intéresser un utilisateur final.

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

boolean

Si un lieu propose des plats à emporter.
delivery

boolean

Si un établissement propose la livraison.
dineIn

boolean

Si un lieu propose des repas sur place.