A C D F G I L O P R S

A

addPartnerExtra(POBPartnerExtra) - Method in class com.pubmatic.sdk.openwrap.banner.POBBannerView

Adds the custom data to the Banner ad to be passed to the respective client side partners

addPartnerExtra(POBPartnerExtra) - Method in class com.pubmatic.sdk.openwrap.interstitial.POBInterstitial

Adds the custom data to the Interstitial ad to be passed to the respective client side partners

C

com.pubmatic.sdk.openwrap.banner - package com.pubmatic.sdk.openwrap.banner

com.pubmatic.sdk.openwrap.interstitial - package com.pubmatic.sdk.openwrap.interstitial

D

destroy() - Method in class com.pubmatic.sdk.openwrap.banner.POBBannerView

Invoke this method when your activity/fragment is about to destroy.

destroy() - Method in class com.pubmatic.sdk.openwrap.banner.POBDefaultBannerEventHandler

Method to do the cleanup

destroy() - Method in class com.pubmatic.sdk.openwrap.interstitial.POBDefaultInterstitialEventHandler

Method to do cleanup

destroy() - Method in class com.pubmatic.sdk.openwrap.interstitial.POBInterstitial

Invoke this method when your activity/fragment is about to destroy.

F

forceRefresh() - Method in class com.pubmatic.sdk.openwrap.banner.POBBannerView

Cancels existing ad requests and initiates new ad request.

G

getAdInteractionListener() - Method in class com.pubmatic.sdk.openwrap.banner.POBBannerEvent

Returns the instance of the Inline Ad interaction listener.

getAdInteractionListener() - Method in class com.pubmatic.sdk.openwrap.interstitial.POBInterstitialEvent

Returns the instance of the FullScreen Ad interaction listener.

getAdRequest() - Method in class com.pubmatic.sdk.openwrap.banner.POBBannerView

Returns an Object representing OpenWrap ad request.

getAdRequest() - Method in class com.pubmatic.sdk.openwrap.interstitial.POBInterstitial

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

getAdServerView() - Method in class com.pubmatic.sdk.openwrap.banner.POBBannerEvent

To retrieve ad server ad view

getAdSize() - Method in class com.pubmatic.sdk.openwrap.banner.POBBannerEvent

OpenWrap SDK calls this method to get the size of the ad rendered by the ad server SDK

getBid() - Method in class com.pubmatic.sdk.openwrap.banner.POBBannerView

Get bid

getBid() - Method in class com.pubmatic.sdk.openwrap.interstitial.POBInterstitial

Get bid

getBidsProvider() - Method in interface com.pubmatic.sdk.openwrap.banner.POBBannerEventListener

Returns bids provider

getBidsProvider() - Method in interface com.pubmatic.sdk.openwrap.interstitial.POBInterstitialEventListener

Returns bids provider

getCreativeSize() - Method in class com.pubmatic.sdk.openwrap.banner.POBBannerView

Returns the Size of the rendered ad creative

getCustomData() - Method in interface com.pubmatic.sdk.openwrap.interstitial.POBInterstitialEventListener

Call this to fetch any additional custom data for handling ad server calls or rendering

getImpression() - Method in class com.pubmatic.sdk.openwrap.banner.POBBannerView

Returns an instance of impression object created internally.

getImpression() - Method in class com.pubmatic.sdk.openwrap.interstitial.POBInterstitial

Returns an instance of POBImpression which gets created internally.

getRenderer(String) - Method in class com.pubmatic.sdk.openwrap.banner.POBBannerEvent

OpenWrap SDK calls this method to get the implementation of POBBannerRendering interface to render ad in custom rendering component.

getRenderer(String) - Method in class com.pubmatic.sdk.openwrap.interstitial.POBInterstitialEvent

Optional method to provide implementation of POBInterstitialRendering interface to render ad in custom rendering component.

I

init(String, int, String, POBBannerEvent) - Method in class com.pubmatic.sdk.openwrap.banner.POBBannerView

Initializes newly allocated banner view object.

init(String, int, String, POBAdSize...) - Method in class com.pubmatic.sdk.openwrap.banner.POBBannerView

Initializes newly allocated banner view object for supporting 'No Ad Server Configuration' Invoke this method only if POBBannerView is inflated via xml resource.

isReady() - Method in class com.pubmatic.sdk.openwrap.interstitial.POBInterstitial

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

L

loadAd() - Method in class com.pubmatic.sdk.openwrap.banner.POBBannerView

Initiate the loading of a banner ad, if the POBRequest is available then it proceeds with further execution else it will log error

loadAd() - Method in class com.pubmatic.sdk.openwrap.interstitial.POBInterstitial

Initiate the loading of an interstitial ad

O

onAdClick() - Method in interface com.pubmatic.sdk.openwrap.banner.POBBannerEventListener

