更新された住所を処理する

1 つの住所に対して Address Validation API を複数回呼び出す場合があります。たとえば、お客様が最初の検証の結果を確認した後に住所を変更した場合などです。次に、更新された住所に対して 2 回目の検証を行います。

このドキュメントでは、Address Validation API に対して同じ住所に関する一連のリクエストを発行する際に実行できる 2 つの重要なアクションについて説明します。これらのアクションは厳格な使用要件ではありませんが、全体的なデータ品質とシステム レスポンスを改善するために役立つアクションです。

  • provideValidationFeedback エンドポイントにリクエストを送信する
  • previousResponseID フィールドを設定する

provideValidationFeedback リクエストを送信する

一連の検証の最後に、Provide Validation Feedback API を呼び出して、すべての検証の最終的な結果を示すことをおすすめします。このリクエストでは、次の 2 つのフィールドが設定されます。

  • conclusion - サービスで使用した検証バージョン（ユーザーが指定したバージョンか、Address Validation API から返されたバージョンか）を示します。
  • responseId - Address Validation API からの最初のレスポンスのレスポンス ID を示します。下記の previousResponseId フィールドを設定するをご覧ください。

provideValidationFeedback メソッド（REST）または ProvideValidationFeedback メソッド（gRPC）を使用します。

次の例では、結論を定義するリクエストに JSON 本文を渡します。

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"
  • conclusion フィールドは、お客様側の次のいずれかのアクションを識別します。
    • VALIDATED_VERSION_USED: Address Validation API から取得した住所の検証済みバージョン。
    • USER_VERSION_USED: ユーザーが提供した元のバージョン。
    • UNVALIDATED_VERSION_USED: ユーザーへのプロンプトの結果として得られたバージョンですが、Address Validation API で再検証されていません。
    • UNUSED: トランザクションを放棄しました。
リファレンス ガイドの検証の結論をご覧ください。
  • responseId フィールドには、フィードバックを提供する住所検証結果を指定します。この値は、validateAddress メソッドの最初の呼び出しで返された responseId 値と同じにする必要があります。
検証フィードバック リファレンス ガイドのリクエスト本文をご覧ください。

previousResponseID フィールドを設定する

特定のアドレスについて Address Validation API にフォローアップ リクエストを送信する場合は、previousResponseId フィールドを設定します。

  • previousResponseId の値には、最初の検証リクエスト後に API から返された responseId の値を使用します。
  • シリーズが完了するまで、すべてのフォローアップ リクエストに同じ値を使用します。

次のシーケンス図は、推奨されるフローを示しています。

レスポンス ID を使用して住所を検証します。