Page Summary
-
The Ad class represents an ad object during dynamic ad insertion.
-
The class provides methods to retrieve various properties of an ad, such as ID, duration, title, and associated information like ad pod details and companion ads.
-
Several methods are available to get identifiers and systems related to the ad, including ad ID, creative ID, advertiser name, and VAST media dimensions.
-
Methods exist to retrieve information about wrapped ads, such as their IDs, systems, and creative IDs.
-
You can check if an ad is skippable using the isSkippable method.
Ad
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
