Referência rápida da API Address Validation

A API Address Validation aceita um endereço, identifica e valida os componentes dele, padroniza o endereço para correspondência e retorna as coordenadas de latitude/longitude mais conhecidas para ele. Para endereços dos EUA e de Porto Rico, é possível ativar o processamento do USPS CASS.

API Address Validation: fatos importantes

  • Produto: API Address Validation
  • Categoria: lugares
  • Plataforma: serviço da Web (REST)
  • Executado em: servidor (código de back-end)
  • Estágio de lançamento: GA
  • Ciclo de vida: Ativo
  • Visão geral: Visão geral da API Address Validation
  • Disponibilidade regional: limitada. Os países com suporte e a qualidade de dados variam de acordo com o país, e alguns países estão em pré-lançamento. Os metadados residenciais e comerciais são retornados apenas para os países sinalizados na página de cobertura. O USPS CASS é compatível apenas com os EUA e Porto Rico. (detalhes da cobertura)

API Address Validation: quando usar

Use a API Address Validation quando:

  • Você precisa verificar se um endereço se refere a um lugar real e descobrir quais componentes estão faltando ou podem estar errados.
  • Você precisa padronizar e completar um endereço para correspondência, por exemplo, durante um processo de finalização da compra.
  • Você precisa da validação certificada pelo CASS do USPS e do uspsData para endereços nos EUA ou em Porto Rico.
  • Você precisa de metadados de endereço residencial ou comercial de um país listado na página de cobertura.

Não use a API Address Validation quando:

  • Você só precisa converter um endereço em latitude/longitude e não precisa validar componentes de endereço individuais. Use a API Geocoding.
  • Você precisa de detalhes de destino hiperlocais, como entradas de edifícios, contornos de edifícios ou pontos de navegação. Use a API Geocoding.

API Address Validation: configuração

Pacotes oficiais da API Address Validation:

  • npm: @googlemaps/addressvalidation
  • pypi: google-maps-addressvalidation
  • go: cloud.google.com/go/maps

API Address Validation: erros comuns

  • Problema: a propriedade addressComplete é omitida do veredito quando o valor é false. Por isso, o código que espera que o campo esteja presente pode interpretar incorretamente endereços incompletos. Correção: trate uma propriedade addressComplete ausente como false ou verifique se ela está presente. Consulte /maps/documentation/address-validation/understand-response.
  • Problema: se regionCode for omitido, a API vai inferir a região com base no endereço, o que pode gerar resultados menos precisos. Correção: inclua o regionCode no PostalAddress quando souber. Consulte /maps/documentation/address-validation/requests-validate-address.
  • Problema: não há garantia de que o objeto uspsData será totalmente preenchido para todos os endereços validados dos EUA. Correção: não use uspsData como o único indicador de validação. Use também o veredito e os componentes do endereço. Consulte /maps/documentation/address-validation/handle-us-address.
  • Problema: o feedback enviado com provideValidationFeedback precisa referenciar o responseId da primeira chamada de validateAddress na sequência, não uma posterior. Correção: armazene o responseId da primeira resposta de validateAddress e envie-o na solicitação de feedback. Consulte /maps/documentation/address-validation/handle-updated-address.

O que você pode fazer com a API Address Validation

Consulte os guias vinculados abaixo para cada tarefa ou compare os produtos no Explorador de recursos.