com.pubmatic.sdk.video.vastmodels

Class POBIcon

java.lang.Object

com.pubmatic.sdk.video.vastmodels.POBIcon

All Implemented Interfaces:

com.pubmatic.sdk.common.base.POBAdDescriptor, POBXMLNodeListener

public class POBIcon
extends java.lang.Object
implements POBXMLNodeListener, com.pubmatic.sdk.common.base.POBAdDescriptor

Instance of this modal class saves the data of VAST Icon.

Field Summary

Fields

Modifier and Type	Field and Description
protected java.lang.String	mClickThroughURL A URI to the advertiser's site that the icon opens when a viewer clicks the ad
protected java.util.List<java.lang.String>	mClickTrackers A URI for tracking when the ClickThrough is triggered.
protected java.util.List<java.lang.String>	mViewTrackers A URI for tracking when the icon is displayed.

Fields inherited from interface com.pubmatic.sdk.common.base.POBAdDescriptor

BID_STATUS_NOT_OK, BID_STATUS_OK, CREATIVE_TYPE_BANNER, CREATIVE_TYPE_NATIVE, CREATIVE_TYPE_VIDEO, DYNAMIC_PRICE_BID, STATIC_PRICE_BID

Constructor Summary

Constructors

Constructor and Description
POBIcon()

Method Summary

Modifier and Type	Method and Description
void	build(POBNodeBuilder builder) POBXMLParser calls this method to build model class object with node builder
com.pubmatic.sdk.common.base.POBAdDescriptor	buildWithRefreshAndExpiryTimeout(int refreshInterval, int expiryTimeout)
java.lang.String	getApiFramework() The API necessary to communicate with the creative if available
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 icon view is clicked.
int	getContentHeight() Returns the height of the icon.
int	getContentWidth() Returns the width of the icon.
java.lang.String	getCreativeType()
int	getDuration() Returns the duration the icon (in seconds) that should be displayed unless clicked or ad is finished playing; In VAST, it is provided in the format HH:MM:SS.mmm or HH:MM:SS where .mmm is milliseconds and optional.
java.lang.String	getId() Returns null as default implementation
int	getOffset() Returns the time of delay in seconds from when the associated linear creative begins playing to when the icon should be displayed; In VAST, it is provided in the format of HH:MM:SS.mmm or HH:MM:SS
java.lang.String	getProgram()
org.json.JSONObject	getRawBid() Not supported for Icon
int	getRefreshInterval() Not supported for Icon
java.lang.String	getRenderableContent() Returns the content to be render as an Icon.
POBResource	getResource() Resources to be displayed
int	getStatus()
java.util.Map<java.lang.String,java.lang.String>	getTargetingInfo()
java.util.List<java.lang.String>	getViewTrackers() A URI to notify the player that icon is loaded.
java.lang.String	getXPosition() Returns the x-coordinate of the top, left corner of the icon asset relative to the ad display area.
java.lang.String	getYPosition() Returns the y-coordinate of the top left corner of the icon asset relative to the ad display area; values of "top" or "bottom" also accepted and indicate the topmost or bottommost available position for the icon asset.
boolean	isAutoClickTrackingEnabled()
boolean	isCompanion()
boolean	isVideo()

Methods inherited from class java.lang.Object

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

Field Detail

mClickThroughURL

@Nullable
protected java.lang.String mClickThroughURL

A URI to the advertiser's site that the icon opens when a viewer clicks the ad

mClickTrackers

@Nullable
protected java.util.List<java.lang.String> mClickTrackers

A URI for tracking when the ClickThrough is triggered.

mViewTrackers

@Nullable
protected java.util.List<java.lang.String> mViewTrackers

A URI for tracking when the icon is displayed.

Constructor Detail

POBIcon

public POBIcon()

Method Detail

getProgram

@Nullable
public java.lang.String getProgram()

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

getXPosition

@Nullable
public java.lang.String getXPosition()

Returns the x-coordinate of the top, left corner of the icon asset relative to the ad display area. Values of "left" or "right" also accepted and indicate the leftmost or rightmost available position for the icon asset.

Returns:

