com.pubmatic.sdk.openbid.core

Class POBRequest

java.lang.Object

com.pubmatic.sdk.openbid.core.POBRequest

public class POBRequest
extends java.lang.Object

Class to represent the OpenBid ad request.

Nested Class Summary

Nested Classes

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.

Method Summary

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.

Methods inherited from class java.lang.Object

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

Method Detail

createInstance

public static POBRequest createInstance(@NonNull
                                        java.lang.String pubId,
                                        int profileId,
                                        @NonNull
                                        POBImpression... impressions)

Returns the object of the POBRequest with provided parameters. Returns null if any of the impression objects or publisher id is not valid

Parameters:

pubId - Identifier of the publisher

profileId - Profile ID of an ad tag

impressions - Objects of POBImpression, separated by comma in case of multiple values.

Returns:

Instance of the POBRequest

isDebugStateEnabled

public boolean isDebugStateEnabled()

Returns the debug state. False means no debug information will be available in bid response.

Returns:

debug state

enableDebugState

public void enableDebugState(boolean state)

Enable/Disable debug information in the response. By default, debug is disabled and no debug information will be available in bid response.

Parameters:

state - debug state

getNetworkTimeout

public int getNetworkTimeout()

Returns the network timeout (in seconds) for making an Ad request.

Returns:

network timeout (in seconds).

setNetworkTimeout

public void setNetworkTimeout(int networkTimeoutInSec)

Sets the network timeout (in seconds) for making an Ad request. Default value is 5 seconds. Provided value should be greater than 0.

Parameters:

networkTimeoutInSec - value in seconds

getImpressions

public POBImpression[] getImpressions()

Returns the array of impression object

Returns:

Array of impression object

getUserKeywords

public java.lang.String getUserKeywords()

Returns the userKeywords list in the form of comma separated String. e.g. Cricket,Pizza

Returns:

user keywords

setUserKeywords

public void setUserKeywords(java.lang.String keyword)

Sets the userKeywords list in the form of comma separated String. e.g. Cricket,Pizza

Parameters:

keyword - the new keyword to be set in ad request

enableBidSummary

public void enableBidSummary(boolean state)

Set to true if summary in response should be enabled. By default it is set to false

Parameters:

state - true if summary in response is expected

setVersionId

public void setVersionId(int versionId)

This is an optional OpenBid version Id of the publisher. If this is not specified, live version of the above profile is considered.

Parameters:

versionId - OpenBid version Id

enableTestMode

public 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. Please disable the Test Mode for requests before you submit your application to the play store.

Parameters:

testMode - boolean value, either true or false

setAdServerUrl

public void setAdServerUrl(java.lang.String adServerUrl)

Setter method to set Ad Server Url Custom server URL for debugging purpose.

Parameters:

adServerUrl - string Url

getAdServerUrl

public java.lang.String getAdServerUrl()

Returns value of Ad Server Url if it is set by method

Returns:

Ad Server Url