Enviar feedback sobre a validação do endereço

Para nos ajudar a melhorar a qualidade da API Address Validation, você pode enviar feedback ao Google para nos informar se um endereço validado foi aceito pelo usuário final. Esse feedback nos ajuda a melhorar a precisão geral da API.

Solicitação de feedback de validação de endereço

Para enviar feedback após uma chamada para um método de validação de endereço, faça uma chamada para o método provideValidationFeedback (REST) ou ProvideValidationFeedback (gRPC). O exemplo a seguir faz uma solicitação POST para a API REST:

https://addressvalidation.googleapis.com/v1:provideValidationFeedback?key=YOUR_API_KEY

Transmita um corpo JSON para a solicitação POST definindo a conclusão da validação de endereço:

{
  "conclusion": "VALIDATED_VERSION_USED",
  "responseId": "de22bed8-7f52-44cb-8526-faceac57150a"
}

Em que:

  • O campo conclusion deve refletir o resultado real da validação.

    Neste exemplo, VALIDATED_VERSION_USED é transmitido como o valor do campo conclusion para indicar que o endereço que você acabou usando foi retornado pela API.

    Se você vir a usar o endereço fornecido pelo usuário final, transmita USER_VERSION_USED.

    Para ver todos os valores possíveis para conclusion, consulte ValidationConclusion.

  • O campo responseId especifica para quais resultados da validação de endereço você está fornecendo feedback. Esse valor precisa ser igual ao responseId retornado por uma chamada anterior para o método validateAddress.

    Para ver exemplos de como chamar o método validateAddress, consulte Validar um endereço.

Como definir responseID

Cada chamada da API Address Validation retorna um valor exclusivo no campo responseId da resposta.

Em alguns casos, é possível fazer várias chamadas à API Address Validation para um único endereço. Por exemplo, o usuário final pode fazer alterações no endereço depois de ver os resultados da primeira validação. Depois disso, você vai fazer uma segunda validação no endereço atualizado.

Se um endereço que você está tentando validar precisar ser validado novamente, transmita o responseId da primeira resposta no campo previousResponseId em todas as solicitações de acompanhamento para a API Address Validation.

Cada resposta a essas solicitações de acompanhamento contém um novo responseId, mas continua usando o valor do primeiro responseId no previousResponseId até que a validação seja concluída.

Saiba mais sobre como validar um endereço atualizado em Validar um endereço atualizado.

Ao final de uma série de validações, recomendamos que você faça uma chamada para a API Fornecer feedback de validação para nos informar sobre o resultado final de todas as validações. Transmita o responseId da primeira resposta na solicitação da API Provide Validation Feedback.

Este diagrama de sequência mostra o fluxo desejado:

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