Interface Ad

An ad object for DAI streams.
Methods
getAdId
getAdPodInfo
getAdSystem
getAdvertiserName
getApiFramework
getCompanionAds
getCreativeAdId
getCreativeId
getDealId
getDescription
getDuration
getSkipTimeOffset
getTitle
getTraffickingParametersString
getUniversalAdIds
getVastMediaHeight
getVastMediaWidth
getWrapperAdIds
getWrapperAdSystems
getWrapperCreativeIds
isSkippable

Methods

getAdId

getAdId(): string
Returns
string the ad ID.

getAdPodInfo

getAdPodInfo(): AdPodInfo
Returns
AdPodInfo the ad pod information.

getAdSystem

getAdSystem(): string
Returns
string the ad system.

getAdvertiserName

getAdvertiserName(): string
Returns
string the advertiser name.

getApiFramework

getApiFramework(): string
Returns
string the API framework.

getCompanionAds

getCompanionAds(): CompanionAd[]
Returns
CompanionAd[] the companion ads for this ad.

getCreativeAdId

getCreativeAdId(): string
Returns
string the creative ad ID.

getCreativeId

getCreativeId(): string
Returns
string the creative ID.

getDealId

getDealId(): string
Returns
string the deal ID.

getDescription

getDescription(): string
Returns
string the description of the ad.

getDuration

getDuration(): number
Returns
number the duration of the ad.

getSkipTimeOffset

getSkipTimeOffset(): number
Returns
number the number of seconds of playback before the ad becomes skippable.

getTitle

getTitle(): string
Returns
string the title of the ad.

getTraffickingParametersString

getTraffickingParametersString(): string
Returns
string ad traffic parameters.

getUniversalAdIds

getUniversalAdIds(): UniversalAdIdInfo[]
Returns
UniversalAdIdInfo[] the universal ad IDs for this ad.

getVastMediaHeight

getVastMediaHeight(): number
Returns
number the VAST media height.

getVastMediaWidth

getVastMediaWidth(): number
Returns
number the VAST media width.

getWrapperAdIds

getWrapperAdIds(): string[]
Returns
string[] the wrapper ad IDs.

getWrapperAdSystems

getWrapperAdSystems(): string[]
Returns
string[] the wrapper ad systems.

getWrapperCreativeIds

getWrapperCreativeIds(): string[]
Returns
string[] the wrapper creative IDs.

isSkippable

isSkippable(): boolean
Returns
boolean true if the ad is skippable, false otherwise.