郵便番号サービスは読み取り専用サービスです。 このサービスを使用して、Xandr に登録されている郵便番号 ID を取得し、ライン アイテムを設定するとき、またはそのディメンションをサポートするレポートを構成して、地理的なターゲット設定を行うことができます。 郵便番号サービスの主な使用例は、郵便番号データベースを Xandr を使用して最新の状態に保つことです。 サービスに対する最後の呼び出し以降に Xandr データベースに加えられた変更にアクセスするには、呼び出しで min_last_modified フィールドを使用してください。
警告
郵便番号の完全な一覧を取得するには (ページネーションの結果として) 多数の GET 呼び出しを行う必要があるため、次のことをお勧めします。
- キャッシュを作成し、サービス上のすべてのオブジェクトに対する GET 呼び出しを設定します
- その後の GET 呼び出しでは、
min_last_modifiedフィルターを使用して更新を取得します (郵便番号は頻繁に更新されないため、1 時間に 1 回または 1 日に 1 回)
このサービスを初めてクエリする場合のみ、 min_last_modified フィルターを省略する必要があります。
REST API
| HTTP メソッド | エンドポイント | 説明 |
|---|---|---|
| GET | https://api.adnxs.com/postal-code |
すべての郵便番号を表示 |
| GET | https://api.adnxs.com/postal-code?country_code=COUNTRY_CODE |
特定の国または地域の郵便番号を表示する |
| GET | https://api.adnxs.com/postal-code/meta |
フィルター処理や並べ替えの基準となるフィールドを確認する |
JSON フィールド
| フィールド | タイプ (長さ) | 説明 |
|---|---|---|
active |
ブール値 | 郵便番号がアクティブかどうかを指定します。
trueの場合、郵便番号はアクティブであり、ターゲットに使用できます。
falseの場合、郵便番号の地理的な場所データがないため、ターゲティングできません。 |
code |
string | 郵便番号は 14 文字までの英数字文字列で、スペースまたはハイフンを含めることができます。 |
country_code |
string | 都市が属する国または地域の ISO Alpha-2 コード。 国別サービスを使用すると、国コードの完全な一覧を取得できます。 |
country_id |
string | 国または地域の ID。 |
country_name |
string | 都市が属する国または地域の名前。 Country Service を使用すると、国名の完全な一覧を取得できます。 |
id |
int | 郵便番号の ID。 |
last_modified |
timestamp | 郵便番号が最後に変更された日時。 |
例
カナダのすべての郵便番号を表示
$ curl -b cookies -c cookies -X GET 'https://api.adnxs.com/postal-code?country_code=CA'
{
"response": {
"status": "OK",
"count": 44101,
"start_element": null,
"num_elements": null,
"postal_codes": [
{
"id": 119892,
"code": "A09 0A1",
"country_id": "41",
"country_code": "CA",
"country_name": "Canada"
},
{
"id": 119893,
"code": "A0A 0B3",
"country_id": "41",
"country_code": "CA",
"country_name": "Canada"
},
{
"id": 119894,
"code": "A0A 0C3",
"country_id": "41",
"country_code": "CA",
"country_name": "Canada"
},
...
]
}
}
郵便番号 ID で郵便番号を表示する
$ curl -b cookies -c cookies 'https://api.adnxs.com/postal-code?id=10'
{
"response": {
"status": "OK",
"count": 1,
"start_element": null,
"num_elements": null,
"postal_code": {
"id": 10,
"code": "00021",
"country_id": "113",
"country_code": "IT",
"country_name": "Italy"
}
}
}
View all postal codes since last modified
$ curl -b cookies -c cookies -X GET 'https://api.adnxs.com/postal-code?min_last_modified=2017-06-28+15:02:37
{
"response": {
"status": "OK",
"count": 8735,
"start_element": null,
"num_elements": null,
"postal_codes": [{
"id": 322567,
"code": "2645-018",
"active": true,
"country_id": "186",
"country_code": "PT",
"country_name": "Portugal",
"last_modified": "2017-06-26 15:39:18"
},
{
"id": 322568,
"code": "BS5 7XA",
"active": true,
"country_id": "80",
"country_code": "GB",
"country_name": "United Kingdom",
"last_modified": "2017-06-26 15:39:18"
},
{
"id": 322569,
"code": "DE7 8HB",
"active": true,
"country_id": "80",
"country_code": "GB",
"country_name": "United Kingdom",
"last_modified": "2017-06-26 15:39:18"
},
...
]
}
}