com.pubmatic.sdk.openwrap.core

Class POBBid

java.lang.Object

com.pubmatic.sdk.openwrap.core.POBBid

All Implemented Interfaces:

com.pubmatic.sdk.common.base.POBAdDescriptor

public class POBBid
extends java.lang.Object
implements com.pubmatic.sdk.common.base.POBAdDescriptor

Holds information of winning bid along with all the bids that participated in the auction.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	POBBid.POBSummary POBSummary class instance holds the information of a single bid which participated in the auction.

Constructor Summary

Constructors

Constructor and Description
POBBid()

Method Summary

Modifier and Type	Method and Description
static POBBid	build(java.lang.String partnerName, org.json.JSONObject bidJsonObject) Initializes and returns POBBid object with given bid details and partner name
static POBBid	create(POBBid bid, java.util.Map<java.lang.String,java.lang.String> targetingInfo)
int	getContentHeight()
int	getContentWidth()
java.lang.String	getCreative() Returns ad creative
java.lang.String	getCreativeId() Returns the creative Id
java.lang.String	getCrType() Returns type of creative is going to serve
java.lang.String	getDealId() Returns deal Id.
int	getHeight() Returns Height of bid creative
java.lang.String	getImpressionId() Returns an Impression Id.
java.lang.String	getlURL() Returns Loss notice URL called by the exchange if the bid lose.
java.lang.String	getnURL() Returns Win notice URL called by the exchange if the bid wins
java.lang.String	getPartnerName() Returns the name of the winning partner
double	getPrice() Returns Price/bid value
org.json.JSONObject	getRawBid()
int	getRefreshInterval() Returns the refresh interval received in ad response
java.lang.String	getRenderableContent()
int	getStatus() Returns Bid status
java.util.List<POBBid.POBSummary>	getSummary() Returns bid summary for debugging purpose
java.util.Map<java.lang.String,java.lang.String>	getTargetingInfo() Returns the map of targeting information, that needs to be passed to ad server SDK.
protected java.util.Map<java.lang.String,java.lang.String>	getTargetingInfoWithPricePrecision(int precision) Returns the map of targeting information, that needs to be passed to ad server SDK with specified price precision.
int	getWidth() Returns Width of bid creative
boolean	hasWon() To get winning status with respect to primary ad server.
boolean	isVideo()
void	setHasWon(boolean hasWon) To update winning status with respect to primary ad server, expected to be updated externally.
void	setHeight(int height)
void	setRefreshInterval(int refreshInterval) Sets refresh interval in seconds
void	setWidth(int width)
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

POBBid

public POBBid()

Method Detail

create

public static POBBid create(@NonNull
                            POBBid bid,
                            java.util.Map<java.lang.String,java.lang.String> targetingInfo)

build

public static POBBid build(java.lang.String partnerName,
                           org.json.JSONObject bidJsonObject)

Initializes and returns POBBid object with given bid details and partner name

Parameters:

partnerName - Name of the partner

bidJsonObject - JSON object for the winning bid

Returns:

Instance of POBBid

getStatus

public int getStatus()

Returns Bid status

Returns:

Returns bid status as 1, if ecpm price is greater than 0 else return 0.

getPartnerName

public java.lang.String getPartnerName()

Returns the name of the winning partner

Returns:

Name of the winning partner

getCreativeId

public java.lang.String getCreativeId()

Returns the creative Id

Returns:

Creative Id

getImpressionId

public java.lang.String getImpressionId()

Returns an Impression Id. Also used as a bid id

Returns:

Impression Id

getPrice

public double getPrice()

Returns Price/bid value

Returns:

Ecpm price / bid value

getCreative

public java.lang.String getCreative()

Returns ad creative

Returns:

Ad creative

getDealId

public java.lang.String getDealId()

Returns deal Id. Used for PMP deals.

Returns:

Deal Id

getlURL

public java.lang.String getlURL()

Returns Loss notice URL called by the exchange if the bid lose.

Returns:

loss url

getCrType

public java.lang.String getCrType()

Returns type of creative is going to serve

Returns:

the cry type string

getSummary

public java.util.List<POBBid.POBSummary> getSummary()

Returns bid summary for debugging purpose

Returns:

Bid summary

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

getnURL

public java.lang.String getnURL()

Returns Win notice URL called by the exchange if the bid wins

Returns:

Notice URL

getWidth

public int getWidth()

Returns Width of bid creative

Returns:

Width of bid creative

setWidth

public void setWidth(int width)

getHeight

public int getHeight()

Returns Height of bid creative

Returns:

Height of bid creative

setHeight

public void setHeight(int height)

getRefreshInterval

public int getRefreshInterval()

Returns the refresh interval received in ad response

Specified by:

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

Returns:

refresh interval

setRefreshInterval

public void setRefreshInterval(int refreshInterval)

Sets refresh interval in seconds

Parameters:

refreshInterval - interval in seconds

getTargetingInfo

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

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

Returns:

Map of targeting information

getTargetingInfoWithPricePrecision

protected java.util.Map<java.lang.String,java.lang.String> getTargetingInfoWithPricePrecision(int precision)

Returns the map of targeting information, that needs to be passed to ad server SDK with specified price precision.

Parameters:

precision - Number of digits allowed after decimal point e.g. If Actual price is 1.456 and precision is 2, then tergeting information dictionary will have value for price as info[pwtecp]=1.46

Returns:

Map of targeting information

getRenderableContent

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

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

public org.json.JSONObject getRawBid()

Specified by:

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

setHasWon

public void setHasWon(boolean hasWon)

To update winning status with respect to primary ad server, expected to be updated externally.

Parameters:

hasWon - winning status of type boolean

hasWon

public boolean hasWon()

To get winning status with respect to primary ad server.

Returns:

winning status of the bid