Criar recursos de validação de local usando a Plataforma Google Maps

Objetivo

Muitas vezes, você precisa validar a localização de um lugar. Existem alguns serviços diferentes na Plataforma Google Maps que podem ajudar você com esse caso de uso. Este documento ajuda você a escolher entre os dois principais serviços de validação de local: a API Address Validation e a API Geocoding.

A API Address Validation é uma oferta da Plataforma Google Maps que ajuda os clientes a validar se um endereço é preciso ou não.

A geocodificação com a API Geocoding é o processo de conversão de endereços em coordenadas geográficas, que podem ser usadas para colocar marcadores em um mapa ou uma posição no mapa.

Confira aqui uma visão geral das diferenças entre a API Address Validation e a Geocoding.

Quando escolher a API Address Validation ou a API Geocoding

Address-Validation-vs-Geocoding

Observações sobre o fluxograma acima:

  • O caso de uso de interação do usuário se refere a quando um usuário está presente para interagir com os resultados.
  • O Place Autocomplete é uma API JavaScript, adequada para integração com interfaces do usuário.
  • Você pode ter conhecimento de problemas de qualidade dos dados nos seus endereços atuais. Portanto, embora você queira apenas geocodificações, é recomendável executar esses locais usando a API Address Validation para corrigir os conjuntos de dados.

Há muitas situações em que você pode escolher, com base na árvore de decisão acima, usar um produto em vez do outro. No entanto, outras situações podem envolver o uso dos dois produtos para atingir suas metas.

Você pode usar a API Address Validation em vez da API Geocoding quando:

  • Há uma grande chance de dados questionáveis ou em que um endereço incorreto vai ter um impacto negativo. Isso ocorre porque a API Address Validation fornece mais feedback sobre por que uma entrada não recebeu um resultado de alta precisão.
  • Você precisa corrigir as entradas do usuário (por exemplo, erros de digitação ou campos ausentes), o que aumenta a probabilidade de um resultado preciso na saída.
  • A região de destino retorna mais metadados da API Address Validation em comparação com a API Geocoding, como a classificação do tipo de edifício como residencial ou comercial.

Você pode usar a API Geocoding em vez da API Address Validation quando:

  • Seu objetivo principal é recuperar o local de um endereço, e a precisão de endereços individuais pode não ser essencial.
    • Por exemplo, para gerar um mapa de calor com um grande conjunto de dados.
  • Você precisa de uma solução global, e a API Address Validation não está disponível em todas as regiões de destino.

Confira a seguir alguns exemplos que demonstram os recursos da API Address Validation em comparação com a API Geocoding.

Exemplo de endereço inválido

1 Fake St, Mountain View, CA 94043, USA

A API Address Validation divide essa entrada em componentes de endereço individuais (rua, cidade, estado etc.). Ele também pode fornecer feedback detalhado sobre por que o endereço não é válido até o nível PREMISE.

A Fake St não existe em Mountain View, CA, e a API Address Validation reflete isso nos detalhes de nível de componente retornados:

{
  "componentName": {
    "text": "Fake St",
    "languageCode": "en"
   },
   "componentType": "route",
   "confirmationLevel":"UNCONFIRMED_BUT_PLAUSIBLE"
 }

A propriedade importante a ser inspecionada neste caso é confirmationLevel. Ao retornar UNCONFIRMED_BUT_PLAUSIBLE para Fake St, a API determinou que seria possível que uma rua tivesse esse nome, mas não é possível fazer a correspondência com os dados de endereço de suporte.

Usando o resultado da API como feedback, é possível deduzir que o componente de rua dessa entrada (Fake St) está com defeito.

Usando o mesmo endereço com a API Geocoding, é possível fazer uma correspondência com "California", conforme mostrado na captura de tela da ferramenta de geocodificação, que você pode testar aqui:

alt_text

No entanto, o resultado é um geocódigo de todo o estado, com um feedback mínimo sobre quais componentes da entrada estavam com problemas.

Exemplo de erro de ortografia

76 Buckingamm Palace Road, Londn, SW1W 9TQ, GB

O endereço acima contém alguns erros de ortografia, um no nome da rua e outro na localidade.

A API de validação de endereço e a API de geocodificação podem corrigir esses erros e alcançar o resultado de 76 Buckingham Palace Road, Londres, SW1W 9TQ. No entanto, a API Address Validation pode fornecer mais informações sobre o processo.

Confira um dos componentes do endereço que foi digitado incorretamente:

{
  "componentName": {
    "text": "Buckingham Palace Road",
    "languageCode": "en"
        },
        "componentType": "route",
        "confirmationLevel": "CONFIRMED",
        "spellCorrected": true
     }
}

