com.pubmatic.sdk.rewardedad

Class POBRewardedAdEvent

java.lang.Object

com.pubmatic.sdk.openwrap.core.POBBaseEvent

com.pubmatic.sdk.rewardedad.POBRewardedAdEvent

Direct Known Subclasses:

POBDefaultRewardedAdEventHandler

public abstract class POBRewardedAdEvent
extends com.pubmatic.sdk.openwrap.core.POBBaseEvent

The OpenWrap rewarded custom event abstract class. Your rewarded custom event handler must implement this class to communicate with ad server SDK.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	KEY_ALLOW_MULTIPLE_INSTANCES_FOR_ADUNIT_ID
static java.lang.String	KEY_IDENTIFER

Constructor Summary

Constructors

Constructor and Description
POBRewardedAdEvent()

Method Summary

Modifier and Type	Method and Description
com.pubmatic.sdk.openwrap.core.POBRewardedAdInteractionListener	getAdInteractionListener() Returns the instance of the Fullscreen Ad interaction listener.
abstract java.util.Map<java.lang.String,java.lang.String>	getAdServerConfig() This method will be called by POBRewardedAd, to retrieve ad server specific config from respective handlers.
java.util.List<com.pubmatic.sdk.openwrap.core.POBReward>	getAdServerRewards() This method will be called by POBRewardedAd, once the Rewarded Ad is successfully loaded.
com.pubmatic.sdk.common.ui.POBRewardedAdRendering	getRenderer(java.lang.String partnerName) Optional method to provide implementation of POBRewardedAdRendering interface to render ad in custom rendering component.
com.pubmatic.sdk.openwrap.core.POBReward	getSelectedReward() To get selected rewards for current instance of Ad Server.
void	setCustomData(java.util.Map<java.lang.String,java.lang.Object> customData) Sets custom data that may be required by the ad server sdk
abstract void	setEventListener(POBRewardedAdEventListener eventListener) OpenWrap SDK calls this method to pass the EventListener to publisher.
void	show() OpenWrap SDK will call this method when publisher app calls show on POBRewardedAd.

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

destroy, requestAd

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

KEY_IDENTIFER

public static final java.lang.String KEY_IDENTIFER

See Also:

Constant Field Values

KEY_ALLOW_MULTIPLE_INSTANCES_FOR_ADUNIT_ID

public static final java.lang.String KEY_ALLOW_MULTIPLE_INSTANCES_FOR_ADUNIT_ID

See Also:

Constant Field Values

Constructor Detail

POBRewardedAdEvent

public POBRewardedAdEvent()

Method Detail

setEventListener

public abstract void setEventListener(@NonNull
                                      POBRewardedAdEventListener eventListener)

OpenWrap SDK calls this method to pass the EventListener to publisher. Publisher can refer the listener for passing the primary SDK's event to OpenWrap SDK.

Parameters:

eventListener - Listener to POBRewardedAdEventListener

getRenderer

@Nullable
public com.pubmatic.sdk.common.ui.POBRewardedAdRendering getRenderer(@NonNull
                                                                               java.lang.String partnerName)

Optional method to provide implementation of POBRewardedAdRendering interface to render ad in custom rendering component. If not implemented i.e. returning null, the OpenWrap SDK internally creates its own renderer capable of handling simple HTML and MRAID creative

Parameters:

partnerName - Winning partner name

Returns:

Renderer instance to render creative

show

@MainThread
public void show()

OpenWrap SDK will call this method when publisher app calls show on POBRewardedAd. Consumer of this method should call show() of primary ad server SDK.

Note: This method must be invoked from Main thread.

getAdInteractionListener

@Nullable
public com.pubmatic.sdk.openwrap.core.POBRewardedAdInteractionListener getAdInteractionListener()

Returns the instance of the Fullscreen Ad interaction listener. Implementation of this method is required for the Handler class integrated using mediation waterfall like MoPub event handlers for RewardedAd.

Returns:

instance of the POBRewardedAdInteractionListener

getAdServerRewards

@Nullable
public java.util.List<com.pubmatic.sdk.openwrap.core.POBReward> getAdServerRewards()

This method will be called by POBRewardedAd, once the Rewarded Ad is successfully loaded. Event handler should implement it and return the list of reward returned from primary ad server SDK.

Returns:

Returns the list of available Rewards returned from the server whose bid won. It maybe OW server or the primary Ad server.

setCustomData

public void setCustomData(@Nullable
                          java.util.Map<java.lang.String,java.lang.Object> customData)

Sets custom data that may be required by the ad server sdk

Parameters:

customData - additional data to be passed on to the ad server sdk

getAdServerConfig

@Nullable
public abstract java.util.Map<java.lang.String,java.lang.String> getAdServerConfig()

This method will be called by POBRewardedAd, to retrieve ad server specific config from respective handlers. These configuration will used by OpenWrapSDK to handle ad server specific workflow.

Returns:

map with config data to be used internally by SDK

getSelectedReward

@Nullable
public com.pubmatic.sdk.openwrap.core.POBReward getSelectedReward()

To get selected rewards for current instance of Ad Server.

Note: This method should be used only after setting custom data on show API. Calling this method before setting custom data on show, may return invalid reward.

Returns:

Selected Reward if present, else returns null