Package 

Class AdInsight.Builder

    • Method Detail

      • setAdsPodIndex

         AdInsight.Builder setAdsPodIndex(Integer adsPodIndex)

        The index of the pod relative to the content. Resets to zero with each change in content.

        Parameters:
        adsPodIndex - - The index of the pod relative to the content.
      • setAdsAdIndex

         AdInsight.Builder setAdsAdIndex(Integer adsAdIndex)

        The position of the ad relative to the pod. Resets to one with each new ad pod. 0-n.

        Parameters:
        adsAdIndex - - The index of the ad relative to the pod.
      • setAdsAdDealId

         AdInsight.Builder setAdsAdDealId(String adsAdDealId)

        The first deal ID present in the wrapper chain for the current ad, starting from the top. Exclude if not available.

        Parameters:
        adsAdDealId - - The first deal ID present in the wrapper chain for the current ad, starting from the top.
      • setAdsAdWrapperSystems

         AdInsight.Builder setAdsAdWrapperSystems(Array<String> adsAdWrapperSystems)

        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.

        Parameters:
        adsAdWrapperSystems - - Comma-separated list of ad systems.
      • setAdsAdSystem

         AdInsight.Builder setAdsAdSystem(String adsAdSystem)

        Source ad server information included in the ad response. Exclude if not available.

        Parameters:
        adsAdSystem - - Source ad server information included in the ad response.
      • setAdsAdSkipTimeOffset

         AdInsight.Builder setAdsAdSkipTimeOffset(Long adsAdSkipTimeOffset)

        Number of seconds of playback before the ad becomes skippable. Exclude for non-skippable ads.

        Parameters:
        adsAdSkipTimeOffset - - Number of seconds of playback before the ad becomes skippable.
      • setAdsAdStartMs

         AdInsight.Builder setAdsAdStartMs(Long adsAdStartMs)

        Milliseconds to start playing the first frame of the ad. Exclude if not available.

        Parameters:
        adsAdStartMs - - Milliseconds to start playing the first frame of the ad.
      • setAdsAdAdvertiser

         AdInsight.Builder setAdsAdAdvertiser(String adsAdAdvertiser)

        The advertiser name as defined by the serving party. Exclude if not available.

        Parameters:
        adsAdAdvertiser - - The advertiser name as defined by the serving party.
      • setAdsAdContentType

         AdInsight.Builder setAdsAdContentType(String adsAdContentType)

        The content type of the currently selected creative. Exclude if no creative is selected or the content type is unavailable.

        Parameters:
        adsAdContentType - - The content type of the currently selected creative.
      • setAdsAdIsci

         AdInsight.Builder setAdsAdIsci(String adsAdIsci)

        The ISCI (Industry Standard Commercial Identifier) code for an ad. Exclude if not available.

        Parameters:
        adsAdIsci - - The ISCI (Industry Standard Commercial Identifier) code for an ad.
      • setAdsAdDuration

         AdInsight.Builder setAdsAdDuration(Double adsAdDuration)

        The duration in seconds of the selected creative for the ad. Exclude for non-linear ads.

        Parameters:
        adsAdDuration - - The duration in seconds of the selected creative for the ad.
      • setAdsAdTitle

         AdInsight.Builder setAdsAdTitle(String adsAdTitle)

        The title of the ad from the VAST response.

        Parameters:
        adsAdTitle - - The title of the ad from the VAST response.
      • setAdsPodDuration

         AdInsight.Builder setAdsPodDuration(Double adsPodDuration)

        The total number of seconds the ad pod is expected to run.

        Parameters:
        adsPodDuration - - The total number of seconds the ad pod is expected to run.
      • setAdsPodHost

         AdInsight.Builder setAdsPodHost(String adsPodHost)

        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”

        Parameters:
        adsPodHost - - Host name from the ad server URL called to return the ad pod.
      • setAdPodType

         AdInsight.Builder setAdPodType(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

        Parameters:
        getAdPodType - - Ad pod type.
      • setAdsPodRequestMs

         AdInsight.Builder setAdsPodRequestMs(Long adsPodRequestMs)

        Milliseconds from ad request sent to ad request received.

        Parameters:
        adsPodRequestMs - - Milliseconds from ad request sent to ad request received.
      • setAdsPodRequestMode

         AdInsight.Builder setAdsPodRequestMode(AdInsight.AdsPodRequestMode adsPodRequestMode)

        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.

        Parameters:
        adsPodRequestMode - - Pod request mode.
      • setAdsPodTimeOffset

         AdInsight.Builder setAdsPodTimeOffset(Long adsPodTimeOffset)

        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

        Parameters:
        adsPodTimeOffset - -The content time offset at which the current ad pod was scheduled.
      • setAdsAdAudibleDuration

         AdInsight.Builder setAdsAdAudibleDuration(Double adsAdAudibleDuration)

        Seconds of ad playback where volume was >= 1% and not muted.

        Parameters:
        adsAdAudibleDuration - - Seconds of ad playback where volume was >= 1% and not muted.Return the Math.
      • setAdsAdInteraction

         AdInsight.Builder setAdsAdInteraction(Boolean adsAdInteraction)

        1 if the ad was clicked or tapped, 0 otherwise.

        Parameters:
        adsAdInteraction - - 1 if the ad was clicked or tapped, 0 otherwise.