Skip to content

Commit f1eae57

Browse files
authored
updating Rubicon video params (#1181)
* updating Rubicon video params * syntax, adding lists
1 parent 6f3e648 commit f1eae57

File tree

2 files changed

+75
-2
lines changed

2 files changed

+75
-2
lines changed

dev-docs/adunit-reference.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -476,5 +476,5 @@ pbjs.addAdUnits([{
476476
[conditionalAds]: {{site.baseurl}}/dev-docs/conditional-ad-units.html
477477
[setConfig]: {{site.baseurl}}/dev-docs/publisher-api-reference.html#module_pbjs.setConfig
478478
[configureResponsive]: {{site.baseurl}}/dev-docs/publisher-api-reference.html#setConfig-Configure-Responsive-Ads
479-
[openRTB]: https://www.iab.com/wp-content/uploads/2015/05/OpenRTB_API_Specification_Version_2_3_1.pdf
479+
[openRTB]: https://www.iab.com/wp-content/uploads/2016/03/OpenRTB-API-Specification-Version-2-5-FINAL.pdf
480480
[pbServer]: {{site.baseurl}}/dev-docs/get-started-with-prebid-server.html

dev-docs/bidders/rubicon.md

Lines changed: 74 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ userIds: unifiedId/tradedesk
1414
### Note:
1515
The Rubicon Project adapter requires setup and approval from the Rubicon Project team, even for existing Rubicon Project publishers. Please reach out to your account team or [email protected] for more information.
1616

17-
### bid params
17+
### Bid Params
1818

1919
{: .table .table-bordered .table-striped }
2020
| Name | Scope | Description | Example | Type |
@@ -46,6 +46,79 @@ The following video parameters are supported:
4646
| `size_id` | optional | Integer indicating the Rubicon Project video ad format ID. If not set, infers from mediaTypes.video.context | `201` | `integer` |
4747
| `language` | recommended | Indicates the language of the content video, in ISO 639-1/alpha2. Highly recommended for successful monetization for pre-, mid-, and post-roll video ads. Not applicable for interstitial and outstream. | `'en'` | `string` |
4848

49+
{: .alert.alert-warning :}
50+
For Prebid.js 2.5 and later, the Rubicon Project adapter for video requires more parameters in the AdUnit's `mediaTypes.video` definition than required for version 2.4 and earlier.
51+
We are requiring these parameters for publishers to fully declare their video inventory to be transparent to bidders, getting the best chance at a high value and technically compatible bid.
52+
Specifically, we're requiring: `mimes`, `protocols`, `maxduration`, `linearity`, and `api`. See the example below.
53+
54+
Here's a video example for Prebid.js 2.5 or later:
55+
56+
```
57+
var videoAdUnit = {
58+
code: 'myVideoAdUnit',
59+
mediaTypes: {
60+
video: {
61+
context: 'instream',
62+
playerSize: [640, 480],
63+
mimes: ['video/mp4', 'video/x-ms-wmv']
64+
protocols: [2,5],
65+
maxduration:30,
66+
linearity: 1,
67+
api: [2]
68+
}
69+
},
70+
bids: [{
71+
bidder: 'rubicon',
72+
params: {
73+
accountId: '7780',
74+
siteId: '87184',
75+
zoneId: '413290',
76+
video: {
77+
language: 'en'
78+
}
79+
}
80+
}]
81+
};
82+
```
83+
84+
This example adunit will also work Prebid.js 2.4 and earlier, but mimes, protocols, maxduration, linearity, and api are not required.
85+
86+
We recommend discussing video demand with your Rubicon Project account representative.
87+
88+
Lists of api, protocol, and linearity values are in the [OpenRTB 2.5](https://www.iab.com/wp-content/uploads/2016/03/OpenRTB-API-Specification-Version-2-5-FINAL.pdf) documentation, copied here for convenience:
89+
90+
##### api
91+
92+
+ `1` : VPAID 1.0
93+
+ `2` : VPAID 2.0
94+
+ `3` : MRAID 1.0
95+
+ `4` : ORMMA
96+
+ `5` : MRAID 2.0
97+
+ `6` : MRAID 3.0
98+
99+
##### linearity
100+
+ `1` : Linear / In-Stream
101+
+ `2` : Non-Linear / Overlay
102+
103+
##### protocols
104+
+ `1` : VAST 1.0
105+
+ `2` : VAST 2.0
106+
+ `3` : VAST 3.0
107+
+ `4` : VAST 1.0 Wrapper
108+
+ `5` : VAST 2.0 Wrapper
109+
+ `6` : VAST 3.0 Wrapper
110+
+ `7` : VAST 4.0
111+
+ `8` : VAST 4.0 Wrapper
112+
+ `9` : DAAST 1.0
113+
+ `10` : DAAST 1.0 Wrapper
114+
115+
116+
#### Outstream Video
117+
118+
Rubicon Project supports outstream video with these restrictions:
119+
120+
* The publisher must [provide their own renderer](/dev-docs/show-outstream-video-ads.html#renderers).
121+
* Rubicon Project does not make concurrent banner and video requests. The Rubicon adapter will send a video request if bids[].params.video is supplied, else a banner request will be made.
49122

50123
### Configuration
51124

0 commit comments

Comments
 (0)