com.pubmatic.sdk.video.vastmodels

Class POBVastAd

java.lang.Object

com.pubmatic.sdk.video.vastmodels.POBVastAd

All Implemented Interfaces:

POBXMLNodeListener

public class POBVastAd
extends java.lang.Object
implements POBXMLNodeListener

Instance of this modal class saves the data of VAST Ad node.

This object may be an inline ad or a wrapper.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	POBVastAd.POBVastAdParameter Enum to specify vast ad parameter type
static class	POBVastAd.POBVastAdType Vast ad type

Constructor Summary

Constructors

Constructor and Description
POBVastAd()

Method Summary

Modifier and Type	Method and Description
void	build(POBNodeBuilder builder) POBXMLParser calls this method to build model class object with node builder
int	getAdSequence() Returns an integer value with sequence values those are part of a pod and are intended to be played in sequence.
java.lang.String	getAdServingId() A unique or pseudo-unique (long enough to be unique when combined with timestamp data) numerical value.
java.lang.String	getAdSystem() A string that provides the name of the ad server that returned the ad
java.lang.String	getAdTitle() A string that provides a common name for the ad
POBVastAd.POBVastAdType	getAdType() Vast ad type inline or wrapper
java.util.List<POBAdVerification>	getAdVerification() List of the AdVerification objects
java.lang.String	getClosestClickThroughURL() Returns the closest clickThrough URL from the Linear ad of current Vast ad.
POBIcon	getClosestIcon() Returns the closest Icon from the Linear ad of current Vast ad.
java.util.List<POBCompanion>	getCombinedCompanions() List of combined companions from all the wrappers
java.util.List<java.lang.String>	getCombinedList(POBVastAd.POBVastAdParameter parameter) Returns the list of the Vast tracking URLs for Inline and all level of its wrapper based on provided parameter
java.util.List<POBXMLNodeListener>	getCombinedObjectList(POBVastAd.POBVastAdParameter parameter) Returns the list of the Vast Ad nodes for Inline and all level of its wrapper based on provided parameter
java.util.List<java.lang.String>	getCombinedTrackingEventList(POBVastCreative.POBEventTypes eventTypes) Returns the list of the Vast tracking URLs for Inline and all level of its wrapper, based on provided event type
java.util.List<com.pubmatic.sdk.common.viewability.POBVideoMeasurementProvider.POBVerificationScriptResource>	getCombinedVerificationList() List of the specified Vast ad parameter
java.util.List<POBCompanion>	getCompanions() List of companion creatives.
POBVastCreative	getCreative() Creative of type POBVastCreative.
java.lang.String	getDescription() A string value that describes a longer description of the ad
java.util.List<java.lang.String>	getErrorURLs() List of URIs to tracking resource to be used when an error in ad playback occurs.
int	getExpires() An integer value that defines the expiry period (in seconds).
java.util.List<java.lang.String>	getImpressions() List of URLs to notify the ad server when the impression occurs.
java.util.List<java.lang.String>	getNotViewableImpressions() A URI that directs the media player to a tracking resource file that the media player should request if the ad is executed but never meets criteria for a viewable impression.
java.lang.String	getPricing() A numerical value that represents a price that can be used in real-time bidding systems
java.lang.String	getVASTAdTagURI() A URI to a VAST response that may be another VAST Wrapper or a VAST InLine ad.
java.util.List<java.lang.String>	getViewableImpressions() A URI that directs the media player to a tracking resource file that the media player should request at the time that criteria is met for a viewable impression.
java.util.List<java.lang.String>	getViewUndeterminedImpressions() A URI that directs the media player to a tracking resource file that the media player should request if the player cannot determine whether criteria is met for a viewable impression.
POBVastAd	getWrapper() Reference of wrapper through which current VastAd is received.
void	setWrapper(POBVastAd wrapper) Setter to set wrpper ad on current VAST ad

Methods inherited from class java.lang.Object

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

Constructor Detail

POBVastAd

public POBVastAd()

Method Detail

build

public void build(@NonNull
                  POBNodeBuilder builder)

Description copied from interface: POBXMLNodeListener

POBXMLParser calls this method to build model class object with node builder

Specified by:

build in interface POBXMLNodeListener

Parameters:

builder - Instance of POBNodeBuilder, to be used for building the model class object

getAdType

@Nullable
public POBVastAd.POBVastAdType getAdType()

Vast ad type inline or wrapper

Returns:

ad type

getAdSystem

@Nullable
public java.lang.String getAdSystem()

A string that provides the name of the ad server that returned the ad

Returns:

ad server name

getAdTitle

@Nullable
public java.lang.String getAdTitle()

A string that provides a common name for the ad

Returns:

ad name

getAdServingId

@Nullable
public java.lang.String getAdServingId()

A unique or pseudo-unique (long enough to be unique when combined with timestamp data) numerical value.

Returns:

ad serving id

