API de objeto de anuncio
En la sección siguiente se describen los distintos campos eventType y sus respectivas firmas de función de devolución de llamada y objetos de datos:
Firma de función de devolución de llamada:function(){}
Objetos de datos: N/A
Firma de función de devolución de llamada:function(adObj){}
Objetos de datos:
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
}
}
Tipo de anuncio puede ser un banner, vídeo o nativo. Consulte la sección del objeto adType a continuación para obtener más ejemplos.
Cuando el origen es una puja en tiempo real (rtb), el objeto de anuncio incluye el anuncio; cuando el origen es la mediación del lado cliente (csm), incluye solo el identificador creativo.
Firma de función de devolución de llamada:adLoaded
Objetos de datos: El objeto de anuncio es el mismo que para adAvailable
.
Firma de función de devolución de llamada:function(adObj) {}
Objetos de datos: El objeto de anuncio es el mismo que para adAvailable
.
Firma de función de devolución de llamada:function(adObj){}
Objetos de datos:
adObj = {
auctionId : '123456',
nobid : true,
tagId : 6051399,
}
Nota
Cuando se usa la mediación, normalmente una oferta mediada se devolvería junto con una oferta RTB por la misma ubicación o ranura. Existe la posibilidad de que la solicitud de subasta solo pueda devolver una oferta mediada. En una respuesta normal, si la oferta mediada no vuelve con una creatividad, intentaría revertir a la oferta creativa de la RTB. En el caso de que no haya ninguna oferta RTB presente, el script de mediación cargaría el evento adNoBid para indicar la falta de una oferta RTB disponible. En este caso, el adObj no se rellenará y el objeto será indefinido, ya que no hay ningún objeto de puja RTB de reserva presente.
Firma de función de devolución de llamada:function(adError){}
Objetos de datos:
adError = {
code : 0
errMessage : 'error message';,
exception : e,
targetId : 'apn_ad_slot_1'
}
Firma de función de devolución de llamada:function(adError, adObj){}
Objetos de datos:adError
es igual que para adRequestFailure
.
El objeto de anuncio es el mismo que para adAvailable
.
Firma de función de devolución de llamada:function(adError){}
Objetos de datos: Etiqueta denominada ubicación que no existe. Esto podría indicar un error del Bus de impresiones.
adError = {
code : 0
errMessage : 'error message';,
exception : e,
targetId : 'apn_ad_slot_1'
}
Firma de función de devolución de llamada:function(){}
Objetos de datos: N/A
Firma de función de devolución de llamada:function(adObj)
Objetos de datos:
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…"
}
}
Firma de función de devolución de llamada:function(adObj)
Objetos de datos:
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…"
}
}
El objeto adType especifica el tipo de anuncio (banner, nativo o vídeo) y el origen del anuncio, ya sea pujas en tiempo real (rtb) o mediación del lado cliente (csm).
En la sección siguiente se describen ejemplos de los distintos objetos 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: ""
}
}