com.pubmatic.sdk.openwrap.banner

Interface POBBannerEvent

All Superinterfaces:

POBBaseEvent

All Known Implementing Classes:

POBDefaultBannerEventHandler

public interface POBBannerEvent
extends POBBaseEvent

The banner custom event interface. Your banner custom event handler must implement this interface to communicate with ad server SDK.

Method Summary

Modifier and Type	Method and Description
com.pubmatic.sdk.common.POBAdSize	getAdSize() OpenWrap SDK calls this method to get the size of the ad rendered by the ad server SDK
com.pubmatic.sdk.common.ui.POBBannerRendering	getRenderer(java.lang.String partnerName) OpenWrap SDK calls this method to get the implementation of POBBannerRendering interface to render ad in custom rendering component.
com.pubmatic.sdk.common.POBAdSize[]	requestedAdSizes() OpenWrap SDK calls this method to get the size for which ad request should be made.
void	setEventListener(POBBannerEventListener listener) 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.

Methods inherited from interface com.pubmatic.sdk.openwrap.core.POBBaseEvent

destroy, requestAd, trackClick, trackImpression

Method Detail

setEventListener

void setEventListener(@NonNull
                      POBBannerEventListener listener)

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.

Save the `listener` to use it in later phases of ad server events execution

Parameters:

listener - object conforming to POBBannerEventListener

getRenderer

@Nullable
com.pubmatic.sdk.common.ui.POBBannerRendering getRenderer(java.lang.String partnerName)

OpenWrap SDK calls this method to get the implementation of POBBannerRendering interface to render ad in custom rendering component. If not implemented, the OpenWrap SDK internally creates its own renderer, capable of handling simple HTML and MRAID creative.

Parameters:

partnerName - name of the partner associated with the winning bid

Returns:

renderer object conforming to `POBBannerRendering` interface

getAdSize

com.pubmatic.sdk.common.POBAdSize getAdSize()

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

Returns:

Ad size of the rendered creative

requestedAdSizes

@Nullable
com.pubmatic.sdk.common.POBAdSize[] requestedAdSizes()

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

Returns:

Array of POBAdSize