Solicitação e resposta de geocodificação reversa (pesquisa de endereço)

O termo geocodificação geralmente se refere à conversão de um endereço legível em uma localização em um mapa. O processo oposto, ou seja, converter uma localização no mapa em um endereço legível, é conhecido como geocodificação inversa.

Solicitações de geocodificação inversa

Parâmetros obrigatórios

  • latlng: as coordenadas de latitude e longitude que especificam o local para onde você quer encontrar o endereço legível mais próximo.
  • key: a chave de API do aplicativo. Essa chave identifica o aplicativo para fins de gerenciamento de cotas. Saiba como receber uma chave.

Parâmetros opcionais

Estes são os parâmetros opcionais que você pode incluir em uma solicitação de geocodificação inversa:

  • language: o idioma no qual os resultados serão retornados.
    • Veja a lista de idiomas compatíveis. O Google atualiza os idiomas compatíveis com frequência, portanto, essa lista pode não estar completa.
    • Se language não for fornecido, o geocodificador tentará usar o idioma preferencial conforme especificado no cabeçalho Accept-Language ou o idioma nativo do domínio de onde a solicitação é enviada.
    • O geocodificador faz o possível para fornecer um endereço legível para o usuário e os locais. Para isso, ele retorna endereços no idioma local, transliterados para um script que pode ser lido pelo usuário, se necessário, seguindo o idioma preferido. Todos os outros endereços são retornados no idioma preferido. Os componentes de endereço são todos retornados no mesmo idioma, escolhido no primeiro componente.
    • Se um nome não estiver disponível no idioma preferencial, o geocodificador vai usar a correspondência mais próxima.
  • region: o código regional, especificado como um valor ccTLD ("domínio de nível superior") de dois caracteres. O parâmetro também pode afetar os resultados com base na legislação aplicável.
  • result_type: um filtro de um ou mais tipos de endereços, separados por uma barra (|). Se o parâmetro tiver vários tipos de endereços, a API retornará todos que correspondam a qualquer um deles. Uma observação sobre o processamento: o parâmetro result_type não restrict a pesquisa aos tipos de endereço especificados. Em vez disso, result_type age como um filtro pós-pesquisa: a API busca todos os resultados para o latlng especificado e descarta os resultados que não correspondem aos tipos de endereço especificados. Os valores a seguir são aceitos:
    • street_address indica um endereço preciso.
    • route indica uma rota nomeada (como "US 101").
    • intersection indica uma interseção principal, normalmente de duas estradas principais.
    • political indica uma entidade política. Normalmente, esse tipo indica um polígono de administração civil.
    • country indica a entidade política nacional e costuma ser o tipo de ordem mais elevada retornado pelo geocodificador.
    • administrative_area_level_1 indica uma entidade civil de primeira ordem abaixo do nível do país. Nos Estados Unidos, esses níveis administrativos são os estados. Nem todos os países têm esses níveis administrativos. Na maioria dos casos, nomes curtos para administrative_area_level_1 vão respeitar quase que totalmente as subdivisões da ISO 3166-2 e outras normas amplamente divulgadas. Porém, isso não é garantido, já que os resultados da nossa geocodificação se baseiam em vários sinais e dados de localização.
    • administrative_area_level_2 indica uma entidade civil de segunda ordem abaixo do nível de país. Nos Estados Unidos, esses níveis administrativos são os condados. Nem todos os países têm esses níveis administrativos.
    • administrative_area_level_3 indica uma entidade civil de terceira ordem abaixo do nível de país. Esse tipo indica uma divisão civil secundária. Nem todos os países incluem esses níveis administrativos.
    • administrative_area_level_4 indica uma entidade civil de quarta ordem abaixo do nível do país. Esse tipo indica uma divisão civil secundária. Nem todos os países incluem esses níveis administrativos.
    • administrative_area_level_5 indica uma entidade civil de quinta ordem abaixo do nível do país. Esse tipo indica uma divisão civil secundária. Nem todos os países incluem esses níveis administrativos.
    • administrative_area_level_6 indica uma entidade civil de sexta ordem abaixo do nível do país. Esse tipo indica uma divisão civil secundária. Nem todos os países incluem esses níveis administrativos.
    • administrative_area_level_7 indica uma entidade civil de sétima ordem abaixo do nível de país. Esse tipo indica uma divisão civil secundária. Nem todos os países incluem esses níveis administrativos.
    • colloquial_area indica um nome alternativo usado comumente para a entidade.
    • locality indica uma entidade política de cidade ou município incorporada.
    • sublocality indica uma entidade civil de primeira ordem abaixo da localidade. Para alguns locais, é possível receber um dos tipos adicionais: sublocality_level_1 até sublocality_level_5. Cada nível de sublocalidade é uma entidade civil. Números maiores indicam uma área geográfica menor.
    • neighborhood indica um bairro nomeado
    • premise indica um local nomeado, normalmente um edifício ou condomínios com um nome comum
    • subpremise indica uma entidade de primeira ordem abaixo de uma localização com nome, geralmente um prédio dentro de um conjunto que prédios com um nome em comum
    • plus_code indica uma referência de local codificada, derivada de latitude e longitude. Os Plus Codes podem ser usados em vez de endereços nos lugares em que não existem, ou seja, quando os imóveis não estão numerados ou as ruas não têm nome. Para mais detalhes, consulte https://plus.codes.
    • postal_code indica um código postal, conforme usado para endereçar correspondências no país.
    • natural_feature indica um recurso natural de destaque.
    • airport indica um aeroporto.
    • park indica um parque nomeado.
    • point_of_interest indica um ponto de interesse nomeado. Normalmente, esses "PDIs" são entidades locais de destaque que não se encaixam facilmente em outra categoria, como "Empire State Building" ou "Torre Eiffel".
  • location_type: um filtro de um ou mais tipos de local, separados por uma barra vertical (|). Se o parâmetro tiver vários tipos de local, a API retornará todos os endereços que correspondam a qualquer um dos tipos. Uma observação sobre o processamento: o parâmetro location_type não restrict a pesquisa aos tipos de local especificados. Em vez disso, location_type age como um filtro pós-pesquisa: a API busca todos os resultados para o latlng especificado e descarta os resultados que não correspondem aos tipos de local especificados. Os seguintes valores são aceitos:
    • "ROOFTOP" retorna apenas os endereços em que o Google tem informações de local com precisão de endereço.
    • "RANGE_INTERPOLATED" retorna apenas os endereços que refletem uma aproximação (normalmente em uma via) interpolada entre dois pontos precisos (como interseções). Um intervalo interpolado geralmente indica que códigos geográficos de telhado não estão disponíveis para um endereço.
    • "GEOMETRIC_CENTER" retorna apenas centros geométricos de um local, como uma polilinha (por exemplo, uma rua) ou um polígono (região).
    • "APPROXIMATE" retorna apenas os endereços que são caracterizados como aproximados.

