Se usó la API de Cloud Translation para traducir esta página.

Nearby Search (nueva)

Selecciona la plataforma: Android iOS JavaScript Servicio web

Una solicitud de Nearby Search (nuevo) toma uno o más tipos de lugares y muestra una lista de lugares coincidentes dentro del área especificada. Se requiere una máscara de campo que especifique uno o más tipos de datos. Nearby Search (nueva) solo admite solicitudes POST.

El Explorador de APIs te permite realizar solicitudes en tiempo real para que puedas familiarizarte con la API y sus opciones:

Pruébalo

Solicitudes de Nearby Search (nuevo)

Una solicitud de Nearby Search (nueva) es una solicitud HTTP POST a una URL con el siguiente formato:

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

Pasa todos los parámetros en el cuerpo de la solicitud JSON o en los encabezados como parte de la solicitud POST. Por ejemplo:

curl -X POST -d '{
  "includedTypes": ["restaurant"],
  "maxResultCount": 10,
  "locationRestriction": {
    "circle": {
      "center": {
        "latitude": 37.7937,
        "longitude": -122.3965},
      "radius": 500.0
    }
  }
}' \
-H 'Content-Type: application/json' -H "X-Goog-Api-Key: API_KEY" \
-H "X-Goog-FieldMask: places.displayName" \
https://places.googleapis.com/v1/places:searchNearby

Respuestas de Nearby Search (nuevo)

Nearby Search (nuevo) muestra un objeto JSON como respuesta. En la respuesta, figura lo siguiente:

El array places contiene todos los lugares que coinciden.
Cada lugar del array está representado por un objeto Place. El objeto Place contiene información detallada sobre un solo lugar.
La FieldMask pasada en la solicitud especifica la lista de campos que se muestran en el objeto Place.

El objeto JSON completo tiene el siguiente formato:

{
  "places": [
    {
      object (Place)
    }
  ]
}

Parámetros obligatorios

FieldMask

Especifica la lista de campos que se debe mostrar en la respuesta; para ello, crea una máscara de campo de respuesta. Pasa la máscara de campo de respuesta al método mediante el parámetro de URL $fields o fields, o bien con el encabezado HTTP X-Goog-FieldMask. No hay una lista predeterminada de los campos mostrados en la respuesta. Si omites la máscara de campo, el método mostrará un error.

El enmascaramiento de campo es una práctica de diseño recomendada para garantizar que no solicites datos innecesarios, lo que ayuda a evitar tiempos de procesamiento y cargos de facturación innecesarios.

Especifica una lista separada por comas de los tipos de datos de lugar que deseas que se muestren. Por ejemplo, para recuperar el nombre visible y la dirección del lugar.
```
X-Goog-FieldMask: places.displayName,places.formattedAddress
```
Nota: No se permiten espacios en ninguna parte de la lista de campos.

Usa * para recuperar todos los campos.
```
X-Goog-FieldMask: *
```
El comodín “*” selecciona todos los campos. Sin embargo, si bien es adecuado usar ese comodín en el desarrollo, Google desaconseja el uso de la máscara de campo de respuesta comodín (*) en producción debido a la gran cantidad de datos que se pueden mostrar.

Puedes encontrar más orientación sobre el uso de places.iconMaskBaseUri y places.iconBackgroundColor en la sección Íconos de lugar.

Especifica uno o más de los siguientes campos:
- Los siguientes campos activan el SKU de Nearby Search (Basic):
  
  places.accessibilityOptions, places.addressComponents, places.adrFormatAddress, places.businessStatus, places.displayName, places.formattedAddress, places.googleMapsUri, places.iconBackgroundColor, places.iconMaskBaseUri, places.id, places.location, places.name^*, places.photos, places.plusCode, places.primaryType, places.primaryTypeDisplayName, places.shortFormattedAddress, places.subDestinations, places.types, places.utcOffsetMinutes, places.viewport
  
  ^* El campo places.name contiene el nombre de recurso del lugar expresado de la siguiente forma: places/PLACE_ID. Utiliza places.displayName para acceder al nombre del lugar en forma de texto.
- Los siguientes campos activan el SKU de Nearby Search (Advanced):
  
  places.currentOpeningHours, places.currentSecondaryOpeningHours, places.internationalPhoneNumber, places.nationalPhoneNumber, places.priceLevel, places.rating, places.regularOpeningHours, places.regularSecondaryOpeningHours, places.userRatingCount, places.websiteUri
