This specification is intended for Supply-Side platforms who want to integrate with E- Planning to sell their inventory. Complying with this specification will allow for a faster and more efficient integration to E-Planning’s production environment.

...

Field	Type	Status	Comment
id	String	Mandatory	An identifier for the request, it can be used to connect the bid request to the bid response outside of the HTTP protocol
tmax	Integer	Recommended	In milliseconds, the time after which bid responses will not enter the auction
at	Integer	Mandatory	Auction type, where 1 = First Price, 2 = Second Price Plus
imp	Object Array	Mandatory	See Imp object
allimps	Integer	Recommended	Flag to indicate whether all the impressions of the context are available or not
user	Object	Mandatory	See User object
device	Object	Mandatory	See Device object
site	Object	Mandatory for Web	See Site object
app	Object	Mandatory for In-App	See App object
source	Object	Mandatory	See Source object
regs	Object	Mandatory	See Regs object
badv	String Array	Recommended	Block list of advertisers by their domains
bcat	String Array	Recommended	Blocked advertiser categories using the IAB content categories

...

Field	Type	Status	Comment
id	String	Mandatory	A unique identifier for this impression within the context of the bid request (typically, starts with 1 and increments)
banner	Object	Mandatory	A Banner object
bidfloorcur	String	Mandatory	Currency in which the bid response is expected, including the floor prices. using ISO-4217 alpha codes. Example: "USD"
bidfloor	Float	Mandatory	The minimum amount for which the impression can be sold, expressed in the currency set in bidfloorcur
secure	Integer	Mandatory	Set to1 if the snipped in the bid response must use HTTPS
instl	Integer	Recommended	Set to 1 when the impression is destined to be an interstitial or full- page

...

clickbrowser

...

Integer

Mandatory for In-App

Indicates the type of browser which should be opened upon clicking the creative in an app, where 0 = embedded, 1 = native

Example

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

...

Field	Type	Status	Comment
id	String	Mandatory	Exchange-specific site ID
page	String	Mandatory	The URL of the page on which the impression will be shown; field should be absent when unknown or alternatively an empty string
publisher	Object	Mandatory	See Publisher Object
domain	String	Recommended	The domain of the page
cat	String Array	Recommended	Array of IAB content categories of the site as described in OpenRTB 2.5
ref	String	Recommended	The referrer URL that caused navigation to the current page

Example

{ "id": "123", "page": "http://example.com/section/page.html

Code Block

language	js
linenumbers	true
collapse	true

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

App Object

Field	Type	Status	Comment
id	String	Obligatorio	Exchange-specific app ID
name	String	Obligatorio	The application’s name
bundle	String	Obligatorio	Application bundle or package name (e.g. "com.foo.mygame" on Android and numeric on iOS)
domain	String	Recomendado	Application domain
storeurl	String	Recomendado	Application store URL (e.g. iTunes store URL or Android store URL)
cat	String Array	Recomendado	Array of IAB content categories of the site as described in OpenRTB 2.5

Example

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

...

Field	Type	Status	Comment
id	String	Mandatory	The publisher’s unique ID; it should be sufficient to identify the party ultimately being paid for the impression auctioned. Cannot be null
domain	String	Recommended	Highest-level domain of the publisher
name	String	Recommended	Name of the publisher

Example

Code Block

language	js
linenumbers	true
collapse	true

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

...

Field	Type	Status	Comment
id	String	Recommended	The user’s ID (SSP wide)
buyeruid	String	Recommended	The E-Planning’s user ID. See user matching section below for comments on how it is obtained

Example

Code Block

language	js
linenumbers	true
collapse	true

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

...

Field	Type	Status	Comment
ua	String	Mandatory	The browser user agent string
ip	String	Mandatory	The user's IP address
dnt	Integer	Recommended	The user’s intent regarding tracking. If a dnt value was sent in the header by the client application when calling the partner, the value 1 should be passed in this field; if no value was sent, it should be 0.
language	String	Optional	The user’s browser language using ISO- 639-1-alpha-2
carrier	String	Recommended	Carrier or Internet Service Provider
connectiontype	Integer	Recommended	Network connection type
os	String	Recommended	The device OS
geo	Object	Recommended	See the Geo Object
ifa	String	Recommended	Only for In-App. The device’s advertising ID

Example

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

...

Field	Type	Status	Comment
country	String	Mandatory	The user's country at the time of the display, using ISO- 3166-1-alpha-3
city	String	Recommended	The user's city
latitude	Float	Recommended	Latitude from -90.0 to +90.0, where negative is south
longitude	Float	Recommended	Longitude from - 180.0 to +180.0, where negative is west

Example

Code Block

language	js
linenumbers	true
collapse	true

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

...

Field	Type	Status	Comment
coppa	Integer	Recommended	Flag indicating if this request is subject to COPPA regulations, where 0 = no, 1 = yes
gdpr	Integer	Mandatory for EU users (Recommended otherwise)	Flag indicating if this request is subject to the GDPR regulations, where 0 = no, 1 = yes
ext.consent	String	Recommended	When the request is subject to GDPR regulations, this field is used to indicate the user's consent string
us_privacy	String	Recommended	Flag indicating is this request is subject to the CCPA (California Consumer Privacy Act) regulations. CCPA field should be exactly 4 chars length, with first char must be 1 (correspond to version), the 3 remaining chars must be either 'Y' or 'y', 'N or 'n', '-'. https://iabtechlab.com/wp-content/uploads/2019/11/U.S.-Privacy-String-v1.0-IAB-Tech-Lab.pdf

Example

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

title	Note

For pchain implementation we accept both TAG ID or domain identification

Example

Using pchain

Code Block

language	js
linenumbers	true
collapse	true

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

...

E-Planning provides partner with a sync URL, which partner should fire from traffic using an IFRAME tag. After URL is called from user's browser E-Planning will handle user's cookies on its side. Then E-Planning will redirect the user to a redirect URL which SSP provides to E- Planning.

There is a placeholder in this redirect URL, which E-Planning will replace with buyeruid generated on our side. This process only applies to Web auctions, not being necessary in In-App.

Example of supply partner’s redirect URL: http://test-partner-domain.com/?uid=$UID, E-Planning will replace $UID placeholder with some buyeruid (e.g. “e3cf38b549b50e01”) and redirect user using this URL.
Partner shall pass a redirect URL as "redir" parameter in E-Planning sync URL:

https://ads.us.e-planning.net/uspd/1/<CLIENT_ID>?ruidm=1&du=<ENCODED_REDIRECT_URL>

Note <CLIENT_ID> is provided by E-Planning

Here is the example of final sync IFRAME tag:

Code Block

language	xml

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

It will redirect to:

https://test-partner-domain.com/?uid=e3cf38b549b50e01

buyeruid format

E-Planning’s buyeruid is a fixed 16 characters length string in all cases, eg: "e3cf38b549b50e01"

Compression

E-Planning can receive compressed bid requests from partners and send them back compressed bid responses. E-Planning recommends usage of compression in requests and responses to decrease auction latency and save network bandwith.

...

Version	Old Version 2	New Version 3
Changes made by	Sebastian Perez	Sebastian Perez
Saved on	Jul 27, 2020	Nov 10, 2020

Versions Compared

Key

Example

Example

App Object

Example

Example

Example

Example

Example

Example

Example

Using pchain

buyeruid format

Compression

Content Comparison

Versions Compared

Key

Example

Example

App Object

Example

Example

Example

Example

Example

Example

Example

Using pchain

buyeruid format

Compression