Method: places.searchNearby

Recherchez des lieux à proximité d'adresses.

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)
  },
  "includeFutureOpeningBusinesses": boolean
}
Champs
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.
includedTypes[]

string

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

Vous pouvez spécifier jusqu'à 50 types du tableau 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 nous avons {includedTypes = ["restaurant"], excludedPrimaryTypes = ["restaurant"]}, les lieux renvoyés proposent des services liés aux "restaurants", mais ne fonctionnent pas principalement comme des "restaurants".
excludedTypes[]

string

Type de lieu exclu (par exemple, "restaurant" ou "gas_station") depuis 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 includedTypes (par exemple, "restaurant") et des excludedTypes (par exemple, "café"), la réponse doit inclure les lieux qui sont des restaurants, mais pas des cafés. La réponse inclut les lieux qui correspondent à 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 répondent à toutes les restrictions sont renvoyés. Par exemple, si nous avons {includedTypes = ["restaurant"], excludedPrimaryTypes = ["restaurant"]}, les lieux renvoyés proposent des services liés aux "restaurants", mais ne fonctionnent pas principalement comme des "restaurants".
includedPrimaryTypes[]

string

Type de lieu principal inclus (par exemple, "restaurant" ou "gas_station") à partir de https://developers.google.com/maps/documentation/places/web-service/place-types. Un lieu ne peut être associé qu'à un seul type principal parmi ceux listés dans le tableau des types acceptés.

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 nous avons {includedTypes = ["restaurant"], excludedPrimaryTypes = ["restaurant"]}, les lieux renvoyés proposent des services liés aux "restaurants", mais ne fonctionnent pas principalement comme des "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.

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 nous avons {includedTypes = ["restaurant"], excludedPrimaryTypes = ["restaurant"]}, les lieux renvoyés proposent des services liés aux "restaurants", mais ne fonctionnent pas principalement comme des "restaurants".
maxResultCount

integer

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

object (LocationRestriction)

Obligatoire. Région dans laquelle effectuer la recherche.
rankPreference

enum (RankPreference)

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

object (RoutingParameters)

Facultatif. Paramètres qui affectent le routage vers les résultats de recherche.
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 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 qui répondent aux exigences de l'utilisateur, comme les types de lieux, le nombre de lieux et la restriction d'emplacement spécifique.
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 doit comporter autant d'entrées que la liste des lieux, le cas échéant.

Champs d'application des autorisations

Requiert le niveau d'accès OAuth suivant :

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

LocationRestriction

Région dans laquelle effectuer la recherche.

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 La valeur RankPreference n'est pas définie. Utilisera le classement par POPULARITÉ par défaut.
DISTANCE Classe les résultats par distance.
POPULARITY Classe les résultats par popularité.