com.pubmatic.sdk.video.vastmodels

Class POBCompanion

java.lang.Object

com.pubmatic.sdk.video.vastmodels.POBVastCreative

com.pubmatic.sdk.video.vastmodels.POBCompanion

All Implemented Interfaces:

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

public class POBCompanion
extends POBVastCreative
implements com.pubmatic.sdk.common.base.POBAdDescriptor

Class represent companion ad associated with InLine or Wrapper Ad

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

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
POBCompanion()

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
int	getAssetHeight() The pixel width of the creative.
int	getAssetWidth() The pixel width of the creative.
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	getContentHeight()
int	getContentWidth()
java.lang.String	getCreativeType()
int	getHeight() Returns the height of placement slot
java.lang.String	getId() Returns null as default implementation
org.json.JSONObject	getRawBid()
int	getRefreshInterval()
java.lang.String	getRenderableContent()
java.lang.String	getRenderingMode()
POBResource	getResource() Companion resources to be displayed
int	getStatus()
java.util.Map<java.lang.String,java.lang.String>	getTargetingInfo()
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
boolean	isAutoClickTrackingEnabled()
boolean	isCompanion()
boolean	isVideo()
void	setRenderingMode(java.lang.String renderingMode)
java.lang.String	toString()

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, wait, wait, wait

Constructor Detail

POBCompanion

public POBCompanion()

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

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

getAssetWidth

public int getAssetWidth()

The pixel width of the creative.

Returns:

width of creative

getAssetHeight

public int getAssetHeight()

The pixel width of the creative.

Returns:

height of creative

getApiFramework

@Nullable
public java.lang.String getApiFramework()

The API necessary to communicate with the creative if available

Returns:

api framework

getRenderingMode

@Nullable
public java.lang.String getRenderingMode()

setRenderingMode

public void setRenderingMode(@Nullable
                             java.lang.String renderingMode)

getResource

@Nullable
public POBResource getResource()

Companion resources to be displayed

Returns:

POBResource

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

getRenderableContent

@Nullable
public java.lang.String getRenderableContent()

Specified by:

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

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()

Specified by:

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

getContentHeight

public int getContentHeight()

Specified by:

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

getRawBid

@Nullable
public org.json.JSONObject getRawBid()

Specified by:

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

getRefreshInterval

public int getRefreshInterval()

Specified by:

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

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

toString

@NonNull
public java.lang.String toString()

Overrides:

toString in class java.lang.Object