x-coordinate of the icon

getYPosition

@Nullable
public java.lang.String getYPosition()

Returns the y-coordinate of the top left corner of the icon asset relative to the ad display area; values of "top" or "bottom" also accepted and indicate the topmost or bottommost available position for the icon asset.

Returns:

y-coordinate of the icon

getApiFramework

@Nullable
public java.lang.String getApiFramework()

The API necessary to communicate with the creative if available

Returns:

api framework

getResource

@Nullable
public POBResource getResource()

Resources to be displayed

Returns:

POBResource object

getClickThroughURL

@Nullable
public java.lang.String getClickThroughURL()

A URI to open when companion ad is clicked.

Returns:

click through URL

getClickTrackers

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

A URI to notify the player that icon view is clicked.

Returns:

click tracking URL

getViewTrackers

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

A URI to notify the player that icon is loaded.

Returns:

view tracking URL

getRenderableContent

@Nullable
public java.lang.String getRenderableContent()

Returns the content to be render as an Icon.

Specified by:

getRenderableContent in interface com.pubmatic.sdk.common.base.POBAdDescriptor

Returns:

Renderable content

isVideo

public boolean isVideo()

Specified by:

isVideo in interface com.pubmatic.sdk.common.base.POBAdDescriptor

isCompanion

public boolean isCompanion()

Specified by:

isCompanion in interface com.pubmatic.sdk.common.base.POBAdDescriptor

getContentWidth

public int getContentWidth()

Returns the width of the icon.

Specified by:

getContentWidth in interface com.pubmatic.sdk.common.base.POBAdDescriptor

Returns:

width of icon

getContentHeight

public int getContentHeight()

Returns the height of the icon.

Specified by:

getContentHeight in interface com.pubmatic.sdk.common.base.POBAdDescriptor

Returns:

height of icon

getRawBid

@Nullable
public org.json.JSONObject getRawBid()

Not supported for Icon

Specified by:

getRawBid in interface com.pubmatic.sdk.common.base.POBAdDescriptor

Returns:

Returns null for the icon

getRefreshInterval

public int getRefreshInterval()

Not supported for Icon

Specified by:

getRefreshInterval in interface com.pubmatic.sdk.common.base.POBAdDescriptor

Returns:

Returns 0 for the icon

getId

@Nullable
public java.lang.String getId()

Returns null as default implementation

Specified by:

getId in interface com.pubmatic.sdk.common.base.POBAdDescriptor

Returns:

null as default implementation

getCreativeType

@Nullable
public java.lang.String getCreativeType()

Specified by:

getCreativeType in interface com.pubmatic.sdk.common.base.POBAdDescriptor

getStatus

public int getStatus()

Specified by:

getStatus in interface com.pubmatic.sdk.common.base.POBAdDescriptor

getTargetingInfo

@Nullable
public java.util.Map<java.lang.String,java.lang.String> getTargetingInfo()

Specified by:

getTargetingInfo in interface com.pubmatic.sdk.common.base.POBAdDescriptor

buildWithRefreshAndExpiryTimeout

@Nullable
public com.pubmatic.sdk.common.base.POBAdDescriptor buildWithRefreshAndExpiryTimeout(int refreshInterval,
                                                                                               int expiryTimeout)

Specified by:

buildWithRefreshAndExpiryTimeout in interface com.pubmatic.sdk.common.base.POBAdDescriptor

isAutoClickTrackingEnabled

public boolean isAutoClickTrackingEnabled()

Specified by:

isAutoClickTrackingEnabled in interface com.pubmatic.sdk.common.base.POBAdDescriptor

getOffset

public int getOffset()

Returns the time of delay in seconds from when the associated linear creative begins playing to when the icon should be displayed; In VAST, it is provided in the format of HH:MM:SS.mmm or HH:MM:SS

Returns:

Icon offset

getDuration

public int getDuration()

Returns the duration the icon (in seconds) that should be displayed unless clicked or ad is finished playing; In VAST, it is provided in the format HH:MM:SS.mmm or HH:MM:SS where .mmm is milliseconds and optional.

Returns:

Icon duration