Method: places.searchNearby

Buscar 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 en el idioma preferido si está disponible. Si el código de idioma no se especifica o no se reconoce, se pueden devolver detalles del lugar en cualquier idioma, con preferencia por el inglés si existen tales detalles.

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

string

Es el código Unicode de país o región (CLDR) de la ubicación desde la que se envía la solicitud. Este parámetro se usa para mostrar los detalles del lugar, como el nombre específico de la región, si está disponible. El parámetro puede afectar los resultados según la legislación 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

Es el 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 la Tabla A.

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

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

string

Es el 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 la Tabla A.

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

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

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

string

Es el 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 a él.

Se pueden especificar hasta 50 tipos de la Tabla A.

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

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

string

Es el 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 la Tabla A.

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

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

integer

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

object (LocationRestriction)

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

enum (RankPreference)

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

object (RoutingParameters)

Opcional. Son los parámetros que afectan el enrutamiento a los resultados de la búsqueda.
includeFutureOpeningBusinesses

boolean

Opcional. Si es verdadero, incluye las empresas que aún no abrieron, pero que lo harán en el futuro.

Cuerpo de la respuesta

Es el 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)

Es 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)

Es una lista de resúmenes de rutas en la que cada entrada se asocia al lugar correspondiente en el mismo índice del campo places. Si el resumen de la ruta 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

Requiere el siguiente permiso de OAuth:

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

LocationRestriction

Es 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)

Es un círculo definido por un punto central y un radio.

RankPreference

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

Enums
RANK_PREFERENCE_UNSPECIFIED No se estableció el valor de RankPreference. De forma predeterminada, se usará el orden por POPULARIDAD.
DISTANCE Clasifica los resultados por distancia.
POPULARITY Clasifica los resultados por popularidad.