com.pubmatic.sdk.common.models

Class POBAdResponse<T extends POBAdDescriptor>

java.lang.Object

com.pubmatic.sdk.common.models.POBAdResponse<T>

Type Parameters:

T - type of POBAdDescriptor

All Implemented Interfaces:

POBBidsProvider

public class POBAdResponse<T extends POBAdDescriptor>
extends java.lang.Object
implements POBBidsProvider

Class representing response, immutable class can be created using builder Maintains meta data of ad response like bid, client side bids, server side bids etc.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	POBAdResponse.Builder<T extends POBAdDescriptor> Builder definition to build POBAdResponse class

Method Summary

Modifier and Type	Method and Description
static <T extends POBAdDescriptor> POBAdResponse<T>	defaultResponse()
POBAdDescriptor	getBid(java.lang.String bidId) Returns the Bid instance based on the provided bidId from the list of all bids.
java.util.List<T>	getBids()
java.util.List<T>	getClientSidePartnerBids() Gets client side bids
org.json.JSONObject	getCustomData() Gets the custom data
java.lang.String	getLogger() Gets the logger
T	getNextHighestDynamicBid() Gets the fallback bid
int	getRefreshInterval() Gets refresh interval
java.util.List<T>	getServerSidePartnerBids() Gets server side bids
java.util.Map<java.lang.String,java.lang.String>	getTargetingInfo() Returns targeting info for all the bids
java.lang.String	getTracker() Gets the tracker
T	getWinningBid() Gets the winning bid
boolean	isSendAllBidsEnabled() Get the send all bids flag value

Methods inherited from class java.lang.Object

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

Method Detail

defaultResponse

@NonNull
public static <T extends POBAdDescriptor> POBAdResponse<T> defaultResponse()

getClientSidePartnerBids

@Nullable
public java.util.List<T> getClientSidePartnerBids()

Gets client side bids

Returns:

list of client side bids

getServerSidePartnerBids

@Nullable
public java.util.List<T> getServerSidePartnerBids()

Gets server side bids

Returns:

list of server side bids

getLogger

@Nullable
public java.lang.String getLogger()

Gets the logger

Returns:

the logger string

getTracker

@Nullable
public java.lang.String getTracker()

Gets the tracker

Returns:

the tracker string

getCustomData

@Nullable
public org.json.JSONObject getCustomData()

Gets the custom data

Returns:

the custom data json

getRefreshInterval

public int getRefreshInterval()

Gets refresh interval

Returns:

refresh interval in secs

getWinningBid

@Nullable
public T getWinningBid()

Gets the winning bid

Returns:

the winning bid

getNextHighestDynamicBid

@Nullable
public T getNextHighestDynamicBid()

Gets the fallback bid

Returns:

the fallback bid

isSendAllBidsEnabled

public boolean isSendAllBidsEnabled()

Get the send all bids flag value

Returns:

true if multi-bid response is enabled

getTargetingInfo

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

Returns targeting info for all the bids

Specified by:

getTargetingInfo in interface POBBidsProvider

Returns:

Targeting info for all the bids

getBids

@NonNull
public java.util.List<T> getBids()

getBid

@Nullable
public POBAdDescriptor getBid(@Nullable
                                        java.lang.String bidId)

Returns the Bid instance based on the provided bidId from the list of all bids. Returns null if the bidId is invalid or not found in the bid list.

Parameters:

bidId - Valid bid Id

Returns:

Bid instance based on the provided bidId