次のいずれかのエンドポイントに 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
フィールドを Address Validation API に送信するときに指定する必要があるのは、addressLines
という 1 つのフィールドだけです。ただし、最もシンプルな住所リクエストには、次のサブフィールドを含める必要があります。
regionCode
- 推奨。これは省略可能なフィールドですが、省略すると、Address Validation API は住所から地域を推測します。ただし、最善の結果を得るために、regionCode
がわかっている場合はそれを含めます。サポートされているリージョンの一覧については、サポートされているリージョンをご覧ください。addressLines
- 必須。住所の下位構造を表す住所を含む配列。
リファレンス ガイドの PostalAddress をご覧ください。 |
USPS CASSTM オプション
米国郵便公社®(USPS®)1 は、住所検証プロバイダをサポートし、認定するために、Coding Accuracy Support System(CASSTM)を運営しています。
米国とプエルトリコのリージョンの場合のみ、リクエスト本文で 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
パラメータをフィールド マスクに設定します。必要に応じて、[Request body] を編集します。
[Execute] ボタンを選択します。ダイアログで、リクエストに使用するアカウントを選択します。
[API Explorer] パネルで、展開アイコン()を選択して API Explorer ウィンドウを展開します。
-
Google Maps Platform は United States Postal Service® の非独占的なライセンシーです。以下の商標は United States Postal Service® が所有し、許可を得て使用しています: United States Postal Service®、CASSTM、CASS CertifiedTM ↩