Integrating VPAID Ads with Player V3

Overview

The following documentation describes the VPAID integration with Player V3. For documentation on the VPAID integration with Player V4, see VAST and VPAID Ad Plugin.

The V3 Ooyala player supports VPAID, allowing you to integrate VPAID ads with your player. The Interactive Advertising Bureau (IAB) defines VPAID (Video Player Ad-Serving Interface Definition) as a standard that "establishes a common interface between video players and ad units, enabling a rich interactive in-stream ad experience." Go to http://www.iab.com/guidelines/digital-video-player-ad-interface-definition-vpaid-2-0/ for more details on VPAID.

You have two options for associating the VPAID ad module with the Ooyala V3 Flash desktop player:

  1. Via Backlot ad sets. Create ad sets with the Backlot UI or API.
  2. Via player embedded parameters. Specify embedded parameters at the page level of the player.
Each of these options is described below.
Note: The VAST ad set can't handle VPAID creative, and VPAID ads module can't handle VAST responses.

Known Issues

For Flash, the Google DFP ad server sometimes returns an empty VPAID tag for DoubleClick ads. Per Google, this is a problem on the ad server side (DFP). On the DFP side, frequency capping can be applied to control how often an ad would serve. Please work with Google IMA on how to correctly set up ad serving to prevent this from happening.

Prerequisites

Before you can use Ooyala's VPAID ad module integration, you need to log into the Customer Portal and submit a ticket requesting to add the VPAID ad source to your account. Once the ad source is enabled you'll be able to create ad sets for VPAID.

Step 1: Create an Ad Set with Backlot

For VPAID ads, you always need to create an ad set in Backlot. You can create a VPAID ad set with the Backlot UI or Backlot API.

Backlot UI: For instructions on how to create an ad set using the Backlot UI, see Creating Ad Sets for Integrating with Ad Sources.

Backlot API: For instructions on how to create an ad set with the Backlot API, see Ad Sets.

The required ad set fields for creating a VPAID ad set are:
  • Ad Set name: A name for the ad set.
  • Ad Tag: The VPAID tag.
Note: The Tracking Pixel URL field is not relevant for the VPAID ad module integration. Leave this field blank.

Step 2: Assign the Ad Set to an Asset with Backlot or the Player API

Assign an ad set to an asset or multiple assets using the Backlot UI, Player API, or Backlot API.

Backlot UI: For instructions on how to assign your VPAID ad set to a single asset, see Managing Monetization. For instructions on how to assign your VPAID ad set to multiple assets, see Bulk Applying Settings.

Player API: With the Player API you can only associate an ad set with an asset on your web page. To associate an ad set with an asset on multiple players you must replicate the code for each player. To associate an ad set with an asset using the Player API, see Assigning Ad Sets Dynamically.

Backlot API: With the Backlot API you can associate an ad set with an asset more concretely. That is, when you associate an asset with an ad set using the Backlot API the asset and the ad set will be paired together on any player and page you play the asset on. To associate an asset with an ad set using the Backlot API, see Associate Ad Set with Asset.

(Optional) Step 3: Specify Player Embedded Parameters

You can optionally specify player embedded parameters for VPAID ads.
  1. Use the Player V3 OO.Player.create function to create the player. See Assigning an Ad Set with OO.Player.create for instructions on how to use OO.Player.create.
  2. Specify the ad set code from your Backlot ad set with the adSetCode parameter. See Assigning an Ad Set with OO.Player.create in Player V3 for instructions for how to retrieve your adSetCode.
    Note: The ad set code identifier is not available by default for security reasons. Please contact your Customer Success Manager or Technical Support to enable this feature for your account.
  3. Pass VPAID ad tags to the Ooyala player using the vpaid-ads-manager and adTag embedded parameters. adTag correlates with the Ad Tag field. vpaid-ads-manager is the parent of adTag and any other parameters you want to specify.
  4. Specify additional embedded parameters, such as showAdMarquee, as children of vpaid-ad-manager. For the full list of parameters you can use with vpaid, see VPAID Ads Embedded Parameters in Player V3.

The following is an example of creating the player and using the vpaid-ads-manager embedded parameter. When you implement this for your own players, you will need to change 'some url' to the actual VPAID Ad Tag.

var videoPlayer = OO.Player.create('playerwrapper','embed_code',{ 
    height:'100%',
    width:'100%',
    'vpaid-ads-manager':{ 
        adTag: 'some url' 
     }    
  }); 

Was this article helpful?