Call this when the ad server SDK informs about click happened on Ad

onAdClick() - Method in interface com.pubmatic.sdk.openwrap.interstitial.POBInterstitialEventListener

Notifies the listener that the user clicked the ad

onAdClicked(POBBannerView) - Method in class com.pubmatic.sdk.openwrap.banner.POBBannerView.POBBannerViewListener

Notifies that the user has clicked the ad view.

onAdClicked(POBInterstitial) - Method in class com.pubmatic.sdk.openwrap.interstitial.POBInterstitial.POBInterstitialListener

Notifies that the interstitial ad has been clicked

onAdClosed() - Method in interface com.pubmatic.sdk.openwrap.banner.POBBannerEventListener

Call this when the ad server SDK is about to close / collapse an Ad

onAdClosed(POBBannerView) - Method in class com.pubmatic.sdk.openwrap.banner.POBBannerView.POBBannerViewListener

Notifies that the banner view has closed the ad on top of the current view.

onAdClosed(POBInterstitial) - Method in class com.pubmatic.sdk.openwrap.interstitial.POBInterstitial.POBInterstitialListener

Notifies that the OpenWrap view has closed the ad on top of the current view.

onAdClosed() - Method in interface com.pubmatic.sdk.openwrap.interstitial.POBInterstitialEventListener

Publisher should call this method to notify the OpenWrap SDK about ad close / collapse state when primary SDK renders the creative.

onAdExecutionComplete() - Method in interface com.pubmatic.sdk.openwrap.banner.POBBannerEventListener

Call this when the ad execution is completed due to external ad events.

onAdExpired(POBInterstitial) - Method in class com.pubmatic.sdk.openwrap.interstitial.POBInterstitial.POBInterstitialListener

Notifies that the interstitial ad has been expired.

onAdExpired() - Method in interface com.pubmatic.sdk.openwrap.interstitial.POBInterstitialEventListener

Publisher/Handler should call this method to notify the OpenWrap SDK about ad expiry

onAdFailed(POBBannerView, POBError) - Method in class com.pubmatic.sdk.openwrap.banner.POBBannerView.POBBannerViewListener

Notifies the listener of an error encountered while loading or rendering an ad.

onAdFailedToLoad(POBInterstitial, POBError) - Method in class com.pubmatic.sdk.openwrap.interstitial.POBInterstitial.POBInterstitialListener

Notifies the listener of an error encountered while loading an ad.

onAdFailedToShow(POBInterstitial, POBError) - Method in class com.pubmatic.sdk.openwrap.interstitial.POBInterstitial.POBInterstitialListener

Notifies the listener of an error encountered while showing an ad.

onAdLeftApplication() - Method in interface com.pubmatic.sdk.openwrap.banner.POBBannerEventListener

Call this when the ad server SDK informs about app leave event as a result of user interaction.

onAdLeftApplication() - Method in interface com.pubmatic.sdk.openwrap.interstitial.POBInterstitialEventListener

Notifies the listener whenever current app goes in the background due to user click

onAdOpened() - Method in interface com.pubmatic.sdk.openwrap.banner.POBBannerEventListener

Call this when the ad server SDK is about to open / expand an Ad

onAdOpened(POBBannerView) - Method in class com.pubmatic.sdk.openwrap.banner.POBBannerView.POBBannerViewListener

Notifies listener that the banner view has open the ad on top of the current view/screen, as a result of user interaction.

onAdOpened(POBInterstitial) - Method in class com.pubmatic.sdk.openwrap.interstitial.POBInterstitial.POBInterstitialListener

Notifies that the OpenWrap view will open an ad on top of the current view.

onAdOpened() - Method in interface com.pubmatic.sdk.openwrap.interstitial.POBInterstitialEventListener

Publisher should call this method to notify the OpenWrap SDK about ad open / expand state when primary SDK renders the creative.

onAdReceived(POBBannerView) - Method in class com.pubmatic.sdk.openwrap.banner.POBBannerView.POBBannerViewListener

Notifies the listener that an ad has been successfully loaded and rendered.

onAdReceived(POBInterstitial) - Method in class com.pubmatic.sdk.openwrap.interstitial.POBInterstitial.POBInterstitialListener

Notifies the listener that an ad has been received successfully.

onAdServerImpressionRecorded() - Method in interface com.pubmatic.sdk.openwrap.banner.POBBannerEventListener

Notifies OpenWrap SDK about ad server impression record.

onAdServerWin(View) - Method in interface com.pubmatic.sdk.openwrap.banner.POBBannerEventListener

Call this when the ad server SDK renders its own ad

onAdServerWin() - Method in interface com.pubmatic.sdk.openwrap.interstitial.POBInterstitialEventListener