getDescription

@Nullable
public java.lang.String getDescription()

A string value that describes a longer description of the ad

Returns:

ad description

getPricing

@Nullable
public java.lang.String getPricing()

A numerical value that represents a price that can be used in real-time bidding systems

Returns:

price value

getExpires

public int getExpires()

An integer value that defines the expiry period (in seconds).

Returns:

expiry period

getAdSequence

public int getAdSequence()

Returns an integer value with sequence values those are part of a pod and are intended to be played in sequence. Returns -1, if not found in vast.

Returns:

Ad sequence in pod

getVASTAdTagURI

@Nullable
public java.lang.String getVASTAdTagURI()

A URI to a VAST response that may be another VAST Wrapper or a VAST InLine ad.

Returns:

VAST Ad Tag URL

getCombinedTrackingEventList

@NonNull
public java.util.List<java.lang.String> getCombinedTrackingEventList(@NonNull
                                                                              POBVastCreative.POBEventTypes eventTypes)

Returns the list of the Vast tracking URLs for Inline and all level of its wrapper, based on provided event type

Parameters:

eventTypes - Vast event type

Returns:

string list of Vast tracking URLs

getClosestClickThroughURL

@Nullable
public java.lang.String getClosestClickThroughURL()

Returns the closest clickThrough URL from the Linear ad of current Vast ad. Preference give to Inline VAST followed by parent's wrapper VAST

Returns:

string closestClickThrough URL

getCreative

@Nullable
public POBVastCreative getCreative()

Creative of type POBVastCreative. The creative may be linear or non-linear

Returns:

linear or non-linear creative

getWrapper

@Nullable
public POBVastAd getWrapper()

Reference of wrapper through which current VastAd is received.

Returns:

wrapper ad

setWrapper

public void setWrapper(@Nullable
                       POBVastAd wrapper)

Setter to set wrpper ad on current VAST ad

Parameters:

wrapper - previous wrapper ad

getClosestIcon

@Nullable
public POBIcon getClosestIcon()

Returns the closest Icon from the Linear ad of current Vast ad. Preference give to Inline VAST followed by parent's wrapper VAST

Returns:

Instance of POBIcon

getCombinedList

@NonNull
public java.util.List<java.lang.String> getCombinedList(@NonNull
                                                                 POBVastAd.POBVastAdParameter parameter)

Returns the list of the Vast tracking URLs for Inline and all level of its wrapper based on provided parameter

Parameters:

parameter - Vast ad parameter

Returns:

string list of Vast tracking URLs

getImpressions

@Nullable
public java.util.List<java.lang.String> getImpressions()

List of URLs to notify the ad server when the impression occurs.

Returns:

list of impression URL's

getErrorURLs

@Nullable
public java.util.List<java.lang.String> getErrorURLs()

List of URIs to tracking resource to be used when an error in ad playback occurs.

Returns:

error URL list

getViewableImpressions

@Nullable
public java.util.List<java.lang.String> getViewableImpressions()

A URI that directs the media player to a tracking resource file that the media player should request at the time that criteria is met for a viewable impression.

Returns:

list of viewable impressions URL's

getNotViewableImpressions

@Nullable
public java.util.List<java.lang.String> getNotViewableImpressions()

A URI that directs the media player to a tracking resource file that the media player should request if the ad is executed but never meets criteria for a viewable impression.

Returns:

list of not viewable impressions URL's

getViewUndeterminedImpressions

@Nullable
public java.util.List<java.lang.String> getViewUndeterminedImpressions()

A URI that directs the media player to a tracking resource file that the media player should request if the player cannot determine whether criteria is met for a viewable impression.

Returns:

list of view undetermined impressions URL's

getCombinedCompanions

@Nullable
public java.util.List<POBCompanion> getCombinedCompanions()

List of combined companions from all the wrappers

Returns:

list of companions

getCompanions

@Nullable
public java.util.List<POBCompanion> getCompanions()

List of companion creatives.

Returns:

list of POBCompanion

getCombinedObjectList

public java.util.List<POBXMLNodeListener> getCombinedObjectList(@NonNull
                                                                POBVastAd.POBVastAdParameter parameter)

Returns the list of the Vast Ad nodes for Inline and all level of its wrapper based on provided parameter

Parameters:

parameter - Vast ad parameter

Returns:

string list of Vast Ad nodes

getCombinedVerificationList

public java.util.List<com.pubmatic.sdk.common.viewability.POBVideoMeasurementProvider.POBVerificationScriptResource> getCombinedVerificationList()

List of the specified Vast ad parameter

Returns:

POBXMLNodeListener list of POBVastAdParameter

getAdVerification

@Nullable
public java.util.List<POBAdVerification> getAdVerification()

List of the AdVerification objects

Each verification object element contains the executable and bootstrapping data required to run the measurement code for a single verification vendor.

Returns:

list of POBAdVerification