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, java.lang.String adSystem, java.lang.String adTitle, java.lang.String adId, java.lang.String clickThroughUrl, AdClient client, java.lang.String creativeType, java.lang.String linear, MediaFile mediaFile, java.lang.String tag, java.lang.String vastVersion, java.lang.String wrapper, VmapInfo vmapInfo, java.lang.String universalAdIdRegistry, java.lang.String universalAdIdValue, java.lang.Boolean conditionalAdOptOut, java.lang.String[] categories, java.lang.Boolean mediaFileCompliance, java.lang.String[] nonComplianceReasons, java.lang.String creativeId, java.lang.String creativeAdId, int podcount, int sequence, java.util.List<VerificationVendor> vendor, java.lang.Integer skipOffset)

Method Summary

Modifier and Type	Method	Description
java.lang.String	getAdId()
AdPosition	getAdPosition()
java.lang.String	getAdSystem()
java.lang.String	getAdTitle()
java.util.List<VerificationVendor>	getAdVerifications()
java.lang.String[]	getCategories()
java.lang.String	getClickThroughUrl()
AdClient	getClient()
java.lang.Boolean	getConditionalAdOptOut()
java.lang.String	getCreativeAdId()
java.lang.String	getCreativeId()
java.lang.String	getCreativeType()
java.lang.String	getLinear()
MediaFile	getMediaFile()
java.lang.Boolean	getMediaFileCompliance()
java.lang.String[]	getNonComplianceReasons()
int	getPodcount()
int	getSequence()
java.lang.Integer	getSkipOffset()
java.lang.String	getTag()
java.lang.String	getUniversalAdIdRegistry()
java.lang.String	getUniversalAdIdValue()
java.lang.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 Detail

AdImpressionEvent

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

Method Detail

getAdPosition

@NonNull
public AdPosition getAdPosition()

Returns:

An ad's position.

getAdSystem

@Nullable
public java.lang.String getAdSystem()

Returns:

AdSystem referenced inside of the VAST XML.

getAdTitle

@Nullable
public java.lang.String getAdTitle()

Returns:

AdTitle referenced inside of the VAST XML.

getAdId

@Nullable
public java.lang.String getAdId()

Returns:

Ad Id referenced inside the VAST XML

getClickThroughUrl

@Nullable
public java.lang.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 java.lang.String getCreativeType()

Returns:

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

getLinear

@Nullable
public java.lang.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 java.lang.String getTag()

Returns:

The URL of the ad tag that was started.

getVastVersion

@Nullable
public java.lang.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 java.lang.String getUniversalAdIdRegistry()

getUniversalAdIdValue

@Nullable
public java.lang.String getUniversalAdIdValue()

getConditionalAdOptOut

@Nullable
public java.lang.Boolean getConditionalAdOptOut()

getCategories

@Nullable
public java.lang.String[] getCategories()

getMediaFileCompliance

@Nullable
public java.lang.Boolean getMediaFileCompliance()

getNonComplianceReasons

@Nullable
public java.lang.String[] getNonComplianceReasons()

getCreativeId

@Nullable
public java.lang.String getCreativeId()

getCreativeAdId

@Nullable
public java.lang.String getCreativeAdId()

getPodcount

public int getPodcount()

getSequence

public int getSequence()

getAdVerifications

public java.util.List<VerificationVendor> getAdVerifications()

getSkipOffset

public java.lang.Integer getSkipOffset()