com.pubmatic.sdk.openwrap.core

Class POBRequest

java.lang.Object

com.pubmatic.sdk.openwrap.core.POBRequest

All Implemented Interfaces:

com.pubmatic.sdk.common.base.POBAdRequest

public class POBRequest
extends java.lang.Object
implements com.pubmatic.sdk.common.base.POBAdRequest

Class to represent the OpenWrap 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.
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, POBAdFormat placementType, POBImpression... impressions) Returns the object of the POBRequest with provided parameters.
void	enableDebugState(boolean state) Enable/Disable debug information in the response.
void	enableReturnAllBidStatus(boolean state) Set to true if seatnonbids in response should be enabled.
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
java.lang.String	getAdUnitId() Returns the Ad unit ID from the 0th index of impression array.
POBImpression[]	getImpressions() Returns the array of impression object
int	getNetworkTimeout() Returns the network timeout (in seconds) for making an Ad request.
POBAdFormat	getPlacementType() Returns the OpenWrap ad format type
int	getProfileId() Returns the profile Id.
java.lang.String	getPubId()
java.lang.Boolean	getTestMode() Returns test Mode of the OpenWrap request
java.lang.Integer	getVersionId() Returns OpenWrap version Id
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	setVersionId(java.lang.Integer versionId) This is an optional OpenWrap 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

@Nullable
public static POBRequest createInstance(@NonNull
                                                  java.lang.String pubId,
                                                  int profileId,
                                                  @NonNull
                                                  POBAdFormat placementType,
                                                  @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

getPlacementType

@NonNull
public POBAdFormat getPlacementType()

Returns the OpenWrap ad format type

Returns:

OpenWrap ad format type

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

getAdUnitId

@NonNull
public java.lang.String getAdUnitId()

Returns the Ad unit ID from the 0th index of impression array. In case Ad unit ID is not available then returns empty string.

Returns:

Ad unit ID from the 0th index of impression array

getImpressions

@Nullable
public POBImpression[] getImpressions()

Returns the array of impression object

Returns:

Array of impression object

getPubId

@NonNull
public java.lang.String getPubId()

Returns:

Publisher id in PubMatic system

enableReturnAllBidStatus

public void enableReturnAllBidStatus(boolean state)

Set to true if seatnonbids in response should be enabled. By default it is set to false
To check the seatnonbids set the log level to OpenWrapSDK.LogLevel.Debug by following Enable SDK Logs.
After response is received check for Received Seat Non Bids: in the logs for the seatnonbids json array received.
The json array contains the statusCode with the rejection of the bid for each partner.

Parameters:

state - true if seatnonbid in response is expected

getProfileId

public int getProfileId()

Returns the profile Id.

Returns:

profile Id

getVersionId

@Nullable
public java.lang.Integer getVersionId()

Returns OpenWrap version Id

Returns:

OpenWrap version Id

setVersionId

public void setVersionId(@Nullable
                         java.lang.Integer versionId)

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

Parameters:

versionId - OpenWrap 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

getTestMode

@Nullable
public java.lang.Boolean getTestMode()

Returns test Mode of the OpenWrap request

Returns:

boolean value of test mode

getAdServerUrl

@Nullable
public java.lang.String getAdServerUrl()

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

Returns:

Ad Server Url

setAdServerUrl

public void setAdServerUrl(@Nullable
                           java.lang.String adServerUrl)

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

Parameters:

adServerUrl - string Url