Package com.jwplayer.pub.api.events

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 Summary

Constructors

Constructor

Description

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 Summary

Modifier and Type	Method	Description
String	getAdId()
AdPosition	getAdPosition()
String	getAdSystem()
String	getAdTitle()
List<VerificationVendor>	getAdVerifications()
String[]	getCategories()
String	getClickThroughUrl()
AdClient	getClient()
Boolean	getConditionalAdOptOut()
String	getCreativeAdId()
String	getCreativeId()
String	getCreativeType()
String	getLinear()
MediaFile	getMediaFile()
Boolean	getMediaFileCompliance()
String[]	getNonComplianceReasons()
int	getPodcount()
int	getSequence()
Integer	getSkipOffset()
String	getTag()
String	getUniversalAdIdRegistry()
String	getUniversalAdIdValue()
String	getVastVersion()
VmapInfo	getVmapInfo()

Methods inherited from class com.jwplayer.pub.api.events.Event

getPlayer

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

AdImpressionEvent

public AdImpressionEvent(@NonNull
 JWPlayer player,
 @NonNull
 AdPosition adPosition,
 @Nullable
 String adSystem,
 @Nullable
 String adTitle,
 @Nullable
 String adId,
 @Nullable
 String clickThroughUrl,
 @NonNull
 AdClient client,
 @Nullable
 String creativeType,
 @Nullable
 String linear,
 @Nullable
 MediaFile mediaFile,
 @NonNull
 String tag,
 @Nullable
 String vastVersion,
 @Nullable
 String wrapper,
 @Nullable
 VmapInfo vmapInfo,
 @Nullable
 String universalAdIdRegistry,
 @Nullable
 String universalAdIdValue,
 @Nullable
 Boolean conditionalAdOptOut,
 @Nullable
 String[] categories,
 @Nullable
 Boolean mediaFileCompliance,
 @Nullable
 String[] nonComplianceReasons,
 @Nullable
 String creativeId,
 @Nullable
 String creativeAdId,
 int podcount,
 int sequence,
 @Nullable
 List<VerificationVendor> vendor,
 @Nullable
 Integer skipOffset)

Method Details

getAdPosition

@NonNull
public AdPosition getAdPosition()

Returns:

An ad's position.

getAdSystem

@Nullable
public String getAdSystem()

Returns:

AdSystem referenced inside of the VAST XML.

getAdTitle

@Nullable
public String getAdTitle()

Returns:

AdTitle referenced inside of the VAST XML.

getAdId

@Nullable
public String getAdId()

Returns:

Ad Id referenced inside the VAST XML

getClickThroughUrl

@Nullable
public String getClickThroughUrl()

Returns:

The URL of the page the user lands on when clicking the ad.

getClient

@NonNull
public AdClient getClient()

Returns:

The client that is currently being used.

getCreativeType

@Nullable
public String getCreativeType()

Returns:

VAST-only The MIME type of the current media file specified in the VAST XML.

getLinear

@Nullable
public String getLinear()

Returns:

Returns if an ad is "linear" or "nonlinear".

getMediaFile

@Nullable
public MediaFile getMediaFile()

Returns:

VAST-only Information regarding the media creative that is currently playing.

getTag

@NonNull
public String getTag()

Returns:

The URL of the ad tag that was started.

getVastVersion

@Nullable
public String getVastVersion()

Returns:

VAST-only The version of VAST referenced in the VAST XML.

getVmapInfo

@Nullable
public VmapInfo getVmapInfo()

Returns:

The VMAP info for this Ad Impression, if available

getUniversalAdIdRegistry

@Nullable
public String getUniversalAdIdRegistry()

getUniversalAdIdValue

@Nullable
public String getUniversalAdIdValue()

getConditionalAdOptOut

@Nullable
public Boolean getConditionalAdOptOut()

getCategories

@Nullable
public String[] getCategories()

getMediaFileCompliance

@Nullable
public Boolean getMediaFileCompliance()

getNonComplianceReasons

@Nullable
public String[] getNonComplianceReasons()

getCreativeId

@Nullable
public String getCreativeId()

getCreativeAdId

@Nullable
public String getCreativeAdId()

getPodcount

public int getPodcount()

getSequence

public int getSequence()

getAdVerifications

public List<VerificationVendor> getAdVerifications()

getSkipOffset

public Integer getSkipOffset()