org.prebid.mobile.core

Class BidResponse

java.lang.Object

org.prebid.mobile.core.BidResponse

public class BidResponse
extends java.lang.Object

Class used to form bid response from response data. It contains bid information like bidderCode, creative, CPM, etc. BidManager Module will use the bid information to create custom keywords to pass to other ad servers.

Constructor Summary

Constructors

Constructor and Description
BidResponse(java.lang.Double cpm, java.lang.String creative)

Method Summary

Modifier and Type	Method and Description
void	addCustomKeyword(java.lang.String key, java.lang.String value) Add a custom keyword for customized BidManager targeting of Line items.
java.lang.Double	getCpm() Get the CPM bid price of the response.
java.lang.String	getCreative() Get the url that can return a creative.
java.util.ArrayList<<any>>	getCustomKeywords() Get the custom keywords for customized BidManager targeting of Line items.
boolean	isExpired() For BidManager Module to check if the bid response is still valid.
void	setBidderCode(java.lang.String bidderCode) Set the name of the bidder that responded this bid
void	setExpiryTime(long expiryTime) Set the expiration time.
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

BidResponse

public BidResponse(java.lang.Double cpm,
                   java.lang.String creative)

Method Detail

getCpm

public java.lang.Double getCpm()

Get the CPM bid price of the response.

Returns:

bid price in CPM

getCreative

public java.lang.String getCreative()

Get the url that can return a creative.

Returns:

creative url

getCustomKeywords

public java.util.ArrayList<<any>> getCustomKeywords()

Get the custom keywords for customized BidManager targeting of Line items.

Returns:

an ArrayList of key value pairs

addCustomKeyword

public void addCustomKeyword(java.lang.String key,
                             java.lang.String value)

Add a custom keyword for customized BidManager targeting of Line items.

Parameters:

key - The key to add; this cannot be null or empty.

value - The value to add; this cannot be null or empty.

setExpiryTime

public void setExpiryTime(long expiryTime)

Set the expiration time. If method not used, will use the default value.

Parameters:

expiryTime - in milliseconds

isExpired

public boolean isExpired()

For BidManager Module to check if the bid response is still valid.

Returns:

false if the bid has been around more then expiration time (in milliseconds)

setBidderCode

public void setBidderCode(java.lang.String bidderCode)

Set the name of the bidder that responded this bid

Parameters:

bidderCode - bidder's name

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object