E-Planning SSP puede recibir impresiones mediante una conexión de servidor a servidor (server to server) utilizando el protocolo OpenRTB.
...
| 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 Format
| Campo | Tipo | Estado | Comentarios |
|---|
| w | Integer | Obligatorio | Ancho en pixeles del tamaño |
| h | Integer | Obligatorio | Alto en pixeles del tamaño |
Objeto Site
| 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 IAB del sitio |
| ref | String | Recomendado | URL de la página desde donde se llego a la página actual |
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"
}
} |
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 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 |
Ejemplo
| Code Block |
|---|
| language | js |
|---|
| linenumbers | true |
|---|
| collapse | true |
|---|
|
{
"id": "1234567",
"buyeruid": "e3cf38b549b50e01",
"consent": "BOEFEAyOEFEAyAHABDENAI4AAAB9vABAASA"
}
|
Objeto Device
| Campo | Tipo | Estado | Comentarios |
|---|
| ua | String | Obligatorio | El valor de user-agent para el navegador |
| ip | String | Obligatorio | Dirección IP del usuario |
| dnt | Integer | Recomendado | El consentimiento del usuario para ser seguido (tracked). Si el usuario no desea ser seguido este campo debe valer 1. |
| language | String | Opcional | El idioma del navegador del usuario utilizando ISO- 639-1-alpha-2 |
| carrier | String | Recomendado | Proveedor de servicios de Internet del usuario |
| connectiontype | Integer | Recomendado | Tipo de conexión |
| os | String | Recomendado | Sistema operativo del dispositivo |
| geo | Object | Recomendado | Ver objeto Geo |
Ejemplo
| Code Block |
|---|
| language | js |
|---|
| linenumbers | true |
|---|
| collapse | true |
|---|
|
{
"ip": "142.93.199.194",
"ua": "Mozilla\/5.0 (Macintosh; Intel Mac OS X 10.12; rv:71.0) Gecko\/20100101 Firefox\/71.0",
"os": "macOS",
"carrier": "verizon",
"connectiontype": 6,
"dnt": 0,
"geo": {
"country": "USA",
"city": "Stanford"
}
} |
Objeto Geo
| Campo | Tipo | Estado | Comentarios |
|---|
| country | String | Obligatorio | País del usuario en ISO- 3166-1-alpha-3 |
| city | String | Recomendado | Ciudad del usuario |
| latitude | Float | Recomendado | Latitud desde -90.0 hasta +90.0, donde negativo significa sur |
| longitude | Float | Recomendado | Longitud desde -180.0 hasta +180.0, donde negativo es oeste |
Ejemplo
| Code Block |
|---|
| language | js |
|---|
| linenumbers | true |
|---|
| collapse | true |
|---|
|
{
"latitude": 37.4194,
"longitude": -122.164,
"country": "USA",
"city": "Stanford"
} |
Objeto Regs
| Campo | Tipo | Estado | Comentarios |
|---|
| coppa | Integer | Recomendado | Indica si la petición esta sujeta a regulaciones de COPPA, donde 0 = no, 1 = si |
| gdpr | Integer | Obligatorio para Europa
(Recomendado para el resto) | Indica si la petición esta sujeta a regulaciones de GDPR, donde 0 = no, 1 = si |
| ext.consent | String | Recomendado | Si la petición esta sujeta a regulaciones de GDPR, indica el Consent String del usuario |
| us_privacy | String | Recomendado | Indica si la petición esta sujeta a regulaciones de CCPA (California Consumer Privacy Act).
Debe contener cuatro caracteres, donde el primero debe ser la versión y los tres siguientes Y, N o -
Mas información haciendo click aquí. |
Ejemplo
| Code Block |
|---|
| language | js |
|---|
| linenumbers | true |
|---|
| collapse | true |
|---|
|
{
"gdpr": 1,
"coppa": 1,
"us_privacy": "1-N-",
"ext": {
"consent": "BOq9e8JOq9e8lAHABBESCv- AAAAst7_______9______9uz_Ov_v_f__33e8__9v_l_7_-___u_-3zd4u_1vf99yfm1-7etr3tp_87ues2_Xur__79__3z3_9pxP78k89r7337Ew_v-_v8b7BCIJ"
}
} |
Objeto Source
| 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 Object |
| Info |
|---|
|
Para implementaciones con pchain soportamos tanto TAG ID como identificación por dominio. |
...
Nivel superior del Bid Response
| Campo | Tipo | Comentarios |
|---|
| id | String | E-Planning SSP devuelve en este campo el valor del identificador del bid request correspondiente.
Esto no es necesario para el protocolo pero permite emparejar el request y el response fuera del protocolo HTTP. |
| seatbid | Object Array | Ver objeto Seatbid. Es un array para compatibilidad con OpenRTB, pero E-Planning SSP siempre devolverá un solo objeto dentro |
| cur | String | La divisa de la oferta utilizando códigos alfanumericos ISO-4217 |
Objeto Seatbid
| 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 pixeles |
| 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. |
...
Este es un ejemplo de como debe ser insertada la URL:
| Code Block |
|---|
| language | xml | linenumbers | true |
|---|
|
<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 a:
https://test-partner-domain.com/?uid=e3cf38b549b50e01
Formato de buyeruid
El formato utilizado por E-Planning para los buyeruids es de 16 caracteres alfanumericos, 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 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 del bid requests.
...