com.pubmatic.sdk.openwrap.interstitial

Class POBInterstitial

java.lang.Object

com.pubmatic.sdk.openwrap.interstitial.POBInterstitial

All Implemented Interfaces:

POBBidEvent

@MainThread
public class POBInterstitial
extends java.lang.Object
implements POBBidEvent

Displays full-screen interstitial ads.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	POBInterstitial.POBInterstitialListener Static member class for interaction with the POBInterstitial instance.
static class	POBInterstitial.POBVideoListener Static member class for interaction with the POBInterstitial instance for video events.

Nested classes/interfaces inherited from interface com.pubmatic.sdk.openwrap.core.POBBidEvent

POBBidEvent.BidEventError

Constructor Summary

Constructors

Constructor and Description
POBInterstitial(Context context) Constructor.
POBInterstitial(Context context, java.lang.String publisherId, int profileId, java.lang.String adUnitId) Constructor.
POBInterstitial(Context context, java.lang.String publisherId, int profileId, java.lang.String adUnitId, com.pubmatic.sdk.openwrap.interstitial.POBInterstitialEvent listener) Constructor.

Method Summary

Modifier and Type	Method and Description
void	destroy() Invoke this method when your activity/fragment is about to destroy.
POBRequest	getAdRequest() Returns an instance of POBRequest, required for setting targeting parameters.
POBBid	getBid() Get bid
POBImpression	getImpression() Returns an instance of POBImpression which gets created internally.
boolean	isReady() Method to check whether the ad is loaded and ready to show InterstitialAd.
void	loadAd() Initiate the loading of an interstitial ad
void	loadAd(java.lang.String bidResponse) Initiates the loading of a interstitial ad with oRTB bid response.
void	proceedOnError(POBBidEvent.BidEventError error, java.lang.String errorMessage) Introduced in OpenWrapSDK v3.6.0
boolean	proceedToLoadAd() Proceeds with bid flow, This method should be called only when POBBidEventListener is set Note: Should be called from Main/UI thread.
void	setBidEventListener(POBBidEventListener bidEventListener) Sets the BidEventListener for the ad view Note: Proper reference management practices should be observed when using this listener
void	setListener(POBInterstitial.POBInterstitialListener listener) Sets instance of POBInterstitialListener for getting callbacks
void	setVideoListener(POBInterstitial.POBVideoListener listener) Sets instance of POBVideoListener for getting callbacks of VAST based video ad
void	show() Presents an interstitial ad in full screen view until the user dismisses it.

Methods inherited from class java.lang.Object

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

Constructor Detail

POBInterstitial

public POBInterstitial(@NonNull
                       Context context,
                       @NonNull
                       java.lang.String publisherId,
                       int profileId,
                       @NonNull
                       java.lang.String adUnitId)

Constructor. Initializes and returns newly allocated interstitial object for supporting `No Ad Server Configuration`

Parameters:

context - Activity context

publisherId - Identifier of the publisher

profileId - Profile ID of an ad tag

adUnitId - Ad unit id used to identify unique placement on screen

POBInterstitial

public POBInterstitial(@NonNull
                       Context context)

Constructor. Initializes and returns newly allocated interstitial object for supporting Bidding feature

Parameters:

context - Activity context

POBInterstitial

public POBInterstitial(@NonNull
                       Context context,
                       @NonNull
                       java.lang.String publisherId,
                       int profileId,
                       @NonNull
                       java.lang.String adUnitId,
                       @NonNull
                       com.pubmatic.sdk.openwrap.interstitial.POBInterstitialEvent listener)

Constructor. Initializes and returns newly allocated interstitial object for supporting `No Ad Server Configuration`

Parameters:

context - Activity context

publisherId - Identifier of the publisher

profileId - Profile ID of an ad tag

adUnitId - Ad unit id used to identify unique placement on screen

listener - Valid instance of POBInterstitialEvent

Method Detail

loadAd

@RequiresPermission(value="android.permission.INTERNET")
public void loadAd()

Initiate the loading of an interstitial ad

loadAd

@RequiresPermission(value="android.permission.INTERNET")
public void loadAd(@NonNull
                                                                            java.lang.String bidResponse)

Initiates the loading of a interstitial ad with oRTB bid response. This API expects the response with oRTB v2.5 specification.

Parameters:

bidResponse - oRTB response of format - oRTB-2.5

getImpression

@Nullable
public POBImpression getImpression()

Returns an instance of POBImpression which gets created internally. POBImpression provides the APIs to set PubMatic zone id and other custom parameters.

Returns:

Returns an instance of POBImpression.

getAdRequest

@Nullable
public POBRequest getAdRequest()

Returns an instance of POBRequest, required for setting targeting parameters.

Returns:

Instance of POBRequest

show

public void show()

Presents an interstitial ad in full screen view until the user dismisses it. Calling this method has no effect until the ad is received i.e. onAdReceived() gets called. Recommended to check if isReady() returns true before calling show().

isReady

public boolean isReady()

Method to check whether the ad is loaded and ready to show InterstitialAd.

Returns:

Returns true if the interstitial is ready to be displayed else returns false.

setListener

public void setListener(@Nullable
                        POBInterstitial.POBInterstitialListener listener)

Sets instance of POBInterstitialListener for getting callbacks

Parameters:

listener - Instance of POBInterstitialListener

setVideoListener

public void setVideoListener(@Nullable
                             POBInterstitial.POBVideoListener listener)

Sets instance of POBVideoListener for getting callbacks of VAST based video ad

Parameters:

listener - Instance of POBVideoListener

setBidEventListener

public void setBidEventListener(@Nullable
                                POBBidEventListener bidEventListener)

Sets the BidEventListener for the ad view Note: Proper reference management practices should be observed when using this listener

Specified by:

setBidEventListener in interface POBBidEvent

Parameters:

bidEventListener - reference of POBBidEventListener

proceedToLoadAd

public boolean proceedToLoadAd()

Description copied from interface: POBBidEvent

Proceeds with bid flow, This method should be called only when POBBidEventListener is set Note: Should be called from Main/UI thread. Also, unnecessary duplicate call will fail and appropriate errors will be logged with return value `false`

Specified by:

proceedToLoadAd in interface POBBidEvent

Returns:

Returns the boolean value indicating success or failure.

proceedOnError

public void proceedOnError(@NonNull
                           POBBidEvent.BidEventError error,
                           @NonNull
                           java.lang.String errorMessage)

Description copied from interface: POBBidEvent

Introduced in OpenWrapSDK v3.6.0

Proceeds with error, If integration type is of primary ad server case like DFP and MoPub, the execution is continued by invoking ad server call ignoring OpenWrap's bid. In case of No ad server integration, flow is completed by setting its state to default considering error at client side. Note: Should be called from Main/UI thread

Specified by:

proceedOnError in interface POBBidEvent

Parameters:

error - the error of type POBBidEvent.BidEventError Example: Scenario 1 : When bid is failed in client-side in-app auction loss proceedOnError(BidEventError#CLIENT_SIDE_AUCTION_LOSS);

Scenario 2 : When bid is expired proceedOnError(BidEventError#BID_EXPIRED);

errorMessage - custom description for the error Example: When the bid is failed in client-side application the publisher can pass on custom message to identify the issue in logs

getBid

@Nullable
public POBBid getBid()

Get bid

Specified by:

getBid in interface POBBidEvent

Returns:

returns bid

destroy

public void destroy()

Invoke this method when your activity/fragment is about to destroy. It cleans the resources.