-
public class AdInsight
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description public enum
AdInsight.AdPodType
public enum
AdInsight.AdsPodRequestMode
public class
AdInsight.Builder
public class
AdInsight.Events
public class
AdInsight.Fields
-
Field Summary
-
Method Summary
Modifier and Type Method Description String
getEventName()
Ad insight event name. Integer
getAdsPodIndex()
The index of the pod relative to the content. Integer
getAdsAdIndex()
The position of the ad relative to the pod. String
getAdsAdDealId()
The first deal ID present in the wrapper chain for the current ad, starting from the top. Array<String>
getAdsAdWrapperSystems()
Comma-separated list of ad systems used for wrapper ads starting at the inline ad and traversing to the outermost wrapper ad.Exclude if not available. String
getAdsAdSystem()
Source ad server information included in the ad response. Long
getAdsAdSkipTimeOffset()
Number of seconds of playback before the ad becomes skippable. Long
getAdsAdStartMs()
Milliseconds to start playing the first frame of the ad. String
getAdsAdAdvertiser()
The advertiser name as defined by the serving party. String
getAdsAdContentType()
The content type of the currently selected creative. String
getAdsAdIsci()
The ISCI (Industry Standard Commercial Identifier) code for an ad. String
getAdsAdCreativeId()
The ID of the selected creative for the ad. Double
getAdsAdDuration()
The duration in seconds of the selected creative for the ad. String
getAdsAdTitle()
The title of the ad from the VAST response. String
getAdsAdMediaUrlDomain()
The hostname parsed from the ad media file. Integer
getAdsPodAdCount()
Number of ads in the current pod. Double
getAdsPodDuration()
The total number of seconds the ad pod is expected to run. String
getAdsPodHost()
Host name from the ad server URL called to return the ad pod. AdInsight.AdPodType
getAdPodType()
pre = preroll: the ad pod played before contentmid = midroll: the ad pod played during contentpost = postroll: the ad pod played after content Long
getAdsPodRequestMs()
Milliseconds from ad request sent to ad request received. AdInsight.AdsPodRequestMode
getAdsPodRequestMode()
How ads were requested. Long
getAdsPodTimeOffset()
The content time offset at which the current ad pod was scheduled. Double
getAdsAdAudibleDuration()
Seconds of ad playback where volume was >= 1% and not muted. Double
getAdsAdPlayDuration()
Seconds of ad media played. String
isAdsAdSkipped()
1 if the ad was skipped, 0 otherwise. String
isAdsAdInteraction()
1 if the ad was clicked or tapped, 0 otherwise. Map<String, String>
toMap()
-
-
Method Detail
-
getEventName
String getEventName()
Ad insight event name.
-
getAdsPodIndex
Integer getAdsPodIndex()
The index of the pod relative to the content. Resets to zero with each change in content.
-
getAdsAdIndex
Integer getAdsAdIndex()
The position of the ad relative to the pod. Resets to one with each new ad pod. 0-n.
-
getAdsAdDealId
String getAdsAdDealId()
The first deal ID present in the wrapper chain for the current ad, starting from the top. Exclude if not available.
-
getAdsAdWrapperSystems
Array<String> getAdsAdWrapperSystems()
Comma-separated list of ad systems used for wrapper ads starting at the inline ad and traversing to the outermost wrapper ad.Exclude if not available.
-
getAdsAdSystem
String getAdsAdSystem()
Source ad server information included in the ad response. Exclude if not available.
-
getAdsAdSkipTimeOffset
Long getAdsAdSkipTimeOffset()
Number of seconds of playback before the ad becomes skippable. Exclude for non-skippable ads.
-
getAdsAdStartMs
Long getAdsAdStartMs()
Milliseconds to start playing the first frame of the ad. Exclude if not available.
-
getAdsAdAdvertiser
String getAdsAdAdvertiser()
The advertiser name as defined by the serving party. Exclude if not available.
-
getAdsAdContentType
String getAdsAdContentType()
The content type of the currently selected creative. Exclude if no creative is selected or the content type is unavailable.
-
getAdsAdIsci
String getAdsAdIsci()
The ISCI (Industry Standard Commercial Identifier) code for an ad. Exclude if not available.
-
getAdsAdCreativeId
String getAdsAdCreativeId()
The ID of the selected creative for the ad.
-
getAdsAdDuration
Double getAdsAdDuration()
The duration in seconds of the selected creative for the ad. Exclude for non-linear ads.
-
getAdsAdTitle
String getAdsAdTitle()
The title of the ad from the VAST response.
-
getAdsAdMediaUrlDomain
String getAdsAdMediaUrlDomain()
The hostname parsed from the ad media file.
-
getAdsPodAdCount
Integer getAdsPodAdCount()
Number of ads in the current pod.
-
getAdsPodDuration
Double getAdsPodDuration()
The total number of seconds the ad pod is expected to run.
-
getAdsPodHost
String getAdsPodHost()
Host name from the ad server URL called to return the ad pod.
For CSAI, this is an arbitrary string.For SSAI, this is an enum of either “ssai” or “dai”
-
getAdPodType
AdInsight.AdPodType getAdPodType()
pre = preroll: the ad pod played before contentmid = midroll: the ad pod played during contentpost = postroll: the ad pod played after content
-
getAdsPodRequestMs
Long getAdsPodRequestMs()
Milliseconds from ad request sent to ad request received.
-
getAdsPodRequestMode
AdInsight.AdsPodRequestMode getAdsPodRequestMode()
How ads were requested.
onload = Ads requested when content began loading.onplay = Ads requested when content playback was requested.ondemand = Ads requested on-demand by the integrator.oncue = Ads requested on Video Cloud cue points.
For SSAI, use onload.
-
getAdsPodTimeOffset
Long getAdsPodTimeOffset()
The content time offset at which the current ad pod was scheduled.
For prerolls, use 0.For midrolls, will be the time offset specified either by the ad or the playhead position when ad playback begins.For postrolls, use the content duration
-
getAdsAdAudibleDuration
Double getAdsAdAudibleDuration()
Seconds of ad playback where volume was >= 1% and not muted.
-
getAdsAdPlayDuration
Double getAdsAdPlayDuration()
Seconds of ad media played.
-
isAdsAdSkipped
String isAdsAdSkipped()
1 if the ad was skipped, 0 otherwise.
-
isAdsAdInteraction
String isAdsAdInteraction()
1 if the ad was clicked or tapped, 0 otherwise.
-
-
-
-