com.pubmatic.sdk.openbid.banner

Interface POBBannerEvent

All Known Implementing Classes:

POBDefaultBannerEventHandler

public interface POBBannerEvent

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
void	destroy() OpenBid SDK calls this method to perform any final cleanup.
com.pubmatic.sdk.common.POBAdSize	getAdSize() OpenBid SDK calls this method to get the size of the ad rendered by the ad server SDK
com.pubmatic.sdk.webrendering.ui.POBBannerRendering	getRenderer(java.lang.String partnerName) OpenBid SDK calls this method to get the implementation of POBBannerRendering interface to render ad in custom rendering component.
void	requestAd(POBBid bid) OpenBid SDK calls this method when it has valid bid/s to pass to the ad server.
com.pubmatic.sdk.common.POBAdSize[]	requestedAdSizes() OpenBid SDK calls this method to get the size for which ad request should be made.
void	setEventListener(POBBannerEventListener listener) OpenBid SDK calls this method to set POBBannerEventListener, so OpenBid custom event handler can inform the OpenBid SDK about the events related to the ad server communication.

Method Detail

requestAd

void requestAd(POBBid bid)

OpenBid SDK calls this method when it has valid bid/s to pass to the ad server. Note that, if the OpenBid SDK does not have valid bids, `requestAd()` will be called with a `null` value.

Parameters:

bid - bid details object having price and other useful information that can be passed to the ad server SDK

setEventListener

void setEventListener(POBBannerEventListener listener)

OpenBid SDK calls this method to set POBBannerEventListener, so OpenBid custom event handler can inform the OpenBid 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

com.pubmatic.sdk.webrendering.ui.POBBannerRendering getRenderer(java.lang.String partnerName)

OpenBid SDK calls this method to get the implementation of POBBannerRendering interface to render ad in custom rendering component. If not implemented, the OpenBid 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()

OpenBid 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

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

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

Returns:

Array of POBAdSize

destroy

void destroy()

OpenBid SDK calls this method to perform any final cleanup.