Publisher should call this method to notify the OpenWrap SDK about ad server SDK renders its own ad

onAppLeaving(POBBannerView) - Method in class com.pubmatic.sdk.openwrap.banner.POBBannerView.POBBannerViewListener

Notifies the listener whenever current app goes in the background due to user click.

onAppLeaving(POBInterstitial) - Method in class com.pubmatic.sdk.openwrap.interstitial.POBInterstitial.POBInterstitialListener

Notifies the listener that a user interaction will open another app (e.g.

onFailed(POBError) - Method in interface com.pubmatic.sdk.openwrap.banner.POBBannerEventListener

Call this when the ad server SDK fails to load the ad

onFailedToLoad(POBError) - Method in interface com.pubmatic.sdk.openwrap.interstitial.POBInterstitialEventListener

Handler should call this method to notify the OpenWrap SDK about any kind of load time error

onFailedToShow(POBError) - Method in interface com.pubmatic.sdk.openwrap.interstitial.POBInterstitialEventListener

Handler should call this method to notify the OpenWrap SDK about any kind of show time error

onOpenWrapPartnerWin(String) - Method in interface com.pubmatic.sdk.openwrap.banner.POBBannerEventListener

Call this when the ad server SDK signals about partner bid win with bid id.

onOpenWrapPartnerWin(String) - Method in interface com.pubmatic.sdk.openwrap.interstitial.POBInterstitialEventListener

Call this when the ad server SDK signals about partner bid win with bid id.

onVideoPlaybackCompleted(POBInterstitial) - Method in class com.pubmatic.sdk.openwrap.interstitial.POBInterstitial.POBVideoListener

Notifies the listener that the playback of the video ad has been completed.

P

pauseAutoRefresh() - Method in class com.pubmatic.sdk.openwrap.banner.POBBannerView

Pauses the auto refresh, By default, banner refreshes automatically as per configured refresh interval on OpenWrap portal.

POBBannerEvent - Class in com.pubmatic.sdk.openwrap.banner

The banner custom event abstract class.

POBBannerEvent() - Constructor for class com.pubmatic.sdk.openwrap.banner.POBBannerEvent

POBBannerEventListener - Interface in com.pubmatic.sdk.openwrap.banner

The banner custom event listener.

POBBannerView - Class in com.pubmatic.sdk.openwrap.banner

The view class that displays the banner ad.

POBBannerView(Context) - Constructor for class com.pubmatic.sdk.openwrap.banner.POBBannerView

Used to create instances when placed in XML layouts.

POBBannerView(Context, AttributeSet) - Constructor for class com.pubmatic.sdk.openwrap.banner.POBBannerView

Used to create instances when placed in XML layouts.

POBBannerView(Context, AttributeSet, int) - Constructor for class com.pubmatic.sdk.openwrap.banner.POBBannerView

Used to create instances when placed in XML layouts with default style.

POBBannerView(Context, String, int, String, POBAdSize...) - Constructor for class com.pubmatic.sdk.openwrap.banner.POBBannerView

Constructor Initializes and returns a newly allocated banner view object for supporting 'No Ad Server Configuration' Publisher should create object of POBBannerView using this constructor when instantiating from code.

POBBannerView(Context, String, int, String, POBBannerEvent) - Constructor for class com.pubmatic.sdk.openwrap.banner.POBBannerView

Constructor Initializes and returns a newly allocated banner view object Publisher should create object of POBBannerView using this constructor when instantiating from java code.

POBBannerView.POBBannerViewListener - Class in com.pubmatic.sdk.openwrap.banner

Static member class for interaction with the POBBannerView.

POBBannerViewListener() - Constructor for class com.pubmatic.sdk.openwrap.banner.POBBannerView.POBBannerViewListener

POBDefaultBannerEventHandler - Class in com.pubmatic.sdk.openwrap.banner

This is EventHandler class used when publisher do not want to support primary ad server.

POBDefaultBannerEventHandler(POBAdSize...) - Constructor for class com.pubmatic.sdk.openwrap.banner.POBDefaultBannerEventHandler

Constructor Accepts POBAdSize and initialize POBDefaultBannerEventHandler

POBDefaultInterstitialEventHandler - Class in com.pubmatic.sdk.openwrap.interstitial

This is EventHandler class used when publisher do not want to support primary ad server.

POBDefaultInterstitialEventHandler() - Constructor for class com.pubmatic.sdk.openwrap.interstitial.POBDefaultInterstitialEventHandler

POBInterstitial - Class in com.pubmatic.sdk.openwrap.interstitial

Displays full-screen interstitial ads.

POBInterstitial(Context, String, int, String) - Constructor for class com.pubmatic.sdk.openwrap.interstitial.POBInterstitial

Constructor.

POBInterstitial(Context, String, int, String, POBInterstitialEvent) - Constructor for class com.pubmatic.sdk.openwrap.interstitial.POBInterstitial

Constructor.

POBInterstitial.POBInterstitialListener - Class in com.pubmatic.sdk.openwrap.interstitial

Static member class for interaction with the POBInterstitial instance.

POBInterstitial.POBVideoListener - Class in com.pubmatic.sdk.openwrap.interstitial

Static member class for interaction with the POBInterstitial instance for video events.

POBInterstitialEvent - Class in com.pubmatic.sdk.openwrap.interstitial

The OpenWrap interstitial custom event abstract class.

POBInterstitialEvent() - Constructor for class com.pubmatic.sdk.openwrap.interstitial.POBInterstitialEvent

POBInterstitialEventListener - Interface in com.pubmatic.sdk.openwrap.interstitial

OpenWrap interstitial custom event listener.

POBInterstitialListener() - Constructor for class com.pubmatic.sdk.openwrap.interstitial.POBInterstitial.POBInterstitialListener

POBVideoListener() - Constructor for class com.pubmatic.sdk.openwrap.interstitial.POBInterstitial.POBVideoListener

proceedOnError(POBBidEvent.BidEventError) - Method in class com.pubmatic.sdk.openwrap.banner.POBBannerView

proceedOnError(POBBidEvent.BidEventError) - Method in class com.pubmatic.sdk.openwrap.interstitial.POBInterstitial

proceedToLoadAd() - Method in class com.pubmatic.sdk.openwrap.banner.POBBannerView

proceedToLoadAd() - Method in class com.pubmatic.sdk.openwrap.interstitial.POBInterstitial

R

requestAd(POBBid) - Method in class com.pubmatic.sdk.openwrap.banner.POBDefaultBannerEventHandler

Provide onOpenWrapPartnerWin() callback since we are providing 'No Ad Server Configuration feature'

requestAd(POBBid) - Method in class com.pubmatic.sdk.openwrap.interstitial.POBDefaultInterstitialEventHandler

Provide onOpenWrapPartnerWin() callback since this is 'No Ad Server Configuration feature'

requestedAdSizes() - Method in class com.pubmatic.sdk.openwrap.banner.POBBannerEvent

OpenWrap SDK calls this method to get the size for which ad request should be made.

requestedAdSizes() - Method in class com.pubmatic.sdk.openwrap.banner.POBDefaultBannerEventHandler

resumeAutoRefresh() - Method in class com.pubmatic.sdk.openwrap.banner.POBBannerView

Resumes the auto-refresh as per configured refresh interval on OpenWrap portal, call this method only if you have previously paused auto-refresh using `pauseAutoRefresh()`.

S

setBidEventListener(POBBidEventListener) - Method in class com.pubmatic.sdk.openwrap.banner.POBBannerView

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

setBidEventListener(POBBidEventListener) - Method in class com.pubmatic.sdk.openwrap.interstitial.POBInterstitial

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

setEventListener(POBBannerEventListener) - Method in class com.pubmatic.sdk.openwrap.banner.POBBannerEvent

OpenWrap SDK calls this method to set POBBannerEventListener, so OpenWrap custom event handler can inform the OpenWrap SDK about the events related to the ad server communication.

setEventListener(POBBannerEventListener) - Method in class com.pubmatic.sdk.openwrap.banner.POBDefaultBannerEventHandler

Method to set POBBannerEventListener to get request ad callback

setEventListener(POBInterstitialEventListener) - Method in class com.pubmatic.sdk.openwrap.interstitial.POBDefaultInterstitialEventHandler

Method to set POBInterstitialEventListener to get request ad callback

setEventListener(POBInterstitialEventListener) - Method in class com.pubmatic.sdk.openwrap.interstitial.POBInterstitialEvent

OpenWrap SDK calls this method to pass the EventListener to publisher.

setListener(POBBannerView.POBBannerViewListener) - Method in class com.pubmatic.sdk.openwrap.banner.POBBannerView

Sets instance of POBBannerViewListener for the Banner view.

setListener(POBInterstitial.POBInterstitialListener) - Method in class com.pubmatic.sdk.openwrap.interstitial.POBInterstitial

Sets instance of POBInterstitialListener for getting callbacks

setVideoListener(POBInterstitial.POBVideoListener) - Method in class com.pubmatic.sdk.openwrap.interstitial.POBInterstitial

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

show() - Method in class com.pubmatic.sdk.openwrap.interstitial.POBInterstitial

Presents an interstitial ad in full screen view until the user dismisses it.

show() - Method in class com.pubmatic.sdk.openwrap.interstitial.POBInterstitialEvent

OpenWrap SDK will call this method when publisher app calls show on POBInterstitial.

A C D F G I L O P R S