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.Builder Builder class to build POBBid, this is an extensible approach can be used for enhancement This helps to make POBBid immutable
static class	POBBid.POBSummary POBSummary class instance holds the information of a single bid which participated in the auction.

Field Summary

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

BID_STATUS_OK

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
com.pubmatic.sdk.common.base.POBAdDescriptor	buildWithRefreshAndExpiryTimeout(int refreshInterval, int expiryTimeout)
java.util.Map<java.lang.String,java.lang.String>	clientBidTargeting(com.pubmatic.sdk.common.POBDataType.POBBidTargetingType targetingType) Method to add buyer prioritization keys.
static POBBid	create(POBBid bid, boolean isOpenWrapBid, com.pubmatic.sdk.common.POBDataType.POBBidTargetingType targetingType)
static POBBid	create(POBBid bid, java.util.Map<java.lang.String,java.lang.String> targetingInfo)
static POBBid	createWithRefreshInterval(POBBid bid, int refreshInterval)
boolean	equals(java.lang.Object obj) Deep comparison by using hashcode
java.lang.String	getBidId() Deprecated. Use getId() instead.
int	getContentHeight()
int	getContentWidth()
java.lang.String	getCreative() Returns ad creative
java.lang.String	getCreativeId() Returns the creative Id
java.lang.String	getCreativeType()
java.lang.String	getDealId() Returns deal Id.
POBReward	getFirstReward() Returns the first Reward object (if any) from the rewards array under bid extension.
int	getHeight() Returns Height of bid creative
java.lang.String	getId() Return bid id of the bid
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	getPartnerId() Returns the OpenWrap partner Id of this bid
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
int	getRemainingExpirationTime() Gives the remaining time for bid expiry.
java.lang.String	getRenderableContent() Returns the winning creative to be render
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
int	hashCode() Custom hash code generation by using concatenation of (rawbid + impression + status)
boolean	hasWon() To get winning status with respect to primary ad server.
boolean	isExpired() The bid expires after the below timeouts it was received based on ad format.
boolean	isServerSideAuctionWinner() Return true if server-side auction wins
boolean	isVideo()
java.util.Map<java.lang.String,java.lang.String>	serverBidTargeting(com.pubmatic.sdk.common.POBDataType.POBBidTargetingType targetingType) Method to remove winning bid targeting from targeting received from server side This method will be used mainly for server side bids as one of them will have winning targeting.
void	setHasWon(boolean hasWon) To update winning status with respect to primary ad server, expected to be updated externally.
java.lang.String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Method Detail

createWithRefreshInterval

@NonNull
public static POBBid createWithRefreshInterval(@NonNull
                                                        POBBid bid,
                                                        int refreshInterval)

create

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

create

@NonNull
public static POBBid create(@NonNull
                                     POBBid bid,
                                     boolean isOpenWrapBid,
                                     @NonNull
                                     com.pubmatic.sdk.common.POBDataType.POBBidTargetingType targetingType)

serverBidTargeting

@Nullable
public java.util.Map<java.lang.String,java.lang.String> serverBidTargeting(@NonNull
                                                                                     com.pubmatic.sdk.common.POBDataType.POBBidTargetingType targetingType)

Method to remove winning bid targeting from targeting received from server side This method will be used mainly for server side bids as one of them will have winning targeting.

Parameters:

targetingType - type of targeting

clientBidTargeting

@Nullable
public java.util.Map<java.lang.String,java.lang.String> clientBidTargeting(@NonNull
                                                                                     com.pubmatic.sdk.common.POBDataType.POBBidTargetingType targetingType)

Method to add buyer prioritization keys. Add winning targeting if the bid is a client-side auction winner. This method will be used mainly for client side bids as they won't have OW server side targeting.

getBidId

@Deprecated
public java.lang.String getBidId()

Deprecated. Use getId() instead.

Return bid id of the bid

Returns:

bid id of type String

getPrice

public double getPrice()

Returns Price/bid value

Returns:

Ecpm price / bid value

getPartnerName

public java.lang.String getPartnerName()

Returns the name of the winning partner

Returns:

Name of the winning partner

build

@NonNull
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

getDealId

@Nullable
public java.lang.String getDealId()

Returns deal Id. Used for PMP deals.

Returns:

Deal Id

getFirstReward

@Nullable
public POBReward getFirstReward()

Returns the first Reward object (if any) from the rewards array under bid extension. It contains the Reward-type and its value. For example: "type": "coins", "value": "50". If no rewards found then it returns null.

Returns:

the first Reward object containing the Reward-type and its value.

getPartnerId

public java.lang.String getPartnerId()

Returns the OpenWrap partner Id of this bid

Returns:

OpenWrap partner Id of this bid

isExpired

public boolean isExpired()

The bid expires after the below timeouts it was received based on ad format. Display banner : 5 min Other : 60 min

Returns:

true if the bid has expired

getRemainingExpirationTime

public int getRemainingExpirationTime()

Gives the remaining time for bid expiry.

Returns:

remaining expiry time in milli-seconds

isServerSideAuctionWinner

public boolean isServerSideAuctionWinner()

Return true if server-side auction wins

Returns:

true if server-side auction wins

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

getCreative

public java.lang.String getCreative()

Returns ad creative

Returns:

Ad creative

getlURL

public java.lang.String getlURL()

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

Returns:

loss url

getSummary

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

Returns bid summary for debugging purpose

Returns:

Bid summary

getnURL

public java.lang.String getnURL()

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

Returns:

Notice URL

hashCode

public int hashCode()

Custom hash code generation by using concatenation of (rawbid + impression + status)

Overrides:

hashCode in class java.lang.Object

Returns:

hash code specific to bid

equals

public boolean equals(@Nullable
                      java.lang.Object obj)

Deep comparison by using hashcode

Overrides:

equals in class java.lang.Object

Parameters:

obj - the obj which is being compared with target bid

Returns:

true if obj is equals with target bid, else returns false

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

getWidth

public int getWidth()

Returns Width of bid creative

Returns:

Width of bid creative

getHeight

public int getHeight()

Returns Height of bid creative

Returns:

Height of bid creative

getRenderableContent

public java.lang.String getRenderableContent()

Returns the winning creative to be render

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

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

getId

public java.lang.String getId()

Return bid id of the bid

Specified by:

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

Returns:

bid id of type String

getCreativeType

@Nullable
public java.lang.String getCreativeType()

Specified by:

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

getStatus

public int getStatus()

Returns Bid status

Specified by:

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

Returns:

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

getTargetingInfo

@Nullable
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. If the the bid is not valid bid (check with its status see POBAdDescriptor.BID_STATUS_OK) it returns null else return valid bid targeting info map

Specified by:

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

Returns:

Map of targeting information

buildWithRefreshAndExpiryTimeout

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

Specified by:

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

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

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