A API Address Validation retorna uma flag para indicar que uma correção foi feita no campo. A lógica de negócios pode ser implementada com base nessa flag para verificar novamente a correção com o provedor de dados, como um cliente em uma finalização de compra de e-commerce.

Exemplo de dados ausentes e erro de ortografia

Bollschestraße 86, 12587, DE

O endereço acima tem um erro de ortografia no nome da rua e não inclui a cidade (localidade) de Berlim.

A API Address Validation pode corrigir esses dois erros e retornar um geocódigo de nível PREMISE e um endereço verificado no nível PREMISE:

Bölschestraße 86, 12587 Berlin, DE

A API Geocoding não consegue superar os erros de entrada nesse caso e retorna um resultado de ZERO_RESULTS.

Exemplo de metadados de endereço adicionais

111 8th Avenue Ste 123, Nova York, NY 10011-5201, EUA

O endereço está correto, exceto pelo número da unidade (Ste 123), que não existe no edifício.

A API Address Validation pode validar o endereço para PREMISE (111 8th Ave) e fornecer alguns metadados sobre a propriedade, incluindo se ela é comercial

local:

"business": true

Além disso, o valor dpvConfirmation retornado como parte do uspsData na resposta é S:

"dpvConfirmation": "S"

Um valor dpvConfirmation de S indica que o endereço é validado no nível PREMISE, mas o número da unidade fornecido na entrada não está associado a esse endereço.

A API Geocoding não pode fornecer essas informações.

Como entender a resposta da API Geocoding

Visão geral

Se você usar a API Geocoding, o resultado da geocodificação vai conter várias pistas na resposta que podem ser usadas para entender os detalhes do endereço fornecido.

A API Geocoding funciona resolvendo os componentes do endereço em uma hierarquia.

Por exemplo, 123 Example Street, Chicago, 60007, USA é resolvido na seguinte ordem:

O / Example Street/ Chicago/ 60007/ USA será avaliado nessa ordem. A primeira correspondência neste caso é Chicago e, mais especificamente, o código postal 60007. Portanto, ele retorna o seguinte Place_id para esse CEP:

ChIJwRKzf8ixD4gRHiXqucwr_HQ

A API Geocode contém as seguintes informações na resposta:

        "partial_match": true,
           "place_id": "ChIJwRKzf8ixD4gRHiXqucwr_HQ",
           "types": [
               "postal_code"
           ]

A API Geocoding pode confirmar a que tipo de lugar esse endereço pertence. Confira aqui uma lista de endereços types retornados pela API Geocoding.

Se nenhum dos componentes da entrada for resolvido, a API vai retornar:

{
   "results": [],
   "status": "ZERO_RESULTS"
}

Fazer uma solicitação com apenas o endereço da rua sem o número da casa retorna um resultado no formato:

"types": [
  "route"
]

Isso significa que a API Geocoding não conseguiu encontrar ou corresponder a um número de rua.

Observação:para saber se um endereço existe, verifique se algum dos parâmetros (como types, partial_match, results, status)) está definido na resposta da API Geocoding. Isso aumenta gradualmente o nível de confiança de que um endereço pode existir, mas não o torna 100% preciso. É por isso que precisamos da API Address Validation.

Você pode usar as técnicas acima para aumentar a confiança na precisão do endereço usando apenas a resposta da API Geocoding. No entanto, ao contrário de um resultado da API Address Validation, a API Geocoding não vai retornar um feedback exato para determinar a precisão do resultado.

Tipo de local

Para entender esta seção corretamente, você precisa entender os diferentes tipos de local que podem ser retornados de uma resposta da API Geocoding:

  • ROOFTOP indica que o resultado retornado é um código geográfico preciso para o qual temos informações de localização com precisão de endereço.
  • RANGE_INTERPOLATED indica que o resultado retornado reflete uma aproximação (normalmente em uma estrada) interpolada entre dois pontos precisos (como interseções). Resultados interpolados geralmente são retornados quando códigos geográficos de rooftop não estão disponíveis para um endereço.
  • GEOMETRIC_CENTER indica que o resultado retornado é o centro geométrico de um resultado, como uma polilinha (por exemplo, uma rua) ou um polígono (região).
  • APPROXIMATE indica que o resultado retornado não é nenhum dos anteriores.

Se uma API Geocoding retornar um location_type de ROOFTOP ou RANGE_INTERPOLATED, isso não significa necessariamente que o endereço existe. Da mesma forma, se uma API Geocoding retornar com a flag partial_match definida como true, ainda poderá ser o resultado certo para você.

