Class POBAdResponse
-
- All Implemented Interfaces:
-
com.pubmatic.sdk.common.base.POBBidsProvider
public class POBAdResponse<T extends POBAdDescriptor> implements POBBidsProvider
Class representing response, immutable class can be created using builder Maintains meta data of ad response like bid, server side bids etc.
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description public classPOBAdResponse.BuilderBuilder definition to build POBAdResponse class
-
Field Summary
Fields Modifier and Type Field Description public List<T>bidspublic IntegernbrCodepublic List<T>serverSidePartnerBidspublic TwinningBidpublic TnextHighestDynamicBidpublic intrefreshIntervalpublic JSONObjectcustomDatapublic booleanisSendAllBidsEnabled
-
Method Summary
Modifier and Type Method Description List<T>getBids()IntegergetNbrCode()NBR (No Bid Reason) Status Code List<T>getServerSidePartnerBids()Gets server side bids TgetWinningBid()Gets the winning bid TgetNextHighestDynamicBid()Gets the fallback bid intgetRefreshInterval()Gets refresh interval JSONObjectgetCustomData()Gets the custom data booleanisSendAllBidsEnabled()Get the send all bids flag value static <T extends POBAdDescriptor> POBAdResponse<T>defaultResponse()Map<String, String>getTargetingInfo()Returns targeting info for all the bids POBAdDescriptorgetBid(@Nullable() String bidId)Returns the Bid instance based on the provided bidId from the list of all bids. -
-
Method Detail
-
getNbrCode
@Nullable() Integer getNbrCode()
NBR (No Bid Reason) Status Code
- Returns:
Nbr error code
-
getServerSidePartnerBids
@Nullable() List<T> getServerSidePartnerBids()
Gets server side bids
- Returns:
list of server side bids
-
getWinningBid
@Nullable() T getWinningBid()
Gets the winning bid
- Returns:
the winning bid
-
getNextHighestDynamicBid
@Nullable() T getNextHighestDynamicBid()
Gets the fallback bid
- Returns:
the fallback bid
-
getRefreshInterval
int getRefreshInterval()
Gets refresh interval
- Returns:
refresh interval in secs
-
getCustomData
@Nullable() JSONObject getCustomData()
Gets the custom data
- Returns:
the custom data json
-
isSendAllBidsEnabled
boolean isSendAllBidsEnabled()
Get the send all bids flag value
- Returns:
true if multi-bid response is enabled
-
defaultResponse
@NonNull() static <T extends POBAdDescriptor> POBAdResponse<T> defaultResponse()
-
getTargetingInfo
@Nullable() Map<String, String> getTargetingInfo()
Returns targeting info for all the bids
- Returns:
Targeting info for all the bids
-
getBid
@Nullable() POBAdDescriptor getBid(@Nullable() 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
-
-
-
-