Class: AdInfo

ima.AdInfo

class   static

Constructor

AdInfo

new AdInfo()

Contains info about an ad. Passed to event callbacks by the SDK.

Properties

adBreakInfo

static

ima.AdBreakInfo

Info related to the entire break this ad is in.

adDescription

static

String

The description of the ad.

adId

static

String

The id of the ad or an empty string if unknown.

adSystem

static

String

The ad system supplying the creative.

adTitle

static

String

The title of the ad.

advertiserName

static

String

The advertiser name as defined by the serving party.

companions

static

Array of Array of T

The companion ads specified in the VAST response.

creativeAdId

static

String

The ISCI (Industry Standard Commercial Identifier) code for an ad. This is the Ad-ID of the selected creative in the VAST response.

creativeId

static

String

The ID of the selected creative for the ad.

currentTime

static

Integer

The current time within an ad in seconds or -1 if unknown.

dealId

static

String

Returns the first deal ID present in the wrapper chain for the current ad, starting from the top.

duration

static

Integer

The duration of this single ad in seconds or -1 if unknown.

skipOffset

static

Integer

The time it takes for the ad to become skippable or -1 if unknown.

universalAdIDRegistry

static

String

A string used to identify the URL for the registry website where the selected creative's Universal Ad ID is cataloged.

universalAdIDValue

static

String

The Universal Ad ID of the selected creative for the ad.

wrappers

static

Array of ima.WrapperInfo

An array of ima.WrapperInfo with wrapper information for this ad. The order will be from outer wrapper to inner.

Method

createAdInfo

static

createAdInfo() returns ima.AdInfo

Returns

ima.AdInfo