VAST overlay
Overview
Formerly named "[VIDEO] VAST x - NONLINEAR". The "VAST overlay" creative template displays a non-linear VAST ad and optional companion creatives.
Demo
Check out Equativ’s video showcase to set up parameters and retrieve video ads.
Creative template parameters
| Name | Description | Default value | VAST 2.0* | VAST 3.0* | VAST 4.x* |
|---|---|---|---|---|---|
| AdParameters (VPAID) | Ad parameters for a VPAID creative. Expected format is: string | ✅ |
✅ |
✅ |
|
| Automatically fill missing clickthrough URLs | If there is no clickthrough URL defined for a given creative, the clickthrough URL from another creative will be used. | true | ✅ |
✅ |
✅ |
| Custom click-tracking for companion creatives | A custom tracking URL fired when a click occurs on the companion creative. Use "||" to separate multiple URLs (no white spaces). | ❌ |
✅ |
✅ |
|
| Custom click-tracking for non-linear creatives | A custom tracking URL fired when a click occurs on the non-linear creative. Use "||" to separate multiple URLs (no white spaces). | ❌ |
✅ |
✅ |
|
| Custom impressions | You can supply a single custom impression URL or a list of custom impression URLs. Use "||" to separate multiple URLs (no white spaces). | ✅ |
✅ |
✅ |
|
| Custom VAST impression-tracking for notViewable | A custom tracking URI that the video player should trigger if the ad is executed but does not meet the criteria for a viewable impression. Several URLs can be supplied using the "||" separator (no white spaces) | ❌ |
❌ |
✅ |
|
| Custom VAST impression-tracking for viewUndetermined | A custom tracking URI that the video player should trigger if it cannot determine whether the criteria for a viewable impression are met. Several URLs can be supplied using the "||" separator (no white spaces) | ❌ |
❌ |
✅ |
|
| Custom VAST impression-tracking for viewable | A custom tracking URI that the video player should trigger at the time the criteria for a viewable impression are met. Several URLs can be supplied using the "||" separator (no white spaces) | ❌ |
❌ |
✅ |
|
| Custom VAST Tracking for VAST [tracking_event] | a custom reporting URL for the VAST [tracking_event]. Several URLs can be provided using the "||" separator. The list of tracking events is available in the VAST specifications. | ✅ |
✅ |
✅ |
|
| ExecutableResource's apiFramework, type and URL | Values of the apiFramework and type attributes together with the URL of the ExecutableResource element. Provide the values following this pattern: apiFramework, type, URL. | ❌ |
❌ |
✅ |
|
| Expected duration | The duration of the creative. Expected format: HH:MM:SS | 00:00:30 | ✅ |
✅ |
✅ |
| ID (advEntityId) provided by IAS |
Dedicated ID (advertisingEntityId) used in Video Ad Network Solution (VANS) provided by Integral Ad Science (IAS). This ID is used when integrating the Firewall (FW) solution dedicated to advertisers/agencies. FW technology can block the ad's display if the impression does not respect brand-safety thresholds and fraud criteria defined for this campaign in the VANS interface. For more information refer to Integralads. Both advEntityId and pubEntityId are required in FW integration. |
✅ |
✅ |
✅ |
|
| ID (pubEntityId) provided by IAS |
Dedicated ID (pubEntityId) used in Video Ad Network Solution (VANS) provided by Integral Ad Science (IAS). This ID is used when integrating the Firewall (FW) solution dedicated to advertisers/agencies. FW technology can block the ad's display if the impression does not respect brand-safety thresholds and fraud criteria defined for this campaign in the VANS interface. For more information, refer to Integralads. Both advEntityId and pubEntityId are required in FW integration. |
✅ |
✅ |
✅ |
|
| Is ad conditional |
In case of programmatic video ad serving, a VPAID ad unit might be used to decide whether there is an ad that matches the placement. When there is no match, an ad may not be served. With this parameter, publishers can avoid accepting these ads in placements where an ad must be served. A value of true indicates that the ad is conditional and should be used in all cases where the inline executable unit (such as VPAID) is not an ad but is instead a framework for finding an ad. A value of false indicates that an ad is available. |
false | ❌ |
❌ |
✅ |
| JavaScriptResource's apiFramework and URL | Values of the apiFramework attribute and the URL of the JavaScriptResource element; provide the values following this pattern: apiFramework, URL. | ❌ |
❌ |
✅ |
|
| Progress offset | Available formats: "HH:MM:SS" / "HH:MM:SS.mmm" / "n%”. One offset format can be supplied. Only available for VAST 3 version | ❌ |
✅ |
❌ |
|
| Required attribute for the element | Provides information about which companion creative to display when multiple companions are provided and about whether the ad can be displayed without its companion creative. | all | ❌ |
✅ |
✅ |
| Show pricing | If checked, the rate of the insertion in the publisher's currency is passed in the VAST <Pricing> node. Since the “flat fee” pricing model is not supported in the VAST protocol, the node is not added for such an insertion. | false | ❌ |
✅ |
✅ |
| Slots for companion ads | A list of companion slots. For instance: "div_1||div_2||div_3". The sorting should be the same as the companion creatives in the list. Use "||" to separate multiple slots (no white spaces). | ❌ |
✅ |
✅ |
|
| URLs for custom errors | A custom error URL that will be placed in the <Error> node of the VAST response. Starting from VAST 4.x, several URLs can be added using the "||" separator. |
✅ |
✅ |
✅ |
|
| Verification parameters | A string intended for bootstrapping the verification code and providing metadata about the current impression. | ❌ |
❌ |
✅ |
|
| Verification Tracking URLs | A reporting URL for the verificationNotExecuted event. Several URLs can be provided using the "||" separator (no white spaces). | ❌ |
❌ |
✅ |
|
| Verification vendor | An identifier for the verification vendor. Note: add the vendor name if you want the AdVerifications node to be included in a VAST response file. | ❌ |
❌ |
✅ |
* Indicates in which VAST version the given parameter is available; see also "VAST version management" below.
Features
VAST version management
The "VAST overlay" creative template supports all VAST versions. For proper VAST version management, it is mandatory that the publisher's player passes the highest VAST version it supports in the ad request, using the out= parameter. Based on the passed VAST version, the creative template will automatically leverage only the parameters supported by the given version. Possible values of the out parameter:
out=vast2out=vast3out=vast4out=vast4.1out=vast4.2
Non-linear and companion ads
Equativ will consider creatives with the following mime types as <NonLinear> ads:
- image/jpeg (StaticResource)
- image/pjpeg (StaticResource)
- image/png (StaticResource)
Equativ will consider creatives with the following mime types as <Companion> ads:
- application/javascript (StaticResource)
- application/x-javascript (StaticResource)
- Creative script (HTMLResource)
- HTML5 (IFrameResource)
Limitations
n/a
Known issues
n/a
Release notes
- 03-04-2025 - Added “Show pricing” parameter that returns rate type, rate and currency of the insertion in pricing node.
- 05-01-2024 - remove UniversalAdId parameter
-
02-08-2023
- replace Smart by Equativ in AdSystem node
- added an additional identifier to Creative nodes and a new identifier based on insertion and creative to Ad nodes
- 29-06-2023 - replace [sas_smartBaseUrl] with [sas_pixelDomain]
- 02-03-2023 - added vastResponseType meta parameter
- 05-10-2022 - removed "Use custom VAST metrics" checkbox
- 21-07-2020 - added AdVerifications node parameters