サード パーティの 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_id が nullされていない場合)、この配列にはピクセルを所有する広告主の 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 コンテンツです。 raw-js ピクセルのPOSTには、contentフィールドまたはsecure_content フィールドが必要です。 ピクセルにマクロを追加することもできます。 ピクセルに追加できるクリエイティブ マクロの一覧については、UI ドキュメントの 「クリエイティブ マクロ 」を参照してください。 必須オン: ピクセルのformatが"raw-js"されている場合にPOSTします。
creatives	オブジェクトの配列	ピクセルが適用されるクリエイティブ。 クリエイティブは、所有するメンバー/広告主に属している必要があります。 サード パーティのピクセルをクリエイティブにアタッチするには、 Creative Service を使用します。 例: "creatives":[{"id":860851}] 読み取り専用
format	string	ピクセルの形式。 クリエイティブに使用できる値: - "raw-js" - "url-html" - "url-js" - "url-image" - "raw-url" 必須:content、secure_content、url、または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 コンテンツ。 raw-js ピクセルのPOSTには、contentフィールドまたはsecure_content フィールドが必要です。 ピクセルにマクロを追加することもできます。 ピクセルに追加できるクリエイティブ マクロの一覧。UI ドキュメントの 「クリエイティブ マクロ 」を参照してください。 必須オン: ピクセルのformatが"raw-js"されている場合にPOSTします。
secure_url	string	ピクセルの format が "url-html"、 "url-js"、 "url-image"、または "raw-url"の場合、セキュリティで保護された (https) 呼び出しでクリエイティブと共に配信する HTML、JavaScript、または Image ピクセルの URL。 これらのピクセル タイプのPOSTには、urlフィールドまたは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、または Image ピクセルの URL。 これらのピクセル タイプのPOSTには、urlフィールドまたは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"
   }
}

関連項目

• API セマンティクス
• API のベスト プラクティス
• クリエイティブ サービス
• 広告主サービス