VPAID 2.0 Creative Guidelines

These basic guidelines are intended to help developers create VPAID compliant SWFs.

If you need more detailed information you can find it on the IAB website at http://www.iab.net/media/file/VPAID_2.0_Final_04-10-2012.pdf.

Note: We have successfully tested these tags in the JWPlayer. If you are running them in another player, and have trouble, we recommend that you contact the support team for the player first.

How VPAID Works

The VPAID standard specifies an interface between video players and ad units, enabling a rich interactive in-stream ad experience. When the VPAID creative is delivered by an ZEDO AdServer, the player initiates interaction by calling the handshakeVersion() method and then the initAd() method. The user interactions with the ad unit (e.g. expand, collapse etc.) are generally captured using listeners and communicated to the player.

Preliminary Requirements

  • VPAID creative must have IVPAID interface implemented.
    • This tells the player that the underlying SWF file is VPAID compliant.
    • The animation portion of the VPAID creative should be in a movieClip with a unique instance name.

The creative should be tested in a VPAID 2.0 compliant video player. If the IVPAID interface has been implemented, the creative should render correctly. Kindly make a note that VPAID 2.0 ad unit interaction experience with the video players having non-standard and customized solutions may not be seamless. The sample code provided in this guide was tested with JW Player with an OVA plugin.

Guidelines for adding functionality to the VPAID creative

clicktag button functionality



function():void {

if (root.loaderInfo.parameters.clickTAG.substr(0,4) == “http”) {

navigateToURL(new URLRequest(root.loaderInfo.parameters.clickTAG));




Expand button functionality

expandbtn.addEventListener(MouseEvent.CLICK,function():void {

dispatchEvent(new Event(“customEventexpandAd”, true));



close button functionality

closebtn.addEventListener(MouseEvent.CLICK,function():void {

dispatchEvent(new Event(“customEventCloseAd”, true));



Compiling instructions

Once the .fla file is compiled, the output should be a .swf.

  • For example, if we compile SampleVPAID_Linear.fla, the output should be SampleVPAID_Linear.swf


  1. Traffic the file in ZEDO.
  2. Create Ad >> VAST Compatible tab >> Linear >> upload VPAID File.
  3. Generate a VAST ad tag from Ad Tag Generator and
  4. Test the tag in your player.

More detailed and comprehensive VPAID 2.0 guidelines are available on IAB website at http://www.iab.net/media/file/VPAID_2.0_Final_04-10-2012.pdf.

1 0