com.pubmatic.sdk.rewardedad

Class POBRewardedAd

java.lang.Object

com.pubmatic.sdk.rewardedad.POBRewardedAd

All Implemented Interfaces:

POBBidEvent

@MainThread
public class POBRewardedAd
extends java.lang.Object
implements POBBidEvent

Displays full-screen rewarded ads.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	POBRewardedAd.POBRewardedAdListener Static member class for interaction with the POBRewardedAd instance.

Nested classes/interfaces inherited from interface com.pubmatic.sdk.openwrap.core.POBBidEvent

POBBidEvent.BidEventError

Method Summary

Modifier and Type	Method and Description
void	destroy() Invoke this method when your activity/fragment is about to destroy.
POBRequest	getAdRequest() Getter for ad request object.
java.util.List<POBReward>	getAvailableRewards() This method returns the list of the available rewards for the loaded Ad.
POBBid	getBid() Get bid
POBImpression	getImpression() Returns an instance of POBImpression which gets created internally.
static POBRewardedAd	getRewardedAd(Context context) Constructor.
static POBRewardedAd	getRewardedAd(Context context, java.lang.String publisherId, int profileId, java.lang.String adUnitId) Constructor.
static POBRewardedAd	getRewardedAd(Context context, java.lang.String publisherId, int profileId, java.lang.String adUnitId, com.pubmatic.sdk.rewardedad.POBRewardedAdEvent eventHandler) Initializes and returns newly allocated rewarded ad object.
boolean	isReady() Method to check whether the ad is loaded and ready to show RewardedAd.
void	loadAd() Initiate the loading of a rewarded ad.
void	loadAd(java.lang.String bidResponse) Initiates the loading of a rewarded ad with oRTB bid response.
void	proceedOnError(POBBidEvent.BidEventError error, java.lang.String errorMessage) Introduced in OpenWrapSDK v3.6.0
boolean	proceedToLoadAd() Proceeds with bid flow, This method should be called only when POBBidEventListener is set Note: Should be called from Main/UI thread.
void	setBidEventListener(POBBidEventListener bidEventListener) Sets the BidEventListener for the ad view Note: Proper reference management practices should be observed when using this listener
void	setListener(POBRewardedAd.POBRewardedAdListener rewardedAdListener) Sets instance of class as a listener to get rewarded ad callbacks
void	setSkipAlertDialogInfo(java.lang.String title, java.lang.String message, java.lang.String resumeTitle, java.lang.String closeTitle) To set info to skip alert dialog, use/set this before calling loadAd() method.
void	show() Presents an rewarded ad in full screen view until the user dismisses it.
void	show(java.util.Map<java.lang.String,java.lang.Object> customData) Presents an Rewarded ad in full screen view until the user dismisses it.

Methods inherited from class java.lang.Object

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

Method Detail

getRewardedAd

@Nullable
public static POBRewardedAd getRewardedAd(@NonNull
                                                    Context context,
                                                    @NonNull
                                                    java.lang.String publisherId,
                                                    int profileId,
                                                    @NonNull
                                                    java.lang.String adUnitId)

Constructor. Initializes and returns newly allocated rewarded ad object for supporting 'No Ad Server Configuration'. Returns null when input parameters are invalid. Note: In case of 'No Ad Server Configuration' it is application side responsibility to call destroy() for every ad instance created.

Parameters:

context - Activity/Application context

publisherId - Identifier of the publisher

profileId - Profile ID of an ad tag

adUnitId - Ad unit id used to identify unique placement on screen

getRewardedAd

@NonNull
public static POBRewardedAd getRewardedAd(@NonNull
                                                   Context context)

Constructor. Initializes and returns newly allocated rewarded ad object for supporting MAX bidding Note: it is application side responsibility to call destroy() for every ad instance created.

Parameters:

context - Activity/Application context

getRewardedAd

@Nullable
public static POBRewardedAd getRewardedAd(@NonNull
                                                    Context context,
                                                    @NonNull
                                                    java.lang.String publisherId,
                                                    int profileId,
                                                    @NonNull
                                                    java.lang.String adUnitId,
                                                    @NonNull
                                                    com.pubmatic.sdk.rewardedad.POBRewardedAdEvent eventHandler)

Initializes and returns newly allocated rewarded ad object. Returns null when input parameters are invalid.

Parameters:

context - Activity/Application context

publisherId - Identifier of the publisher

profileId - Profile ID of an ad tag

adUnitId - Ad unit id used to identify unique placement on screen

eventHandler - Valid instance of POBRewardedAdEvent

setListener

public void setListener(@Nullable
                        POBRewardedAd.POBRewardedAdListener rewardedAdListener)

Sets instance of class as a listener to get rewarded ad callbacks

Parameters:

rewardedAdListener - Instance of POBRewardedAdListener

setSkipAlertDialogInfo

