次の方法で共有

Digital Platform API - City サービス

  • [アーティクル]

読み取り専用シティ サービスを使用すると、地域、指定された市場地域、各都市が属する国など、Xandr システムに登録されている都市に関する情報を表示できます。 このサービスを使用すると、キャンペーンでターゲット設定する都市の ID を取得できます (プロファイル サービスを参照)。city_targets

REST API

HTTP メソッド エンドポイント 説明
GET https://api.appnexus.com/city すべての都市を表示します。
GET https://api.appnexus.com/city?country_code=COUNTRY_CODE 特定の国のすべての都市を表示します。
GET https://api.appnexus.com/city?country_name=COUNTRY_NAME 特定の国のすべての都市を表示します。
GET https://api.appnexus.com/city?dma_id=DMA_ID 特定の指定された市場エリアのすべての都市を表示します。
GET https://api.appnexus.com/city?dma_name=DMA_NAME 特定の指定された市場エリアのすべての都市を表示します。
GET https://api.appnexus.com/city?id=ID ID で特定の都市を表示します。
GET https://api.appnexus.com/city?name=NAME 特定の都市を名前で表示します。
GET https://api.appnexus.com/city/meta フィルター処理および並べ替えの対象となるフィールドを確認します。

JSON フィールド

フィールド 種類 説明
id int 市区町村の ID。
name string 市区町村の名前。
country_id int 市区町村が属する国の ID。 Country Service を使用して、国 ID の完全な一覧を取得できます。
country_name string 市が属する国の名前。 Country Service を使用して、国名の完全な一覧を取得できます。
country_code string 市区町村が属する国の ISO コード 。 Country Service を使用して、国コードの完全な一覧を取得できます。
region_id int 市区町村が属するリージョンの ID。 リージョン サービスを使用して、リージョン ID の完全な一覧を取得できます。
region_name string 市区町村が属する地域の名前。 リージョン サービスを使用して、リージョン名の完全な一覧を取得できます。
region_code string 市区町村が属するリージョンの ISO または FIPS コード。 リージョン サービスを使用して、リージョン コードの完全な一覧を取得できます。
dma_id int 市が属する指定された市場地域の ID。 指定されたマーケット エリア サービスを使用して、DMA ID の完全な一覧を取得できます。
dma_name string 市が属する指定された市場地域の名前。 指定されたマーケット エリア サービスを使用して、DMA 名の完全な一覧を取得できます。
active ブール型 の場合 true、市区町村はターゲット設定に使用できます。 の場合 false、市区町村の位置情報データがないため、配信できません。

例

ドイツのすべての都市を表示

$ curl -b cookies -c cookies 'https://api.appnexus.com/city?country_code=DE'
{
    "response": {
        "status": "OK",
        "count": 15769,
        "start_element": 0,
        "num_elements": 100,
        "cities": [
            {
                "id": 36677,
                "name": "Aach",
                "region_id": 825,
                "region_name": "Baden-Wurttemberg",
                "region_code": "01",
                "country_id": 59,
                "country_name": "Germany",
                "country_code": "DE",
                "dma_id": 1,
                "dma_name": "--",
                "active": true,
                "last_modified": "2015-04-09 19:40:57"
            },
            {
                "id": 36678,
                "name": "Aalen",
                "region_id": 825,
                "region_name": "Baden-Wurttemberg",
                "region_code": "01",
                "country_id": 59,
                "country_name": "Germany",
                "country_code": "DE",
                "dma_id": 1,
                "dma_name": "--",
                "active": true,
                "last_modified": "2015-04-09 19:40:57"
            },
            {
                "id": 36679,
                "name": "Abstatt",
                "region_id": 825,
                "region_name": "Baden-Wurttemberg",
                "region_code": "01",
                "country_id": 59,
                "country_name": "Germany",
                "country_code": "DE",
                "dma_id": 1,
                "dma_name": "--",
                "active": true,
                "last_modified": "2015-04-09 19:40:57"
            },
            ...
        ]
    }
}

ドイツのバイエルン州のすべての都市を表示

$ curl -b cookies -c cookies 'https://api.appnexus.com/city?region_name=Bayern'
{
  "response": {
    "status": "OK",
    "count": 3066,
    "start_element": 0,
    "num_elements": 100,
    "cities": [
      {
        "id": 39026,
        "name": "Abenberg",
        "region_id": 826,
        "region_name": "Bayern",
        "region_code": "02",
        "country_id": 59,
        "country_name": "Germany",
        "country_code": "DE",
        "dma_id": 1,
        "dma_name": "--",
        "active": true,
        "last_modified": "2015-04-09 19:40:57"
      },
      {
        "id": 39027,
        "name": "Abensberg",
        "region_id": 826,
        "region_name": "Bayern",
        "region_code": "02",
        "country_id": 59,
        "country_name": "Germany",
        "country_code": "DE",
        "dma_id": 1,
        "dma_name": "--",
        "active": true,
        "last_modified": "2015-04-09 19:40:57"
      },
      {
        "id": 39028,
        "name": "Absberg",
        "region_id": 826,
        "region_name": "Bayern",
        "region_code": "02",
        "country_id": 59,
        "country_name": "Germany",
        "country_code": "DE",
        "dma_id": 1,
        "dma_name": "--",
        "active": true,
        "last_modified": "2015-04-09 19:40:57"
      },
      ...
    ]
  }
}

"Karlsruhe" という名前の都市をすべて表示

$ curl -b cookies -c cookies 'https://api.appnexus.com/city?name=Karlsruhe'
{
    "response": {
        "status": "OK",
        "count": 2,
        "start_element": 0,
        "num_elements": 100,
        "cities": [
            {
                "id": 37739,
                "name": "Karlsruhe",
                "region_id": 825,
                "region_name": "Baden-Wurttemberg",
                "region_code": "01",
                "country_id": 59,
                "country_name": "Germany",
                "country_code": "DE",
                "dma_id": 1,
                "dma_name": "--",
                "active": true,
                "last_modified": "2015-04-09 19:40:57"
            },
            {
                "id": 195431,
                "name": "Karlsruhe",
                "region_id": 3952,
                "region_name": "North Dakota",
                "region_code": "ND",
                "country_id": 233,
                "country_name": "United States",
                "country_code": "US",
                "dma_id": 687,
                "dma_name": "Minot-Bismarck-Dickinson(Williston) ND",
                "active": false,
                "last_modified": "2016-10-19 05:01:12"
            }
        ]
    }
}