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

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 を使用して住所を検証します。