Package com.brightcove.player.analytics.insights

Class AdInsight

java.lang.Object
com.brightcove.player.analytics.insights.AdInsight
public class AdInsight extends Object

  • Field Details

  • Method Details

    • getEventName

      public String getEventName()
      Ad insight event name.
      Returns:
      - Event name.

    • getAdsPodIndex

      public Integer getAdsPodIndex()
      The index of the pod relative to the content. Resets to zero with each change in content.
      Returns:
      - The index of the pod relative to the content.

    • getAdsAdIndex

      public Integer getAdsAdIndex()
      The position of the ad relative to the pod. Resets to one with each new ad pod. 0-n.
      Returns:
      - The position of the ad relative to the pod.

    • getAdsAdDealId

      public String getAdsAdDealId()
      The first deal ID present in the wrapper chain for the current ad, starting from the top. Exclude if not available.
      Returns:
      - First ad deal id.

    • getAdsAdWrapperSystems

      public 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.
      Returns:
      - Comma-separated list of ad systems.

    • getAdsAdSystem

      public String getAdsAdSystem()
      Source ad server information included in the ad response. Exclude if not available.
      Returns:
      - Source ad server information included in the ad response.

    • getAdsAdSkipTimeOffset

      public Long getAdsAdSkipTimeOffset()
      Number of seconds of playback before the ad becomes skippable. Exclude for non-skippable ads.
      Returns:
      - Number of seconds of playback before the ad becomes skippable.

    • getAdsAdStartMs

      public Long getAdsAdStartMs()
      Milliseconds to start playing the first frame of the ad. Exclude if not available.
      Returns:
      - Milliseconds to start playing the first frame of the ad.

    • getAdsAdAdvertiser

      public String getAdsAdAdvertiser()
      The advertiser name as defined by the serving party. Exclude if not available.
      Returns:
      - The advertiser name as defined by the serving party.

    • getAdsAdContentType

      public String getAdsAdContentType()
      The content type of the currently selected creative. Exclude if no creative is selected or the content type is unavailable.
      Returns:
      - The content type of the currently selected creative.

    • getAdsAdIsci

      public String getAdsAdIsci()
      The ISCI (Industry Standard Commercial Identifier) code for an ad. Exclude if not available.
      Returns:
      - The ISCI (Industry Standard Commercial Identifier) code for an ad.

    • getAdsAdCreativeId

      public String getAdsAdCreativeId()
      The ID of the selected creative for the ad.
      Returns:
      - The ID of the selected creative for the ad.

    • getAdsAdDuration

      public Double getAdsAdDuration()
      The duration in seconds of the selected creative for the ad. Exclude for non-linear ads.
      Returns:
      - The duration in seconds of the selected creative for the ad.

    • getAdsAdTitle

      public String getAdsAdTitle()
      The title of the ad from the VAST response.
      Returns:
      - The title of the ad from the VAST response.

    • getAdsAdMediaUrlDomain

      public String getAdsAdMediaUrlDomain()
      The hostname parsed from the ad media file.
      Returns:
      - The hostname parsed from the ad media file.

    • getAdsPodAdCount

      public Integer getAdsPodAdCount()
      Number of ads in the current pod.
      Returns:
      - Number of ads in the current pod.

    • getAdsPodDuration

      public Double getAdsPodDuration()
      The total number of seconds the ad pod is expected to run.
      Returns:
      - The total number of seconds the ad pod is expected to run.

    • getAdsPodHost

      public 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”

      Returns:
      - Host name from the ad server URL called to return the ad pod.

    • getAdPodType

      public AdInsight.AdPodType getAdPodType()
      pre = preroll: the ad pod played before content mid = midroll: the ad pod played during content post = postroll: the ad pod played after content
      Returns:
      - Ad pod type.

    • getAdsPodRequestMs

      public Long getAdsPodRequestMs()
      Milliseconds from ad request sent to ad request received.
      Returns:
      - Milliseconds from ad request sent to ad request received.

    • getAdsPodRequestMode

      public 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.

      Returns:
      How ads were requested.

    • getAdsPodTimeOffset

      public 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

      Returns:
      - The content time offset at which the current ad pod was scheduled.

    • getAdsAdAudibleDuration

      public Double getAdsAdAudibleDuration()
      Seconds of ad playback where volume was >= 1% and not muted.
      Returns:
      - Seconds of ad playback where volume was >= 1% and not muted.

    • getAdsAdPlayDuration

      public Double getAdsAdPlayDuration()
      Seconds of ad media played.
      Returns:
      - Seconds of ad media played.

    • isAdsAdSkipped

      public String isAdsAdSkipped()
      1 if the ad was skipped, 0 otherwise.
      Returns:
      1 if the ad was skipped, 0 otherwise.

    • isAdsAdInteraction

      public String isAdsAdInteraction()
      1 if the ad was clicked or tapped, 0 otherwise.
      Returns:
      - 1 if the ad was clicked or tapped, 0 otherwise.

    • toMap

      public Map<String,String> toMap()