com.pubmatic.sdk.common.models

Class POBAdResponse.Builder<T extends POBAdDescriptor>

java.lang.Object

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

Type Parameters:

T -

Enclosing class:

POBAdResponse<T extends POBAdDescriptor>

public static class POBAdResponse.Builder<T extends POBAdDescriptor>
extends java.lang.Object

Builder definition to build POBAdResponse class

Constructor Summary

Constructors

Constructor and Description
Builder(org.json.JSONObject customData) Constructor with the JSON object
Builder(java.util.List<T> bids) Constructor with the list of all bids
Builder(POBAdResponse<T> adResponse) Constructor with the ad response

Method Summary

Modifier and Type	Method and Description
POBAdResponse<T>	build() Builds the instance of the POBAdResponse based on provided details.
POBAdResponse.Builder<T>	setClientSidePartnerBids(java.util.List<T> clientSidePartnerBids) Update the client-side Partner bids in the adResponse builder
POBAdResponse.Builder<T>	setLogger(java.lang.String logger) Sets the logger url
POBAdResponse.Builder<T>	setRefreshInterval(int refreshInterval) Sets the refresh interval
POBAdResponse.Builder<T>	setSendAllBidsState(boolean state) Sets the state of the SendAllBids flag
POBAdResponse.Builder<T>	setServerSidePartnerBids(java.util.List<T> serverSidePartnerBids) Update the server-side Partner bids in the adResponse builder
POBAdResponse.Builder<T>	setTracker(java.lang.String tracker) Sets the tracker url
POBAdResponse.Builder<T>	setWinningBid(T winningBid) Sets the winning bid
POBAdResponse.Builder<T>	updateWinningBid(T winningBid) Update the winning bid in the adResponse builder, This will update all respective bids to make winning bid consistent across adResponse like bids, clientSidePartnerBids, serverSidePartnerBids
POBAdResponse.Builder<T>	updateWithRefreshIntervalAndExpiryTimeout(boolean isInterstitial) Update ad response bids (this#bids, this#clientSidePartnerBids, this#serverSidePartnerBids) with refresh interval and expiry timeout.

Methods inherited from class java.lang.Object

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

Constructor Detail

Builder

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

Constructor with the list of all bids

Parameters:

bids - List of bids

Builder

public Builder(@NonNull
               POBAdResponse<T> adResponse)

Constructor with the ad response

Parameters:

adResponse - ad response object

Builder

public Builder(@NonNull
               org.json.JSONObject customData)

Constructor with the JSON object

Parameters:

customData - JSON object of an Ad response

Method Detail

updateWinningBid

public POBAdResponse.Builder<T> updateWinningBid(@NonNull
                                                 T winningBid)

Update the winning bid in the adResponse builder, This will update all respective bids to make winning bid consistent across adResponse like bids, clientSidePartnerBids, serverSidePartnerBids

Parameters:

winningBid - bid instance to be update

Returns:

Returns updated instance

updateWithRefreshIntervalAndExpiryTimeout

public POBAdResponse.Builder<T> updateWithRefreshIntervalAndExpiryTimeout(boolean isInterstitial)

Update ad response bids (this#bids, this#clientSidePartnerBids, this#serverSidePartnerBids) with refresh interval and expiry timeout. While updating exirytimeout isInterstitial flag is used i.e if it's true, the timeout will be POBCommonConstants.BID_EXPIRE_TIME_IN_MILLIS set, else it's considered as an Banner type and expiry timeout is set based on whether banner is of video if it's video the timeout will be POBCommonConstants.BID_EXPIRE_TIME_IN_MILLIS set else the timeout will be POBCommonConstants.BANNER_BID_EXPIRE_TIME_IN_MILLIS set

Parameters:

isInterstitial - used to set expiryTimeout

Returns:

updated adResponse builder.

setClientSidePartnerBids

public POBAdResponse.Builder<T> setClientSidePartnerBids(java.util.List<T> clientSidePartnerBids)

Update the client-side Partner bids in the adResponse builder

Parameters:

clientSidePartnerBids - client-side Partner bids to be update

Returns:

Returns updated instance

setServerSidePartnerBids

public POBAdResponse.Builder<T> setServerSidePartnerBids(java.util.List<T> serverSidePartnerBids)

Update the server-side Partner bids in the adResponse builder

Parameters:

serverSidePartnerBids - server-side Partner bids to be update

Returns:

Returns updated instance

setWinningBid

public POBAdResponse.Builder<T> setWinningBid(T winningBid)

Sets the winning bid

Parameters:

winningBid - winning bid instance

Returns:

Returns updated instance

setLogger

public POBAdResponse.Builder<T> setLogger(java.lang.String logger)

Sets the logger url

Parameters:

logger - logger url

Returns:

Returns updated instance

setTracker

public POBAdResponse.Builder<T> setTracker(java.lang.String tracker)

Sets the tracker url

Parameters:

tracker - tracker url

Returns:

Returns updated instance

setRefreshInterval

public POBAdResponse.Builder<T> setRefreshInterval(int refreshInterval)

Sets the refresh interval

Parameters:

refreshInterval - refresh interval

Returns:

Returns updated instance

setSendAllBidsState

public POBAdResponse.Builder<T> setSendAllBidsState(boolean state)

Sets the state of the SendAllBids flag

Parameters:

state - true if the send all bid state is enabled else false

Returns:

Returns updated instance

build

@NonNull
public POBAdResponse<T> build()

Builds the instance of the POBAdResponse based on provided details.

Returns:

Returns updated instance