Obter Geocodificação

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

Parâmetros de Entrada

Retorno

Retorna um objeto JSON contendo as propriedades geocodificadas.

Compatibilidade

 Cliente

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 1, 2, 3 e 4, ao executar, todas exibirão o mesmo resultado (Figura 5).

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 1 - Bloco de programação Obter Geocodificação

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

Figura 2 - 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 3).
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 4).

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

Na figura 4 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 4 - 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 1,2,3 ou 4 ao executar, todas apresentarão o mesmo resultado (figura 5). 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 5 -  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 6 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 6 - Bloco Obter Geocodificação com dois parâmetros obrigatórios

A figura 7 exibe o erro gerado a partir da figura 6.

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