Processar endereços atualizados

Em alguns casos, é possível fazer várias chamadas para a API Address Validation em um único endereço. Por exemplo, o cliente pode fazer mudanças no endereço depois de ver os resultados da primeira validação. Em seguida, faça uma segunda validação no endereço atualizado.

Este documento descreve duas ações principais que você pode realizar ao emitir uma série de solicitações para o mesmo endereço à API Address Validation. Essas ações não são um requisito de uso estrito, mas são úteis para melhorar a qualidade geral dos dados e a resposta do sistema.

  • Enviar uma solicitação para o endpoint provideValidationFeedback
  • Defina o campo previousResponseID

Enviar uma solicitação provideValidationFeedback

Ao final de uma série de validações, o Google recomenda fazer uma chamada para a API Provide Validation Feedback para indicar o resultado final de todas as validações. A solicitação define dois campos:

  • conclusion: indica a versão de validação usada no seu serviço, seja a fornecida pelo usuário ou a retornada pela API Address Validation.
  • responseId: indica o ID da primeira resposta da API Address Validation. Consulte Definir o campo previousResponseId abaixo.

Use o método provideValidationFeedback (REST) ou ProvideValidationFeedback (gRPC).

O exemplo a seguir transmite um corpo JSON à solicitação que define a conclusão:

curl -X POST -d '{
  "conclusion": "VALIDATED_VERSION_USED",
  "responseId": "de22bed8-7f52-44cb-8526-faceac57150a"
}' \
-H 'Content-Type: application/json' \
"https://addressvalidation.googleapis.com/v1:provideValidationFeedback?key=API_KEY"
  • O campo conclusion identifica uma das seguintes ações do seu lado:
    • VALIDATED_VERSION_USED: a versão validada do endereço da API Address Validation.
    • USER_VERSION_USED: a versão original fornecida pelo usuário.
    • UNVALIDATED_VERSION_USED: uma versão que resultou de uma solicitação ao usuário, mas não foi revalidada com a API Address Validation.
    • UNUSED: abandonou a transação.
Consulte Conclusão da validação no guia de referência.
  • O campo responseId especifica para quais resultados da validação de endereço você está enviando feedback. Esse valor precisa ser igual ao valor responseId retornado pela primeira chamada do método validateAddress.
Consulte Corpo da solicitação no guia de referência de feedback de validação.

Defina o campo previousResponseID

Ao emitir uma solicitação de acompanhamento para a API Address Validation de um determinado endereço, defina o campo previousResponseId.

  • Para o valor de previousResponseId, use o valor de responseId retornado pela API após a primeira solicitação de validação.
  • Use esse mesmo valor para todas as solicitações de acompanhamento até que a série seja concluída.

Este diagrama de sequência mostra o fluxo preferencial:

Use o ID da resposta para validar um endereço.