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

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

Responder à solicitação de feedback de validaçã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 do endereço:

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

Em que:

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

    Neste exemplo, transmita VALIDATED_VERSION_USED como o valor do campo conclusion para indicar que o endereço que você acabou de usar foi aquele retornado pela API.

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

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

  • O campo responseId especifica para quais resultados de 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 exemplos de como chamar o método validateAddress, consulte Validar um endereço.

Como definir o responseID

Cada chamada da API de validação de endereço retorna um valor exclusivo no campo responseId da resposta.

Em alguns casos, é possível fazer várias chamadas para a 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. Em seguida, faça uma segunda validação no endereço atualizado.

Se um endereço que você está tentando validar precisar ser revalidado, 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 da primeira responseId no previousResponseId até que a validação seja concluída.

Para mais informações sobre como validar um endereço atualizado, consulte Validar um endereço atualizado.

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

O diagrama a seguir mostra o fluxo desejado:

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