VPAID ads

Documentation sections

• VPAID definition and scope of support
• VPAID player setting
• VPAID player API

VPAID definition and scope of support

VPAID stands for Video Player Ad-Serving Interface Definition. It is a specification developed by the Interactive Advertising Bureau (IAB) which defines how an ad unit and a video player can interact with one another. VPAID add a new dimension to the VAST standard as it enables true engagement and interactivity with the ad viewer. VPAID is built on top of VAST and allows a video player to display rich interactive media ads (JavaScript executable ad unit for example).

Radiant Media Player supports the following types of VPAID ads in HTML5 video:

• JavaScript VPAID 1 & 2 creatives

VPAID ads are supported with both the IMA SDK and rmp-vast.

In mid-2019, the IAB introduced a successor to VPAID: SIMID. We support SIMID ads with our Google IMA integration.

VPAID player setting

adVpaidMode: String

This setting applies only to the IMA SDK. A set of constants for enabling VPAID functionality with HTML5 video. Default: 'insecure'. Other accepted values are 'disabled' and 'enabled'.

• 'insecure' means VPAID is enabled. The VPAID ad will load in a friendly iframe. This allows the ad access to the site via javascript.
• 'enabled' means VPAID is enabled using a cross domain iframe. The VPAID ad cannot access the site. VPAID ads that depend on friendly iframe access may not play.
• 'disabled' means VPAID is disabled. VPAID ads will be discarded when requested. An aderror event will be raised when this happens and content should resume.

See here for more information on the subject.

adVpaidControls: Boolean

By default the player does not show any controls when a linear VPAID ad is shown. It is expected that the VPAID ad would provide those controls if any are required. This setting lets you forces the display of controls during the display of linear VPAID ads. Only set adVpaidControls to true if required to support a specific use-case. Default: false.

adRmpVastEnableVpaid: Boolean

This setting applies only to rmp-vast. Enables support for VPAID ads in rmp-vast. Default: true.

VPAID player API

The general video ads API for the IMA SDK or rmp-vast can be used to control VPAID creatives. In addition the following method is available:

isVpaidCreative()

rmp.isVpaidCreative();

This method returns a Boolean stating if the creative on stage is a JavaScript VPAID creative or not. It should be queried when the adstarted event fires.