Package com.jwplayer.pub.api.events
Class AdImpressionEvent
java.lang.Object
com.jwplayer.pub.api.events.Event
com.jwplayer.pub.api.events.AdImpressionEvent
Payload that accompanies the onAdImpression() event.
-
Constructor Summary
ConstructorsConstructorDescriptionAdImpressionEvent
(JWPlayer player, AdPosition adPosition, String adSystem, String adTitle, String adId, String clickThroughUrl, AdClient client, String creativeType, String linear, MediaFile mediaFile, String tag, String vastVersion, String wrapper, VmapInfo vmapInfo, String universalAdIdRegistry, String universalAdIdValue, Boolean conditionalAdOptOut, String[] categories, Boolean mediaFileCompliance, String[] nonComplianceReasons, String creativeId, String creativeAdId, int podcount, int sequence, List<VerificationVendor> vendor, Integer skipOffset) -
Method Summary
-
Constructor Details
-
AdImpressionEvent
public AdImpressionEvent(JWPlayer player, AdPosition adPosition, String adSystem, String adTitle, String adId, String clickThroughUrl, AdClient client, String creativeType, String linear, MediaFile mediaFile, String tag, String vastVersion, String wrapper, VmapInfo vmapInfo, String universalAdIdRegistry, String universalAdIdValue, Boolean conditionalAdOptOut, String[] categories, Boolean mediaFileCompliance, String[] nonComplianceReasons, String creativeId, String creativeAdId, int podcount, int sequence, List<VerificationVendor> vendor, Integer skipOffset)
-
-
Method Details
-
getAdPosition
- Returns:
- An ad's position.
-
getAdSystem
- Returns:
- AdSystem referenced inside of the VAST XML.
-
getAdTitle
- Returns:
- AdTitle referenced inside of the VAST XML.
-
getAdId
- Returns:
- Ad Id referenced inside the VAST XML
-
getClickThroughUrl
- Returns:
- The URL of the page the user lands on when clicking the ad.
-
getClient
- Returns:
- The client that is currently being used.
-
getCreativeType
- Returns:
- VAST-only The MIME type of the current media file specified in the VAST XML.
-
getLinear
- Returns:
- Returns if an ad is "linear" or "nonlinear".
-
getMediaFile
- Returns:
- VAST-only Information regarding the media creative that is currently playing.
-
getTag
- Returns:
- The URL of the ad tag that was started.
-
getVastVersion
- Returns:
- VAST-only The version of VAST referenced in the VAST XML.
-
getVmapInfo
- Returns:
- The VMAP info for this Ad Impression, if available
-
getUniversalAdIdRegistry
-
getUniversalAdIdValue
-
getConditionalAdOptOut
-
getCategories
-
getMediaFileCompliance
-
getNonComplianceReasons
-
getCreativeId
-
getCreativeAdId
-
getPodcount
public int getPodcount() -
getSequence
public int getSequence() -
getAdVerifications
-
getSkipOffset
-