com.pubmatic.sdk.openwrap.interstitial

Interface POBInterstitialEventListener

@MainThread
public interface POBInterstitialEventListener

OpenWrap interstitial custom event listener. It is used to inform ad server SDK events back to the OpenWrap SDK

Method Summary

Modifier and Type	Method and Description
com.pubmatic.sdk.common.base.POBBidsProvider	getBidsProvider() Returns bids provider
java.util.Map<java.lang.String,java.lang.Object>	getCustomData() Call this to fetch any additional custom data for handling ad server calls or rendering
void	onAdClick() Notifies the listener that the user clicked the ad
void	onAdClosed() Publisher should call this method to notify the OpenWrap SDK about ad close / collapse state when primary SDK renders the creative.
void	onAdExpired() Publisher/Handler should call this method to notify the OpenWrap SDK about ad expiry
void	onAdLeftApplication() Notifies the listener whenever current app goes in the background due to user click
void	onAdOpened() Publisher should call this method to notify the OpenWrap SDK about ad open / expand state when primary SDK renders the creative.
void	onAdServerWin() Publisher should call this method to notify the OpenWrap SDK about ad server SDK renders its own ad
void	onFailed(com.pubmatic.sdk.common.POBError error) Deprecated.
void	onFailedToLoad(com.pubmatic.sdk.common.POBError error) Handler should call this method to notify the OpenWrap SDK about any kind of load time error
void	onFailedToShow(com.pubmatic.sdk.common.POBError error) Handler should call this method to notify the OpenWrap SDK about any kind of show time error
void	onOpenWrapPartnerWin(java.lang.String bidId) Call this when the ad server SDK signals about partner bid win with bid id.

Method Detail

onOpenWrapPartnerWin

void onOpenWrapPartnerWin(@Nullable
                          java.lang.String bidId)

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

Parameters:

bidId - Winning partner bid id

getBidsProvider

@Nullable
com.pubmatic.sdk.common.base.POBBidsProvider getBidsProvider()

Returns bids provider

Returns:

bids provider

onAdServerWin

void onAdServerWin()

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

onFailed

@Deprecated
void onFailed(@NonNull
                          com.pubmatic.sdk.common.POBError error)

Deprecated.

This callback is deprecated from OpenWrap SDK v2.0.0 onwards and will be removed in subsequent releases. Use onFailedToLoad(POBError) or onFailedToShow(POBError) instead. Publisher should call this method to notify the OpenWrap SDK about any kind of error scenario may be when primary SDK gives error.

Parameters:

error - Error object with error details from primary SDK

onFailedToLoad

void onFailedToLoad(@NonNull
                    com.pubmatic.sdk.common.POBError error)

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

Parameters:

error - Error object with error details from ad server SDK

onFailedToShow

void onFailedToShow(@NonNull
                    com.pubmatic.sdk.common.POBError error)

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

Parameters:

error - Error object with error details from ad server SDK

onAdOpened

void onAdOpened()

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

onAdClosed

void onAdClosed()

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

onAdLeftApplication

void onAdLeftApplication()

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

onAdClick

void onAdClick()

Notifies the listener that the user clicked the ad

getCustomData

java.util.Map<java.lang.String,java.lang.Object> getCustomData()

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

onAdExpired

void onAdExpired()

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