Class AdImpressionEvent

java.lang.Object
com.jwplayer.pub.api.events.Event
com.jwplayer.pub.api.events.AdImpressionEvent

public class AdImpressionEvent extends Event
Payload that accompanies the onAdImpression() event.
  • Constructor Details

  • Method Details

    • getAdPosition

      public AdPosition getAdPosition()
      Returns:
      An ad's position.
    • getAdSystem

      public String getAdSystem()
      Returns:
      AdSystem referenced inside of the VAST XML.
    • getAdTitle

      public String getAdTitle()
      Returns:
      AdTitle referenced inside of the VAST XML.
    • getAdId

      public String getAdId()
      Returns:
      Ad Id referenced inside the VAST XML
    • getClickThroughUrl

      public String getClickThroughUrl()
      Returns:
      The URL of the page the user lands on when clicking the ad.
    • getClient

      public AdClient getClient()
      Returns:
      The client that is currently being used.
    • getCreativeType

      public String getCreativeType()
      Returns:
      VAST-only The MIME type of the current media file specified in the VAST XML.
    • getLinear

      public String getLinear()
      Returns:
      Returns if an ad is "linear" or "nonlinear".
    • getMediaFile

      public MediaFile getMediaFile()
      Returns:
      VAST-only Information regarding the media creative that is currently playing.
    • getTag

      public String getTag()
      Returns:
      The URL of the ad tag that was started.
    • getVastVersion

      public String getVastVersion()
      Returns:
      VAST-only The version of VAST referenced in the VAST XML.
    • getVmapInfo

      public VmapInfo getVmapInfo()
      Returns:
      The VMAP info for this Ad Impression, if available
    • getUniversalAdIdRegistry

      public String getUniversalAdIdRegistry()
    • getUniversalAdIdValue

      public String getUniversalAdIdValue()
    • getConditionalAdOptOut

      public Boolean getConditionalAdOptOut()
    • getCategories

      public String[] getCategories()
    • getMediaFileCompliance

      public Boolean getMediaFileCompliance()
    • getNonComplianceReasons

      public String[] getNonComplianceReasons()
    • getCreativeId

      public String getCreativeId()
    • getCreativeAdId

      public String getCreativeAdId()
    • getPodcount

      public int getPodcount()
    • getSequence

      public int getSequence()
    • getAdVerifications

      public List<VerificationVendor> getAdVerifications()
    • getSkipOffset

      public Integer getSkipOffset()