Skip to content
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.

Sign up for GitHub

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

SOVRN - Video parameters and examples #3493

Merged
merged 6 commits into from
Mar 10, 2022
Merged

SOVRN - Video parameters and examples #3493

Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
3d93aca
EX-3450 Create Sovrn docs on how to use prebid video
Dec 9, 2021
ca5685a
EX-3450 Add all supported fields for video ad
Dec 23, 2021
cb15819
EX-3450 Fix table
Dec 23, 2021
5251dcb
EX-3450: Remove incorrect iOS information
Jan 7, 2022
c582abf
EX-3450: PR update
Jan 18, 2022
342e68e
SOVRN: PR update
Mar 9, 2022
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
158 changes: 158 additions & 0 deletions dev-docs/bidders/sovrn.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,7 @@ schain_supported: true
gvl_id: 13
floors_supported: true
fpd_supported: true
media_types: banner, video
---

### Bid Params
Expand All @@ -22,3 +23,160 @@ fpd_supported: true
|------------|----------|----------------------|------------|----------|
| `tagid` | required | The sovrn Ad Tag ID | `'315045'` | `string` |
| `bidfloor` | optional | Bid floor in dollars | `'0.04'` | `string` |

Bid Params for video ads. These params should be added to `mediatype.video`.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please add a note indicating that these video parameters go in mediatype.video rather than your bidder-specific params.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Done

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Sorry to be picky, but please move 'These params should be added to mediatype.video.' out of the heading level 3. That will make the formatting rather awkward.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@bretg Is this what you were looking for?

{: .table .table-bordered .table-striped }
| Name | Scope | Description | Example | Type |
|------------------|----------|--------------------------------------------------------------------------------------------------------------------------------|-----------------|-----------------|
| `mimes` | required | Content MIME types supported | `['video/mp4']` | `string array` |
| `minduration` | required | Minimum video ad duration in seconds | `5` | `integer` |
| `maxduration` | required | Maximum video ad duration in seconds | `10` | `integer` |
| `protocols` | optional | The array of supported video protocols | `[1, 2]` | `integer array` |
| `w` | optional | Width of the video player in device independent pixels (DIPS) | `5` | `integer` |
| `h` | optional | Height of the video player in device independent pixels (DIPS) | `5` | `integer` |
| `startdelay` | optional | Indicates the start delay in seconds for pre-roll, mid-roll, or post-roll ad placements | `5` | `integer` |
| `placement` | optional | Placement type for the impression. Refer to List 5.9 | `5` | `integer` |
| `linearity` | optional | Indicates if the impression must be linear, nonlinear, etc. Allowed by default | `0` | `integer` |
| `skip` | optional | Indicates if the player will allow the video to be skipped, where 0 = no, 1 = yes | `0` | `integer` |
| `skipmin` | optional | Only if the ad is skippable. Videos of total duration greater than this number of seconds can be skippable | `5` | `integer` |
| `skipafter` | optional | Only if the ad is skippable. Number of seconds a video must play before skipping is enabled | `5` | `integer` |
| `sequence` | optional | For multiple ad in the same bid request. This value allow will for the coordinated delivery of multiple ad | `5` | `integer` |
| `battr` | optional | Blocked creative attributes | `[1]` | `integer array` |
| `maxextended` | optional | Max extended ad duration beyond the maxduration if extension is allowed. Blank or 0 - blocked. -1 - allowed without time limit | `5` | `integer` |
| `minbitrate` | optional | Minimum bit rate in Kbps | `5` | `integer` |
| `maxbitrate` | optional | Maximum bit rate in Kbps | `5` | `integer` |
| `boxingallowed` | optional | Indicates if letter-boxing of 4:3 content into a 16:9 window is allowed, where 0 = no, 1 = yes | `5` | `integer` |
| `playbackmethod` | optional | Playback methods that may be in use. See [Video Playback Methods](#video-playback-methods) | `[1]` | `integer array` |
| `playbackend` | optional | The event that causes playback to end. Refer to Playback Cessation Modes | `5` | `integer` |
| `delivery` | optional | Supported delivery methods (1 = streaming, 2 = progressive, 3 = download). If none specified, assume all are supported. | `[1, 2]` | `integer array` |
| `pos` | optional | Ad position on screen. Refer to [Ad Position](#ad-position) | `5` | `integer` |
| `api` | optional | List of supported API frameworks for this impression. Refer to [API Frameworks](api-frameworks) | `[1, 2, 3]` | `integer array` |


### Note

[Protocols list](https://docs.prebid.org/dev-docs/bidders/conversant.html#protocols)
Copy link
Contributor

@bretg bretg Mar 10, 2022 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I find it confusing that you're referring to Conversant's protocols but copy all the rest of the dimensional values here. But this has been open for so long, I'll merge this and let you decide whether you want to fix.


#### MIME types:

##### With VPAID2:

video/mp4,
video/3gpp,
application/javascript

##### Without VPAID2:

video/mp4,
video/3gpp

#### Video Playback Methods:

{: .table .table-bordered .table-striped }
| Value | Description |
|-------|----------------------------------------------------------|
| `1` | Initiates on Page Load with Sound On |
| `2` | Initiates on Page Load with Sound Off by Default |
| `3` | Initiates on Click with Sound On |
| `4` | Initiates on Mouse-Over with Sound On |
| `5` | Initiates on Entering Viewport with Sound On |
| `6` | Initiates on Entering Viewport with Sound Off by Default |

#### Playback Cessation Modes:

{: .table .table-bordered .table-striped }
| Value | Description |
|-------|-----------------------------------------------------------------------------------------------------------|
| `1` | On Video Completion or when Terminated by User |
| `2` | On Leaving Viewport or when Terminated by User |
| `3` | On Leaving Viewport Continues as a Floating/Slider Unit until Video Completion or when Terminated by User |

#### Ad Position:

{: .table .table-bordered .table-striped }
| Value | Description |
|-------|----------------|
| `0` | Unknown |
| `1` | Above the Fold |
| `2` | DEPRECATED |
| `3` | Below the Fold |
| `4` | Header |
| `5` | Footer |
| `6` | Sidebar |
| `7` | Full Screen |

#### API Frameworks:

{: .table .table-bordered .table-striped }
| Value | Description |
|-------|-------------|
| `1` | VPAID 1.0 |
| `2` | VPAID 2.0 |
| `3` | MRAID-1 |
| `4` | ORMMA |
| `5` | MRAID-2 |
| `6` | MRAID-3 |

Source: [OpenRTB scpecification](https://www.iab.com/wp-content/uploads/2016/03/OpenRTB-API-Specification-Version-2-5-FINAL.pdf)

### Example

#### Video instream adUnit

```
var instreamAdUnit = {
code: 'instream-div',
sizes: [[640, 480]],
mediaTypes: {
video: {
mimes: ['video/mp4'],
minduration: 4,
maxduration: 6,
context: 'instream'
}
},
bids: [{
bidder: 'sovrn',
params: {
tagid: '315045'
}
}]
}
```
#### Video outstream adUnit

```
var outstreamAdUnit = {
code: 'outstream-div',
sizes: [[640, 480]],
mediaTypes: {
video: {
mimes: ['video/mp4'],
minduration: 4,
maxduration: 6,
context: 'outstream'
}
},
bids: [{
bidder: 'sovrn',
params: {
tagid: '315045'
}
}]
},
```
#### Banner adUnit

```
var bannerAdUnit = {
code: 'banner-div',
sizes: [[300, 250]],
bids: [{
bidder: 'sovrn',
params: {
tagid: '315045'
}
}]
}
```