デジタル プラットフォーム API - 国サービス

  • [アーティクル]

読み取り専用 Country Service を使用すると、Xandr システムに登録されている国に関する情報を表示できます。 このサービスを使用して、キャンペーンのターゲット設定の ID を取得できます (プロファイル サービスを参照)。country_targets

REST API

HTTP メソッド エンドポイント 説明
GET https://api.appnexus.com/country すべての国を表示します。
GET https://api.appnexus.com/country?id=ID ID で特定の国を表示します。
GET https://api.appnexus.com/country?name=NAME 特定の国を NAME で表示します。
GET https://api.appnexus.com/country?code=CODE 特定の国を CODE で表示します。
GET https://api.appnexus.com/country/meta フィルター処理および並べ替えの対象となるフィールドを確認します。

JSON フィールド

フィールド 種類 説明
id int 国の ID。
name string 国の名前。
code string 国の ISO コード。
active ブール型 true の場合、国はターゲット設定に使用できます。 false の場合、国の位置情報データがないため、配信できません。

例

すべての国を表示する

$ curl -b cookies -c cookies 'https://api.appnexus.com/country'
{
    "response": {
        "status": "OK",
        "count": 250,
        "start_element": null,
        "num_elements": null,
        "countries": [
            {
                "id": 1,
                "name": "Anonymous Proxy",
                "code": "A1",
                "active": true
            },
            {
                "id": 2,
                "name": "Satellite Provider",
                "code": "A2",
                "active": true
            },
            {
                "id": 3,
                "name": "Other Country",
                "code": "O1",
                "active": true
            },
            ...
        ]
    }
}

ID で特定の国を表示する

$ curl -b cookies -c cookies 'https://api.appnexus.com/country?id=59'
{
    "response": {
        "status": "OK",
        "count": 1,
        "start_element": null,
        "num_elements": null,
        "country": {
            "id": 59,
            "name": "Germany",
            "code": "DE",
            "active": true
        }
    }
}

コードで特定の国を表示する

$ curl -b cookies -c cookies 'https://api.appnexus.com/country?code=DE'
{
    "response": {
        "status": "OK",
        "count": 1,
        "start_element": null,
        "num_elements": null,
        "countries": [
            {
                "id": 59,
                "name": "Germany",
                "code": "DE",
                "active": true
            }
        ]
    }
}

名前に "United" が含まれているすべての国を表示する

$ curl -b cookies -c cookies 'https://api.appnexus.com/country?like_name=United'
{
    "response": {
        "status": "OK",
        "count": 5,
        "start_element": null,
        "num_elements": null,
        "countries": [
            {
                "id": 5,
                "name": "United Arab Emirates",
                "code": "AE",
                "active": true
            },
            {
                "id": 80,
                "name": "United Kingdom",
                "code": "GB",
                "active": true
            },
            {
                "id": 229,
                "name": "Tanzania, United Republic of",
                "code": "TZ",
                "active": true
            },
            {
                "id": 232,
                "name": "United States Minor Outlying Islands",
                "code": "UM",
                "active": true
            },
            {
                "id": 233,
                "name": "United States",
                "code": "US",
                "active": true
            }
        ]
    }
}