Obter Geocodificação
Função que obtém todas as características de uma localização.
Parâmetros de Entrada
Nome | Nome | Tipo | Doc |
|---|---|---|---|
| Parâmetro 1 | Requisição do Endereço | Objeto | Parâmetro obrigatório, define o endereço do local que se deseja obter a geocodificação. |
| Parâmetro 2 | Limites | Objeto | 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 o bloco de programação Pontos do retângulo e Criar coordenada. |
| Parâmetro 3 | Opções avançadas | Objeto | Recebe parâmetros obrigatórios, opcionais ou os dois em formato JSON, confira abaixo
|
| Parâmetro 4 | Comandos | Envio de Comandos | Adiciona novos blocos de programação que serão utilizados junto com o retorno do bloco. |
Retorno
Retorna um objeto JSON contendo as propriedades geocodificadas.
Compatibilidade
Cliente
Exemplo
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 e um opcional, porém o parâmetro "Opções avançadas" pode utilizar tanto um quanto o outro ou os dois ao mesmo tempo. A documentação oficial nos apresenta outros tipos de parâmetros obrigatórios e opcionais que podemos utilizar.
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
Na figura anterior, passamos um parâmetro obrigatório (parâmetro 1) e um opcional (parâmetro 2). Porém, também é possível utilizar o bloco somente com um parâmetro obrigatório, confira na figura 2.
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", a primeira é passando somente o parâmetro obrigatório, e dessa forma não devemos informar o parâmetro 1. A segunda, exemplo da figura 3, é passar um parâmetro opcional, e dessa forma devemos informar o parâmetro 1. E a ultima forma é passar o parâmetro obrigatório e um opcional no mesmo campo, como mostra a figura 4
Figura 3 - Bloco de programação Obter Geocodificação utilizando Opções avançadas com parâmetro opcional
A requisição tem que ser feita no formato JSON. Na figura 4 passamos o parâmetro "address" e "region", o parâmetro obrigatório "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
Independente de qual função das figuras anteriores seja executada, o resultado é o mesmo, confira na figura 5. O resultado é apresentado na forma de um 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
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 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 - Resultado da execução da figura 6
Sobre o Bloco
O bloco Obter Geocodificação possui parâmetros obrigatórios e opcionais, verifique o tópico Solicitações do Geocoding da documentação oficial para mais informações. Este é um bloco do tipo Google Maps, antes de utilizá-lo é necessário fazer a instalação do plugin do Google Maps, confira na documentação Usando a API do Google Maps em seu projeto como instalá-lo.
Para que a função funcione é necessário ter a Geocoding API instalada no seu projeto, mas antes disso precisamos inicializar o mapa, para isso, utilize o bloco de programação Inicializar Mapa. É nele que definimos os pontos iniciais de latitude e longitude.