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

Address Validation API は、2 つの最上位プロパティを含む JSON オブジェクトとしてレスポンスの本文を提供します。

• result: ValidationResult 型のオブジェクト
• responseID

{
  "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 に送信された住所から取得される詳細レベルを指定します。住所の詳細レベルは リクエストは検証レスポンスの住所の詳細レベルに影響します。 たとえば、PREMISE 未満の inputGranularity を持つアドレスは、通常、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 に設定されている。

住所の品質

表示されるフィールドの多くは、住所コンポーネントの問題、または 推定される住所要素や欠落している住所要素など）に対する調整を行います。たとえば、次の verdict プロパティは、未確認のコンポーネントを含む住所と、addressComplete フィールドがないことを示しています。

"verdict": {
    "inputGranularity": "PREMISE",
    "validationGranularity": "OTHER",
    "geocodeGranularity": "OTHER",
    "hasUnconfirmedComponents": true,
    "hasInferredComponents": true
}

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

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

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

geocode プロパティ

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

metadata プロパティ

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

uspsData プロパティ

このプロパティは、米国の住所に関して有用な情報を提供します。 ただし、検証されたすべてのアドレスに完全なデータが入力されるとは限りません。 許可します。そのため、このプロパティを住所の検証手段としてのみ使用せず、verdict と address も確認してください。