com.pubmatic.sdk.video.vastmodels

Class POBNonLinear

java.lang.Object

com.pubmatic.sdk.video.vastmodels.POBVastCreative

com.pubmatic.sdk.video.vastmodels.POBNonLinear

All Implemented Interfaces:

POBXMLNodeListener

public class POBNonLinear
extends POBVastCreative

Instance of this modal class saves the data of Non-Linear video ads. NonLinear ads are the overlay ads that display as an image or rich media on top of video content during playback.

Nested Class Summary

Nested classes/interfaces inherited from class com.pubmatic.sdk.video.vastmodels.POBVastCreative

POBVastCreative.CreativeType, POBVastCreative.POBEventTypes

Field Summary

Fields inherited from class com.pubmatic.sdk.video.vastmodels.POBVastCreative

mClickTrackers

Constructor Summary

Constructors

Constructor and Description
POBNonLinear()

Method Summary

Modifier and Type	Method and Description
void	build(POBNodeBuilder builder) POBXMLParser calls this method to build model class object with node builder
java.lang.String	getClickThroughURL() A URI to open when companion ad is clicked.
java.util.List<java.lang.String>	getClickTrackers() A URI to notify the player that ad was clicked.
int	getExpandedHeight() The maximum pixel height of the creative in its expanded state
int	getExpandedWidth() The maximum pixel width of the creative in its expanded state
int	getHeight() Returns the height of placement slot
boolean	getMaintainAspectRatio() A Boolean value that indicates whether aspect ratio for media file dimensions should be maintained when scaled to new dimensions.
java.lang.String	getMinSuggestedDuration() The minimum suggested duration that the creative should be displayed.
java.util.List<POBResource>	getResource() List of resources to be displayed
boolean	getScalable() A Boolean value that indicates whether the media file is meant to scale to larger dimensions.
java.util.List<POBTracking>	getTrackingEvents() List of event tracker URL's
java.lang.String	getUniversalAdId() A unique creative identifier
POBVastCreative.CreativeType	getVastCreativeType() Getter method, provides type of creative which is implemented at child classes specific event type classes
int	getWidth() Returns the width of placement slot

Methods inherited from class com.pubmatic.sdk.video.vastmodels.POBVastCreative

getTrackingEvents, getTrackingEventUrls

Methods inherited from class java.lang.Object

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

Constructor Detail

POBNonLinear

public POBNonLinear()

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

Parameters:

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

getWidth

public int getWidth()

Returns the width of placement slot

Returns:

width of ad

getHeight

public int getHeight()

Returns the height of placement slot

Returns:

height of ad

getExpandedWidth

public int getExpandedWidth()

The maximum pixel width of the creative in its expanded state

Returns:

maximum width of ad

getExpandedHeight

public int getExpandedHeight()

The maximum pixel height of the creative in its expanded state

Returns:

maximum height of ad

getMinSuggestedDuration

@Nullable
public java.lang.String getMinSuggestedDuration()

The minimum suggested duration that the creative should be displayed. The duration is in the format HH:MM:SS.mmm (mmm is optional)

Returns:

MinSuggestedDuration boolean value

getScalable

public boolean getScalable()

A Boolean value that indicates whether the media file is meant to scale to larger dimensions.

Returns:

scalable boolean value

getMaintainAspectRatio

public boolean getMaintainAspectRatio()

A Boolean value that indicates whether aspect ratio for media file dimensions should be maintained when scaled to new dimensions.

Returns:

maintainAspectRatio boolean value

getResource

@Nullable
public java.util.List<POBResource> getResource()

List of resources to be displayed

Returns:

POBResource list

getClickThroughURL

@Nullable
public java.lang.String getClickThroughURL()

A URI to open when companion ad is clicked.

Overrides:

getClickThroughURL in class POBVastCreative

Returns:

click through URL

getClickTrackers

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

A URI to notify the player that ad was clicked.

Overrides:

getClickTrackers in class POBVastCreative

Returns:

click trcking URL

getTrackingEvents

@Nullable
public java.util.List<POBTracking> getTrackingEvents()

Description copied from class: POBVastCreative

List of event tracker URL's

Returns:

List of the tracking URL specific model class

getVastCreativeType

public POBVastCreative.CreativeType getVastCreativeType()

Description copied from class: POBVastCreative

Getter method, provides type of creative which is implemented at child classes specific event type classes

Specified by:

getVastCreativeType in class POBVastCreative

Returns:

creative type(linear, non-linear, campanion)

getUniversalAdId

@Nullable
public java.lang.String getUniversalAdId()

A unique creative identifier

Returns:

creative id