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

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