E-Planning SSP puede recibir impresiones mediante una conexión de servidor a servidor (server to server) utilizando el protocolo OpenRTB.
...
| Campo | Tipo | Estado | Comentarios |
|---|
| id | String | Obligatorio | Identificador único para la impresión dentro del Bid Request. Habitualmente comienza en "1" y se incrementa progresivamente. |
| banner | Object | Obligatorio para display | Ver objeto Banner |
| video | Object | Obligatorio para video | Ver objeto Video |
| bidfloorcur | String | Obligatorio | Divisa a utilizar en los precios, tanto en el bid response como en los precios mínimos. Utiliza códigos ISO-4217, por ejemplo "USD". |
| bidfloor | Float | Obligatorio | El precio mínimo al cual la impresión puede ser vendida, expresado en la divisa especificada en bidfloorcur |
| secure | Integer | Obligatorio | Indica "1" si el anuncio en el bid response debe utilizar HTTPS |
| instl | Integer | Recomendado | Indica "1" cuando la impresión corresponde a un anuncio de página completa (Full page o Interstitial) |
| clickbrowser | Integer | Obligatorio para In-App | Indica el tipo de navegador a abrirse al realizar click en el anuncio. 0 = Interno de la App, 1 = Nativo |
...
| Campo | Tipo | Estado | Comentarios |
|---|
| format | Object Array | Obligatorio si no estan presentes "w" y "h" | Ver objeto Format. Tamaños soportados en la subasta. |
| w | Integer | Obligatorio si no esta presente "Format" | Ancho en pixeles del banner |
| h | Integer | Obligatorio si no esta presente "Format" | Alto en pixeles del banner |
| wmin | Integer | Recomendado si no esta presente "Format" | Mínimo ancho en pixeles del banner |
| wmax | Integer | Recomendado si no esta presente "Format" | Máximo ancho en pixeles del banner |
| hmin | Integer | Recomendado si no esta presente "Format" | Mínimo alto en pixeles del banner |
| hmax | Integer | Recomendado si no esta presente "Format" | Máximo alto en pixeles del banner |
| pos | Integer | Recomendado | Posición del anuncio en la pagina según Ad Position IAB standard |
| topframe | Integer | Recomendado | 0 = El banner se encuentra dentro de un iframe, 1 = El banner se encuentra en el marco superior de la página |
| api | Integer | Recomendado | Listado de las APIs soportadas según están descriptas en OpenRTB 2.5. Si se encuentra enviando tráfico inApp, por favor considere indicar si soporta OMID-1 (7) |
| battr | Integer Array | Recomendado | Atributos del creativo bloqueadas |
| btype | Integer Array | Recomendado | Tipos de banner bloqueados |
| expdir | Integer Array | Opcional | Direcciones en las cuales el banner puede ser expandido |
...
| Code Block |
|---|
| language | js |
|---|
| linenumbers | true |
|---|
| collapse | true |
|---|
|
{
"pos": 1,
"w": 300,
"h": 250,
"wmin": 300,
"wmax": 300,
"hmin": 50,
"hmax": 600,
"battr": [ 11, 12 ],
"btype": [ 4 ]
} |
...
Objeto Video
| Campo | Tipo | Estado | Comentarios |
|---|
| w | Integer | Obligatorio | Ancho en pixeles del tamañoreproductor de video |
| h | Integer | Obligatorio | Alto en pixeles del tamaño |
Objeto Site
...
Ejemplo
| Code Block |
|---|
| language | js |
|---|
| linenumbers | true |
|---|
| collapse | true |
|---|
|
{
"id": "123",
"page": "http://example.com/section/page.html",
"cat": [ "IAB1-2" ],
"publisher": {
"id": "456",
"domain": "example.com",
"name": "Example Inc"
}
} |
...
| del reproductor de video |
| maxduration | Integer | Obligatorio | Máxima duración del video, en segundos |
| minduration | Integer | Obligatorio | Mínima duración del video, en segundos |
| mimes | String Array | Obligatorio | Listado de MIME types soportados. Los mas comunes son: video/mp4, video/webm, video/ogg. Para VPAID, por favor especifique application/javascript |
| protocols | Integer Array | Obligatorio | Protocolos soportados. Al menos un protocolo debe ser soportado, ejemplos: 2 = VAST 2.0, 3 = VAST 3.0, 5 = VAST 2.0 Wrapper, 6 = VAST 3.0 Wrapper |
| pos | Integer | Recomendado | Posición del anuncio en la pagina según Ad Position IAB standard |
| api | Integer | Recomendado | Listado de las APIs soportadas según están descriptas en OpenRTB 2.5. Si se encuentra enviando tráfico inApp, por favor considere indicar si soporta OMID-1 (7) |
| battr | Integer Array | Recomendado | Atributos del creativo bloqueadas |
| boxingallowed | Integer | Recomendado | Especifica si es posible insertar contenido de video 4:3 en una ventana de 16:9. 1 = Permitido, 0 = No permitido |
| delivery | Integer Array | Opcional | Metodos de entrega soportados. 1 = streaming, 2 = progressive |
| linearity | Integer Array | Opcional | Especifica si la impresión es lineal o no-lineal. 1 = linear / in-stream, 2 = non-linear / overlay |
Objeto Format
| Campo | Tipo | Estado | Comentarios |
|---|
idStringID de la App en el SSP | | name | String | Obligatorio | Nombre de la aplicación |
bundle| Ancho en pixeles del tamaño |
| h | Integer | Obligatorio | Alto en pixeles del tamaño |
Objeto Site
domain| Campo | Tipo | Estado | Comentarios |
|---|
| id | String | Obligatorio |
Bundle de la aplicación o nombre del paquete (por ejemplo, "com.foo.myapp" en Android o un valor numerico en iOS) | | ID del sitio en el SSP |
| page | String |
RecomendadoDominio aplicación | página donde se mostrará la impresión |
storeurl | String | Recomendado | URL de la aplicación en la tienda. Si es desconocido, el campo no debe ser enviado o estar en blanco. |
| publisher | Object | Obligatorio | Ver objeto Publisher |
| domain | String | Recomendado | Dominio de la página donde se mostrará la impresión |
| cat | String Array | Recomendado | Array de categorías IAB |
de la aplicación Ejemplo
...
| language | js |
|---|
| linenumbers | true |
|---|
| collapse | true |
|---|
...
| del sitio. Máximo 8 categorias. |
| ref | String | Recomendado | URL de la página desde donde se llego a la página actual |
| ext.inventorypartnerdomain | String | Recomendado | Inventory partner domain. Dominio de terceros autorizado para validar ads.txt |
Ejemplo
| Code Block |
|---|
| language | js |
|---|
| linenumbers | true |
|---|
| collapse | true |
|---|
|
{
"id": "123",
"storeurlpage": "httpshttp://storeexample.com/appsection/12345page.html",
"cat": [ "IAB1-2" ],
"publisher": {
"id": "456",
"domain": "example.com",
"name": "Example Inc"
}
} |
Objeto Publisher
...
Ejemplo
| Code Block |
|---|
| language | js |
|---|
| linenumbers | true |
|---|
| collapse | true |
|---|
|
{
"id": "456",
"domain": "example.com",
"name": "Example Inc"
}"domain": "example.com",
"name": "Example Inc"
}
} |
Objeto App
| Campo | Tipo | Estado | Comentarios |
|---|
| id | String | Obligatorio | ID de la App en el SSP |
| name | String | Obligatorio | Nombre de la aplicación |
| bundle | String | Obligatorio | Bundle de la aplicación o nombre del paquete (por ejemplo, "com.foo.myapp" en Android o un valor numerico en iOS) |
| domain | String | Recomendado | Dominio de la aplicación donde se mostrará la impresión |
| storeurl | String | Recomendado | URL de la aplicación en la tienda |
| cat | String Array | Recomendado | Array de categorías IAB de la aplicación. Máximo 8 categorias. |
| ext.inventorypartnerdomain | String | Recomendado | Inventory partner domain. Dominio de terceros autorizado para validar app-ads.txt |
Ejemplo
| Code Block |
|---|
| language | js |
|---|
| linenumbers | true |
|---|
| collapse | true |
|---|
|
{
"id": "12345",
"name": "My App",
"bundle": "com.foo.myapp",
"domain": "myapp.com",
"storeurl": "https://store.com/app/12345",
"cat": [ "IAB1-2" ],
"publisher": {
"id": "456",
"domain": "example.com",
"name": "Example Inc"
}
} |
Objeto Publisher
| Campo | Tipo | Estado | Comentarios |
|---|
| id | String | Obligatorio | El ID del publisher. Debe ser suficiente para identificar a la parte finalmente pagada |
| domain | String | Recomendado | Dominio del publisher |
| name | String | Recomendado | Nombre del publisher |
Ejemplo
| Code Block |
|---|
| language | js |
|---|
| linenumbers | true |
|---|
| collapse | true |
|---|
|
{
"id": "456",
"domain": "example.com",
"name": "Example Inc"
} |
Objeto Content
Este objeto describe el contenido en el que aparecerá la impresión, que puede ser contenido sindicado o no sindicado. Este objeto puede ser útil cuando el contenido sindicado contiene impresiones y no coincide necesariamente con el contenido general del editor. Este objeto es altamente recomendable en el inventario de CTV y debe enviarse siempre que sea posible.
| Field | Type | Status | Comment |
|---|
| id | String | Recomendado | Identificador único del contenido |
| episode | Integer | Recomendado | Número de episodio |
| title | String | Recomendado | Título del contenido |
| series | String | Recomendado | Serie del contenido |
| season | String | Recomendado | Temporada del contenido |
| artist | String | Recomendado | Artista al que se atribuye el contenido |
| genre | String | Recomendado | Género que mejor describe el contenido |
| album | String | Recomendado | Álbum al que pertenece el contenido |
| producer | Object | Recomendado | Datos sobre el productor del contenido (véase "Objeto Producer") |
| url | String | Recomendado | URL del contenido, para contextualización o revisión por parte del comprador |
| cat | String Array | Recomendado | Conjunto de categorías IAB que describen el contenido |
| prodq | Integer | Recomendado | Calidad de producción. Consulte la lista: Production Qualities en AdCOM 1.0 |
| context | Integer | Recomendado | Tipo de contenido (juego, vídeo, texto, etc.). Consulte la lista: Content Contexts en AdCOM 1.0 |
| contentrating | String | Recomendado | Clasificación del contenido (por ejemplo: MPAA) |
| userrating | String | Recomendado | Valoración del contenido por parte de los usuarios (por ejemplo, número de estrellas, me gusta, etc.) |
| qagmediarating | Integer | Recomendado | Clasificación de los medios según las directrices de IQG. Consulte la lista: Media Ratings en AdCOM 1.0 |
| keywords | String | Recomendado | Lista separada por comas de palabras clave que describen el contenido |
| livestream | Integer | Recomendado | 0 = no en vivo, 1 = vivo |
| sourcerelationship | Integer | Recomendado | 0 = indirecto, 1 = directo |
| len | Integer | Recomendado | Duración del contenido en segundos; apropiado para vídeo o audio |
| language | String | Recomendado | Lenguaje del contenido en ISO-639-1-alfa-2 |
| embeddable | Integer | Recomendado | Indicador de si el contenido es incrustable (por ejemplo, un reproductor de vídeo incrustable), donde 0 = no, 1 = sí |
| channel | Object | Recomendado | Información sobre el canal en el que se encuentra el contenido (véase "Objeto Channel") |
Objeto Producer
Este objeto define el productor del contenido en el que se mostrará el anuncio. Esto es especialmente útil cuando el contenido está sindicado y puede distribuirse a través de diferentes editores y, por tanto, cuando el productor y el editor no son necesariamente la misma entidad.
| Field | Type | Status | Comment |
|---|
| id | String | Recomendado | ID del productor u originador del contenido |
| name | String | Recomendado | Nombre del productor u originador del contenido (por ejemplo, "Warner Bros") |
| cat | String | Recomendado | Conjunto de categorías de contenidos IAB que describen al productor del contenido |
| domain | String | Recomendado | Dominio de nivel superior del productor del contenido (por ejemplo, "productor.com") |
Objecto Channel
Este objeto describe el canal en el que se mostrará un anuncio. Un canal se define como la entidad que gestiona una biblioteca de contenidos o un flujo dentro de una marca para los espectadores. Algunos ejemplos son los «canales» específicos que se pueden seleccionar dentro de la televisión lineal y en streaming (MTV, HGTV, CNN, BBC One, etc.) o un flujo específico de contenido de audio comúnmente denominado «emisoras». El nombre es un campo legible por las personas, mientras que el dominio y el identificador pueden utilizarse con fines informativos y de segmentación.
| Field | Type | Status | Comment |
|---|
| id | String | Recomendado | Identificador único asignado por el editor. Este identificador puede no ser único para todas las fuentes de suministro. |
| name | String | Recomendado | Canal en el que se emite el contenido (por ejemplo, un canal local como "WABC-TV") |
| domain | String | Recomendado | El dominio principal del canal (por ejemplo, "abc7ny.com" en el caso del canal local WABC-TV). Se recomienda incluir el dominio privado superior (PSL+1) a efectos de normalización en la segmentación del DSP. |
Objeto User
| Campo | Tipo | Estado | Comentarios |
|---|
| id | String | Recomendado | ID del usuario en el DSP |
| buyeruid | String | Recomendado | ID del usuario en E-Planning SSP. Ver sección Sincronización de usuarios |
...
| Campo | Tipo | Estado | Comentarios |
|---|
| fd | Integer | Obligatorio | Entidad responsable de la decisión final sobre la impresión, donde 0 = SSP, 1 = la siguiente fuente |
| pchain | String | Recomendado si schain no esta presente | Cadena TAG Payment ID |
| ext.schain | String | Recomendado si pchain no esta presente | Según propuesta de IAB, Supply Chain ObjectSupply Chain Object |
| ext.omidpn | String | Recomendado si es tráfico inApp | Identificador del OM SDK |
| ext.omidpv | String | Recomendado si es tráfico inApp | Versión del OM SDK |
| Info |
|---|
|
Para implementaciones con pchain soportamos tanto TAG ID como identificación por dominio. |
...
| Campo | Tipo | Comentarios |
|---|
| seat | String | Un identificador, usualmente utilizado para reflejar los requerimientos de facturación de E-Planning |
| bid | Object Array | Ver objeto Bid |
Objeto Bid
| Campo | Tipo | Comentarios |
|---|
| id | String | Un identificador del bid para assistir con el registro y seguimiento |
| impid | String | Valor del identificador envíado en el objeto Imp |
| price | Float | Oferta hecha en CPM (1 significa que E-Planning SSP esta dispuesto a pagar 0.001 por la impresión) |
| adm | String | El código HTML del anuncio a mostrar si la subasta es ganada. El mismo contiene una macro que debe ser reeamplazada con el precio en CPM. |
| adomain | String Array | El dominio del anunciante de la creatividad |
| w | Integer | El ancho del anuncio en pixeles |
| h | Integer | El alto del anuncio en pixelesPlanning |
| bid | Object Array | Ver objeto Bid |
Objeto Bid
| Campo | Tipo | Comentarios |
|---|
| id | String | Un identificador del bid para assistir con el registro y seguimiento |
| impid | String | Valor del identificador envíado en el objeto Imp |
| price | Float | Oferta hecha en CPM (1 significa que E-Planning SSP esta dispuesto a pagar 0.001 por la impresión) |
| adm | String | El código HTML del anuncio a mostrar si la subasta es ganada. El mismo contiene una macro que debe ser reeamplazada con el precio en CPM. |
| adomain | String Array | El dominio del anunciante de la creatividad |
| w | Integer | El ancho del anuncio en pixeles |
| h | Integer | El alto del anuncio en pixeles |
| lurl | String | URL llamada por el Exchange cuando se sabe que se ha perdido una puja. Se incluyen las macros ${AUCTION_PRICE} y ${AUCTION_LOSS}. La política específica de cada Exchange puede impedir el llamado de lurl o la divulgación del precio ganador, lo que da lugar a que se eliminen las macros (es decir, se sustituyan por una cadena de longitud cero). |
| Info |
|---|
|
E-Planning SSP contabiliza la impresión junto con la ejecución del código HTML del anuncio (counting via adm). En consecuencia, nurl no es soportado. |
...
La cual en el ejemplo redirigirá finalmente a:
https://test-partner-domain.com/?uid=e3cf38b549b50e01
Formato de buyeruid
El formato utilizado por E-Planning para los buyeruids es de 16 caracteres alfanuméricos, por ejemplo e3cf38b549b50e01
Compresión
E-Planning puede enviar y recibir bid requests y bid responses comprimidos. Se recomienda el uso de compresión en ambos para disminuir la latencia en la subasta y reducir el uso de ancho de banda.
- Para que los requests comprimidos utilizando gzip sean manejados adecuadamente debe agregar la cabecera HTTP Content-Encoding: gzip en el envio del bid request.
- Para que los bid requests responses sean enviados comprimidos mediante gzip debe agregar la cabecera HTTP Accept-Encoding: gzip en el envío del bid request.
...