Method: places.searchNearby

Rechercher 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 (LocationRestriction)
  },
  "rankPreference": enum (RankPreference),
  "routingParameters": {
    object (RoutingParameters)
  }
}
Champs
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 de pays/région Unicode (CLDR) de l'emplacement d'où provient 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. 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 de région à trois chiffres ne sont pas acceptés pour le moment.
includedTypes[]

string

Type d'établissement inclus (par exemple, "restaurant" ou "station_service") sur https://developers.google.com/maps/documentation/places/web-service/place-types.

Vous pouvez spécifier jusqu'à 50 types de la table A.

Si des types sont 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 répondent à toutes les restrictions sont renvoyés. Par exemple, si {includedTypes = ["restaurant"], excludedPrimaryTypes = ["restaurant"]}, les lieux affichés proposent des services liés aux "restaurants", mais ne fonctionnent pas principalement comme des "restaurants".
excludedTypes[]

string

Type d'établissement exclu (par exemple, "restaurant" ou "station_service") sur https://developers.google.com/maps/documentation/places/web-service/place-types.

Vous pouvez spécifier jusqu'à 50 types de la table 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 les lieux correspondant à au moins l'un des types inclus et à aucun des types exclus.

Si des types sont 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 affichés proposent des services liés aux restaurants, mais ne sont pas principalement des restaurants.
includedPrimaryTypes[]

string

Type d'établissement principal inclus (par exemple, "restaurant" ou "station_service") sur https://developers.google.com/maps/documentation/places/web-service/place-types. Un lieu ne peut être associé qu'à un seul type principal de la table des types acceptés.

Vous pouvez spécifier jusqu'à 50 types de la table A.

Si des types principaux sont en conflit, 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 affichés proposent des services liés aux restaurants, mais ne sont pas principalement des restaurants.
excludedPrimaryTypes[]

string

Type d'établissement 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.

Si des types principaux sont en conflit, 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 répondent à toutes les restrictions sont renvoyés. Par exemple, si {includedTypes = ["restaurant"], excludedPrimaryTypes = ["restaurant"]}, les lieux affichés proposent des services liés aux "restaurants", mais ne fonctionnent pas principalement comme des "restaurants".
maxResultCount

integer

Nombre maximal de résultats sur une page. Cette valeur doit être comprise entre 1 et 20 (par défaut), inclus. Si le nombre n'est pas défini, la valeur par défaut est la limite supérieure. Si le nombre est défini sur une valeur négative ou dépasse la limite supérieure, une erreur INVALID_ARGUMENT est renvoyée.
locationRestriction

object (LocationRestriction)

Obligatoire. Région à rechercher.
rankPreference

enum (RankPreference)

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

object (RoutingParameters)

Facultatif. Paramètres qui affectent l'acheminement vers les résultats de recherche.

Corps de la réponse

Proto de réponse pour la recherche à proximité.

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)
    }
  ]
}
Champs
places[]

object (Place)

Liste des lieux répondant aux exigences de l'utilisateur, comme les types de lieux, le nombre de lieux et les restrictions géographiques spécifiques.
routingSummaries[]

object (RoutingSummary)

Liste des récapitulatifs d'itinéraires, où chaque entrée est associée au lieu correspondant au même indice 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. Cette liste doit contenir autant d'entrées que la liste des lieux, le cas échéant.

LocationRestriction

Région à rechercher.

Représentation JSON 
{

  // Union field type can be only one of the following:
  "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 :
circle

object (Circle)

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

RankPreference

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

Enums
RANK_PREFERENCE_UNSPECIFIED Valeur RankPreference non définie. Par défaut, le classement est basé sur la POPULARITÉ.
DISTANCE Classifie les résultats par distance.
POPULARITY Classement des résultats par popularité.