サードパーティの Pixel サービス

サードパーティのピクセル サービスを使用すると、サードパーティのクリエイティブ ピクセルをアップロードおよび変更し、広告主またはクリエイティブに添付することができます。 メンバーにサード パーティのクリエイティブ ピクセルを添付することもできます。

REST API

HTTP メソッド エンドポイント 説明
GET https://api.appnexus.com/thirdparty-pixel すべてのサードパーティ ピクセルを表示します。
GET https://api.appnexus.com/thirdparty-pixel?id=THIRDPARTY-PIXEL_ID 特定のサードパーティのピクセルを表示します。
POST https://api.appnexus.com/thirdparty-pixel 新しいサードパーティ ピクセルを追加します。
PUT https://api.appnexus.com/thirdparty-pixel?id=THIRDPARTY-PIXEL_ID 既存のサードパーティのピクセルを変更する。
DELETE https://api.appnexus.com/thirdparty-pixel?id=THIRDPARTY-PIXEL_ID 既存のサードパーティのピクセルを削除します。

JSON フィールド

フィールド 種類 説明
active ブール値 ピクセルがアクティブかどうかを示すフラグ。

既定値: true
adservers オブジェクトの配列 ピクセルが呼び出すアドサーバー。 Google 広告マネージャーの在庫で提供されるピクセルに必要です。 広告サーバーの完全なリストは、 広告サーバー サービスから取得できます。

例:
"adservers":[{"id":11},{"id":12}]
advertisers オブジェクトの配列 ピクセルに所有の広告主がいる (つまり、 advertiser_idnullしない場合)、この配列にはピクセルを所有する広告主の ID (ID のみ) が含まれている必要があります。 その結果、このピクセルは、その広告主が所有するすべてのクリエイティブにレンダリングされます。 ピクセルに所有する広告主がいない場合、この配列には、ピクセルが適用される複数の広告主を含めることができます。

例:
"advertisers":[{"id":3}]

Optional
advertiser_id int サードパーティのピクセルを所有する広告主の ID。

既定値: null
audit_status string ピクセルの監査ステータス。 使用可能な値は次のとおりです。
- "pending"
- "rejected"
- "approved"
- "exempt"

:
未監査のピクセルによってクリエイティブの配信が妨げられることはありませんが、監査に合格するまでクリエイティブと共に配信されません。

読み取り専用
既定値: "pending"
content string ピクセルの format"raw-js"の場合、これはクリエイティブと共に配信する JavaScript コンテンツです。 content フィールドや secure_content フィールドは、raw-jsピクセルの POST で必須です。
また、ピクセルにマクロを追加することもできます。 ピクセルに追加できるクリエイティブ マクロのリストについては、UI ドキュメントの 「クリエイティブ マクロ 」を参照してください。

必須: ピクセルのformat"raw-js"の場合はPOST
creatives オブジェクトの配列 ピクセルが適用されるクリエイティブ。 クリエイティブは、所有しているメンバー/広告主に属している必要があります。 サードパーティのピクセルをクリエイティブにアタッチするには、 クリエイティブ サービスを使用します。

例:
"creatives":[{"id":860851}]

読み取り専用
format string ピクセルのフォーマット。 クリエイティブに指定できる値:
- "raw-js"
- "url-html"
- "url-js"
- "url-image"
- "raw-url"

必須:contentsecure_contenturl、またはurl_secureフィールドを変更する場合は、POSTおよびPUT

既定値: "raw-js"

:
視認性ピクセルの場合は、 "url-image" または "url-js" 形式のみを使用します。
id int サードパーティのピクセルの ID。

必須:PUT および DELETE
members オブジェクトの配列 オプション。 指定した場合、このフィールドにはピクセルを所有するメンバーの ID が含まれ、このピクセルはそのメンバーが所有するすべてのクリエイティブにレンダリングされます。

例:
"members":[{"id":1}]
member_id int このピクセルを所有するメンバー/ネットワークの ID。

必須:POST
name string サードパーティのピクセルの名前。
secure_content string ピクセルの format"raw-js"の場合、クリエイティブと共に配信する JavaScript コンテンツ。 content フィールドや secure_content フィールドは、raw-jsピクセルの POST で必須です。

