Class: Ad

  • The Ad class represents an ad object during dynamic ad insertion and provides various methods to access ad information.

  • Developers can use methods like getAdId, getTitle, getDescription, and getDuration to retrieve basic ad details.

  • Information about the ad's creative, advertiser, and ad system can be accessed using methods such as getCreativeId, getAdvertiserName, and getAdSystem.

  • Companion ads and universal ad IDs are accessible via getCompanionAds and getUniversalAdIds respectively.

  • Methods like isSkippable and getSkipTimeOffset offer details about the ad's skippability.

Ad

class   public

A class representing an ad object during dynamic ad insertion.

Methods

getAdId

getAdId() returns string

Returns

string 

getAdPodInfo

getAdPodInfo() returns AdPodInfo

Returns

non-null AdPodInfo 

getAdSystem

getAdSystem() returns string

Returns

string 

getAdvertiserName

getAdvertiserName() returns string

Returns

string 

getApiFramework

getApiFramework() returns (null or string)

Returns

(null or string) 

getCompanionAds

getCompanionAds() returns Array of non-null CompanionAd

Returns

non-null Array of non-null CompanionAd 

getCreativeAdId

getCreativeAdId() returns string

Returns

string 

getCreativeId

getCreativeId() returns string

Returns

string 

getDealId

getDealId() returns string

Returns

string 

getDescription

getDescription() returns string

Returns

string 

getDuration

getDuration() returns number

Returns

number 

getSkipTimeOffset

getSkipTimeOffset() returns number

Returns

number 

getTitle

getTitle() returns string

Returns

string 

getUniversalAdIdRegistry

getUniversalAdIdRegistry() returns string

Deprecated
Use ad.getUniversalAdIds() instead
Returns

string 

getUniversalAdIdValue

getUniversalAdIdValue() returns string

Deprecated
Use ad.getUniversalAdIds() instead
Returns

string 

getUniversalAdIds

getUniversalAdIds() returns Array of non-null UniversalAdIdInfo

Returns

non-null Array of non-null UniversalAdIdInfo 

getVastMediaHeight

getVastMediaHeight() returns number

Returns

number 

getVastMediaWidth

getVastMediaWidth() returns number

Returns

number 

getWrapperAdIds

getWrapperAdIds() returns Array of string

Returns

non-null Array of string 

getWrapperAdSystems

getWrapperAdSystems() returns Array of string

Returns

non-null Array of string 

getWrapperCreativeIds

getWrapperCreativeIds() returns Array of string

Returns

non-null Array of string 

isSkippable

isSkippable() returns boolean

Returns

boolean