E-Planning SSP puede recibir impresiones mediante una conexión de servidor a servidor (server to server) utilizando el protocolo OpenRTB.
Este documento describe como se realizará la conexión, como deben ser enviados las impresiones y como serán devueltos los anuncios entre otros puntos operativos importantes como la sincronización de usuarios.
Contenido
| Table of Contents |
|---|
| maxLevel | 3 |
|---|
| exclude | Contenido|Ejemplo |
|---|
|
Subasta
Lo que normalmente se refiere como subasta, consiste en:
- Un bid request enviado a E-Planning SSP (entre otros compradores) por otro SSP
- E-Planning SSP respondiendo con un bid response
- El SSP elegiendo un ganador
- El SSP mostrando el anuncio de la fuente ganadora
Protocolo RTB
- E-Planning SSP utiliza como formato de transporte JSON y el metodo HTTP POST.
- E-Planning SSP devuelve un mensaje HTTP 204 en caso de que no participe en la subasta.
- El protocolo utilizado por E-Planning SSP es OpenRTB 2.3. Sin embargo, algunas caracteristicas de OpenRTB 2.5 son soportadas (como por ejemplo Banner.format)
Bid Request
Para comenzar la conexión el SSP será provisto de una serie de URLs (Endpoints), cada una apuntando a diferentes datacenters de E-Planning. El objetivo de esto es utilizar el datacenter mas cercano al utilizado por el SSP para realizar la subasta.
Solo un bid request debe ser enviado para cada subasta. Sin embargo, multiples impresiones pueden ser enviadas en un mismo bid request.
| Info |
|---|
|
- Los campos obligatorios siempre deben ser includos.
- Los campos recomendados tienen un impacto positivo en la subasta si son enviados.
- Los campos opcionales tienen un impacto positivo en la operación y reportes, pero no influyen de forma directa en el resultado de la subasta.
|
Nivel superior del Bid Request
| Campo | Tipo | Estado | Comentarios |
|---|
| id | String | Obligatorio | Un identificador para el request. Puede ser utilizado para relacionar el bid request al bid response fuera del protocolo HTTP |
| tmax | Integer | Recomendado | En milisegundos, el tiempo máximo de respuesta para participar de la subasta |
| at | Integer | Obligatorio | Tipo de subasta, donde 1 = First Price, 2 = Second Price Plus |
| imp | Object Array | Obligatorio | Ver objeto Imp |
| allimps | Integer | Recomendado | Indica si todas las impresiones del contexto estan disponibles o no |
| user | Object | Obligatorio | Ver objeto User |
| device | Object | Obligatorio | Ver objeto Device |
| site | Object | Obligatorio | Ver objeto Site |
| source | Object | Obligatorio | Ver objeto Source |
| regs | Object | Obligatorio para Europa
(Recomendado para el resto) | Ver objeto Regs |
| badv | String Array | Recomendado | Listado de dominios de anunciantes bloqueados |
| bcat | String Array | Recomendado | Listado de categorias IAB bloqueadas |
Ejemplo
| Code Block |
|---|
| language | js |
|---|
| linenumbers | true |
|---|
| collapse | true |
|---|
|
{
"id": "bfebe4d6f24efacd", "tmax": 300,
"at": 1,
"cur": ["USD"],
"imp": [{ "...": "..." }],
"user": { "...": "..." },
"device": { "...": "..." },
"site": { "...": "..." },
"source": { "...": "..." },
"regs": { "...": "..." },
"badv": ["ford.com","bmw.com"],
"bcat":, ["IAB8-1","IAB8-2"]
} |
Objeto Imp
| Campo | Tipo | Estado | Comentarios |
|---|
| id | String | Obligatorio | Identificador unico para la impresión dentro del Bid Request.
Habitualmente comienza en "1" y se incrementa progresivamente. |
| banner | Object | Obligatorio | Ver objeto Banner |
| 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) |
Ejemplo
| Code Block |
|---|
| language | js |
|---|
| linenumbers | true |
|---|
| collapse | true |
|---|
|
{
"id": "1",
"bidfloor": 0.4286,
"bidfloorcur": "USD",
"secure": 1,
"instl": 0,
"banner": {
"w": 300,
"h": 250,
"pos": 1,
"topframe": 0
},
"tagid": "79a4e192e54cc0d9"
} |
Objeto Banner
| 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 estan descriptas en OpenRTB 2.5 |
| 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 |
| Info |
|---|
|
- Ambos formatos de tamaño de OpenRTB 2.3 y 2.5 son soportados. Recomendamos no definir ambos a la vez, pero en caso de suceder, se ignorará el formato de OpenRTB 2.5.
- OpenRTB 2.3: Utiliza w y h
- OpenRTB 2.5: Utiliza format
- Si lo que se desea vender son dos espacios separados en la misma página, por ejemplo un 728x90 en la parte superior y un 300x250 a la derecha, dos objetos Imp deben ser enviados con un tamaño independiente cada uno.
- Si el objetivo es vender un unico espacio que soporta mas de un tamaño, entonces un solo objeto Imp debe ser enviado con los tamaños soportados.
|
Ejemplo
| Code Block |
|---|
| language | js |
|---|
| linenumbers | true |
|---|
| collapse | true |
|---|
|
{
"pos": 1,
"format": [
{
"w": 300,
"h": 600
},
{
"w": 300,
"h": 250
}
],
"battr": [ 11, 12 ],
"btype": [ 4 ]
} |
Utilizando w y h
| 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 ]
} |