sdk/com.brightcove.player.analytics.insights/AdInsight/Builder

Builder

open class Builder

Constructors

Link copied to clipboard
constructor()

Functions

Link copied to clipboard
open fun build(): AdInsight
Link copied to clipboard
open fun setAdPodType(getAdPodType: AdInsight.AdPodType): AdInsight.Builder
pre = preroll: the ad pod played before content mid = midroll: the ad pod played during content post = postroll: the ad pod played after content
Link copied to clipboard
open fun setAdsAdAdvertiser(adsAdAdvertiser: String): AdInsight.Builder
The advertiser name as defined by the serving party.
Link copied to clipboard
open fun setAdsAdAudibleDuration(adsAdAudibleDuration: Double): AdInsight.Builder
Seconds of ad playback where volume was >= 1% and not muted.
Link copied to clipboard
open fun setAdsAdContentType(adsAdContentType: String): AdInsight.Builder
The content type of the currently selected creative.
Link copied to clipboard
open fun setAdsAdCreativeId(adsAdCreativeId: String): AdInsight.Builder
The ID of the selected creative for the ad.
Link copied to clipboard
open fun setAdsAdDealId(adsAdDealId: String): AdInsight.Builder
The first deal ID present in the wrapper chain for the current ad, starting from the top.
Link copied to clipboard
open fun setAdsAdDuration(adsAdDuration: Double): AdInsight.Builder
The duration in seconds of the selected creative for the ad.
Link copied to clipboard
open fun setAdsAdIndex(adsAdIndex: Integer): AdInsight.Builder
The position of the ad relative to the pod.
Link copied to clipboard
open fun setAdsAdInteraction(adsAdInteraction: Boolean): AdInsight.Builder
1 if the ad was clicked or tapped, 0 otherwise.
Link copied to clipboard
open fun setAdsAdIsci(adsAdIsci: String): AdInsight.Builder
The ISCI (Industry Standard Commercial Identifier) code for an ad.
Link copied to clipboard
open fun setAdsAdMediaUrlDomain(adsAdMediaUrlDomain: String): AdInsight.Builder
The hostname parsed from the ad media file.
Link copied to clipboard
open fun setAdsAdPlayDuration(adsAdPlayDuration: Double): AdInsight.Builder
Seconds of ad media played.
Link copied to clipboard
open fun setAdsAdSkipped(adsAdSkipped: Boolean): AdInsight.Builder
1 if the ad was skipped, 0 otherwise.
Link copied to clipboard
open fun setAdsAdSkipTimeOffset(adsAdSkipTimeOffset: Long): AdInsight.Builder
Number of seconds of playback before the ad becomes skippable.
Link copied to clipboard
open fun setAdsAdStartMs(adsAdStartMs: Long): AdInsight.Builder
Milliseconds to start playing the first frame of the ad.
Link copied to clipboard
open fun setAdsAdSystem(adsAdSystem: String): AdInsight.Builder
Source ad server information included in the ad response.
Link copied to clipboard
open fun setAdsAdTitle(adsAdTitle: String): AdInsight.Builder
The title of the ad from the VAST response.
Link copied to clipboard
open fun setAdsAdWrapperSystems(adsAdWrapperSystems: Array<String>): AdInsight.Builder
Comma-separated list of ad systems used for wrapper ads starting at the inline ad and traversing to the outermost wrapper ad.
Link copied to clipboard
open fun setAdsPodAdCount(adsPodAdCount: Integer): AdInsight.Builder
Number of ads in the current pod.
Link copied to clipboard
open fun setAdsPodDuration(adsPodDuration: Double): AdInsight.Builder
The total number of seconds the ad pod is expected to run.
Link copied to clipboard
open fun setAdsPodHost(adsPodHost: String): AdInsight.Builder
Host name from the ad server URL called to return the ad pod.
Link copied to clipboard
open fun setAdsPodIndex(adsPodIndex: Integer): AdInsight.Builder
The index of the pod relative to the content.
Link copied to clipboard
open fun setAdsPodRequestMode(adsPodRequestMode: AdInsight.AdsPodRequestMode): AdInsight.Builder
How ads were requested.
Link copied to clipboard
open fun setAdsPodRequestMs(adsPodRequestMs: Long): AdInsight.Builder
Milliseconds from ad request sent to ad request received.
Link copied to clipboard
open fun setAdsPodTimeOffset(adsPodTimeOffset: Long): AdInsight.Builder
The content time offset at which the current ad pod was scheduled.
Link copied to clipboard
open fun setEventName(eventName: String): AdInsight.Builder
Sets ad insight event name.