次の方法で共有

Digital Platform API - ドメイン リスト サービス

  • [アーティクル]

注:

今後は、API に対して "allowlist" と "blocklist" の用語に従います。 これは、現在の用語の使用状況を評価し、Xandr プラットフォームのより包括的な用語を導き出す継続的な取り組みの一環です。

ドメイン リスト サービスを使用すると、キャンペーンのターゲティング プロファイルに含めたり除外したりできるドメインのリストを定義できます。 ターゲット プロファイルのドメイン リストは、類似の特性を持つドメインをグループに配置するために使用されます。これを使用すると、キャンペーンのターゲット設定にドメインを簡単に含めたり除外したりできます。 これらは通常、 許可リスト またはブロックリストとして使用 されます。 許可リストにはキャンペーンのターゲット設定に含めるドメインが含まれており、ブロックリストには除外するドメインが含まれます。 domain_list_targetsdomain_list_action(プロファイル にこれらのリストを含める方法については、Profile Service の と を参照してください)。

REST API

HTTP メソッド エンドポイント 説明
GET https://api.appnexus.com/domain-list すべてのドメイン リストを表示します。
GET https://api.appnexus.com/domain-list?id=DOMAIN_LIST_ID 特定のドメイン リストを表示します。
GET https://api.appnexus.com/domain-list?search=SEARCH_TERM 特定の文字を含む名前または説明を含むドメイン リストを検索します。
POST https://api.appnexus.com/domain-list 新しいドメイン リストを追加します。
PUT https://api.appnexus.com/domain-list?id=DOMAIN_LIST_ID 既存のドメイン リストを変更します。
DELETE https://api.appnexus.com/domain-list?id=DOMAIN_LIST_ID 既存のドメイン リストを削除します。

JSON フィールド

フィールド 種類 説明
description string(100) ドメイン リストの説明。
domains 配列 形式 ["domain1.com", "domain2.com", ... , "domain10.com"]のドメインの配列。

注: "www" ドメインから削除されます。
で始まる "www" ドメインでは、システムに "www" 格納される前に部分文字列が削除されます。 たとえば、 "www.example.org" は に "example.org"短縮されます。
id int ドメイン リストの内部システム識別子。
必須:PUT
last_modified string ドメイン リストが最後に変更されたときの読み取り専用タイムスタンプ。
name string(100) ユーザーによって指定されたドメイン リストの名前。 この名前は一意である必要があります。
必須:POST
type string ドメイン リストの種類。 可能な値は、black と white です。 この値は厳密に情報です。リストがターゲット設定に含まれるか除外されるかは判断されません。
既定値: "white"

例

ドメイン リストの追加

$ cat domain-list

{
   "domain-list":{
      "name":"Domains to target",
      "description":"A list of the domains to target for Campaign A",
      "type":"white",
      "domains":["domain-a.com", "domain-b.net", "domain-c.org"]
   }
}

$ curl -b cookies -c cookies -X POST --data-binary @domain-list 'https://api.appnexus.com/domain-list'

{
   "response":{
      "status":"OK",
      "id":9
   }
}

ドメイン一覧の表示 9

$ curl -b cookies -c cookies 'https://api.appnexus.com/domain-list?id=9'

{
   "response":{
      "domain-list":{
         "id":9,
         "name":"Domains to target",
         "description":"A list of the domains to target for Campaign A",
         "type":"white",
         "domains":["domain-a.com", "domain-b.net", "domain-c.org"]
      }
      "status":"OK"
   }
}

としてプロファイル 35 にドメイン リストを追加する "allowlist"

$ cat domain-list-profile

{
   "profile":{
      "id":35,
      "domain_list_targets":[{"id":9}, {"id":10}, {"id":15}, {"id":18}],
      "domain_list_action":"include",
   }
}

$ curl -b cookies -c cookies -X PUT --data-binary @domain-list-profile 'https://api.appnexus.com/profile?id=35'

{
   "response":{
      "status":"OK",
      "id":35
   }
}

名前または説明が含まれるドメイン リストの検索 "test"

$ curl -b cookies -c cookies 'https://api.appnexus.com/domain-list?search=test'

{
  "response": {
    "status": "OK",
    "domain-lists": [
      {
        "id": 1733,
        "name": "Add Test",
        "description": "",
        "type": "white",
        "domains": [
          "amblergazette.com",
          "facebook.com",
          "google.com",
          "zwire.com"
        ],
        "last_modified": "2011-03-10 18:03:07"
      }
      }