E-Planning SSP puede recibir impresiones mediante una conexión de servidor a servidor (server to server) utilizando el protocolo OpenRTB.
...
- 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 características de OpenRTB 2.5 son soportadas (como por ejemplo Banner.format)
...
Solo un bid request debe ser enviado para cada subasta. Sin embargo, multiples múltiples impresiones pueden ser enviadas en un mismo bid request.
| Info | ||
|---|---|---|
| ||
|
...
| 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 están 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 categorías IAB bloqueadas |
Ejemplo
| Code Block | ||||||
|---|---|---|---|---|---|---|
| ||||||
{
"id": "bfebe4d6f24efacd",
"tmax": 300,
"at": 1,
"cur": ["USD"],
"imp": [{ "...": "..." }],
"user": { "...": "..." },
"device": { "...": "..." },
"site": { "...": "..." },
"source": { "...": "..." },
"regs": { "...": "..." },
"badv": ["ford.com","bmw.com"],
"bcat":, ["IAB8-1","IAB8-2"]
} |
...
| Campo | Tipo | Estado | Comentarios |
|---|---|---|---|
| id | String | Obligatorio | Identificador unico único 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) |
...
| 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 están 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 | ||
|---|---|---|
| ||
|
...
| Campo | Tipo | Estado | Comentarios |
|---|---|---|---|
| id | String | Obligatorio | ID del sitio en el SSP |
| page | String | Obligatorio | URL de la página donde se mostrará la impresión. 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 categorias categorías IAB del sitio |
| ref | String | Recomendado | URL de la página desde donde se llego a la página actual |
...
E-Planning proveerá al SSP con una URL de sincronización de usuarios, la cual debe ser insertada en los sitios a subastar utilizando una etiqueta <iframe>. Luego de que la URL sea llamada en el navegador E-Planning SSP creará un nuevo ID de usuario. Luego E-Planning redirigira redirigirá a una URL provista por el SSP. En la misma existirá debe existir una macro $UID que será reemplazada por el ID de usuario de E-Planning (buyeruid).
Por ejemplo, si la URL del SSP es httphttps://www.test-partner-domain.com/?uid=$UID, E-Planning reemplazará la macro $UID con el correspondiente buyeruid (por ejemplo "e3cf38b549b50e01") y redirigira redirigirá al usuario a la URL final. El SSP debe enviar pasar la URL a redirigir en el parametro redir= de la URL de E-Planning.:
https://ads.us.e-planning.net/uspd/1/<CLIENT_ID>?ruidm=1&du=<ENCODED_REDIRECT_URL>
Note que <CLIENT_ID> es un valor provisto por E-Planning.
Este es un ejemplo de como debe ser insertada la URL:
| Code Block | ||
|---|---|---|
| ||
<iframe src="https://ads.us.e- planning.net/uspd/1/5a1ad71d2d53a0f5?ruidm=1&du=https%3A%2F%2Ftest-partner- domain.com%2F%3Fuid%3D%24UID" width="0" height="0" style="display: none;"></iframe> |
La cual en el ejemplo redirigira 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 alfanumericosalfanumé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 ahorrar 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 sean enviados comprimidos mediante gzip debe agregar la cabecera HTTP Accept-Encoding: gzip en el envio envío del bid requestsrequest.
Por default los bid responses no estarán comprimidos.
...