Core SDK API Documentation

Class: Ad

Ad

Ad is a representation of an ad. Do not construct: instances are created internally.

Members

<static> AdType :string

Indicates the type or format of an Ad.

Type:
  • string
Properties:
Name Type Default Description
INVENTORY string inventory
SPOT_STANDARD string spot_standard
SPOT_INTERACTIVE string spot_interactive
SPOT_SELECTOR string spot_selector
SPOT_TAKEOVER string spot_takeover
SPOT_IPTV string spot_iptv
OVERLAY_STANDARD string overlay_standard
OVERLAY_VIDEO string overlay_video
OVERLAY_IMAGESET string overlay_imageset
OVERLAY_SPLASH string overlay_splash
SPLASH_STANDARD string splash_standard
SKIN_INSKIN string skin_inskin

<static> Variant :string

Indicates the variant of an ad.

Type:
  • string
Properties:
Name Type Default Description
NORMAL string normal
SPONSOR string sponsor

ads :Array.<videoplaza.adresponse.Ad>

List of Ads. Used for nested ads found in the Selector Ad format, or in Passback Ads where every ad candidate is listed.

Type:

advertiser :string

The advertiser of the ad.

Type:
  • string

allowLinearityToChange :boolean

Whether or not the ad can change linearity or not.

Type:
  • boolean

campaignId :string

The id of the campaign to which the ad belongs; supplied by Pulse.

Type:
  • string

categories :Array.<videoplaza.adresponse.Ad.AdCategory>

Contains information on ad categories.

Type:
  • Array.<videoplaza.adresponse.Ad.AdCategory>

companions :Array

List of Companions in the ad.

Type:
  • Array

conditional :boolean

Specifies whether or not an ad unit is marked as conditional, meaning it cannot be guaranteed to result in ad playback. If null, it means the conditional state if the ad is unknown.

Type:
  • boolean

creatives :Array.<videoplaza.adresponse.LinearCreative>

List of linear creatives contained in the ad.

Type:

customCampaignId :string

The custom id of the campaign to which the ad belongs; set in the Pulse UI.

Type:
  • string

customGoalId :string

The custom id of the goal to which the ad belongs; set in the Pulse UI.

Type:
  • string

customId :string

The custom ad id set in the Pulse UI.

Type:
  • string

description :string

The description of the ad.

Type:
  • string

goalId :string

The id of the goal to which the ad belongs; supplied by Pulse.

Type:
  • string

id :string

The ad id assigned by Pulse.

Type:
  • string

labels :object

Stores ad labels, such as overlay captions and the like.

Type:
  • object

maximumPreparationTime :number

The maximum time in seconds the SDK waits for a 'lazy' ad to load (including potential passback candidate requests).

Type:
  • number

parentSlot :Object

The Slot which the Ad belongs to.
See videoplaza.adresponse.Slot

Type:
  • Object

partOfAnExclusiveCampaign :boolean

Whether or not the ad is part of an exclusive campaign.

Type:
  • boolean

pricing :videoplaza.adresponse.Ad.AdPricing

The pricing information in the ad, if any.

Type:
  • videoplaza.adresponse.Ad.AdPricing

ready :boolean

If true, this ad is ready to be displayed. If false, it needs to be retrieved on demand using videoplaza.adrequest.AdRequester.requestThirdParty.

Type:
  • boolean

showCountdown :boolean

Whether or not to display a remaining time countdown when this ad is being displayed.

Type:
  • boolean

startTimeout :number

The maximum time in seconds the video player should wait for an ad to show (including potential passback candidate requests).

Type:
  • number

survey :string

Survey URI from the VAST Ad (if any).

Type:
  • string

thirdPartyChain :Array.<string>

List of wrapper URLs that were requested from third parties, if any, before receiving a valid ad response.

Type:
  • Array.<string>

thirdPartyURL :string

URL to the 3rd party ad source from where the ad will be requested. In VAST this is referred to as a wrapper url.

Type:
  • string

title :string

The title of the ad.

Type:
  • string

trackingEvents :object

Map of URLs for various tracking events.

Type:
  • object

type :videoplaza.adresponse.Ad.AdType

The format of the ad. An unloaded ('lazy') ad will have this field undefined.

Type:

variant :videoplaza.adresponse.Ad.Variant

The variant of the Ad.

Type:

verifications :Array.<videoplaza.adresponse.Ad.AdVerification>

Contains information from any ad verification elements provided by a third party.

Type:
  • Array.<videoplaza.adresponse.Ad.AdVerification>

Methods

<static> hasPassback(ad)

Helper function that returns 'true' if this (3rd party) Ad has passback ad sources.

Parameters:
Name Type Description
ad