Skip to content

updating Rubicon video params #1181

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Mar 6, 2019
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion dev-docs/adunit-reference.md
Original file line number Diff line number Diff line change
Expand Up @@ -415,5 +415,5 @@ pbjs.addAdUnits([{
[conditionalAds]: {{site.baseurl}}/dev-docs/conditional-ad-units.html
[setConfig]: {{site.baseurl}}/dev-docs/publisher-api-reference.html#module_pbjs.setConfig
[configureResponsive]: {{site.baseurl}}/dev-docs/publisher-api-reference.html#setConfig-Configure-Responsive-Ads
[openRTB]: https://www.iab.com/wp-content/uploads/2015/05/OpenRTB_API_Specification_Version_2_3_1.pdf
[openRTB]: https://www.iab.com/wp-content/uploads/2016/03/OpenRTB-API-Specification-Version-2-5-FINAL.pdf
[pbServer]: {{site.baseurl}}/dev-docs/get-started-with-prebid-server.html
75 changes: 74 additions & 1 deletion dev-docs/bidders/rubicon.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ userIds: unifiedId/tradedesk
### Note:
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.

### bid params
### Bid Params

{: .table .table-bordered .table-striped }
| Name | Scope | Description | Example | Type |
Expand Down Expand Up @@ -46,6 +46,79 @@ The following video parameters are supported:
| `size_id` | optional | Integer indicating the Rubicon Project video ad format ID. If not set, infers from mediaTypes.video.context | `201` | `integer` |
| `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` |

{: .alert.alert-warning :}
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.
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.
Specifically, we're requiring: `mimes`, `protocols`, `maxduration`, `linearity`, and `api`. See the example below.

Here's a video example for Prebid.js 2.5 or later:

```
var videoAdUnit = {
code: 'myVideoAdUnit',
mediaTypes: {
video: {
context: 'instream',
playerSize: [640, 480],
mimes: ['video/mp4', 'video/x-ms-wmv']
protocols: [2,5],
maxduration:30,
linearity: 1,
api: [2]
}
},
bids: [{
bidder: 'rubicon',
params: {
accountId: '7780',
siteId: '87184',
zoneId: '413290',
video: {
language: 'en'
}
}
}]
};
```

This example adunit will also work Prebid.js 2.4 and earlier, but mimes, protocols, maxduration, linearity, and api are not required.

We recommend discussing video demand with your Rubicon Project account representative.

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:

##### api

+ `1` : VPAID 1.0
+ `2` : VPAID 2.0
+ `3` : MRAID 1.0
+ `4` : ORMMA
+ `5` : MRAID 2.0
+ `6` : MRAID 3.0

##### linearity
+ `1` : Linear / In-Stream
+ `2` : Non-Linear / Overlay

##### protocols
+ `1` : VAST 1.0
+ `2` : VAST 2.0
+ `3` : VAST 3.0
+ `4` : VAST 1.0 Wrapper
+ `5` : VAST 2.0 Wrapper
+ `6` : VAST 3.0 Wrapper
+ `7` : VAST 4.0
+ `8` : VAST 4.0 Wrapper
+ `9` : DAAST 1.0
+ `10` : DAAST 1.0 Wrapper


#### Outstream Video

Rubicon Project supports outstream video with these restrictions:

* The publisher must [provide their own renderer](/dev-docs/show-outstream-video-ads.html#renderers).
* 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.

### Configuration

Expand Down