基本的な住所確認のレスポンスについて

Address Validation API はレスポンスの本文を JSON 形式で提供する このオブジェクトには、次の 2 つのトップレベル プロパティが含まれます。

{
  "result": {
    // Validation verdict.
    "verdict": {},
    // Address details determined by the API.
    "address": {},
    // The geocode generated for the input address.
    "geocode": {},
    // Information indicating if the address is a business, residence, etc.
    "metadata": {},
    // Information about the address from the US Postal Service
    // ("US" and "PR" addresses only).
    "uspsData": {},
  },
  // A unique identifier generated for every request to the API.
  "responseId": "ID"
}

このドキュメントでは、result オブジェクトについて説明します。詳細については、 responseID については、更新された住所を処理するをご覧ください。

verdict プロパティ

verdict プロパティは、住所の検証結果を要約したものです。住所チェック ロジックを構築する際に、最初に評価するプロパティにする必要があります。このプロパティは、出力アドレスの品質に応じてさまざまなフィールドを返すことができます。たとえば、次の変数の verdict プロパティは、 品質が良いアドレスの場合、この特定のリクエストに対して 4 つのフィールドが返されます。

"verdict": {
  "inputGranularity": "PREMISE",
  "validationGranularity": "PREMISE",
  "geocodeGranularity": "PREMISE",
  "addressComplete": true
}

以下のセクションでは、verdict プロパティのすべてのフィールドの概要について説明します。

リファレンス ガイドの判定結果をご覧ください。

アドレスの粒度

アドレスの粒度とは、 住所やジオコーディングの特異性も考慮します。validationGranularity レスポンスの住所の詳細は、住所が配達可能かどうかを判断するための重要なシグナルです。

verdict プロパティは、以下の粒度シグナルを返します。

  • inputGranularity - ビューから取得された詳細レベル Address Validation API に送信されます。住所の詳細レベルは リクエストは検証レスポンスの住所の詳細レベルに影響します。 たとえば、inputGranularity が PREMISE より下の住所の場合 レベルでは、通常、validationGranularity は PREMISE にはならない できます。
  • validationGranularity - 送信される粒度レベル Address Validation API は送信先の住所を完全に検証できます。ほとんどの場合、 PREMISE または SUB_PREMISE の粒度は、質の高いアドレスを示します。 提示します
  • geocodeGranularity - ジオコードの詳細レベルを表します。 関連付けられていますたとえば、Google のレコードでは、 アパート番号は存在するが、その正確な位置はわからない 大きな集合住宅内の特定の集合住宅に 密集しているのがわかりますその場合、 validationGranularity は SUB_PREMISE ですが、geocodeGranularityisPREMISE です。
リファレンス ガイドの粒度をご覧ください。

住所の完全性

判定結果では、addressComplete プロパティがイベントのシグナルとして返されます。 質の高い住所、つまり住所の欠落がないこと、 未解決のコンポーネントや予期しないコンポーネントが

"verdict": {
    "inputGranularity": "PREMISE",
    "validationGranularity": "PREMISE",
    "geocodeGranularity": "PREMISE",
    "addressComplete": true
}

住所に欠落している要素、未解決の要素、想定外の要素がある場合は、 false に設定されている。

リファレンス ガイドの判定結果とアドレスの addressComplete をご覧ください。

住所の品質

考えられるフィールドの多くは、住所コンポーネントの問題、または住所コンポーネントの推定や欠落などの調整を示しています。対象 次の verdict プロパティは、住所が未確認であることを示しています。 欠落している addressComplete フィールドがあります。

"verdict": {
    "inputGranularity": "PREMISE",
    "validationGranularity": "OTHER",
    "geocodeGranularity": "OTHER",
    "hasUnconfirmedComponents": true,
    "hasInferredComponents": true
}
リファレンス ガイドの判定結果をご覧ください。

address プロパティと addressComponent プロパティ

address プロパティには、リクエストで指定された処理済みの住所の形式と、住所のコンポーネント レベルの概要（住所のスペルミス、誤った部分の置換、推定された不足部分など）が含まれます。

リファレンス ガイドの Address をご覧ください。

addressComponent プロパティは address のサブコンポーネントであり、 住所の要素（または構成要素）の詳細なリストが Address Validation API が処理されました。API は各コンポーネントを フィールドは、名前、タイプ、確認レベルごとに表示されます。

リファレンス ガイドの addressComponent をご覧ください。

geocode プロパティ

geocode プロパティは、入力に関連付けられたジオコーディングされた位置を示します。 あります。このプロパティは、 使用します。

リファレンス ガイドの Geocode をご覧ください。

metadata プロパティ

このプロパティは、 Address Validation API。住所のタイプが住宅（住宅）であるかどうかを ビジネス、私書箱などです。

詳しくは、Address Validation API の対象範囲と Address metadata のリファレンスをご覧ください。

uspsData プロパティ

このプロパティは米国の住所に役立つ情報を提供します。 ただし、検証されたすべてのアドレスに完全なデータが入力されるとは限りません。 許可します。そのため、このプロパティを 唯一の方法でアドレスを検証しますが、代わりに verdict と address も同様です。

米国の住所を処理すると UspsData のリファレンスをご覧ください。
前へ
住所確認リクエストを送信する
次へ
検証ロジックを作成する