com.pubmatic.sdk.openwrap.eventhandler.dfp

Class DFPRewardedEventHandler

java.lang.Object

com.pubmatic.sdk.openwrap.core.POBBaseEvent

com.pubmatic.sdk.rewardedad.POBRewardedAdEvent

com.pubmatic.sdk.openwrap.eventhandler.dfp.DFPRewardedEventHandler

public class DFPRewardedEventHandler
extends com.pubmatic.sdk.rewardedad.POBRewardedAdEvent

This class implements the communication between the OpenWrap SDK and the GAM SDK for a given ad unit. It implements the PubMatic's Wrapper interface. OW SDK notifies (using wrapper interface) to make a request to MoPub SDK and pass the targeting parameters. This class also loads & show the GAM's Rewarded ad, and listen for the callback methods. And pass the GAM ad event to OpenWrap SDK via POBRewardedAdEventListener.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	DFPRewardedEventHandler.DFPConfigListener Interface to get the GAM Rewarded ad and it's request builder, to configure the properties.

Field Summary

Fields inherited from class com.pubmatic.sdk.rewardedad.POBRewardedAdEvent

KEY_ALLOW_MULTIPLE_INSTANCES_FOR_ADUNIT_ID, KEY_IDENTIFER

Constructor Summary

Constructors

Constructor and Description
DFPRewardedEventHandler(Activity activity, java.lang.String adUnitId)

Method Summary

Modifier and Type	Method and Description
void	destroy() OpenWrap SDK calls this method to perform any final cleanup.
com.pubmatic.sdk.openwrap.core.POBRewardedAdInteractionListener	getAdInteractionListener() Returns the instance of the Fullscreen Ad interaction listener.
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<POBReward>	getAdServerRewards() This method will be called by POBRewardedAd, once the Rewarded Ad is successfully loaded.
POBRewardedAdRendering	getRenderer(java.lang.String partnerName) Optional method to provide implementation of POBRewardedAdRendering interface to render ad in custom rendering component.
POBReward	getSelectedReward() To get selected rewards for current instance of Ad Server.
void	requestAd(POBBid bid) OpenWrap SDK calls this method to make a request to primary SDK.
void	setConfigListener(DFPRewardedEventHandler.DFPConfigListener configListener)
void	setCustomData(java.util.Map<java.lang.String,java.lang.Object> customData) Sets custom data that may be required by the ad server sdk
void	setEventListener(com.pubmatic.sdk.rewardedad.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

prepareErrorFromResponse

Methods inherited from class java.lang.Object

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

Constructor Detail

DFPRewardedEventHandler

public DFPRewardedEventHandler(@NonNull
                               Activity activity,
                               @NonNull
                               java.lang.String adUnitId)

Method Detail

setEventListener

public void setEventListener(@NonNull
                             com.pubmatic.sdk.rewardedad.POBRewardedAdEventListener eventListener)

Description copied from class: com.pubmatic.sdk.rewardedad.POBRewardedAdEvent

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.

Specified by:

setEventListener in class com.pubmatic.sdk.rewardedad.POBRewardedAdEvent

Parameters:

eventListener - Listener to POBRewardedAdEventListener

getRenderer

@Nullable
public POBRewardedAdRendering getRenderer(@NonNull
                                                    java.lang.String partnerName)

Description copied from class: com.pubmatic.sdk.rewardedad.POBRewardedAdEvent

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

Overrides:

getRenderer in class com.pubmatic.sdk.rewardedad.POBRewardedAdEvent

Parameters:

partnerName - Winning partner name

Returns:

Renderer instance to render creative

show

@MainThread
public void show()

Description copied from class: com.pubmatic.sdk.rewardedad.POBRewardedAdEvent

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.

Overrides:

show in class com.pubmatic.sdk.rewardedad.POBRewardedAdEvent

getAdInteractionListener

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

Description copied from class: com.pubmatic.sdk.rewardedad.POBRewardedAdEvent

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.

Overrides:

getAdInteractionListener in class com.pubmatic.sdk.rewardedad.POBRewardedAdEvent

Returns:

instance of the POBRewardedAdInteractionListener

getAdServerRewards

@Nullable
public java.util.List<POBReward> getAdServerRewards()

Description copied from class: com.pubmatic.sdk.rewardedad.POBRewardedAdEvent

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.

Overrides:

getAdServerRewards in class com.pubmatic.sdk.rewardedad.POBRewardedAdEvent

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)

Description copied from class: com.pubmatic.sdk.rewardedad.POBRewardedAdEvent

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

Overrides:

setCustomData in class com.pubmatic.sdk.rewardedad.POBRewardedAdEvent

Parameters:

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

getAdServerConfig

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

Description copied from class: com.pubmatic.sdk.rewardedad.POBRewardedAdEvent

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.

Specified by:

getAdServerConfig in class com.pubmatic.sdk.rewardedad.POBRewardedAdEvent

Returns:

map with config data to be used internally by SDK

getSelectedReward

@Nullable
public POBReward getSelectedReward()

Description copied from class: com.pubmatic.sdk.rewardedad.POBRewardedAdEvent

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.

Overrides:

getSelectedReward in class com.pubmatic.sdk.rewardedad.POBRewardedAdEvent

Returns:

Selected Reward if present, else returns null

requestAd

public void requestAd(@Nullable
                      POBBid bid)

Description copied from class: com.pubmatic.sdk.openwrap.core.POBBaseEvent

OpenWrap SDK calls this method to make a request to primary SDK. OpenWrap SDK passes the winning bid for the requested impression. Publisher needs to pass the details as a targeting parameter to primary SDK

Specified by:

requestAd in class com.pubmatic.sdk.openwrap.core.POBBaseEvent

Parameters:

bid - winning bid for the requested impression

destroy

public void destroy()

Description copied from class: com.pubmatic.sdk.openwrap.core.POBBaseEvent

OpenWrap SDK calls this method to perform any final cleanup.

Specified by:

destroy in class com.pubmatic.sdk.openwrap.core.POBBaseEvent

setConfigListener

public void setConfigListener(@Nullable
                              DFPRewardedEventHandler.DFPConfigListener configListener)