- Requête HTTP
- Corps de la requête
- Corps de la réponse
- LocationRestriction
<ph type="x-smartling-placeholder">
- </ph>
- Représentation JSON
- RankPreference
Recherchez des lieux à proximité de lieux.
Requête HTTP
POST https://places.googleapis.com/v1/places:searchNearby
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 |
---|
{ "languageCode": string, "regionCode": string, "includedTypes": [ string ], "excludedTypes": [ string ], "includedPrimaryTypes": [ string ], "excludedPrimaryTypes": [ string ], "maxResultCount": integer, "locationRestriction": { object ( |
Champs | |
---|---|
languageCode |
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 |
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. |
includedTypes[] |
Type de lieu inclus (par exemple, "restaurant" ou "station-service") disponible sur https://developers.google.com/maps/documentation/places/web-service/place-types. Vous pouvez spécifier jusqu'à 50 types du Tableau A. S'il existe des types en conflit, c'est-à-dire qu'un type apparaît à la fois dans "includedTypes" et "excludedTypes", une erreur INVALID_ARGUMENT est renvoyée. Si un type de lieu est spécifié avec plusieurs restrictions de type, seuls les lieux qui remplissent toutes les restrictions sont renvoyés. Par exemple, si nous avons {includedTypes = ["restaurant"], excludedPrimaryTypes = ["restaurant"]}, les lieux renvoyés indiquent "restaurant". de services connexes, mais ne fonctionnent pas principalement en tant que "restaurants". |
excludedTypes[] |
Type de lieu exclu (par exemple, "restaurant" ou "station-service") de https://developers.google.com/maps/documentation/places/web-service/place-types. Vous pouvez spécifier jusqu'à 50 types du Tableau A. Si le client fournit à la fois des types "includedTypes" (par exemple, "restaurant") et "excludedTypes" (par exemple, "café"), la réponse doit inclure des lieux qui correspondent à "restaurant", mais pas à "café". La réponse inclut des lieux qui correspondent à au moins un des incluesTypes et aucun des types exclus. S'il existe des types en conflit, c'est-à-dire qu'un type apparaît à la fois dans "includedTypes" et "excludedTypes", une erreur INVALID_ARGUMENT est renvoyée. Si un type de lieu est spécifié avec plusieurs restrictions de type, seuls les lieux qui remplissent toutes les restrictions sont renvoyés. Par exemple, si nous avons {includedTypes = ["restaurant"], excludedPrimaryTypes = ["restaurant"]}, les lieux renvoyés indiquent "restaurant". de services connexes, mais ne fonctionnent pas principalement en tant que "restaurants". |
includedPrimaryTypes[] |
Inclus le type de lieu principal (par exemple, "restaurant" ou "station-service") disponible sur https://developers.google.com/maps/documentation/places/web-service/place-types. Un lieu ne peut être associé qu'à un seul type principal issu de la table des types acceptés. Vous pouvez spécifier jusqu'à 50 types du Tableau A. En cas de conflit entre des types principaux (c'est-à-dire qu'un type apparaît à la fois dans "includedPrimaryTypes" et "excludedPrimaryTypes"), une erreur INVALID_ARGUMENT est renvoyée. Si un type de lieu est spécifié avec plusieurs restrictions de type, seuls les lieux qui remplissent toutes les restrictions sont renvoyés. Par exemple, si nous avons {includedTypes = ["restaurant"], excludedPrimaryTypes = ["restaurant"]}, les lieux renvoyés indiquent "restaurant". de services connexes, mais ne fonctionnent pas principalement en tant que "restaurants". |
excludedPrimaryTypes[] |
Type de lieu principal exclu (par exemple, "restaurant" ou "station-service") de https://developers.google.com/maps/documentation/places/web-service/place-types. Vous pouvez spécifier jusqu'à 50 types du Tableau A. En cas de conflit entre des types principaux (c'est-à-dire qu'un type apparaît à la fois dans "includedPrimaryTypes" et "excludedPrimaryTypes"), une erreur INVALID_ARGUMENT est renvoyée. Si un type de lieu est spécifié avec plusieurs restrictions de type, seuls les lieux qui remplissent toutes les restrictions sont renvoyés. Par exemple, si nous avons {includedTypes = ["restaurant"], excludedPrimaryTypes = ["restaurant"]}, les lieux renvoyés indiquent "restaurant". de services connexes, mais ne fonctionnent pas principalement en tant que "restaurants". |
maxResultCount |
Nombre maximal de résultats sur une page. Cette valeur doit être comprise entre 1 et 20 (valeur par défaut). 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. |
locationRestriction |
Obligatoire. Région dans laquelle effectuer la recherche. |
rankPreference |
Mode de classement des résultats dans la réponse. |
Corps de la réponse
Proto de réponse pour Search Nearby.
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 ( |
Champs | |
---|---|
places[] |
Liste de lieux répondant aux exigences de l'utilisateur (types de lieux, nombre de lieux et restriction d'emplacement spécifique, par exemple). |
LocationRestriction
Région dans laquelle effectuer la recherche.
Représentation JSON |
---|
{ // Union field |
Champs | |
---|---|
Champ d'union
|
|
circle |
Cercle défini par un point central et un rayon. |
RankPreference
Mode de classement des résultats dans la réponse.
Enums | |
---|---|
RANK_PREFERENCE_UNSPECIFIED |
Valeur RankPreference non définie. Le classement par POPULARITÉ sera utilisé par défaut. |
DISTANCE |
Classe les résultats en fonction de la distance. |
POPULARITY |
Classe les résultats en fonction de leur popularité. |