次のいずれかのエンドポイントに POST リクエストを発行して、住所の検証リクエストを送信します。
- validateAddress(REST)
- ValidateAddress(gRPC)
また、検証するアドレスを定義するリクエストに JSON リクエスト本文を渡す必要があります。次のリクエスト本文には、1 つのフィールドと 3 つのサブフィールドが含まれています。
curl -X POST -d '{ "address": { "regionCode": "US", "locality": "Mountain View", "addressLines": ["1600 Amphitheatre Pkwy"] } }' \ -H 'Content-Type: application/json' \ "https://addressvalidation.googleapis.com/v1:validateAddress?key=API_KEY"
locality
を省略して、addressLines
配列の要素として指定することもできます。
{
"address": {
"regionCode": "US",
"addressLines": ["1600 Amphitheatre Pkwy", "Mountain View, CA, 94043"]
},
}
住所リクエスト フィールド
リクエストの本文は 1 つのフィールドで構成されます。
address
-PostalAddress
型のフィールド。addressLines
に少なくとも 1 つのエントリを含める必要があります。
Address Validation API に address
フィールドを送信する場合は、addressLines
フィールドを 1 つ指定するだけで済みます。ただし、最もシンプルな住所リクエストには、次のサブフィールドを含める必要があります。
regionCode
- 推奨。これは省略可能なフィールドですが、省略した場合、Address Validation API はアドレスからリージョンを推測します。ただし、最良の結果を得るには、regionCode
が判明している場合は含めてください。サポートされているリージョンの一覧については、サポートされているリージョンをご覧ください。addressLines
- 必須。住所の下位構造を表す住所を含む配列。
リファレンス ガイドの PostalAddress をご覧ください。 |
USPS CASS™ オプション
United States Postal Service®(USPS®)1 は、住所検証サービスのプロバイダを支援し認定するために、Coding Accuracy Support System(CASS™)を運営しています。
米国とプエルトリコのリージョンでのみ、リクエスト本文で enableUspsCass
を true
に設定して CASS 処理を有効にできます。CASS を使用する場合は、市区町村、都道府県、郵便番号とともに、番地と道路名を含む住所を指定してください。
{
"address": {
"regionCode": "US",
"locality": "Mountain View",
"administrativeArea": "CA",
"postalCode": "94043",
"addressLines": ["1600 Amphitheatre Pkwy"]
},
"enableUspsCass": true
}
試してみよう:
API Explorer では、サンプル リクエストを実行して、API と API オプションを把握できます。
ページの右側にある API アイコン を選択します。
必要に応じて [標準パラメータを表示] を開き、
fields
パラメータをフィールド マスクに設定します。必要に応じて、リクエスト本文を編集します。
[Execute] ボタンを選択します。ダイアログで、リクエストに使用するアカウントを選択します。
API Explorer パネルで展開アイコン を選択して、API Explorer ウィンドウを開きます。
-
Google Maps Platform は、United States Postal Service® の非独占的なライセンシーです。United States Postal Service®、CASS™、CASS Certified™ の各商標は、United States Postal Service® が所有し、許諾を得て使用しています。↩