- Los siguientes campos activan el SKU de Nearby Search (Preferred):
  
  <br class="2-2-14">.<ph-2-2-13">1-4-14">.<ph-2-2-41></ph>-14">1-4-14">.<ph-2-2-4/10">.<ph-2-2-4/10">.<ph> <ph-2-4/2-1>">.<ph-2-4-02">.places.allowsDogsplaces.curbsidePickupplaces.deliveryplaces.dineInplaces.editorialSummaryplaces.evChargeOptionsplaces.fuelOptionsplaces.goodForChildrenplaces.goodForGroupsplaces.goodForWatchingSportsplaces.liveMusicplaces.menuForChildrenplaces.parkingOptionsplaces.paymentOptionsplaces.outdoorSeatingplaces.reservableplaces.restroomplaces.reviewsplaces.servesBeerplaces.servesBreakfastplaces.servesBrunchplaces.servesCocktailsplaces.servesCoffeeplaces.servesDessertsplaces.servesDinnerplaces.servesLunchplaces.servesVegetarianFoodplaces.servesWineplaces.takeout
locationRestriction

La región a buscar especificada como un círculo, definida por el punto central y el radio en metros. El radio debe ser de entre 0.0 y 50,000.0, inclusive. El radio predeterminado es 0.0. Debes configurarlo en un valor mayor que 0.0 en la solicitud.

Por ejemplo:
```
"locationRestriction": {
  "circle": {
    "center": {
      "latitude": 37.7937,
      "longitude": -122.3965
    },
    "radius": 500.0
  }
}
```

Parámetros opcionales

includeTypes/excludedTypes, includedPrimaryTypes/excludedPrimaryTypes

Te permite especificar una lista de tipos de los tipos de la Tabla A que se usa para filtrar los resultados de la búsqueda. Se pueden especificar hasta 50 tipos en cada categoría de restricción de tipos.

Nota: Los valores de la Tabla B solo se muestran en la respuesta. No puedes usar los valores de la Tabla B como filtro.

Un lugar solo puede tener asociado un tipo principal de los tipos de la Tabla A. Por ejemplo, el tipo principal podría ser "mexican_restaurant" o "steak_house". Usa includedPrimaryTypes y excludedPrimaryTypes para filtrar los resultados según el tipo principal de un lugar.

Un lugar también puede tener varios valores de tipo asociados a los tipos de la Tabla A. Por ejemplo, un restaurante podría tener los siguientes tipos: "seafood_restaurant", "restaurant", "food", "point_of_interest" y "establishment". Utiliza includedTypes y excludedTypes para filtrar los resultados en la lista de tipos asociados con un lugar.

Si se especifica una búsqueda con varias restricciones de tipo, solo se muestran los lugares que satisfacen todas las restricciones. Por ejemplo, si especificas {"includedTypes": ["restaurant"], "excludedPrimaryTypes": ["steak_house"]}, los lugares que se muestran proporcionan servicios relacionados con "restaurant", pero no operan principalmente como "steak_house".

Si omites includedTypes, excludedTypes, includedPrimaryTypes y excludedPrimaryTypes de la solicitud, la búsqueda muestra lugares para todos los tipos dentro de los límites de restricción de ubicación.

includedTypes

Una lista separada por comas de los tipos de lugares de la Tabla A que se buscarán. Si se omite este parámetro, se devuelven lugares de todos los tipos.

excludedTypes

Lista separada por comas de los tipos de lugares de la Tabla A que se excluirán de una búsqueda.

Si especificas tanto includedTypes ( como "school") como excludedTypes (como "primary_school") en la solicitud, la respuesta incluirá lugares que se clasifican como "school", pero no como "primary_school". La respuesta incluye lugares que coinciden con al menos uno de los includedTypes y ninguno de los excludedTypes.

Si hay tipos en conflicto, como uno que aparece en includedTypes y excludedTypes, se muestra un error INVALID_REQUEST.

includedPrimaryTypes

Una lista separada por comas de los tipos de lugares principales de la Tabla A que se incluirán en una búsqueda.

excludedPrimaryTypes

Una lista separada por comas de los tipos de lugares principales de la Tabla A que se excluirán de una búsqueda.

Si hay tipos principales en conflicto, como uno que aparece en includedPrimaryTypes y excludedPrimaryTypes, se muestra un error INVALID_ARGUMENT.
languageCode

