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

Field Summary

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

Method Summary

Modifier and Type	Method and Description
static POBBid	build(java.lang.String partnerName, 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) Create new descriptor type by updating existing descriptor's refresh interval and expiryTimeout
static POBBid	create(POBBid bid, java.util.Map<java.lang.String,java.lang.String> targetingInfo)
boolean	enableDsaInfoIcon() Returns whether sdk should render the dsa data.
boolean	equals(java.lang.Object obj) Deep comparison by using hashcode
java.util.List<POBReward>	getAllRewards() Returns the list of Rewards object (if any) from the rewards array under bid extension.
java.lang.String	getBidType() Bid type
java.lang.String	getBundle() Returns bundle id received from ad response
java.util.List<java.lang.String>	getClickTrackers() Returns the PubMatic's click trackers
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	getCreative() Returns ad creative
java.lang.String	getCreativeId() Returns the creative Id
java.lang.String	getCreativeType() To get creative type of ad descriptor
java.lang.String	getDealId() Returns deal Id.
java.lang.String	getDisplayedOnBehalfOf() Returns the behalf value.
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
POBImpressionCountingMethod	getImpressionCountingMethod() Returns the method of impression tracking
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	getPaidBy() Returns the paid value.
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 Net Price/bid value This method is updated to return net price from OW SDK v2.4.0.
JSONObject	getRawBid() Returns the JSON object of the Bid
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.Map<java.lang.String,java.lang.String>	getTargetingInfo() Returns the map of targeting information, that needs to be passed to ad server SDK.
java.util.List<POBDSATransparencyInfo>	getTransparencyData() Array of entities that applied user parameters and the parameters they applied.
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	isCompanion() Returns if descriptor id of companion or not
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	isStaticBid() Returns of Bid is of static price
boolean	isVideo() Returns the state of type video
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

create

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

getPrice

public double getPrice()

Returns Net Price/bid value This method is updated to return net price from OW SDK v2.4.0.

Returns:

Net Ecpm price / bid value

getPartnerName

@Nullable
public java.lang.String getPartnerName()

Returns the name of the winning partner

Returns:

Name of the winning partner

build

@NonNull
public static POBBid build(@NonNull
                                    java.lang.String partnerName,
                                    @NonNull
                                    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

getAllRewards

@Nullable
public java.util.List<POBReward> getAllRewards()

Returns the list of Rewards 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 List of Rewards object containing the Reward-type and its value.

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

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

@Nullable
public java.lang.String getCreativeId()

Returns the creative Id

Returns:

Creative Id

getImpressionId

@Nullable
public java.lang.String getImpressionId()

Returns an Impression Id. Also used as a bid id

Returns:

Impression Id

getCreative

@Nullable
public java.lang.String getCreative()

Returns ad creative

Returns:

Ad creative

getlURL

@Nullable
public java.lang.String getlURL()

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

Returns:

loss url

getnURL

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

getBidType

@NonNull
public java.lang.String getBidType()

Bid type

Returns:

bid type

isStaticBid

public boolean isStaticBid()

Returns of Bid is of static price

Returns:

true bid is of POBAdDescriptor.STATIC_PRICE_BID, else returns false

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

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

@Nullable
public java.lang.String getRenderableContent()

Returns the winning creative to be render

Specified by:

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

Returns:

content to be render

isVideo

public boolean isVideo()

Description copied from interface: com.pubmatic.sdk.common.base.POBAdDescriptor

Returns the state of type video

Specified by:

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

Returns:

true if current descriptor has video details else return false

isCompanion

public boolean isCompanion()

Description copied from interface: com.pubmatic.sdk.common.base.POBAdDescriptor

Returns if descriptor id of companion or not

Specified by:

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

Returns:

true if current descriptor is companion else return false

getContentWidth

public int getContentWidth()

Description copied from interface: com.pubmatic.sdk.common.base.POBAdDescriptor

Returns the width of the content to be render

Specified by:

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

Returns:

width of the content to be render

getContentHeight

public int getContentHeight()

Description copied from interface: com.pubmatic.sdk.common.base.POBAdDescriptor

Returns the height of the content to be render

Specified by:

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

Returns:

height of the content to be render

getRawBid

@Nullable
public JSONObject getRawBid()

Description copied from interface: com.pubmatic.sdk.common.base.POBAdDescriptor

Returns the JSON object of the Bid

Specified by:

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

Returns:

JSON object of the Bid

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

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

Description copied from interface: com.pubmatic.sdk.common.base.POBAdDescriptor

To get creative type of ad descriptor

Specified by:

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

Returns:

creative type

getBundle

@Nullable
public java.lang.String getBundle()

Description copied from interface: com.pubmatic.sdk.common.base.POBAdDescriptor

Returns bundle id received from ad response

Specified by:

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

Returns:

bundle id string

getStatus

public int getStatus()

Returns Bid status

Specified by:

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

Returns:

Returns bid status as POBAdDescriptor.BID_STATUS_OK, if ecpm price is greater than 0 else return POBAdDescriptor.BID_STATUS_NOT_OK.

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)

Description copied from interface: com.pubmatic.sdk.common.base.POBAdDescriptor

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

Specified by:

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

Parameters:

refreshInterval - the refresh interval in seconds

expiryTimeout - the expiryTimeout in milliseconds

Returns:

newly instance descriptor with updated refresh interval and expirytimeout

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

getPaidBy

@Nullable
public java.lang.String getPaidBy()

Description copied from interface: com.pubmatic.sdk.common.base.POBAdDescriptor

Returns the paid value. The Advertiser who paid for the ad.

Specified by:

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

Returns:

paid value

enableDsaInfoIcon

public boolean enableDsaInfoIcon()

Description copied from interface: com.pubmatic.sdk.common.base.POBAdDescriptor

Returns whether sdk should render the dsa data.

Specified by:

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

Returns:

boolean indicating whether sdk should render the dsa data.

getDisplayedOnBehalfOf

@Nullable
public java.lang.String getDisplayedOnBehalfOf()

Description copied from interface: com.pubmatic.sdk.common.base.POBAdDescriptor

Returns the behalf value. The entity on whose behalf the ad is displayed. Maximum 100 characters.

Specified by:

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

Returns:

behalf value

getTransparencyData

@Nullable
public java.util.List<POBDSATransparencyInfo> getTransparencyData()

Description copied from interface: com.pubmatic.sdk.common.base.POBAdDescriptor

Array of entities that applied user parameters and the parameters they applied.

Specified by:

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

Returns:

List of POBDSATransparencyInfo

getImpressionCountingMethod

@NonNull
public POBImpressionCountingMethod getImpressionCountingMethod()

Returns the method of impression tracking

Specified by:

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

Returns:

the method of impression tracking

getClickTrackers

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

Description copied from interface: com.pubmatic.sdk.common.base.POBAdDescriptor

Returns the PubMatic's click trackers

Specified by:

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

Returns:

List of click trackers