Method: places.searchNearby

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 (LocationRestriction)
  },
  "rankPreference": enum (RankPreference)
}
Champs
languageCode

string

Les détails du lieu s'afficheront 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 peuvent s'afficher, quelle que soit la langue. La préférence pour l'anglais est l'anglais, si de telles informations existent.

Liste actuelle des langues acceptées: https://developers.google.com/maps/faq#languagesupport
regionCode

string

Code pays/région Unicode (CLDR) de l'emplacement d'où provient la requête. Ce paramètre permet d'afficher des détails sur le lieu (s'il est disponible, comme son nom spécifique). Ce paramètre peut avoir une incidence sur les résultats conformément à 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[]

string

Type de lieu inclus (par exemple, "restaurant" ou "gas_station") dans https://developers.google.com/maps/documentation/places/web-service/place-types.

Jusqu'à 50 types du tableau A peuvent être spécifiés.

En cas de conflits entre des types, c'est-à-dire qu'un type apparaît à la fois dans includeTypes 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 correspondant à toutes les restrictions sont renvoyés. Par exemple, si nous avons {includedTypes = ["restaurant"], excludedPrimaryTypes = ["restaurant"]}, les lieux renvoyés proposent des services liés au "restaurant", mais ne fonctionnent pas principalement en tant que "restaurants".
excludedTypes[]

string

Type de lieu exclu (par exemple, "restaurant" ou "gas_station") de https://developers.google.com/maps/documentation/places/web-service/place-types.

Jusqu'à 50 types du tableau A peuvent être spécifiés.

Si le client fournit à la fois includeTypes (par exemple, restaurant) et excludedTypes (par exemple, café), la réponse doit inclure les lieux qui sont des restaurants, mais pas les cafés. La réponse inclut des lieux qui correspondent à au moins un des includeTypes, mais à aucun des excludedTypes.

En cas de conflits entre des types, c'est-à-dire qu'un type apparaît à la fois dans includeTypes 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 correspondant à toutes les restrictions sont renvoyés. Par exemple, si nous avons {includedTypes = ["restaurant"], excludedPrimaryTypes = ["restaurant"]}, les lieux renvoyés proposent des services liés au "restaurant", mais ne fonctionnent pas principalement en tant que "restaurants".
includedPrimaryTypes[]

string

Type de lieu principal inclus (par exemple, "restaurant" ou "gas_station") dans https://developers.google.com/maps/documentation/places/web-service/place-types. Un lieu ne peut avoir qu'un seul type principal dans le tableau des types compatibles qui lui est associé.

Jusqu'à 50 types du tableau A peuvent être spécifiés.

En cas de conflit avec des types principaux, c'est-à-dire qu'un type apparaît à la fois dans includePrimaryTypes 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 correspondant à toutes les restrictions sont renvoyés. Par exemple, si nous avons {includedTypes = ["restaurant"], excludedPrimaryTypes = ["restaurant"]}, les lieux renvoyés proposent des services liés au "restaurant", mais ne fonctionnent pas principalement en tant que "restaurants".
excludedPrimaryTypes[]

string

Type de lieu principal exclu (par exemple, "restaurant" ou "gas_station") de https://developers.google.com/maps/documentation/places/web-service/place-types.

Jusqu'à 50 types du tableau A peuvent être spécifiés.

En cas de conflit avec des types principaux, c'est-à-dire qu'un type apparaît à la fois dans includePrimaryTypes 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 correspondant à toutes les restrictions sont renvoyés. Par exemple, si nous avons {includedTypes = ["restaurant"], excludedPrimaryTypes = ["restaurant"]}, les lieux renvoyés proposent des services liés au "restaurant", mais ne fonctionnent pas principalement en tant que "restaurants".
maxResultCount

integer

Nombre maximal de résultats sur une page. Elle doit être comprise entre 1 et 20 (par défaut), inclus. 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

object (LocationRestriction)

Obligatoire. Région à rechercher.
rankPreference

enum (RankPreference)

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

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

object (Place)

Une liste de lieux qui répond aux exigences de l'utilisateur, comme les types de lieux, le nombre de lieux et des restrictions géographiques spécifiques.

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

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

Enums
RANK_PREFERENCE_UNSPECIFIED Valeur RankPreference non définie. Utilise le classement par POPULARITY par défaut.
DISTANCE Classe les résultats par distance.
POPULARITY Il classe les résultats par popularité.