Se os filtros result_type e location_type estiverem presentes, a API vai retornar apenas os resultados que correspondam aos valores result_type e location_type. Se nenhum dos valores de filtro for aceitável, a API vai retornar ZERO_RESULTS.

Exemplo de geocodificação inversa

A consulta a seguir contém um valor de latitude/longitude para uma localização no Brooklyn:

https://maps.googleapis.com/maps/api/geocode/json?latlng=40.714224,-73.961452&key=YOUR_API_KEY

A consulta acima retorna o seguinte resultado:

{
   "results" : [
      {
         "address_components" : [
            {
               "long_name" : "277",
               "short_name" : "277",
               "types" : [ "street_number" ]
            },
            {
               "long_name" : "Bedford Avenue",
               "short_name" : "Bedford Ave",
               "types" : [ "route" ]
            },
            {
               "long_name" : "Williamsburg",
               "short_name" : "Williamsburg",
               "types" : [ "neighborhood", "political" ]
            },
            {
               "long_name" : "Brooklyn",
               "short_name" : "Brooklyn",
               "types" : [ "sublocality", "political" ]
            },
            {
               "long_name" : "Kings",
               "short_name" : "Kings",
               "types" : [ "administrative_area_level_2", "political" ]
            },
            {
               "long_name" : "New York",
               "short_name" : "NY",
               "types" : [ "administrative_area_level_1", "political" ]
            },
            {
               "long_name" : "United States",
               "short_name" : "US",
               "types" : [ "country", "political" ]
            },
            {
               "long_name" : "11211",
               "short_name" : "11211",
               "types" : [ "postal_code" ]
            }
         ],
         "formatted_address" : "277 Bedford Avenue, Brooklyn, NY 11211, USA",
         "geometry" : {
            "location" : {
               "lat" : 40.714232,
               "lng" : -73.9612889
            },
            "location_type" : "ROOFTOP",
            "viewport" : {
               "northeast" : {
                  "lat" : 40.7155809802915,
                  "lng" : -73.9599399197085
               },
               "southwest" : {
                  "lat" : 40.7128830197085,
                  "lng" : -73.96263788029151
               }
            }
         },
         "place_id" : "ChIJd8BlQ2BZwokRAFUEcm_qrcA",
         "types" : [ "street_address" ]
      },

  ... Additional <code>results[]</code> ...

Observe que o geocodificador inverso retornou mais de um resultado. Os resultados "formatted_address" não são apenas endereços postais, mas qualquer forma de nomear uma localização geograficamente. Por exemplo, ao geocodificar um ponto da cidade de Chicago, ele pode ser indicado como um endereço, como a cidade (Chicago), o estado (Illinois) ou o país (Estados Unidos). Todos são "endereços" para o geocodificador. O geocodificador inverso retorna qualquer um desses tipos como resultados válidos.

Ele pode corresponder a entidades políticas (países, províncias, cidades e bairros), endereços e códigos postais.

Veja abaixo a lista completa de valores formatted_address retornados pela consulta anterior.

{
   "plus_code" : {
      "compound_code" : "P27Q+MCM New York, NY, USA",
      "global_code" : "87G8P27Q+MCM"
   },
   "results" : [
      {
         "formatted_address" : "277 Bedford Ave, Brooklyn, NY 11211, USA",
         ...
         "types" : [ "street_address" ]
      },
      {
         "formatted_address" : "279 Bedford Ave, Brooklyn, NY 11211, USA",
         ...
         "types" : [ "premise" ]
      },
      {
         "formatted_address" : "277 Bedford Ave, Brooklyn, NY 11211, USA",
         ...
         "types" : [ "establishment", "point_of_interest" ]
      },
      {
         "formatted_address" : "291-275 Bedford Ave, Brooklyn, NY 11211, USA",
         ...
         "types" : [ "route" ]
      },
      {
         "formatted_address" : "P27Q+MC New York, NY, USA",
         ...
         "types" : [ "plus_code" ]
      },
      {
         "formatted_address" : "South Williamsburg, Brooklyn, NY, USA",
         ...
         "types" : [ "neighborhood", "political" ]
      },
      {
         "formatted_address" : "Brooklyn, NY 11211, USA",
         ...
         "types" : [ "postal_code" ]
      },
      {
         "formatted_address" : "Williamsburg, Brooklyn, NY, USA",
         ...
         "types" : [ "neighborhood", "political" ]
      },
      {
         "formatted_address" : "Kings County, Brooklyn, NY, USA",
         ...
         "types" : [ "administrative_area_level_2", "political" ]
      },
      {
         "formatted_address" : "Brooklyn, NY, USA",
         ...
         "types" : [ "political", "sublocality", "sublocality_level_1" ]
      },
      {
         "formatted_address" : "New York, NY, USA",
         ...
         "types" : [ "locality", "political" ]
      },
      {
         "formatted_address" : "New York, USA",
         ...
         "types" : [ "administrative_area_level_1", "political" ]
      },
      {
         "formatted_address" : "United States",
         ...
         "types" : [ "country", "political" ]
      }
   ],
   "status" : "OK"
}

Essa API retorna diferentes tipos de endereços, desde o mais específico até entidades políticas menos específicas, como bairros, cidades, condados e estados. Geralmente, o endereço mais exato é o resultado mais proeminente, como neste caso. Se você quiser corresponder um tipo específico de endereço, consulte a seção abaixo sobre como restringir resultados por tipo. Por isso, a localização dos resultados em relação um ao outro pode variar.

Geocodificação inversa filtrada por tipo

O exemplo a seguir filtra os endereços retornados para incluir apenas aqueles com um tipo de local ROOFTOP e um tipo de endereço street_address.

https://maps.googleapis.com/maps/api/geocode/json?latlng=40.714224,-73.961452
&location_type=ROOFTOP&result_type=street_address&key=YOUR_API_KEY

Observação:esses filtros são válidos apenas para a geocodificação inversa.

Respostas de geocodificação inversa

O formato da resposta de geocodificação inversa é o mesmo da resposta da geocodificação. Consulte Respostas do Geocoding. Veja abaixo os códigos de status possíveis em uma resposta de geocodificação inversa.

Códigos de status da geocodificação inversa

O campo "status" no objeto de resposta da geocodificação contém o status da solicitação e pode conter informações de depuração para ajudar a rastrear o motivo pelo qual a geocodificação reversa não está funcionando. O campo "status" pode conter os seguintes valores:

  • "OK" indica que nenhum erro ocorreu e que pelo menos um endereço foi retornado.
  • "ZERO_RESULTS" indica que a geocodificação inversa foi bem-sucedida, mas não retornou resultados. Isso pode ocorrer se o geocodificador recebeu um latlng em um local remoto.
  • "OVER_QUERY_LIMIT" indica que você ultrapassou sua cota.
  • "REQUEST_DENIED" indica que a solicitação foi negada. Possivelmente, porque a solicitação inclui um parâmetro result_type ou location_type, mas não uma chave de API.
  • "INVALID_REQUEST" geralmente indica uma das seguintes opções:
    • A consulta (address, components ou latlng) está ausente.
    • Foi fornecido um result_type ou location_type inválido.
  • "UNKNOWN_ERROR" indica que a solicitação não foi processada devido a um erro de servidor. Se você tentar novamente, a solicitação pode dar certo.

Plus Codes de geocodificação inversa

O campo plus_code na resposta da geocodificação contém um plus code que melhor se aproxima da latitude e longitude consultadas. Além disso, a matriz de resultados JSON, na maioria dos casos, contém um resultado completo da geocodificação com um tipo plus_code e um endereço com um código de adição. A distância entre o Plus Code decodificado e o ponto de solicitação é menor que 10 metros.