public class POBRequest
extends java.lang.Object
| Modifier and Type | Class and Description |
|---|---|
static class |
POBRequest.AdPosition
Fold placement of the ad to be served.
|
protected static class |
POBRequest.API
Supported API of the ad to be served.
|
| Modifier and Type | Method and Description |
|---|---|
static POBRequest |
createInstance(java.lang.String pubId,
int profileId,
POBImpression... impressions)
Returns the object of the POBRequest with provided parameters.
|
void |
enableBidSummary(boolean state)
Set to true if summary in response should be enabled.
|
void |
enableDebugState(boolean state)
Enable/Disable debug information in the response.
|
void |
enableTestMode(boolean testMode)
Setter method to set Test mode of the request
By default set to false
When set to true, PubMatic may deliver only test ads which are not billable.
|
java.lang.String |
getAdServerUrl()
Returns value of Ad Server Url if it is set by method
|
POBImpression[] |
getImpressions()
Returns the array of impression object
|
int |
getNetworkTimeout()
Returns the network timeout (in seconds) for making an Ad request.
|
java.lang.String |
getUserKeywords()
Returns the userKeywords list in the form of comma separated String.
|
boolean |
isDebugStateEnabled()
Returns the debug state.
|
void |
setAdServerUrl(java.lang.String adServerUrl)
Setter method to set Ad Server Url
Custom server URL for debugging purpose.
|
void |
setNetworkTimeout(int networkTimeoutInSec)
Sets the network timeout (in seconds) for making an Ad request.
|
void |
setUserKeywords(java.lang.String keyword)
Sets the userKeywords list in the form of comma separated String.
|
void |
setVersionId(int versionId)
This is an optional OpenBid version Id of the publisher.
|
public static POBRequest createInstance(@NonNull java.lang.String pubId, int profileId, @NonNull POBImpression... impressions)
pubId - Identifier of the publisherprofileId - Profile ID of an ad tagimpressions - Objects of POBImpression, separated by comma in case of multiple
values.public boolean isDebugStateEnabled()
public void enableDebugState(boolean state)
state - debug statepublic int getNetworkTimeout()
public void setNetworkTimeout(int networkTimeoutInSec)
networkTimeoutInSec - value in secondspublic POBImpression[] getImpressions()
public java.lang.String getUserKeywords()
public void setUserKeywords(java.lang.String keyword)
keyword - the new keyword to be set in ad requestpublic void enableBidSummary(boolean state)
state - true if summary in response is expectedpublic void setVersionId(int versionId)
versionId - OpenBid version Idpublic void enableTestMode(boolean testMode)
testMode - boolean value, either true or falsepublic void setAdServerUrl(java.lang.String adServerUrl)
adServerUrl - string Urlpublic java.lang.String getAdServerUrl()