Packagese.videoplaza.kit.api
Classpublic class Ad

Wrapper for an Ad object passed by the Adplayer.


Example
 var beforeLinear:Function = function(ads:Array, resume:Function):void {
     for each(var adObj:Object in ads) {
         //Loop over the ads and gather whatever information you need
         //Wrap the passed object in an Ad object:
         var ad:Ad = new Ad(adObj);
     }
  //Let the Adplayer know you're done:
     resume();
 }
 adplayerWrapper.beforeLinearCallback = beforeLinear;  

 



Public Properties
 PropertyDefined by
  campaignId : String
[read-only] Ooyala Pulse campaign id.
Ad
  companions : Array
[read-only] An Array of companions.
Ad
  customCampaignId : String
[read-only] User configurable campaign id configured in Ooyala Pulse
Ad
  customGoalId : String
[read-only] User configurable goal id configured in Ooyala Pulse
Ad
  customId : String
[read-only] User configurable ad id configured in Ooyala Pulse
Ad
  goalId : String
[read-only] Ooyala Pulse goal id
Ad
  id : String
[read-only] Ooyala Pulse ad id
Ad
  survey : String
[read-only] Survey vendor URI, as defined in IAB Video Ad Serving Template (VAST) 2.0.
Ad
  type : String
[read-only] Currently supported adTypes:
   Ad.INVENTORY
   Ad.SPOT_STANDARD
   Ad.SPOT_INTERACTIVE
   Ad.SPOT_SELECTOR
   Ad.SPOT_TAKEOVER
   Ad.OVERLAY_STANDARD
   Ad.OVERLAY_VIDEO
   Ad.OVERLAY_IMAGESET
   Ad.OVERLAY_SPLASH
   Ad.SKIN_INSKIN
   Ad.SPLASH_STANDARD
   Ad.PASSBACK 
   
Ad
  variant : String
[read-only] The ad variant.
Ad
Public Methods
 MethodDefined by
  
Ad(adObject:Object)
Constructor.
Ad
Public Constants
 ConstantDefined by
  INVENTORY : String = "inventory"
[static]
Ad
  OVERLAY_IMAGESET : String = "overlay_imageset"
[static]
Ad
  OVERLAY_SPLASH : String = "overlay_splash"
[static]
Ad
  OVERLAY_STANDARD : String = "overlay_standard"
[static]
Ad
  OVERLAY_VIDEO : String = "overlay_video"
[static]
Ad
  PASSBACK : String = "passback"
[static]
Ad
  SKIN_INSKIN : String = "skin_inskin"
[static]
Ad
  SPLASH_STANDARD : String = "splash_standard"
[static]
Ad
  SPOT_INTERACTIVE : String = "spot_interactive"
[static]
Ad
  SPOT_SELECTOR : String = "spot_selector"
[static]
Ad
  SPOT_STANDARD : String = "spot_standard"
[static]
Ad
  SPOT_TAKEOVER : String = "spot_takeover"
[static]
Ad
Property detail
campaignIdproperty
campaignId:String  [read-only]

Ooyala Pulse campaign id.

Implementation
    public function get campaignId():String
companionsproperty 
companions:Array  [read-only]

An Array of companions.

Implementation
    public function get companions():Array

See also

customCampaignIdproperty 
customCampaignId:String  [read-only]

User configurable campaign id configured in Ooyala Pulse

Implementation
    public function get customCampaignId():String
customGoalIdproperty 
customGoalId:String  [read-only]

User configurable goal id configured in Ooyala Pulse

Implementation
    public function get customGoalId():String
customIdproperty 
customId:String  [read-only]

User configurable ad id configured in Ooyala Pulse

Implementation
    public function get customId():String
goalIdproperty 
goalId:String  [read-only]

Ooyala Pulse goal id

Implementation
    public function get goalId():String
idproperty 
id:String  [read-only]

Ooyala Pulse ad id

Implementation
    public function get id():String
surveyproperty 
survey:String  [read-only]

Survey vendor URI, as defined in IAB Video Ad Serving Template (VAST) 2.0.

Implementation
    public function get survey():String
typeproperty 
type:String  [read-only]

Currently supported adTypes:

   Ad.INVENTORY
   Ad.SPOT_STANDARD
   Ad.SPOT_INTERACTIVE
   Ad.SPOT_SELECTOR
   Ad.SPOT_TAKEOVER
   Ad.OVERLAY_STANDARD
   Ad.OVERLAY_VIDEO
   Ad.OVERLAY_IMAGESET
   Ad.OVERLAY_SPLASH
   Ad.SKIN_INSKIN
   Ad.SPLASH_STANDARD
   Ad.PASSBACK 
   

Implementation
    public function get type():String
variantproperty 
variant:String  [read-only]

The ad variant.

Implementation
    public function get variant():String

See also

Constructor detail
Ad()constructor
public function Ad(adObject:Object)

Constructor.

Parameters
adObject:Object — Object to wrap.
Constant detail
INVENTORYconstant
public static const INVENTORY:String = "inventory"
OVERLAY_IMAGESETconstant 
public static const OVERLAY_IMAGESET:String = "overlay_imageset"
OVERLAY_SPLASHconstant 
public static const OVERLAY_SPLASH:String = "overlay_splash"
OVERLAY_STANDARDconstant 
public static const OVERLAY_STANDARD:String = "overlay_standard"
OVERLAY_VIDEOconstant 
public static const OVERLAY_VIDEO:String = "overlay_video"
PASSBACKconstant 
public static const PASSBACK:String = "passback"
SKIN_INSKINconstant 
public static const SKIN_INSKIN:String = "skin_inskin"
SPLASH_STANDARDconstant 
public static const SPLASH_STANDARD:String = "splash_standard"
SPOT_INTERACTIVEconstant 
public static const SPOT_INTERACTIVE:String = "spot_interactive"
SPOT_SELECTORconstant 
public static const SPOT_SELECTOR:String = "spot_selector"
SPOT_STANDARDconstant 
public static const SPOT_STANDARD:String = "spot_standard"
SPOT_TAKEOVERconstant 
public static const SPOT_TAKEOVER:String = "spot_takeover"