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

Subasta

Lo que normalmente se refiere como subasta, consiste en:

1. Un bid request enviado a E-Planning SSP (entre otros compradores) por otro SSP
2. E-Planning SSP respondiendo con un bid response
3. El SSP elegiendo un ganador
4. 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 características 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, múltiples impresiones pueden ser enviadas en un mismo bid request.

Nivel superior del Bid Request

Ejemplo

{
	"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

Ejemplo

{
	"id": "1",
	"bidfloor": 0.4286,
	"bidfloorcur": "USD",
	"secure": 1,
	"instl": 0,
	"banner": {
		"w": 300,
		"h": 250,
		"pos": 1,
		"topframe": 0
	},
	"tagid": "79a4e192e54cc0d9"
}

Objeto Banner

Ejemplo

Utilizando format

{
	"pos": 1,
	"format": [
		{
			"w": 300,
			"h": 600
		},
		{
			"w": 300,
			"h": 250
		}
	],
	"battr": [ 11, 12 ],
	"btype": [ 4 ]
}

Utilizando w y h

{
	"pos": 1,
	"w": 300,
	"h": 250,
	"wmin": 300,
	"wmax": 300,
	"hmin": 50,
	"hmax": 600,
	"battr": [ 11, 12 ],
	"btype": [ 4 ]
}

Objeto Video

Objeto Format

Objeto Site

Ejemplo

{
	"id": "123",
	"page": "http://example.com/section/page.html",
	"cat": [ "IAB1-2" ],
	"publisher": {
		"id": "456",
		"domain": "example.com",
		"name": "Example Inc"
	}
}

Objeto App

Ejemplo

{
	"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

Ejemplo

{
	"id": "456",
	"domain": "example.com",
	"name": "Example Inc"
}

Objeto User

Ejemplo

{
	"id": "1234567",
	"buyeruid": "e3cf38b549b50e01",
	"consent": "BOEFEAyOEFEAyAHABDENAI4AAAB9vABAASA"
}

Objeto Device

Ejemplo

{
	"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

Ejemplo

{
	"latitude": 37.4194,
	"longitude": -122.164,
	"country": "USA",
	"city": "Stanford"
}

Objeto Regs

Ejemplo

{
	"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

Ejemplo

Utilizando pchain

{
	"fd": 1,
	"pchain": "directseller.com:12345"
}

Utilizando schain

{
	"fd": 1,
	"ext": {
		"schain": {
			"complete": 1,
			"nodes": [
				{
					"asi":"directseller.com",
					"pid":"12345",
					"rid":"c7ecc1f7b1628d49"
				}
			]
		}
	}
}

Ejemplo de Bid Request

Ejemplo para banner (web)

{
	"id": "6cb84abfabb2990d",
	"tmax": 300,
	"at": 1,
	"cur": ["USD"],
	"imp": [{
		"id": "1",
		"bidfloor": 0.4,
		"secure": 1,
		"instl": 0,
		"banner": {
			"w": 300,
			"h": 600,
			"pos": 1,
			"topframe": 0
		}
	}],
	"user": {
		"id": "2e6r4g56ez1hz8er4h",
		"buyeruid": "e3cf38b549b50e01"
	},
	"device": {
		"ip": "171.67.194.75",
		"ua": "Mozilla\/5.0 (Macintosh; Intel Mac OS X 10.12; rv:71.0) Gecko\/20100101 Firefox\/71.0",
		"os": "macOS",
		"carrier": "verizon",
		"connectiontype": 1,
		"dnt": 0,
		"lmt": 0,
		"geo": {
			"country": "USA",
			"city": "Stanford"
		}
	},
	"site": {
		"id": "123",
		"page": "http://example.com/section/page.html",
		"cat": [ "IAB1-2" ],
		"publisher": {
			"id" : "456",
			"domain": "example.com",
			"name": "Example Inc"
		}
	}
	"source": {
		"fd": 1,
		"ext": {
			"sourcetype": 3,
			"sourceorigin": 7,
			"schain": {
				"complete": 1,
				"nodes": [{
					"asi":"directseller.com",
					"pid":"456",
					"rid":" c7ecc1f7b1628d49"
				}]
			}
		}
	},
	"regs": {
		"gdpr": 1,
		"us_privacy": "1-N-",
		"coppa": 1,
		"ext": {
			"consent": "BOq9e8JOq9e8lAHABBESCv- AAAAst7_______9______9uz_Ov_v_f__33e8__9v_l_7_-___u_-3zd4u_1vf99yfm1- 7etr3tp_87ues2_Xur__79__3z3_9pxP78k89r7337Ew_v-_v8b7BCIJ"
		}
	},
	"badv": ["ford.com","bmw.com"],
	"bcat": ["IAB8-7","IAB8-8"]
}

Bid Response

Cada bid response generado por E-Planning SSP es único y debe ser utilizado solo una vez, en el mismo contexto del bid request original.

Nivel superior del Bid Response

Objeto Seatbid

Objeto Bid

Ejemplo de Bid Response

Ejemplo para banner (web)

{
	"id": "658cc151efd92b1b",
	"cur": "USD",
	"seatbid": [
		{
			"seat": "9ac35426a22738bc",
			"bid": [
				{
					"id": "9c53f0f503c6a52d",
					"impid": "1",
					"price": 1.07,
					"w": 300,
					"h": 250,
					"adm": "<script type='text/javascript' src='https://ads.us.e-planning.net/sample/ad '></script><img src='https://u-iad02-i01.e-planning.net/eli/1/5a1ad71d2d53a0f5?b=018b8f1a3b2a9341&s=9ac35426a22738bc&p =${AUCTION_PRICE:B64}' />",
					"adomain": ["advertiser.com"]
				}
			]
		}
	]
}

Macros

Cuando E-Planning SSP gana una subasta debe informar cual fue el precio final reemplazando las macros correspondientes.
La macro de precio se encuentra en Bidresponse.seatbid[...].bid[...].adm y debe ser reemplazada en el lugar donde se encuentra. Por favor, utilice la misma divisa de la subasta (usualmente USD).

Hay dos tipos de macros diferentes:

• ${AUCTION_PRICE}: Debe ser reemplazada con el precio final en CPM

• ${AUCTION_PRICE:B64}: Idem ${AUCTION_PRICE} pero codificada utilizando base64

Sincronización de usuarios

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:

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:

<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 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 responses sean enviados comprimidos mediante gzip debe agregar la cabecera HTTP Accept-Encoding: gzip en el envío del bid request.
  

Por default los bid responses no estarán comprimidos.

Conexiones persistentes

E-Planning soporta conexiones HTTP Keep-Alive. Agregando la cabecera HTTP Connection: Keep-Alive múltiples bid requests pueden ser enviados utilizando la misma conexión TCP. Se recomienda su implementación ya que reduce la latencia de la subasta evitando el inicio de una nueva conexión TCP para cada bid request enviado.