Sovrn Video Fields and Parameters
Many of the fields below are non-essential, but are included to offer further controls over your video ad units with Sovrn when needed.
Note: Publishers that utilize Prebid for video ads can rely on the Sovrn Adapter Page in Prebid to see much more information than what is included in this article.
Generally speaking, if you send Sovrn information about your video ad units from the oRTB spec, we will capture that information and pass it along to our demand partners. This includes the parameters listed below, as well as the full list from this spec sheet (specifically from section 3.2.7).
The presence of a Video as a subordinate of the Imp object indicates that this impression is offered as a video type impression. That same impression can also be offered as a banner by also including Imp subordinates objects of those types.
However, any given bid for the impression must conform to one of the offered types:
Attribute | Type | Description |
|---|---|---|
mimes | string array; required | Content MIME types supported (examples: "video/x-ms-wmv", "video/mp4") |
minduration | integer; recommended | Minimum video ad duration in seconds |
maxduration | integer; required | Maximum video ad duration in seconds. |
protocols | integer array; required | Array of supported video protocols (examples: VAST 2.0, VAST 4.0, VAST 4.0 Wrapper) |
w | integer; required | Width of the video player in device independent pixels (DIPS) |
h | integer; required | Height of the video player in device independent pixels (DIPS) |
placement | integer; recommended | Placement type for the impression |
api | integer array; recommended | List of supported API frameworks for this impression |
pos | integer; recommended | Ad position on screen |
start delay | integer; recommended | Indicates the start delay in seconds for pre-roll, mid-roll, or post-roll ad placements |
linearity | integer; optional | Indicates if the impression must be linear, nonlinear, etc. |
battr | integer array; optional | Blocked creative attributes |
playback method | integer array; optional | Playback methods that may be in use. If none are specified, any method may be used |
sequence | integer; optional | If multiple ad impressions are offered in the same bid request, the sequence number will allow for the coordinated delivery of multiple creatives |
skip | integer; optional | Indicates if the player will allow the video to be skipped, where 0 = no, 1 = yes |
skipmin | integer; optional | Videos of total duration greater than this number of seconds can be skippable; only applicable if the ad is skippable. Default value is 0 |
skipafter | integer; optional | Number of seconds a video must play before skipping is enabled; only applicable if the ad is skippable Default value is 0 |
maxextended | integer; optional | Maximum extended ad duration if extension is allowed. If blank or 0, extension is not allowed. If -1, extension is allowed, and there is no time limit imposed. If greater than 0, then the value represents the number of seconds of extended play supported beyond the maxduration value. |
minbitrate | integer; optional | Minimum bit rate in Kbps. |
maxbitrate | integer; optional | Maximum bit rate in Kbps |
boxing allowed | integer; optional | Indicates if letter-boxing of 4:3 content into a 16:9 window is allowed 0 = no, 1 = yes. Default value is 1 |
playback method | integer array; optional | Playback methods that may be in use. If none are specified, any method may be used. |
playback end | integer; optional | The event that causes playback to end. |
delivery | integer array; optional | Supported delivery methods (e.g., streaming, progressive). If none specified, assume all are supported. |
protocols
The following table lists the options for various bid response protocols that are supported by Sovrn.
Value | Description |
|---|---|
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 |
startdelay
The following table lists the various options for the video or audio start delay. If the start delay value is greater than 0, then the position is mid-roll and the value indicates the start delay.
We recommend that you use this field for optimal video ad spend.
Value | Description |
> 0 | Mid-Roll (value indicates start delay in seconds) |
0 | Pre-roll |
-1 | Generic Mid-Roll |
-2 | Generic Post-Roll |
linearity
The following table indicates the options for video linearity. "In-stream" or "linear" video refers to preroll, post-roll, or mid-roll video ads where the user is forced to watch ad in order to see the video content.
"Overlay" or "non-linear" refers to ads that are shown on top of the video content.
Value | Description |
|---|---|
1 | Linear / In-stream |
2 | Non-Linear / Overlay |
placement or plcmt
Note: Using “placement” for this object is currently supported, but using “plcmt” here is recommended. See more details under the Video Object in this article.
The following table lists the various types of video placements that you can send to Sovrn.
Value | Description |
|---|---|
1 | In-Stream: Played before, during or after the streaming video content that the consumer has requested (e.g., Pre-roll, Mid-roll, Post-roll) |
2 | In-Banner: Exists within a web banner that leverages the banner space to deliver a video experience as opposed to another static or rich media format. The format relies on the existence of display ad inventory on the page for its delivery. |
3 | In-Article: Loads and plays dynamically between paragraphs of editorial content; existing as a standalone branded message. |
4 | In-Feed: Found in content, social, or product feeds |
5 | Interstitial/Slider/Floating: Covers the entire or a portion of screen area, but is always on screen while displayed (i.e. cannot be scrolled out of view). Note that a full-screen interstitial (e.g., in mobile) can be distinguished from a floating/slider unit by the imp.instl field |
pos
The following table specifies the position of the video ad.
Value | Description |
|---|---|
0 | Unknown |
1 | Above the Fold |
3 | Below the Fold |
4 | Header |
5 | Footer |
6 | Sidebar |
7 | Full Screen |
api
The following table is a list of API frameworks that are commonly supported.
Value | Description |
1 | VPAID 1.0 |
2 | VPAID 2.0 |
3 | MRAID-1 |
4 | ORMMA |
5 | MRAID-2 |
6 | MARID-3 |
skip
If the video is skippable, the bid object should include the attr array, and should contain 16 for skippable video. See the battr table below for more information.
battr
The following table shows a standard list of creative attributes that Sovrn utilizes to allow or restrict specific ad types.
Value | Description |
|---|---|
1 | Audio Ad (Auto-Play) |
2 | Audio Ad (User Initiated) |
3 | Expandable (Automatic) |
4 | Expandable (User Initiated - Click) |
5 | Expandable (User Initiated - Rollover) |
6 | In-Banner Video Ad (Auto-Play) |
7 | In-Banner Video Ad (User Initiated) |
8 | Pop (e.g., Over, Under, or Upon Exit) |
9 | Provocative or Suggestive Imagery |
10 | Shaky, Flashing, Flickering, Extreme Animation, Smileys |
11 | Surveys |
12 | Text Only |
13 | User Interactive (e.g., Embedded Games) |
14 | Windows Dialog or Alert Style |
15 | Has Audio On/Off Button |
16 | Ad Provides Skip Button (e.g., VPAID-rendered skip button on pre-roll video) |
17 | Adobe Flash |
playbackmethod
The following table lists the various playback methods that Sovrn supports.
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 |
playbackend
The following table lists the various modes for when playback terminates.
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 |
Delivery
The following table lists the various options for the delivery of video or audio content.