public void setSkipAlertDialogInfo(@NonNull
                                   java.lang.String title,
                                   @NonNull
                                   java.lang.String message,
                                   @NonNull
                                   java.lang.String resumeTitle,
                                   @NonNull
                                   java.lang.String closeTitle)

To set info to skip alert dialog, use/set this before calling loadAd() method. Note: This method validate parameter values, if one of the parameter is null or empty then the skip alert uses default values.

Parameters:

title - the title for skip alert dialog

message - the message for skip alert dialog

resumeTitle - the resume button title for skip alert dialog

closeTitle - the close button title for skip alert dialog

loadAd

public void loadAd()

Initiate the loading of a rewarded ad.

loadAd

public void loadAd(@NonNull
                   java.lang.String bidResponse)

Initiates the loading of a rewarded ad with oRTB bid response. This API expects the response with oRTB v2.5 specification.

Parameters:

bidResponse - oRTB response of format - oRTB-2.5

getImpression

@Nullable
public POBImpression getImpression()

Returns an instance of POBImpression which gets created internally. POBImpression provides the APIs to set PubMatic zone id and other custom parameters.

Returns:

Returns an instance of POBImpression.

getAdRequest

@Nullable
public POBRequest getAdRequest()

Getter for ad request object. It returns null, only when the arguments provided in the constructor are not valid like publisherId or adUnitId.

Returns:

POBRequest object

show

public void show()

Presents an rewarded ad in full screen view until the user dismisses it. Note: Calling this method has no effect until the ad is received i.e. onAdReceived() gets called.

show

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

Presents an Rewarded ad in full screen view until the user dismisses it. Publisher should invoke this method when the primary ad server SDK expects to get notified about the reward selection. This method will convey the selected reward to the event handler.

Note: Calling this method has no effect until the ad is received i.e. onAdReceived() gets called.

Parameters:

customData - Publisher should pass the custom data to be used for Reward selection like: Select the rewards among the multiple configured rewards and pass it in this method. For example:

                        HashMap customDataMap = new HashMap(1);
                        List availableRewards = owRewardedAd.getAvailableRewards();
                        if(availableRewards != null && availableRewards.size()>0) {
                          // Use your own logic for reward selection
                          customDataMap.put(OpenWrapSDK.KEY_SELECTED_REWARD, availableRewards.get(0));
                        }
                        owRewardedAd.show(customDataMap);
                   

Note: In case multiple rewards are configured then passing the selected reward is mandatory. Else, OW SDK will consider any random reward from the configured rewards.

getAvailableRewards

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

This method returns the list of the available rewards for the loaded Ad. It should be called after an Ad has been received and before destroy method called to get valid list of rewards.

Returns:

the list of available rewards for the loaded Ad. It may return null, if the reward is not configured to respective Ad server (OW / primary ad server) or when this method gets called before an Ad has been received or after ad has been destroyed.

isReady

public boolean isReady()

Method to check whether the ad is loaded and ready to show RewardedAd.

Returns:

Returns true if the Rewarded Ad is ready to be displayed else returns false.

destroy

public void destroy()

Invoke this method when your activity/fragment is about to destroy. It cleans the resources.

setBidEventListener

public void setBidEventListener(@Nullable
                                POBBidEventListener bidEventListener)

Sets the BidEventListener for the ad view Note: Proper reference management practices should be observed when using this listener

Specified by:

setBidEventListener in interface POBBidEvent

Parameters:

bidEventListener - reference of POBBidEventListener

proceedToLoadAd

public boolean proceedToLoadAd()

Description copied from interface: POBBidEvent

Proceeds with bid flow, This method should be called only when POBBidEventListener is set Note: Should be called from Main/UI thread. Also, unnecessary duplicate call will fail and appropriate errors will be logged with return value `false`

Specified by:

proceedToLoadAd in interface POBBidEvent

Returns:

Returns the boolean value indicating success or failure.

proceedOnError

public void proceedOnError(@NonNull
                           POBBidEvent.BidEventError error,
                           @NonNull
                           java.lang.String errorMessage)

Description copied from interface: POBBidEvent

Introduced in OpenWrapSDK v3.6.0

Proceeds with error, If integration type is of primary ad server case like DFP and MoPub, the execution is continued by invoking ad server call ignoring OpenWrap's bid. In case of No ad server integration, flow is completed by setting its state to default considering error at client side. Note: Should be called from Main/UI thread

Specified by:

proceedOnError in interface POBBidEvent

Parameters:

error - the error of type POBBidEvent.BidEventError Example: Scenario 1 : When bid is failed in client-side in-app auction loss proceedOnError(BidEventError#CLIENT_SIDE_AUCTION_LOSS);

Scenario 2 : When bid is expired proceedOnError(BidEventError#BID_EXPIRED);

errorMessage - custom description for the error Example: When the bid is failed in client-side application the publisher can pass on custom message to identify the issue in logs

getBid

@Nullable
public POBBid getBid()

Get bid

Specified by:

getBid in interface POBBidEvent

Returns:

returns bid