Method: places.searchNearby

Busca lugares cerca de las 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)
}
Campos
languageCode

string

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

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 de donde proviene la solicitud. Este parámetro se usa para mostrar los detalles del lugar, como el nombre del lugar específico de una 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 actualmente no se admiten los códigos regionales de 3 dígitos.

includedTypes[]

string

Se debe incluir 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 hay tipos en conflicto, es decir, un tipo aparece tanto en includeTypes como enexcludedTypes, se muestra 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 que se muestran proporcionan "restaurant". servicios relacionados, pero que no operan 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 tanto includeTypes (p.ej., restaurante) como excludedTypes (p.ej., cafetería), la respuesta debe incluir lugares que son restaurantes, pero no cafeterías. La respuesta incluye lugares que coinciden con, al menos, uno de los includeTypes y ninguno de los excluidosTypes.

Si hay tipos en conflicto, es decir, un tipo aparece tanto en includeTypes como enexcludedTypes, se muestra 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 que se muestran proporcionan "restaurant". servicios relacionados, pero que no operan 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 tipos primarios en conflicto, es decir, un tipo aparece en includePrimaryTypes y excludedPrimaryTypes, se muestra 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 que se muestran proporcionan "restaurant". servicios relacionados, pero que no operan principalmente como "restaurantes".

excludedPrimaryTypes[]

string

Se excluyó el tipo de lugar principal (p.ej., "restaurante" o "estación_de_gaso") 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 primarios en conflicto, es decir, un tipo aparece en includePrimaryTypes y excludedPrimaryTypes, se muestra 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 que se muestran proporcionan "restaurant". servicios relacionados, pero que 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 no se establece, se vuelve 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. La región en la que se buscará.

rankPreference

enum (RankPreference)

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

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)
    }
  ]
}
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 las restricciones de ubicación específicas.

LocationRestriction

La región en la 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)

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

RankPreference

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

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