Address Validation API はレスポンスの本文を JSON 形式で提供する このオブジェクトには、次の 2 つのトップレベル プロパティが含まれます。
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 に送信されます。住所の詳細レベルは リクエストは検証レスポンスの住所の詳細レベルに影響します。 たとえば、inputGranularity
がPREMISE
より下の住所の場合 レベルでは、通常、validationGranularity
はPREMISE
にはならない できます。validationGranularity
- 送信される粒度レベル Address Validation API は送信先の住所を完全に検証できます。ほとんどの場合、PREMISE
またはSUB_PREMISE
の粒度は、質の高いアドレスを示します。 提示しますgeocodeGranularity
- ジオコードの詳細レベルを表します。 関連付けられていますたとえば、Google のレコードでは、 アパート番号は存在するが、その正確な位置はわからない 大きな集合住宅内の特定の集合住宅に 密集しているのがわかりますその場合、validationGranularity
はSUB_PREMISE
ですが、geocodeGranularity
is
PREMISE です。
詳しくは、 粒度 をご覧ください。 |
住所の完全性
判定結果では、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 のリファレンスをご覧ください。
|