com.pubmatic.sdk.common.base

Interface POBAdDescriptor

public interface POBAdDescriptor

Base class denoting the descriptor to be used by the actual creative / bid class implementation

Field Summary

Fields

Modifier and Type	Field and Description
static int	BID_STATUS_OK Constant for OK status

Method Summary

Modifier and Type	Method and Description
POBAdDescriptor	buildWithRefreshAndExpiryTimeout(int refreshInterval, int expiryTimeout) Create new descriptor type by updating existing descriptor's refresh interval and expiryTimeout
int	getContentHeight() Returns the height of the content to be render
int	getContentWidth() Returns the width of the content to be render
java.lang.String	getCreativeType() To get creative type of ad descriptor
java.lang.String	getId() Returns the Id associated with the Ad descriptor's sub class
org.json.JSONObject	getRawBid() Returns the JSON object of the Bid
int	getRefreshInterval() Returns the refresh interval from the ad response descriptor
java.lang.String	getRenderableContent() Returns the content to be render
int	getStatus() Returns status of bid.
java.util.Map<java.lang.String,java.lang.String>	getTargetingInfo() Returns the map of bid-targeting information only, that needs to be passed to ad server SDK.
boolean	isVideo() Returns the state of type video

Field Detail

BID_STATUS_OK

static final int BID_STATUS_OK

Constant for OK status

See Also:

Constant Field Values

Method Detail

getRenderableContent

java.lang.String getRenderableContent()

Returns the content to be render

Returns:

content to be render

isVideo

boolean isVideo()

Returns the state of type video

Returns:

true if current descriptor has video details else return false

getContentWidth

int getContentWidth()

Returns the width of the content to be render

Returns:

width of the content to be render

getContentHeight

int getContentHeight()

Returns the height of the content to be render

Returns:

height of the content to be render

getRawBid

org.json.JSONObject getRawBid()

Returns the JSON object of the Bid

Returns:

JSON object of the Bid

getRefreshInterval

int getRefreshInterval()

Returns the refresh interval from the ad response descriptor

Returns:

refresh interval from the ad response descriptor

getId

@Nullable
java.lang.String getId()

Returns the Id associated with the Ad descriptor's sub class

Returns:

Id associated with the Ad descriptor's sub class

getCreativeType

@Nullable
java.lang.String getCreativeType()

To get creative type of ad descriptor

Returns:

creative type

getStatus

int getStatus()

Returns status of bid. If there are multiple bids, it returns true even if at least status of one of the bid is true.

Returns:

Bid status

getTargetingInfo

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

Returns the map of bid-targeting information only, that needs to be passed to ad server SDK.

Returns:

Map of bid-targeting information

buildWithRefreshAndExpiryTimeout

@Nullable
POBAdDescriptor buildWithRefreshAndExpiryTimeout(int refreshInterval,
                                                           int expiryTimeout)

Create new descriptor type by updating existing descriptor's refresh interval and expiryTimeout

Parameters:

refreshInterval - the refresh interval in seconds

expiryTimeout - the expiryTimeout in milliseconds

Returns:

newly instance descriptor with updated refresh interval and expirytimeout