El idioma en el que se mostrarán los resultados.
- Consulta la lista de idiomas compatibles. A menudo, Google actualiza los idiomas admitidos, por lo que es posible que esta lista no sea exhaustiva.
- Si no se proporciona languageCode, la API se establece de forma predeterminada en en. Si especificas un código de idioma no válido, la API mostrará un error INVALID_ARGUMENT.
- La API hace todo lo posible para proporcionar una dirección que sea legible tanto para el usuario como para los usuarios locales. Para lograr ese objetivo, muestra las direcciones en el idioma local, transliteradas a una secuencia de comandos legible para el usuario si es necesario, que observa el idioma preferido. Todas las demás direcciones se muestran en el idioma preferido. Los componentes de la dirección se devuelven en el mismo idioma, que se elige a partir del primer componente.
- Si un nombre no está disponible en el idioma preferido, la API usa la coincidencia más cercana.
- El idioma preferido tiene una pequeña influencia en el conjunto de resultados que la API elige mostrar y en el orden en el que se muestran. El geocodificador interpreta las abreviaturas de manera diferente según el idioma; por ejemplo, las abreviaturas para los tipos de calle o los sinónimos que pueden ser válidos en un idioma, pero no en otro.
maxResultCount

Especifica la cantidad máxima de resultados de lugares que se mostrarán. Debe ser un valor entre 1 y 20 (valor predeterminado) inclusive.
rankPreference

El tipo de clasificación que se usará. Si se omite este parámetro, los resultados se clasifican por popularidad. Puede ser una de las siguientes opciones:
- POPULARITY (predeterminado) ordena los resultados según su popularidad.
- DISTANCE Ordena los resultados en orden ascendente por su distancia desde la ubicación especificada.
regionCode

Es el código de región que se usa para dar formato a la respuesta, especificado como un valor de código CLDR de dos caracteres. No hay un valor predeterminado.

Si el nombre del país del campo formattedAddress en la respuesta coincide con regionCode, el código de país se omite de formattedAddress. Este parámetro no tiene efecto en adrFormatAddress, que siempre incluye el nombre del país, ni en shortFormattedAddress, que nunca lo incluye.

La mayoría de los códigos CLDR son idénticos a los códigos ISO 3166-1, con algunas excepciones notables. Por ejemplo, el ccTLD del Reino Unido es "uk" (.co.uk), mientras que su código ISO 3166-1 es "gb" (técnicamente para la entidad del "Reino Unido de Gran Bretaña e Irlanda del Norte"). El parámetro puede afectar los resultados según la ley aplicable.

Ejemplos de Nearby Search (nuevo)

Buscar lugares de un mismo tipo

En el siguiente ejemplo, se muestra una solicitud de Nearby Search (nuevo) para los nombres visibles de todos los restaurantes dentro de un radio de 500 metros, definido por circle:

curl -X POST -d '{
  "includedTypes": ["restaurant"],
  "maxResultCount": 10,
  "locationRestriction": {
    "circle": {
      "center": {
        "latitude": 37.7937,
        "longitude": -122.3965},
      "radius": 500.0
    }
  }
}' \
-H 'Content-Type: application/json' -H "X-Goog-Api-Key: API_KEY" \
-H "X-Goog-FieldMask: places.displayName" \
https://places.googleapis.com/v1/places:searchNearby

Ten en cuenta que el encabezado X-Goog-FieldMask especifica que la respuesta contiene los siguientes campos de datos: places.displayName. Entonces, la respuesta tendrá el siguiente formato:

{
  "places": [
    {
      "displayName": {
        "text": "La Mar Cocina Peruana",
        "languageCode": "en"
      }
    },
    {
      "displayName": {
        "text": "Kokkari Estiatorio",
        "languageCode": "en"
      }
    },
    {
      "displayName": {
        "text": "Harborview Restaurant & Bar",
        "languageCode": "en"
      }
    },
...
}

Agrega más tipos de datos a la máscara de campo para mostrar información adicional. Por ejemplo, agrega places.formattedAddress,places.types,places.websiteUri para incluir la dirección, el tipo y la dirección web del restaurante en la respuesta:

curl -X POST -d '{
  "includedTypes": ["restaurant"],
  "maxResultCount": 10,
  "locationRestriction": {
    "circle": {
      "center": {
        "latitude": 37.7937,
        "longitude": -122.3965},
      "radius": 500.0
    }
  }
}' \
-H 'Content-Type: application/json' -H "X-Goog-Api-Key: API_KEY" \
-H "X-Goog-FieldMask: places.displayName,places.formattedAddress,places.types,places.websiteUri" \
https://places.googleapis.com/v1/places:searchNearby

La respuesta ahora tiene el siguiente formato:

