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 | 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 están disponibles o no |
| user | Object | Obligatorio | Ver objeto User |
| device | Object | Obligatorio | Ver objeto Device |
| site | Object | Obligatorio para Web | Ver objeto Site |
| app | Object | Obligatorio para In-App | Ver objeto App |
| 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 categorías IAB bloqueadas |
...
| 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 | 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) |
...
...
| language | js |
|---|
| linenumbers | true |
|---|
| collapse | true |
|---|
| 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 |
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"
} |
...
Ejemplo
| Code Block |
|---|
| language | js |
|---|
| linenumbers | true |
|---|
| collapse | true |
|---|
| {
"id": "123",
"page": "http://example.com/section/page.html | 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 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 |
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"
}
} |
...
| 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"
} |
...
| 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"
}
|
...
| 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 |
| ifa | String | Recomendado | Solo para In-App. El ID para anuncios del dispositivo |
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"
}
} |
...
| 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"
} |
...
| 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"
}
} |
...
| Info |
|---|
|
Para implementaciones con pchain soportamos tanto TAG ID como identificación por dominio. |
Ejemplo
Utilizando pchain
| Code Block |
|---|
| language | js |
|---|
| linenumbers | true |
|---|
| collapse | true |
|---|
|
{
"fd": 1,
"pchain": "directseller.com:12345"
} |
...
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 creará un nuevo ID de usuario. Luego E-Planning redirigirá a una URL provista por el SSP. En la misma debe existir una macro $UID que será reemplazada por el ID de usuario de E-Planning (buyeruid). Este proceso solo aplica para subastas Web, no siendo necesario en In-App.
Por ejemplo, si la URL del SSP es https://www.test-partner-domain.com/?uid=$UID, E-Planning reemplazará la macro $UID con el correspondiente buyeruid (por ejemplo "e3cf38b549b50e01") y redirigirá al usuario a la URL final. El SSP debe pasar la URL a redirigir en el parametro redir= de la URL de E-Planning:
...
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 sean enviados comprimidos mediante gzip debe agregar la cabecera HTTP Accept-Encoding: gzip en el envío del bid request.
...