また、ピクセルにマクロを追加することもできます。 ピクセルに追加できるクリエイティブ マクロの一覧は以下のとおりです。UI ドキュメントの 「クリエイティブ マクロ 」を参照してください。

必須: ピクセルのformat"raw-js"の場合はPOST
secure_url string ピクセルの format"url-html""url-js""url-image"、または "raw-url" の場合、安全な (https) 呼び出しでクリエイティブと共に配信する HTML、JavaScript、または画像ピクセルの URL。 これらのピクセル タイプでは、POSTurl フィールドや secure_url フィールドが必要です。 また、ピクセルにマクロを追加することもできます。

また、ピクセルにマクロを追加することもできます。 ピクセルに追加できるクリエイティブ マクロのリストについては、UI ドキュメントの 「クリエイティブ マクロ 」を参照してください。

必須: ピクセルのformat"url-html""url-js""url-image"、または "raw-url" の場合にPOSTします。
supply_exceptions オブジェクトの配列 ピクセルが not されるメンバーの名前。 "AdX" が現時点で唯一の許容値です。

例:
"supply_exceptions":[{"name":"AdX"}]
url string ピクセルの format"url-html""url-js""url-image"、または "raw-url" の場合、クリエイティブと共に配信する HTML、JavaScript、または画像ピクセルの URL。 これらのピクセル タイプでは、POSTurl フィールドや secure_url フィールドが必要です。

また、ピクセルにマクロを追加することもできます。 ピクセルに追加できるクリエイティブ マクロのリストについては、UI ドキュメントの 「クリエイティブ マクロ 」を参照してください。

特定のサードパーティ ピクセルを表示する

この例では、ID 123を持つサードパーティのピクセルを表示します。

$ curl -b cookies -X GET 'https://api.appnexus.com/thirdparty-pixel?id=123'
 
{
    "thirdparty-pixel":{
        "id":123,
        "active":true,
        "member_id":456,
        "advertiser_id": 789,
        "format":"raw-js",
        "content":"var img = new Image(); img.src="https://url.com/event/js?self=" + data;"
        "url":null,
        "secure_url":null,
        "members":null,
        "advertisers":[{"id":789}], 
        "creatives":null
        "audit_status":"unaudited" // admin only
        "supply_exceptions":[
            {"name":"AdX"},
        ]
        "adservers":[
            {"id":123}
        ]
  }
}

新しいサードパーティ ピクセルを追加する

この例では、ID 123 を持つ新しいセルサイドのサードパーティ ピクセルを作成します。 API に渡した JSON ファイルではピクセルの親オブジェクトが指定されていないため、親オブジェクト情報が "null" であることに注意してください。

$ cat thirdparty-pixel.json
{
  "thirdparty-pixel":
    {
      "format":"url-html",
      "secure_url":"https://secureurl.com"
    }
}  

$ curl -b cookies -c cookies -X POST -d @thirdparty_pixel 'https://api.appnexus.com/thirdparty-pixel'

{
    "response":{
        "status":"OK",
        "count":1,
        "id":123,
        "start_element":0,
        "num_elements":100,
        "thirdparty-pixel":{
            "id":123,
            "active":true,
            "name":null,
            "member_id":456,
            "advertiser_id":789,
            "publisher_id":null,
            "format":"url-html",
            "audit_status":"pending",
            "created_on":"2014-11-05 19:51:44",
            "last_modified":"2014-11-05 19:51:44",
            "url":null,
            "secure_url":"https://secureurl.com",
            "members":null,
            "advertisers":null,
            "publishers":null,
            "creatives":null,
            "supply_exceptions":null,
            "adservers":null
       
    }
}

サードパーティのピクセルを更新する

この例では、サードパーティのピクセルを ID 123 で更新し、所有している広告主のすべてのクリエイティブに適用します。

$ cat pixelupdate.json

{
  "thirdparty-pixel":
    {
      "advertisers":[{"id":789}]
    }
}  

$ curl -b cookies -c cookies -X PUT -d @pixelupdate 'https://api.appnexus.com/thirdparty-pixel?id=123'

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

サードパーティ製ピクセルを削除する

この例では、ID が 123 のサードパーティのピクセルを削除します。

$ curl -b cookies -X DELETE 'https://api.appnexus.com/thirdparty-pixel?id=123'

{
   "response":{
      "status":"OK"
   }
}