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 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)
  }
}
Campos
languageCode

string

Los detalles del lugar se mostrarán con el idioma preferido, si está disponible. Si el código de idioma no se especifica o no se reconoce, se pueden mostrar detalles de cualquier idioma, con preferencia por el inglés si existen esos 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 de la que proviene 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 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 la Tabla A.

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

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

string

Se excluyó el tipo de lugar (p. ej., "restaurante" 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 includedTypes y ninguno de los excludedTypes.

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

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

string

Se incluyó el tipo de lugar principal (p.ej., "restaurante" o "gas_station") de https://developers.google.com/maps/documentation/places/web-service/place-types. Un lugar solo puede tener asociado un único tipo principal de la tabla de tipos admitidos.

Se pueden especificar hasta 50 tipos de la Tabla A.

Si hay algún tipo principal en conflicto, es decir, si un tipo aparece en includedPrimaryTypes y excludedPrimaryTypes, se muestra un error INVALID_ARGUMENT.

Si se especifica un tipo de Place con varias restricciones de tipo, solo se muestran los lugares que cumplen con todas las restricciones. Por ejemplo, si tenemos {includedTypes = ["restaurant"], excludedPrimaryTypes = ["restaurant"]}, los lugares que se muestran proporcionan servicios relacionados con "restaurantes", pero no funcionan principalmente como "restaurantes".
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 la Tabla A.

Si hay tipos principales en conflicto, es decir, un tipo aparece tanto en includePrimaryTypes como en excludedPrimaryTypes, se mostrará un error INVALID_ARGUMENT.

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

integer

Cantidad máxima de resultados que se mostrarán. Debe estar comprendido entre 1 y 20 (valor predeterminado), inclusive. Si no se establece, se vuelve 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 buscará.
rankPreference

enum (RankPreference)

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

object (RoutingParameters)

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

Cuerpo de la respuesta

Proto de respuesta para Nearby Search.

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 los tipos de lugares, la cantidad de lugares y la restricción de ubicación específica.
routingSummaries[]

object (RoutingSummary)

Es una lista de resúmenes de planificación de ruta en la que cada entrada se asocia al lugar correspondiente en el mismo índice del campo places. Si el resumen de planificación de ruta no está disponible para uno de los lugares, contendrá una entrada vacía. Si se solicita, esta lista debe tener tantas entradas como la lista de lugares.

LocationRestriction

La región que se buscará.

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 un punto central y un radio.

RankPreference

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

Enumeraciones
RANK_PREFERENCE_UNSPECIFIED No se estableció el valor de RankPreference. Usará la clasificación por POPULARITY de forma predeterminada.
DISTANCE Clasifica los resultados por distancia.
POPULARITY Clasifica los resultados por popularidad.