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

場合によっては、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 を使用して住所を検証します。