Apply global settings with the PrebidMobile object.
##Methods
Parameters
accountId: String containing the Prebid Server account ID.
void setPrebidServerAccountId(String accountId)
Example:
PrebidMobile.setPrebidServerAccountId("1234");
Retrieve the Prebid Server account ID.
Parameters
none
String getPrebidServerAccountId()
Parameters
host: Object containing configuration your Prebid Server host with which Prebid SDK will communicate. Choose from the system-defined Prebid Server hosts or define your own custom Prebid Server host.
void setPrebidServerHost(Host host)
Example:
PrebidMobile.setPrebidServerHost(Host.RUBICON);
//or set a custom host
Host.CUSTOM.setHostUrl("https://prebid-server.bidder.com/");
PrebidMobile.setPrebidServerHost(Host.CUSTOM);
Retrieve the Prebid Server host with which Prebid Mobile will communicate.
Parameters
none
Host getPrebidServerHost()
Parameters
timoeoutMillis: The Prebid timeout (accessible to Prebid SDK 1.2+), set in milliseconds, will return control to the ad server SDK to fetch an ad once the expiration period is achieved. Because Prebid SDK solicits bids from Prebid Server in one payload, setting Prebid timeout too low can stymie all demand resulting in a potential negative revenue impact.
void setTimeoutMillis(int timeoutMillis)
int getTimeoutMillis()
Example:
PrebidMobile.setTimeoutMillis(3_000);
If this flag is True AND the app collects the user’s geographical location data, Prebid Mobile will send the user’s geographical location data to Prebid Server. If this flag is False OR the app does not collect the user’s geographical location data, Prebid Mobile will not populate any user geographical location information in the call to Prebid Server.
Parameters
share: Boolean value. Default = false.
void setShareGeoLocation(boolean share)
Example:
PrebidMobile.setShareGeoLocation(true);
Returns a boolean value specifying whether geographic location is shared.
Parameters
none
boolean isShareGeoLocation()
The following methods enable the customization of the HTTP call to the Prebid server:
public static void setCustomHeaders(HashMap<String, String> customHeaders)
You can also inspect the current custon headers using:
public static HashMap<String, String> getCustomHeaders()
Prebid Mobile will use the application context to retrieve metadata needed for targeting, such as user agent, location, device information, and connectivity information.
Parameters
context: Context object.
void setApplicationContext(Context context)
Parameters
none
Context getApplicationContext()
Example:
PrebidMobile.setApplicationContext(getApplicationContext());
Parameters
storedAuctionResponse: Set as type string, stored auction responses signal Prebid Server to respond with a static response matching the storedAuctionResponse found in the Prebid Server Database, useful for debugging and integration testing. No bid requests will be sent to any bidders when a matching storedAuctionResponse is found. For more information on how stored auction responses work, refer to the written description on github issue 133.
void setStoredAuctionResponse(@NonNull String storedAuctionResponse)
Parameters none
String getStoredAuctionResponse()
Example:
PrebidMobile.setStoredAuctionResponse("111122223333");
Stored Bid Responses are similar to Stored Auction Responses in that they signal to Prebid Server to respond with a static pre-defined response, except Stored Bid Responses is done at the bidder level, with bid requests sent out for any bidders not specified in the bidder parameter. For more information on how stored auction responses work, refer to the written description on github issue 133.
Parameters
bidder: Bidder name as defined by Prebid Server bid adapter of type string.
responseId: Configuration ID used in the Prebid Server Database to store static bid responses.
void addStoredBidResponse(String bidder, String responseId)
Example:
PrebidMobile.addStoredBidResponse("appnexus", "221144");
PrebidMobile.addStoredBidResponse("rubicon", "221155");
Parameters none
void clearStoredBidResponses()
pbsDebug: adds the debug flag (“test”:1) on the outbound http call to Prebid Server. The test:1 flag will signal to Prebid Server to emit the full resolved request (resolving any Stored Request IDs) as well as the full Bid Request and Bid Response to and from each bidder.
pbsDebug(Boolean)
Example: PrebidMobile.setPbsDebug(true);