Esse tipo de correspondência falsa é um problema muito difícil de resolver com a API Geocoding. No mínimo, você pode implementar algumas validações básicas pós-processamento no país e na localidade da solicitação / resposta. Melhor ainda, compare os endereços reais para verificar se há erros de ortografia e/ou se eles estão incompletos.

Observação: se você decidir usar a API Geocoding, recomendamos que realize verificações de qualidade de dados entre a solicitação inicial e a resposta da API Geocoding regularmente.

Correspondência parcial e correspondência falsa

Se um endereço for uma correspondência parcial, ou seja, se a API Geocoding não conseguir identificar exatamente o endereço, a resposta conterá:

"partial_match": true,
"types": [
           "locality",
           "political"
         ]

Mais importante do que os tipos de local acima é considerar quando partial_match = true está na resposta. partial_match indica que a API Geocoding não retornou uma correspondência exata para a solicitação original, mas conseguiu corresponder parte do endereço solicitado.

Talvez seja necessário verificar se a solicitação original inclui um endereço incompleto. Correspondências parciais ocorrem com mais frequência para endereços que não existem na localidade especificada na solicitação. Elas também podem ser retornadas quando uma solicitação corresponde a dois ou mais locais na mesma localidade.

Por exemplo, "21 Henr St, Bristol, UK" retorna uma correspondência parcial para Henry Street e Henrietta Street. Se uma solicitação incluir um componente de endereço com um erro ortográfico, a API Geocoding poderá sugerir um endereço alternativo. As sugestões acionadas dessa maneira não serão marcadas como correspondências parciais.

Endereços sintéticos

A API Geocoding pode retornar locais para endereços "sintéticos" que não existem como locais precisos no banco de dados do Google.

Nesses casos, o objeto de resposta geralmente contém um ID de lugar longo e a seguinte propriedade: geometry.location_type=APPROXIMATE.

Se você encontrar esses indicadores na resposta, marque o endereço de entrada como inválido e tente validar novamente de outra forma.

Observação: este é outro exemplo em que, com a API Address Validation, você recebe feedback direto se um endereço não existe.

Como entender a resposta da API Address Validation

Já há uma ótima documentação sobre como entender as respostas da API Address Validation. Por isso, não vamos entrar em mais detalhes aqui.

Práticas recomendadas

Como especificar a região geográfica

Ao fazer chamadas para as APIs Address Validation ou Geocoding, é recomendável tentar limitar a área geográfica em que o endereço será pesquisado. As duas APIs implementam isso de duas maneiras diferentes:

  • API Geocoding: viés de região

    Se você souber que os códigos geográficos vão estar em um determinado país, vai conseguir resultados muito melhores usando a Viés de região. Por exemplo, se você estiver fazendo geocodificação no Canadá, recomendamos adicionar &region=ca às suas solicitações para direcionar o resultado para o Canadá. O direcionamento regional só prioriza resultados dentro dessa região. Você ainda pode receber resultados fora da região.

  • API Address Validation: código da região

    Da mesma forma, a API Address Validation produz resultados mais precisos se um código ISO2 for transmitido na solicitação usando o campo regionCode.

Armazenar IDs de lugar

Para armazenar informações da Plataforma Google Maps sobre o local para solicitações futuras, armazene o ID de lugar indefinidamente no seu banco de dados como um atributo do local. Você só precisa fazer uma solicitação de Find Place uma vez por ID de lugar. Também é possível pesquisar o ID de lugar sempre que um usuário solicitar detalhes da transação.

Para ter sempre as informações mais atualizadas, atualize os IDs de lugar a cada 12 meses usando uma solicitação de Place Details com o parâmetro place_id.

Observação: consulte também o guia de práticas recomendadas para geocodificação.

Conclusão

Este documento descreve as principais diferenças entre as APIs Address Validation e Geocoding. Em resumo, use a API Address Validation quando:

  • É necessário informar um endereço de correspondência correto, especialmente para fins de entrega.
  • Os dados de entrada são de baixa qualidade. A API Address Validation é mais tolerante a erros de entrada, destaca componentes de endereço não verificáveis e corrige os dados de entrada.
  • Mais informações são necessárias para um endereço, como Residencial ou Comercial (disponível em regiões selecionadas).

Próximas etapas

Baixe o documento técnico Melhorar a finalização da compra, o envio e as operações com endereços confiáveis e assista o webinar Como melhorar a finalização da compra, o envio e as operações com a validação de endereço .

Leitura adicional sugerida:

Colaboradores

Este artigo é mantido pelo Google. Os seguintes colaboradores a escreveram originalmente.

Autores principais:

Henrik Valve | Engenheiro de soluções

Thomas Anglaret | Engenheiro de soluções

Sarthak Ganguly | Engenheiro de soluções