Method: places.searchNearby

Busca lugares cerca de ubicaciones.

Solicitud HTTP

POST https://places.googleapis.com/v1/places:searchNearby

La URL usa la sintaxis de la transcodificación de gRPC.

Cuerpo de la solicitud

El cuerpo de la solicitud contiene datos con la siguiente estructura:

Representación 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
}
Campos
languageCode

string

Los detalles del lugar se mostrarán con el idioma preferido si está disponible. Si el código de idioma no está especificado o no se reconoce, es posible que se muestren los detalles del lugar en cualquier idioma, con una preferencia por el inglés si existen esos detalles.

Lista actual de idiomas admitidos: https://developers.google.com/maps/faq#languagesupport.
regionCode

string

El código Unicode de país o región (CLDR) de la ubicación desde la que proviene la solicitud. Este parámetro se usa para mostrar los detalles del lugar, como el nombre del lugar específico de la región, si está disponible. El parámetro puede afectar los resultados según la ley aplicable.

Para obtener más información, consulta https://www.unicode.org/cldr/charts/latest/supplemental/territory_language_information.html.

Ten en cuenta que, por el momento, no se admiten los códigos de región de 3 dígitos.
includedTypes[]

string

Tipo de lugar incluido (p. ej., "restaurant" o "gas_station") de https://developers.google.com/maps/documentation/places/web-service/place-types.

Se pueden especificar hasta 50 tipos de Tabla A.

Si hay tipos en conflicto, es decir, si un tipo aparece en includedTypes y excludedTypes, se muestra un error INVALID_ARGUMENT.

Si se especifica un tipo de lugar con varias restricciones de tipo, solo se muestran los lugares que satisfacen todas las restricciones. Por ejemplo, si tenemos {includedTypes = ["restaurant"], excludedPrimaryTypes = ["restaurant"]}, los lugares que se muestran proporcionan servicios relacionados con "restaurant", pero no operan principalmente como "restaurants".
excludedTypes[]

string

Tipo de lugar excluido (p. ej., "restaurant" o "gas_station") de https://developers.google.com/maps/documentation/places/web-service/place-types.

Se pueden especificar hasta 50 tipos de Tabla A.

Si el cliente proporciona includedTypes (p.ej., restaurant) y excludedTypes (p.ej., cafe), la respuesta debe incluir lugares que sean restaurantes, pero no cafeterías. La respuesta incluye lugares que coinciden con al menos uno de los includedTypes y ninguno de los excludedTypes.

Si hay tipos en conflicto, es decir, si un tipo aparece en includedTypes y excludedTypes, se muestra un error INVALID_ARGUMENT.

Si se especifica un tipo de lugar con varias restricciones de tipo, solo se muestran los lugares que satisfacen todas las restricciones. Por ejemplo, si tenemos {includedTypes = ["restaurant"], excludedPrimaryTypes = ["restaurant"]}, los lugares que se muestran proporcionan servicios relacionados con "restaurant", pero no operan principalmente como "restaurants".
includedPrimaryTypes[]

string

Tipo de lugar principal incluido (p.ej., "restaurant" o "gas_station") de https://developers.google.com/maps/documentation/places/web-service/place-types. Un lugar solo puede tener un tipo principal de la tabla de tipos admitidos asociado.

Se pueden especificar hasta 50 tipos de Tabla A.

Si hay tipos principales en conflicto, es decir, si un tipo aparece en includedPrimaryTypes y excludedPrimaryTypes, se muestra un error INVALID_ARGUMENT.

Si se especifica un tipo de lugar con varias restricciones de tipo, solo se muestran los lugares que satisfacen todas las restricciones. Por ejemplo, si tenemos {includedTypes = ["restaurant"], excludedPrimaryTypes = ["restaurant"]}, los lugares que se muestran proporcionan servicios relacionados con "restaurant", pero no operan principalmente como "restaurants".
excludedPrimaryTypes[]

string

Tipo de lugar principal excluido (p.ej., "restaurant" o "gas_station") de https://developers.google.com/maps/documentation/places/web-service/place-types.

Se pueden especificar hasta 50 tipos de Tabla A.

Si hay tipos principales en conflicto, es decir, si un tipo aparece en includedPrimaryTypes y excludedPrimaryTypes, se muestra un error INVALID_ARGUMENT.

Si se especifica un tipo de lugar con varias restricciones de tipo, solo se muestran los lugares que satisfacen todas las restricciones. Por ejemplo, si tenemos {includedTypes = ["restaurant"], excludedPrimaryTypes = ["restaurant"]}, los lugares que se muestran proporcionan servicios relacionados con "restaurant", pero no operan principalmente como "restaurants".
maxResultCount

integer

Cantidad máxima de resultados que se mostrarán Debe estar entre 1 y 20 (predeterminado), inclusive. Si el número no está configurado, se revierte al límite superior. Si el número se establece en negativo o supera el límite superior, se muestra un error INVALID_ARGUMENT.
locationRestriction

object (LocationRestriction)

Obligatorio. La región en la que se realizará la búsqueda.
rankPreference

enum (RankPreference)

Cómo se clasificarán los resultados en la respuesta.
routingParameters

object (RoutingParameters)

Es opcional. Parámetros que afectan el enrutamiento a los resultados de la búsqueda.
includeFutureOpeningBusinesses

boolean

Es opcional. Si es verdadero, incluye empresas que aún no están abiertas, pero que lo harán en el futuro.

Cuerpo de la respuesta

Proto de respuesta para Search Nearby.

Si se ejecuta correctamente, el cuerpo de la respuesta contendrá datos con la siguiente estructura:

Representación JSON 
{
  "places": [
    {
      object (Place)
    }
  ],
  "routingSummaries": [
    {
      object (RoutingSummary)
    }
  ]
}
Campos
places[]

object (Place)

Una lista de lugares que cumplen con los requisitos del usuario, como tipos de lugares, cantidad de lugares y restricción de ubicación específica.
routingSummaries[]

object (RoutingSummary)

Una lista de resúmenes de enrutamiento en la que cada entrada se asocia con el lugar correspondiente en el mismo índice en el campo places. Si el resumen de enrutamiento no está disponible para uno de los lugares, contendrá una entrada vacía. Esta lista debe tener tantas entradas como la lista de lugares si se solicita.

Permisos de autorización

Se necesita uno de los siguientes permisos de OAuth:

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

LocationRestriction

La región en la que se realizará la búsqueda.

Representación JSON 
{

  // Union field type can be only one of the following:
  "circle": {
    object (Circle)
  }
  // End of list of possible types for union field type.
}
Campos

Campo de unión type.

type puede ser una de las siguientes opciones:
circle

object (Circle)

Un círculo definido por el punto central y el radio.

RankPreference

Cómo se clasificarán los resultados en la respuesta.

Enums
RANK_PREFERENCE_UNSPECIFIED Valor de RankPreference no establecido. Usará la clasificación por POPULARIDAD de forma predeterminada.
DISTANCE Clasifica los resultados por distancia.
POPULARITY Clasifica los resultados por popularidad.