{
  "places": [
    {
      "types": [
        "seafood_restaurant",
        "restaurant",
        "food",
        "point_of_interest",
        "establishment"
      ],
      "formattedAddress": "PIER 1 1/2 The Embarcadero N, San Francisco, CA 94105, USA",
      "websiteUri": "http://lamarsf.com/",
      "displayName": {
        "text": "La Mar Cocina Peruana",
        "languageCode": "en"
      }
    },
    {
      "types": [
        "greek_restaurant",
        "meal_takeaway",
        "restaurant",
        "food",
        "point_of_interest",
        "establishment"
      ],
      "formattedAddress": "200 Jackson St, San Francisco, CA 94111, USA",
      "websiteUri": "https://kokkari.com/",
      "displayName": {
        "text": "Kokkari Estiatorio",
        "languageCode": "en"
      }
    },
...
}

Encuentra lugares de varios tipos

En el siguiente ejemplo, se muestra una solicitud de Nearby Search (nuevo) para los nombres visibles de todos los minimercados y las licorerías dentro de un radio de 1,000 metros del circle especificado:

curl -X POST -d '{
  "includedTypes": ["liquor_store", "convenience_store"],
  "maxResultCount": 10,
  "locationRestriction": {
    "circle": {
      "center": {
        "latitude": 37.7937,
        "longitude": -122.3965
      },
      "radius": 1000.0
    }
  }
}' \
-H 'Content-Type: application/json' -H "X-Goog-Api-Key: API_KEY" \
-H "X-Goog-FieldMask: places.displayName,places.primaryType,places.types" \
https://places.googleapis.com/v1/places:searchNearby

En este ejemplo, se agregan places.primaryType y places.types a la máscara de campo para que la respuesta incluya información de tipo sobre cada lugar, lo que facilita la selección del lugar apropiado en los resultados.

Cómo excluir un tipo de lugar de una búsqueda

En el siguiente ejemplo, se muestra una solicitud de Nearby Search (nuevo) para todos los lugares de tipo "school", sin incluir todos los lugares de tipo "primary_school", que clasifica los resultados por distancia:

curl -X POST -d '{
  "includedTypes": ["school"],
  "excludedTypes": ["primary_school"],
  "maxResultCount": 10,
  "locationRestriction": {
    "circle": {
      "center": {
        "latitude": 37.7937,
        "longitude": -122.3965
      },
      "radius": 1000.0
    }
  },
  "rankPreference": "DISTANCE"
}' \
-H 'Content-Type: application/json' -H "X-Goog-Api-Key: API_KEY" \
-H "X-Goog-FieldMask: places.displayName" \
https://places.googleapis.com/v1/places:searchNearby

Buscar todos los lugares cerca de un área, clasificados por distancia

En el siguiente ejemplo, se muestra una solicitud de Nearby Search (nueva) para lugares cercanos a un punto del centro de San Francisco. En este ejemplo, se incluye el parámetro rankPreference para clasificar los resultados por distancia:

curl -X POST -d '{
  "maxResultCount": 10,
  "rankPreference": "DISTANCE",
  "locationRestriction": {
    "circle": {
      "center": {
        "latitude": 37.7937,
        "longitude": -122.3965
      },
      "radius": 1000.0
    }
  }
}' \
-H 'Content-Type: application/json' -H "X-Goog-Api-Key: API_KEY" \
-H "X-Goog-FieldMask: places.displayName" \
https://places.googleapis.com/v1/places:searchNearby

Pruébalo

El Explorador de APIs te permite realizar solicitudes de muestra para que puedas familiarizarte con la API y sus opciones.

Selecciona el ícono de la API, , en el lado derecho de la página.
De manera opcional, puedes expandir Mostrar parámetros estándar y establecer el parámetro fields en la máscara de campo.
De manera opcional, edita el Cuerpo de la solicitud.
Selecciona el botón Ejecutar. En la ventana emergente, elige la cuenta que deseas usar para realizar la solicitud.
En el panel Explorador de API, selecciona el ícono de expansión, , para expandir la ventana del Explorador de API.

Nearby Search (nueva)

Solicitudes de Nearby Search (nuevo)

Respuestas de Nearby Search (nuevo)

Parámetros obligatorios

FieldMask

locationRestriction

Parámetros opcionales

includeTypes/excludedTypes, includedPrimaryTypes/excludedPrimaryTypes

includedTypes

excludedTypes

includedPrimaryTypes

excludedPrimaryTypes

languageCode

maxResultCount

rankPreference

regionCode

Ejemplos de Nearby Search (nuevo)

Buscar lugares de un mismo tipo

Encuentra lugares de varios tipos

Cómo excluir un tipo de lugar de una búsqueda

Buscar todos los lugares cerca de un área, clasificados por distancia

Pruébalo