Ad Object API
次のセクションでは、さまざまな eventType フィールドと、それぞれのコールバック関数シグネチャとデータ オブジェクトについて説明します。
コールバック関数シグネチャ:function(){}
データ オブジェクト: N/A
コールバック関数シグネチャ:function(adObj){}
データ オブジェクト:
adObj = {
cpm: 10,
cpm_publisher_currency: 10,
publisher_currency_code: '$',
adType : 'banner', // could also be 'video' or 'native'
auctionId : '123456',
buyerMemberId : 999, creativeId : 53122972,
source : 'rtb', // could also be 'csm'
tagId : 6051399,
banner : {
// will match adType above; based on source // SEE BELOW
}
}
広告の種類は、バナー、ビデオ、ネイティブのいずれかです。 その他の例については、以下の 「adType オブジェクト 」セクションを参照してください。
ソースがリアルタイム入札 (rtb) の場合、広告オブジェクトには広告が含まれます。source がクライアント側仲介 (csm) の場合は、クリエイティブ ID だけが含まれます。
コールバック関数シグネチャ:adLoaded
データ オブジェクト: Ad オブジェクトは、 adAvailable
の場合と同じです。
コールバック関数シグネチャ:function(adObj) {}
データ オブジェクト: Ad オブジェクトは、 adAvailable
の場合と同じです。
コールバック関数シグネチャ:function(adObj){}
データ オブジェクト:
adObj = {
auctionId : '123456',
nobid : true,
tagId : 6051399,
}
注意
仲介を使用する場合、通常、仲介入札は同じプレースメント/スロットの RTB 入札と共に返されます。 オークションリクエストが仲介入札のみを返す可能性があります。 通常の応答では、仲介された入札がクリエイティブで返されない場合、RTB 入札のクリエイティブにフォールバックしようとします。 RTB 入札が存在しない場合、仲介スクリプトは adNoBid イベントを読み込み、利用可能な RTB 入札がないことを示します。 この場合、adObj は設定されず、フォールバック RTB bid オブジェクトがないため、オブジェクトは未定義になります。
コールバック関数シグネチャ:function(adError){}
データ オブジェクト:
adError = {
code : 0
errMessage : 'error message';,
exception : e,
targetId : 'apn_ad_slot_1'
}
コールバック関数シグネチャ:function(adError, adObj){}
データ オブジェクト:adError
は、 adRequestFailure
の場合と同じです。
Ad オブジェクトは、 adAvailable
の場合と同じです。
コールバック関数シグネチャ:function(adError){}
データ オブジェクト: 存在しない配置と呼ばれるタグ。 これは、インプレッション バスからのエラーを示している可能性があります。
adError = {
code : 0
errMessage : 'error message';,
exception : e,
targetId : 'apn_ad_slot_1'
}
コールバック関数シグネチャ:function(){}
データ オブジェクト: N/A
コールバック関数シグネチャ:function(adObj)
データ オブジェクト:
adObj = {
cpm: 10,
cpm_publisher_currency: 10,
publisher_currency_code: "$"
creativeId : 12345678,
contentSource : 'csm',
targetId : 7654321,
width: 728
height: 90
banner : {
width: 728,
height: 90,
content: "<!-- Creative 26299226 served by Member 12345 via Xandr --><a href=\"http://lax1.ib.adnxs.com/click?AAAAAAAA6D8AAAAAAADoPwAAAAAAAPA_AAAAAAAA6D8A…"
}
}
コールバック関数シグネチャ:function(adObj)
データ オブジェクト:
adObj = {
cpm: 10,
cpm_publisher_currency: 10,
publisher_currency_code: '$'
creativeId : 12345678,
contentSource : 'csm',
targetId : 7654321,
width: 728
height: 90
banner : {
width: 728,
height: 90,
content: "<!-- Creative 26299226 served by Member 12345 via AppNexus --><a href=\"http://lax1.ib.adnxs.com/click?AAAAAAAA6D8AAAAAAADoPwAAAAAAAPA_AAAAAAAA6D8A…"
}
}
adType オブジェクトは、広告の種類 (バナー、ネイティブ、またはビデオ) と広告のソース (リアルタイム入札 (rtb) またはクライアント側仲介 (csm) を指定します。
次のセクションでは、さまざまな adType オブジェクトの例について説明します。
adObj = {
adType: "banner",
cpm: 10,
cpm_publisher_currency: 10,
publisher_currency_code: '$',
isExclusive: false,
isRoadblock: false,
source: "rtb",
creativeId: 26299226,
targetId : "target_id_123",
banner: {
width: 728,
height: 90,
content: "<!-- Creative 26299226 served by Member 12345 via AppNexus --><a href=\"http://lax1.ib.adnxs.com/click?AAAAAAAA6D8AAAAAAADoPwAAAAAAAPA_AAAAAAAA6D8A…",
trackers: [{
impression_urls: ["http://lax1.ib.adnxs.com/it?e=wqT_3QK2BMAtAgAAAgDWAAUIo4aftQUQhaGP-8eK89JxG…S4xMy4xMzKoBO6QCbIEBwgAEAAY2AU.&s=7674360f6a0ea8c3ba7018acd3467ba291de4ad0"]
}]
},
// other data in adObj omitted for brevity
}
adObj = {
adType: "banner",
cpm: 10,
cpm_publisher_currency: 10,
publisher_currency_code: '$',
source: "csm",
creativeId: 47259021,
targetId : "target_id_123",
// other data in adObj omitted for brevity
}
adObj = {
adType: "video",
cpm: 10,
cpm_publisher_currency: 10,
publisher_currency_code: '$',
source: "rtb",
creativeId: 47259021,
targetId : "target_id_123",
video: {
duration: 20000,
playbackMethods: ["auto_play_sound_on"],
frameworks: [],
content: "<?xml version=\"1.0\" encoding=\"UTF-8\" standalone=\"yes\"?><VAST version=\"2.0\">...."
},
// other data in adObj omitted for brevity
}
adObj = {
adType: "video",
cpm: 10,
cpm_publisher_currency: 10,
publisher_currency_code: '$',
source: "csm",
creativeId: 47211028,
targetId : "target_id_123",
// other data in adObj omitted for brevity
}
adObj = {
adType": "native",
cpm: 10,
cpm_publisher_currency: 10,
publisher_currency_code: "$",
source": "rtb",
targetId: "target_id_123",
renderer_id: 123,
renderer_url: "https://renderer.url.com/here",
native: {
title: "Native Creative Title",
body: "Native creative body.",
icon: {
width: 0,
height: 0,
url: "http://cdn.adnxs.com/p/5d/f0/53/fb/5df053fbcb7...png"
},
image: {
width: 2352,
height: 1516,
url: "http://cdn.adnxs.com/p/d9/d9/c7/3f/d9d9c73fb6aed0ba9...jpg"
},
cta: "Click Here",
sponsoredBy: "AppNexus",
impressionTrackers: [
"http://lax1-ib.adnxs.com/it?e=wqT_3QKqBqgqAwAAAwDWAAUBC..."
],
clickTrackers: [
"http://lax1-ib.adnxs.com/click?AAAAAAAA8D8AAAAAAADwPwA..."
],
javascriptTrackers: "",
clickUrl: "https://www.appnexus.com",
clickFallbackUrl: ""
}
}