/
Obter Geocodificação / Geographical coordinates

Obter Geocodificação / Geographical coordinates

Função que obtém todas as características de uma localização.

Figura 1 - Bloco Obter Geocodificação

 

Este bloco faz parte do plugin Google Maps Api. Para visualizá-lo, é necessário instalar o plugin.

Compatibilidade

  • Bloco cliente: cronapi.maps.geocoder()

Retorno

Retorna um objeto JSON contendo as propriedades geocodificadas.

Parâmetros

Requisição do endereço

Parâmetro obrigatório. Define o endereço do local que se deseja obter a geocodificação.

  • Posição: 1

  • Inglês: Path

  • Tipo: Texto / String

  • Exemplo:  "Av. alfredo egídio de souza aranha"

Limites

Parâmetro opcional. Define os limites de busca do endereço, ele não restringe totalmente (apenas influencia) os resultados do geocodificador, é necessário utilizar os blocos de programação Pontos do retângulo e Criar coordenada.

Opções avançadas

Espera receber um objeto JSON com parâmetros obrigatórios, opcionais ou ambos. Veja mais detalhes na documentação oficial.

  • Posição: 3

  • Inglês: Advanced options

  • Tipo: Objeto / Object

  • Exemplo: {"region":"Brasil"}

  • Opções:

    •  Parâmetros obrigatórios

      1. address: recebe o endereço que você quer geocodificar (corresponde ao parâmetro 1, porém, em formato JSON). 

      2. location: recebe a LatLng (ou LatLngLiteral) em que você quer encontrar o endereço legível mais próximo.

      3. placeId: recebe o ID do lugar que deseja-se encontrar o endereço legível mais próximo. 

    • Parâmetros opcionais

      1. bounds: recebe a LatLngBounds em que os resultados de geocódigo são direcionados de forma mais proeminente (corresponde ao parâmetro 2, porém, em formato JSON). 

      2. componentRestrictions: usado para restringir os resultados a uma área específica.

      3. region: recebe o código da região, especificado como uma subtag de região Unicode de dois caracteres (não numéricos).

Comandos

Receberá outras funções ou blocos de programação a serem executados na inicialização do mapa.

  • Posição: 4

  • Inglês: Confirmation

  • Tipo: Comando com retorno ("item") / Command with return ("item")

  • Exemplo: utilização do bloco Criar o autocompletar

Exemplo 1

Existem várias maneiras de utilizar o bloco de programação Obter Geocodificação e isso se deve ao fato de haver parâmetros obrigatórios e opcionais. Este bloco apresenta somente um parâmetro obrigatório (Requisição do Endereço) e um opcional (Limites), já o parâmetro Opções avançadas pode ser tanto obrigatório quanto opcional, isso dependerá dos atributos utilizados do objeto JSON. Não é permitido informar 2 parâmetros obrigatório ao mesmo tempo. A documentação oficial nos apresenta outros tipos de parâmetros obrigatórios e opcionais que podemos utilizar.

Apesar das configurações diferentes nas figuras 2, 2.1, 2.2  e 2.3, ao executar, todas exibirão o mesmo resultado (Figura 2.4).

No exemplo da figura abaixo, a função busca os dados de geocodificação do endereço passado no parâmetro 1 (Requisição do Endereço). No segundo parâmetro (Limites) definimos o limite do ponto até onde queremos geocodificar, esse parâmetro sempre recebe o bloco de programação Pontos do retângulo seguido de blocos Criar coordenada. 

Figura 2 - Bloco de programação Obter Geocodificação

 

No exemplo da figura 2, informamos o endereço sem delimitar uma área de busca.

Figura 2.1 - Bloco de programação Obter Geocodificação utilizando somente o parâmetro obrigatório

 

Existem 3 formas de utilização do parâmetro "Opções avançadas":

  1. Incluir um atributo JSON obrigatório no objeto e não informar o parâmetro 1 (Requisição do Endereço), já que não são aceitos 2 parâmetros obrigatórios (ver problema com 2 parâmetros obrigatórios no tópico Exemplo 2).

  2. Incluir um atributo JSON opcional e informar o parâmetro 1 (Requisição do Endereço), já que é necessário pelo menos 1 parâmetro obrigatório (figura 2.2).

  3. Preencher apenas o parâmetro Opções avançadas com o objeto JSON do objeto contendo 1 atributo obrigatório e 1 ou mais opcionais (figura 2.3).

Figura 2.2 - Bloco de programação Obter Geocodificação utilizando Opções avançadas com parâmetro opcional

 

Na figura 2.3 passamos o parâmetro "address" (parâmetro JSON obrigatório) e "region" (parâmetro JSON opcional) , o parâmetro "address" corresponde ao parâmetro "Requisição do Endereço".

Figura 2.3 - Bloco de programação Obter Geocodificação utilizando Opções avançadas com os dois tipos de parâmetros

 

O usuário pode configurar a função da forma que foi apresentada nas figuras acima. Ao executar, todas apresentarão o mesmo resultado (figura 2.4). O retorno estará em formato JSON, para entender mais sobre o que significa cada parâmetro apresentado na imagem, confira na documentação oficial.

Figura 2.4 -  Resultado da execução das funções anteriores

Exemplo 2

Não é possível utilizar dois parâmetros obrigatórios ao mesmo tempo, no exemplo da figura 3 estamos informando o endereço da requisição no parâmetro 1 e, em seguida, passamos outro parâmetro JSON obrigatório, o placeId.

Figura 3 - Bloco Obter Geocodificação com dois parâmetros obrigatórios

 

A figura 3.1 exibe o erro gerado a partir da figura 3.

Figura 3.1 - Erro ao utilizar 2 parâmetros obrigatórios

Nesta página