Skip to content

Commit fadea3b

Browse files
chompichompi
committed
Merge pull request #1 from jm3/clean-up-docs
Clean up spot-exchange docs
2 parents 00ad419 + f288bf5 commit fadea3b

9 files changed

+519
-492
lines changed

‎README.md‎

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,7 @@
1-
Overview
2-
========
1+
# OpenRTB examples
32

4-
This the repository of OpenRTB examples.
3+
Some OpenRTB example requests + responses, with notes.
4+
5+
* [Brandscreen](https://github.com/openrtb/examples/blob/master/brandscreen/example-request-mobile.json)
6+
* [Rubicon Project](https://github.com/openrtb/examples/blob/master/rubiconproject/example-request-app-android-1.json)
7+
* [Spotxchange](https://github.com/openrtb/examples/blob/master/spotxchange/example-video-request-multiple_impr.md)

‎spotxchange/example-video-request-multiple_impr.md‎

Lines changed: 230 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,230 @@
1+
# Video Request for Multiple Impressions with a Private Deal
2+
3+
The following example illustrates a bid request for multiple video
4+
impressions, possibly for long-form content, with no companion ad
5+
slot. It includes requests for pre, mid and post-roll impressions.
6+
Additionally, the video content itself is described in the "content"
7+
object. A few notes about specific fields in the example:
8+
9+
## Bid Request Object
10+
- `at`: This is a second-price auction.
11+
12+
## For all Impression objects
13+
- `api`: Indicates that VPAID 1.0 containers are explicitly supported. As such, the mime types supported for VPAID are only "application/x-shockwave-flash" and "application/javascript". *Note that there is an implicit restriction as to which protocol is allowed in which mimetype. JavaScript support was not specified until VPAID 2.0, while Flash supports both VPAID 1.0 and 2.0.*
14+
- `battr`: User interactive and alert type ads (value '13' and '14', respectively) are explicitly being blocked for both the video and its companions.
15+
- `delivery`: Progressive download is only supported.
16+
- `linearity`: All video impressions are linear.
17+
- `maxextended`: This is not included meaning no extended video ad duration is allowed.
18+
- `playbackmethod`: Only auto-play with sound on is allowed.
19+
- `pos`: Indicates this opportunity is "above the fold".
20+
- `protocol`: Only VAST 2.0 and 3.0 are allowed. *Note that a wrapper response is not allowed in this example.*
21+
- `sequence`: Included and showing the progression of the impression opportunities available.
22+
23+
## For the Pre-Roll Impression Object (id 1)
24+
25+
- `bidfloor`: Specified per deal.
26+
- `startdelay`: This is 0 indicating the pre-roll.
27+
- `pmp`: This is a private auction restricted to one deal, but that deal is not restricted in seats that can bid.
28+
- `ext`: an exchange-specific deals extension is passed to inform the bidder of the priority assigned deals.
29+
30+
## For the Mid-Roll Impression Object (id 2)
31+
32+
- `bidfloor`: Specified per deal.
33+
- `startdelay`: This is 300 indicating the mid-roll starts 5 minutes into the content.
34+
- `pmp`: This is a private auction restricted to two deals, with the second deal restricted to only certain seats.
35+
- `ext`: an exchange-specific deals extension is passed to inform the bidder of the priority assigned deals.
36+
37+
## For the Post-Roll Impression Object (id 3)
38+
39+
- `bidfloor`: Set at $2.00 CPM.
40+
- `startdelay`: This is -2 indicating the post-roll.
41+
- `pmp`: There are no private marketplace restrictions and all deals and seats are allowed to participate.
42+
43+
```json
44+
{
45+
"id": "0123456789ABCDEF0123456789ABCDEF",
46+
"at": 2,
47+
"tmax": 120,
48+
"imp": [
49+
{
50+
"id": "1",
51+
"pmp": {
52+
"private_auction":1,
53+
"deals": [{
54+
"id":"1452f.eadb4.7aaa",
55+
"bidfloor":5.3,
56+
"at":1,
57+
"wseats":[],
58+
"ext": {
59+
"priority":1,
60+
"wadvs":[]
61+
}
62+
}
63+
]
64+
},
65+
"video": {
66+
"mimes": [
67+
"video/x-flv",
68+
"video/mp4",
69+
"application/x-shockwave-flash",
70+
"application/javascript"
71+
],
72+
73+
"api": [1,2],
74+
"battr": [13,14],
75+
"boxingallowed": true,
76+
"delivery": [2],
77+
"h": 480,
78+
"linearity": 1,
79+
"maxbitrate": 1500,
80+
"maxduration": 30,
81+
"minbitrate": 300,
82+
"minduration": 5,
83+
"playbackmethod": [1],
84+
"pos": 1,
85+
"protocol": [2,3],
86+
"sequence": 1,
87+
"startdelay": 0,
88+
"w": 640
89+
}
90+
},
91+
{
92+
"id": "2",
93+
"pmp": {
94+
"private_auction":1,
95+
"deals": [
96+
{
97+
"id":"1452f.eadb4.7aaa",
98+
"bidfloor":3.5,
99+
"at":1,
100+
"wseats":[],
101+
"ext": {
102+
"priority":1,
103+
"wadvs":[]
104+
}
105+
},
106+
{
107+
"id":"1452f.eadb4.f9bc",
108+
"bidfloor":2.5,
109+
"at":1,
110+
"wseats":["45","165","33"],
111+
"ext": {
112+
"priority":2,
113+
"wadvs":[]
114+
}
115+
}
116+
]
117+
},
118+
"video": {
119+
"mimes": [
120+
"video/x-flv",
121+
"video/mp4",
122+
"application/x-shockwave-flash",
123+
"application/javascript"
124+
],
125+
126+
"api": [1,2],
127+
"battr": [13,14],
128+
"boxingallowed": true,
129+
"delivery": [2],
130+
"h": 480,
131+
"linearity": 1,
132+
"maxbitrate": 1500,
133+
"maxduration": 60,
134+
"minbitrate": 300,
135+
"minduration": 30,
136+
"playbackmethod": [1],
137+
"pos": 1,
138+
"protocol": [2,3],
139+
"sequence": 2,
140+
"startdelay": 300,
141+
"w": 640
142+
}
143+
},
144+
{
145+
"id": "3",
146+
"bidfloor": 2.00
147+
"video": {
148+
"mimes": [
149+
"video/x-flv",
150+
"video/mp4",
151+
"application/x-shockwave-flash",
152+
"application/javascript"
153+
],
154+
155+
"api": [1,2],
156+
"battr": [13,14],
157+
"boxingallowed": true,
158+
"delivery": [2],
159+
"h": 480,
160+
"linearity": 1,
161+
"maxbitrate": 1500,
162+
"maxduration": 60,
163+
"minbitrate": 300,
164+
"minduration": 30,
165+
"playbackmethod": [1],
166+
"pos": 1,
167+
"protocol": [2,3],
168+
"sequence": 3,
169+
"startdelay": -2,
170+
"w": 640
171+
}
172+
}
173+
],
174+
"site": {
175+
"id": "1345135123",
176+
"name": "Site ABCD",
177+
"domain": "siteabcd.com",
178+
"cat": [
179+
"IAB2-1",
180+
"IAB2-2"
181+
],
182+
"page": "http://siteabcd.com/page.htm",
183+
"ref": "http://referringsite.com/referringpage.htm",
184+
"privacypolicy": true,
185+
"publisher": {
186+
"id": "pub12345",
187+
"name": "Publisher A"
188+
},
189+
"content": {
190+
191+
"cat": ["IAB2-2"],
192+
"episode": 23,
193+
"id": "1234567",
194+
"keyword": ["keyword a", "keyword b", "keyword c"],
195+
"season": 2,
196+
"series": "All About Cars",
197+
"title": "Car Show"
198+
199+
}
200+
},
201+
"device": {
202+
"ip": "64.124.253.1",
203+
"ua": "Mozilla/5.0 (Mac; U; Intel Mac OS X 10.6; en-US; rv:1.9.2.16) Gecko/20140420 Firefox/3.6.16",
204+
"os": "OS X",
205+
"flashversion": "10.1",
206+
"js": 1
207+
},
208+
"user":
209+
{
210+
"uid": "456789876567897654678987656789",
211+
"buyeruid": "545678765467876567898765678987654",
212+
"data": [
213+
{
214+
"id": "6",
215+
"name": "Data Provider 1",
216+
"segment": [
217+
{
218+
"id": "12341318394918",
219+
"name": "auto intenders"
220+
},
221+
{
222+
"id": "1234131839491234",
223+
"name": "auto enthusiasts"
224+
}
225+
]
226+
}
227+
]
228+
}
229+
}
230+
```

0 commit comments

Comments
 (0)