Video canvas
Overview
Formerly named "Smart Video-Screening". The "Video canvas" creative template displays a video ad in the background, expanding to full-screen mode on mouse over.
Demo
Compliancy
Criterion | Compliancy |
---|---|
Creative rotation | ✅ |
Friendly iFrame | ✅ |
Responsive web design | ✅ |
RTB | ❌ |
SIMID | ❌ |
VAST 4.2 and lower | ✅ |
VAST wrapper | ✅ |
Viewability counting (MRC standard) | ✅ |
VPAID | ✅ |
Creatives
- Creative #1: optional banner; supported file formats: image (use transparency for better effects), creative script, HTML5
- Creative #2: optional video; supported file formats: mp4, webm (use files with high resolution and bitrate) - or - any VAST redirect containing the formats: mp4, ogg, webm, javascript (for VPAID only)
- Creative #3: optional banner shown after close; supported file formats: image, creative script, HTML5
Equativ strongly recommends to use HD video files for this ad format.
Note 1: In case of VAST redirects, use the "Paste script" creation method and paste the URL or the entire XML into the "Creative script" field.
Note 2: If the first or third creative is an creative script or HTML5, make sure you specify the size
Note 3: If there is no third creative, the first creative will be displayed after close
Note 4: To get the behavior shown in this sample (transparent banner), add the first creative as a creative script and specify the width and height; then add the following code to make it transparent
<div style="width:750px;height:200px"></div>
Note 5: To avoid showing the banner after close (third creative), add the third creative as an empty creative script and set its width and height to 0.
Note 6: In case of VAST redirects, the ad format picks the most appropriate file to play according to the following priorities: (1) mp4, (2) webm, (3) ogg, (4) javascript
Creative template parameters
Name | Description | Default value |
---|---|---|
Options | ||
Place of ad | Specifies where the ad should be placed | top |
Tracking url | Make sure you add [timestamp] to the URL for cache busting |
|
zIndex | zIndex of the expanded video; max. value: 999999999 | 9999 |
Player controls options | ||
Background vertical offset | Specifies the vertical offset of the background video, positive number: to the bottom; number with "-": to the top | 0 |
Background video opacity | Specifies the opacity of the video background | 0.8 |
Controls bar mode | Specifies the bar mode | FLOATING |
Controls bar opacity | Specifies the opacity of the control bar | 0.5 |
Duration label | Specifies the duration label; Note: Use {0} in label to count down the time until the end of the ad | End of break ad in {0}s |
Loop video | Specifies if the video will be looped; this option is taken into account only for the video in background mode; in fullscreen mode, the video will not be looped | false |
Pause on tab changing | Stops the video while changing browser tabs | true |
Player controls color | Specifies controls color | #cccccc |
Player play/pause button | Specifies if the player has play/pause buttons | true |
Player volume button | Specifies if the player has a volume button | true |
Video starts from beginning in expand mode | Specifies if the video starts from the beginning in expand mode | true |
Close button options | ||
Close button font size | Specifies the size of the close font (in px) | 14 |
Close button link color | Specifies the close link color | #cccccc |
Close button position | Specifies the position of the close button | topRight |
Close button text | Can be text and HTML | |
Default close button image | Specifies if the default close button image appears | true |
Show close button at the beginning | Shows the close button also before expand mode | false |
Start expand options | ||
Click starts expand | Specifies if click starts expand | false |
Hover over banner starts expand | Specifies if hover over the banner starts counting to expand | true |
Click map options | ||
Click map height (right and left side) | Specifies the click map height for both sides | 1000 |
Click map horizontal offset | Specifies the horizontal offset of the click map; positive value: to the right side; value with "-": to the left side | 0 |
Click map vertical offset | Specifies the vertical offset of the click map; positive value: to the bottom; value with "-": to the top | 0 |
Click map width (right and left side) | Specifies the click map width for both sides | 5000 |
Click map zIndex | Specifies the zIndex of the click map | 9999 |
Page width | Specifies the page width to use the click map feature | 0 |
Show click map test border line | Show border line over the clickmap; this option is supposed to help with the setup of the click map position | false |
Features
Event listening
The Video canvas supports the following events: adBegin
, adDuration
, adEnd
and adError
. You can listen to these events to control the functioning of your site. Any event contains the parameter formatId
to get which formatId (on the page) fired the event:
window.addEventListener('adBegin', function (e) {
console.log(e.formatId);
});
adBegin / adEnd
For instance, if your website has a video player playing video content, you can mute that player when the ad appears and unmute when it disappears:
window.addEventListener('adBegin', function (e) {
document.querySelector('video').muted = true;
});
adDuration
The adDuration
provides access to the videoDuration
property, which can be useful to retrieve the duration of the whole video ad:
window.addEventListener('adDuration', function (e) {
console.log(e.videoDuration);
});
adError
To take an action when there is an error or the VAST is empty:
window.addEventListener('adError', function (e) {
console.log("Ad error occured");
});
Force VPAID media files
To update media files selection and prioritize VPAID creatives the sasVpaidFirst variable can be used with a value of true. The below snippet can be added as a custom script:
<script> sasVpaidFirst = true; </script>
Metrics
The player and data logging start immediately. The Equativ visibility events always have a value of 100. Equativ logs the "fullscreen" event when the user goes to fullscreen mode. Also see the Report metric reference article.
Limitations
- works for web only (no mobile web supported!)
- IE 10, 9, 8 are not supported anymore
Known issues
n/a
Release notes
- 2024-09-25 - Add support for OMSDK
- 2024-01-24 - Removed support for obsolete macros
- 2023-04-05 - Update sas-libs version to 1.1
- 2023-03-27 - Select the most appropriate creative encoded version based on bandwidth and resolution
- 2020-05-13 - Remove start muted custom parameter
- 2019-03-25 - Hide player controls in non-expand mode
- 2019-02-05 - Viewability module improvements - Measures are now more accurate and more integrations are covered
- 2018-10-15 - Fix for creatives as creative script
- 2018-07-02 - Removed support for flash video creatives
- 2018-04-25 - Parse RTB parameters into strings
- 2018-03-06 - Additional RTB parameters in event trackers
- 2018-02-19 - Enable viewability counting by default
- 2018-01-30 - Updated tracking urls
- 2018-01-22 - Updated meta parameters
- 2017-12-20 - Code refactoring + VAST4 support
- 2017-08-24 - Add click map
- 2017-08-16 - Support for standalone tag
- 2017-06-28 - Support for tagId ad call parameter