OpenRTB API integration: samples
Overview
Banner display web bid request sample
Banner display web bid response sample
Video app bid request sample
Video app bid response sample
Native bid request sample
Native bid response sample
bidresponse.ext object sample
Inventory mapping sample
Keywords sample
Source object sample
Equativ user sync response sample
ext.bid_feedback object sample
Overview
Equativ provides an OpenRTB API for suppliers which is able to receive OpenRTB bid requests. Equativ then runs an auction for each request so Equativ’s demand partners can bid on the opportunity. This article contains samples for bid requests and bid responses.
Banner display web bid request sample
{
"id": "Xxg5DgAMZRgKAVNEyAUBPA",
"imp": [
{
"id": "1",
"banner": {
"w": 300,
"h": 250,
"pos": 3,
"format": [
{
"w": 300,
"h": 250
},
{
"w": 300,
"h": 600
}
]
},
"bidfloor": 0.19,
"bidfloorcur": "EUR",
"secure": 1
}
],
"site": {
"page": "https://publisherpage.com",
"publisher": {
"id": "1234",
"country": "US"
}
}
},
"device": {
"ua": "REDACTED FOR PRIVACY REASONS",
"ip": "REDACTED FOR PRIVACY REASONS",
"geo": {
"country": "USA",
"region": "WI",
"metro": "702",
"city": "Bloomer",
"zip": "REDACTED FOR PRIVACY REASONS"
},
"os": "REDACTED FOR PRIVACY REASONS",
"devicetype": 2
},
"user": {
"id": "REDACTED FOR PRIVACY REASONS",
"buyeruid": "REDACTED FOR PRIVACY REASONS"
},
"at": 1,
"tmax": 300,
"cur": [
"EUR"
]
}Banner display web bid response sample
{
"id": "Xxg5DgAMZRgKAVNEyAUBPA",
"seatbid": [
{
"bid": [
{
"id": "369118252108780732",
"impid": "1",
"price": 0.3043884949016383736565211036,
"adm": "<THE AD MARKUP>",
"adomain": [
"progressive.com"
],
"crid": "200113844",
"w": 300,
"h": 250,
"api": 0,
"protocol": 0,
"exp": 0,
"qagmediarating": 0
}
],
"seat": "10602"
}
],
"cur": "EUR",
"statuscode": 0
}Video app bid request sample
{
"id": "Xxg7LwAKQbAJHUFKsQ0AFg",
"imp": [
{
"id": "1",
"video": {
"mimes": [
"video/mp4"
],
"linearity": 1,
"w": 300,
"h": 250,
"playbackmethod": [
6
],
"pos": 1,
"api": [
3,
5,
6,
7
],
"skip": 1,
"placement": 4,
"playbackend": 2
},
"bidfloor": 0.01,
"bidfloorcur": "EUR",
"secure": 1,
}
],
"app": {
"name": "Cdiscount",
"bundle": "398364165",
"publisher": {
"id": "1234",
},
"storeurl": "https://itunes.apple.com/app/id398364165"
},
"device": {
"ua": "REDACTED FOR PRIVACY REASONS",
"ip": "REDACTED FOR PRIVACY REASONS",
"geo": {
"country": "FRA",
"region": "FR-P",
"zip": "REDACTED FOR PRIVACY REASONS"
},
"make": "apple",
"model": "iphone",
"os": "REDACTED FOR PRIVACY REASONS",
"osv": "REDACTED FOR PRIVACY REASONS",
"devicetype": 4,
"ifa": "REDACTED FOR PRIVACY REASONS",
"hwv": "7",
"w": 375,
"h": 667
},
"user": {
"id": "REDACTED FOR PRIVACY REASONS",
}
},
"at": 1,
"tmax": 300,
"cur": [
"EUR"
],
"regs": {
"ext": {
"gdpr": 1
}
}
}Video app bid response sample
{
"id": "Xxg7LwAKQbAJHUFKsQ0AFg",
"seatbid": [
{
"bid": [
{
"id": "225847488998764848",
"impid": "1",
"price": 0.2076839082012064520761728781,
"adm": "THE AD MARKUP",
"adomain": [
"westernunion.com"
],
"crid": "875469",
"w": 300,
"h": 250,
"api": 0,
"protocol": 0,
"exp": 0,
"qagmediarating": 0
}
],
"seat": "4779"
}
],
"cur": "EUR",
"statuscode": 0
}Native bid request sample
{
"id": "fcb8763b-db58-4822-9647-49f09c751884",
"imp": [
{
"id": "1234",
"native": {
"ver": "1.2",
"request": "{\"native\":{\"ver\":\"1.2\",\"assets\":[{\"id\":1234,\"required\":1,\"title\":{\"len\":50}},{\"id\":2,\"required\":1,\"img\":{\"type\":3,\"wmin\":200,\"hmin\":50}},{\"id\":4,\"data\":{\"type\":12,\"len\":25}},{\"id\":5,\"data\":{\"type\":1,\"len\":25}},{\"id\":6,\"img\":{\"type\":1}}],\"context\":1,\"plcmttype\":1,\"privacy\":1,\"eventtrackers\":[{\"event\":1,\"methods\":[1,2]}],\"aurlsupport\":1}}"
},
"tagid": "1245039-43459",
"bidfloor": 0.1,
"ext": null
}
],
"site": {
"id": "12345",
"name": "PublisherName",
"domain": "publisherpage.com",
"page": "https://publisherpage.com",
"publisher": {
"id": "1234",
"name": "Publisher",
"ext": null
},
"ext": null,
"cattax": 1
},
"device": {
"ua": "REDACTED FOR PRIVACY REASONS",
"ip": "REDACTED FOR PRIVACY REASONS",
"geo": {
"country": "FRA",
"region": "75",
"zip": "REDACTED FOR PRIVACY REASONS"
},
"make": "Apple",
"model": "iPhone",
"js": 1,
"devicetype": 4,
"lmt": 0,
"ext": null
},
"user": {
"id": "REDACTED FOR PRIVACY REASONS",
"ext": {
"consent": "REDACTED FOR PRIVACY REASONS"
}
},
"at": 1,
"tmax": 500,
"allimps": 0,
"cur": [
"USD"
],
"source": {
"fd": 1,
"ext": {
"schain": {
"ver": "1.0",
"complete": 1,
"nodes": [
{
"asi": "network.com",
"sid": "12345",
"hp": 1
}
]
}
}
},
"regs": {
"coppa": 0,
"ext": {
"gdpr": 1
}
},
"ext": {},
"cattax": 1
}Native bid response sample
{
"id": "90420da0-031c-4df1-936a-c53a182dde4b",
"seatbid": [
{
"bid": [
{
"id": "0",
"impid": "d318c459-7db7-4d01-a224-32b76c95d8d6",
"price": 0.601864,
"adid": "552753230",
"adm": "{\"native\":{\"ver\":\"1.2\",\"assets\":[{\"id\":...THE AD MARKUP\"}}",
"adomain": [
"walmart.com.mx"
],
"iurl": "https://s0.2mdn.net/simgad/149334858874628551",
"cid": "352237598",
"crid": "1234567890",
"w": 1200,
"h": 627,
"language": "xx",
"mtype": 4
}
],
"seat": "1613631"
}
],
"cur": "USD"
}bidresponse.ext object sample
"bid":[{
"id":"1234567890",
...
"ext":
{
"feedback_token":"AB1234"
}
}]Inventory mapping sample
Note that XXXXXX is to be replaced by the actual siteId / pageId / formatId.
{
"id": "Xxg5DgAMZRgKAVNEyAUBPA",
"imp": [{
"id": "1",
"banner": {
"w": 300,
"h": 250,
"pos": 3,
"format": [{
"w": 300,
"h": 250
}
]
},
"bidfloor": 0.19,
"bidfloorcur": "USD",
"secure": 1,
"ext": {
"bidder": {
"siteId": XXXXXX,
"pageId": XXXXXX,
"formatId": XXXXXX
}
}
}
],
...Keywords sample
...
"site": {
"domain": "www.yourdomain.com",
"keywords": "key1=value;key2=value;key3=value"
},
...
...
"app": {
"bundle": "com.yourdomain",
"keywords": "key1=value;key2=value;key3=value"
},
...Source object sample
"source": {
"ext": {
"schain": {
"ver": "1.0",
"complete": 1,
"nodes": [{
"asi": "directseller.com",
"sid": "00001"
"rid": "BidRequest1",
"hp": 1
}, {
"asi": "reseller.com",
"sid": "aaaaa",
"rid": "BidRequest2",
"hp": 1
}
]
}
}
}Equativ user sync response sample
<html>
<head></head>
<body>
<img src="//[MATCH_PARTNER1_URL]"/>
[...]
<img src="//[MATCH_PARTNERn_URL]"/>
</body>
</html>ext.bid_feedback object sample
{
"id":"1234567890",
...
"ext":
{
"bid_feedback":[
{
"price":5.1,
"loss":102,
"feedback_token":"AB1234"
}