Package com.pubmatic.sdk.rewardedad

Class POBRewardedAdEvent

  • All Implemented Interfaces:
    
public abstract class POBRewardedAdEvent
extends POBBaseEvent

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

    • Nested Class Summary

      Nested Classes 
      Modifier and Type Class Description

    • Enum Constant Summary

      Enum Constants 
      Enum Constant Description

    • Method Summary

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

      • 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

    • Constructor Detail

      • POBRewardedAdEvent

        POBRewardedAdEvent()

    • Method Detail

      • setEventListener

         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() POBRewardedAdRendering getRenderer(@NonNull() 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() 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() 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() List<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

         void setCustomData(@Nullable() Map<String, 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() abstract Map<String, 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() 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