com.pubmatic.sdk.openbid.interstitial

Class POBInterstitial

java.lang.Object

com.pubmatic.sdk.openbid.interstitial.POBInterstitial

public class POBInterstitial
extends java.lang.Object

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.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	ORIENTATION_KEY

Constructor Summary

Constructors

Constructor and Description
POBInterstitial(android.content.Context context, java.lang.String publisherId, int profileId, java.lang.String adUnitId) Constructor.
POBInterstitial(android.content.Context context, java.lang.String publisherId, int profileId, java.lang.String adUnitId, 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.
POBInterstitialImpression	getImpression() Returns an instance of POBInterstitialImpression 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	setListener(POBInterstitial.POBInterstitialListener listener) Sets instance of POBInterstitialListener for getting callbacks
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

Field Detail

ORIENTATION_KEY

public static final java.lang.String ORIENTATION_KEY

See Also:

Constant Field Values

Constructor Detail

POBInterstitial

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

Constructor. Initializes and returns newly allocated interstitial object

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

POBInterstitial

public POBInterstitial(@NonNull
                       android.content.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

Method Detail

loadAd

public void loadAd()

Initiate the loading of an interstitial ad

getAdRequest

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(POBInterstitial.POBInterstitialListener listener)

Sets instance of POBInterstitialListener for getting callbacks

Parameters:

listener - Instance of POBInterstitialListener

destroy

public void destroy()

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

getImpression

public POBInterstitialImpression getImpression()

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

Returns:

Returns an instance of POBInterstitialImpression.