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 ( |
Campos | |
---|---|
languageCode |
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 reconoce, se pueden mostrar detalles del lugar de cualquier idioma, con preferencia por el inglés, si tales detalles existen. Lista actual de idiomas admitidos: https://developers.google.com/maps/faq#languagesupport. |
regionCode |
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 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[] |
Se incluye 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 algún tipo en conflicto, es decir, si aparece un tipo tanto en includeTypes y excluyenType, se muestra un error INVALID_{8/}. Si se especifica un tipo de lugar con varias restricciones de tipo, solo se devolverán los lugares que cumplan con 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[] |
Tipo de lugar excluido (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 includeTypes (p.ej., restaurante) y exclusiones (p.ej., cafetería), la respuesta debe incluir lugares que son restaurante, pero no cafetería. La respuesta incluye lugares que coinciden con, al menos, uno de los includeTypes y ninguno de los excluidos. Si hay algún tipo en conflicto, es decir, si aparece un tipo tanto en includeTypes y excluyenType, se muestra un error INVALID_{8/}. Si se especifica un tipo de lugar con varias restricciones de tipo, solo se devolverán los lugares que cumplan con 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[] |
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 tipo principal de la tabla de tipos admitidos. Se pueden especificar hasta 50 tipos de la Tabla A. Si hay tipos principales en conflicto, es decir, si un tipo aparece tanto en includePrimaryTypes como de excludedPrimaryTypes, se muestra un error INVALID_{8/}. Si se especifica un tipo de lugar con varias restricciones de tipo, solo se devolverán los lugares que cumplan con 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[] |
Tipo de lugar principal excluido (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 principales en conflicto, es decir, si un tipo aparece tanto en includePrimaryTypes como de excludedPrimaryTypes, se muestra un error INVALID_{8/}. Si se especifica un tipo de lugar con varias restricciones de tipo, solo se devolverán los lugares que cumplan con 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 |
Cantidad máxima de resultados que se mostrarán Debe estar comprendido entre 1 y 20 (valor predeterminado), inclusive. Si no se establece el número, volverá al límite superior. Si el número se establece como negativo o excede el límite superior, se muestra un error INVALID_{8/}. |
locationRestriction |
Obligatorio. La región en la que se buscará. |
rankPreference |
Cómo se clasificarán los resultados en la respuesta. |
Cuerpo de la respuesta
Protocolo de respuesta para Buscar en alrededores.
Si se ejecuta correctamente, el cuerpo de la respuesta contendrá datos con la siguiente estructura:
Representación JSON |
---|
{
"places": [
{
object ( |
Campos | |
---|---|
places[] |
Una lista de lugares que cumplen con los requisitos del usuario, como los tipos de lugares, la cantidad de lugares y una restricción de ubicación específica. |
LocationRestriction
La región en la que se buscará.
Representación JSON |
---|
{ // Union field |
Campos | |
---|---|
Campo de unión
|
|
circle |
Es un círculo definido por el punto central y el radio. |
RankPreference
Cómo se clasificarán los resultados en la respuesta.
Enumeradores | |
---|---|
RANK_PREFERENCE_UNSPECIFIED |
No se estableció el valor de rango de preferencia. Se usará la clasificación por POPULARITY de forma predeterminada. |
DISTANCE |
Clasifica los resultados por distancia. |
POPULARITY |
Clasifica los resultados por popularidad. |