Migrar para o Nearby Search (novo)

A API Places é compatível com o Nearby Search. Se você já conhece o Nearby Search, a nova versão dele faz as seguintes alterações:

  • A nova Nearby Search usa solicitações POST HTTP. Transmitir parâmetros no corpo da solicitação ou nos cabeçalhos como parte de uma solicitação HTTP POST. Por outro lado, com o Nearby Search, você transmite parâmetros de URL usando uma solicitação HTTP GET.
  • O mascaramento de campo é obrigatório. Especifique quais campos você quer retornar na resposta. Não há lista padrão de campos retornados. Se você omitir essa lista, os métodos retornarão um erro. Para mais informações, consulte FieldMask.
  • O novo Nearby Search é compatível com chaves de API e tokens OAuth como mecanismo de autenticação.
  • Somente JSON é aceito como formato de resposta no novo Nearby Search.
  • Todas as solicitações que incluem uma consulta de texto agora precisam usar Text Search (New) porque o Nearby Search (New) não é compatível com a entrada de texto.
  • O formato de resposta JSON para a API Nearby Search (nova) foi alterado do formato das APIs existentes. Para mais detalhes, consulte Migrar a resposta da API Places.

A tabela a seguir lista os parâmetros no Nearby Search que foram renomeados ou modificados para a nova Nearby Search ou os parâmetros que não têm mais suporte.

Parâmetro atual Novo parâmetro Observações
keyword Incompatível. Use a Pesquisa de texto (novo).
language languageCode
location locationRestriction Obrigatório.
maxprice/minprice Incompatível.
maxResultCount Novo parâmetro.
opennow Incompatível.
pagetoken Incompatível.
radius Use o locationRestriction agora.
rankby rankPreference
regionCode Novo parâmetro.
type includedTypes
excludedTypes
includedPrimaryTypes
excludedPrimaryTypes
Os novos parâmetros também aceitam vários valores de tipo. A API atual aceita apenas um valor.

Exemplo de solicitação

O exemplo de solicitação GET a seguir usa a Nearby Search existente. Neste exemplo, você solicita uma resposta JSON que contém informações sobre lugares do tipo restaurant e transmite todos os parâmetros como parâmetros de URL:

curl -L -X GET \
'https://maps.googleapis.com/maps/api/place/nearbysearch/json?location=37.7937%2C-122.3965&radius=500&type=restaurant&key=API_KEY'

Com o Nearby Search (novo), você faz uma solicitação POST e transmite todos os parâmetros no corpo da solicitação JSON ou nos cabeçalhos como parte da solicitação POST. Este exemplo também usa uma máscara de campo para que a resposta inclua apenas o nome de exibição e o endereço formatado do local:

curl -X POST -d '{
  "includedTypes": ["restaurant"],
  "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" \
https://places.googleapis.com/v1/places:searchNearby