Rewarded Video

Rewarded Video

Rewarded Video Ad with strong interactive ability has become the mainstream form of mobile advertising industry. It is becoming increasingly common for mobile game developers to rely more on built-in ads than IAP to monetize.

The reward generally comes in the form of in-game currency (gold, coins, power-ups, etc.) and is distributed to the user after a successful video completion. We recommend that rewarded video ads be placed where users are already engaging with in-app purchases or where users may be seeking in-app rewards, such as at the end of the game level or at currency exchange points. After users complete their reward experience, you can designate the rewards they will receive.

The Rewarded Video ad unit offers an engaging ad experience that rewards your users with valuable virtual content in exchange for a completed view. This user-initiated ad unit is great for gaming apps, and enhances your apps experience. This section tells you how to init, load, and show Rewarded Video Ads. 

The SDK will notify the listener of all possible events listed below:

import com.openmediation.sdk.utils.error.Error;
import com.openmediation.sdk.utils.model.Scene;
import com.openmediation.sdk.video.RewardedVideoAd;
import com.openmediation.sdk.video.RewardedVideoListener;
...
RewardedVideoAd.setAdListener(new RewardedVideoListener() {

    /**
     * Invoked when the ad availability status is changed.
     *
     * @param available is a boolean.
     *      True: means the rewarded videos is available and
     *          you can show the video by calling RewardedVideoAd.showAd().
     *      False: means no videos are available
     */
    @Override
    public void onRewardedVideoAvailabilityChanged(boolean available) {
        // Change the rewarded video state according to availability in app.
        // You could show ad right after it's was loaded here
    }

    /**
     * Invoked when the RewardedVideo ad view has opened.
     * Your activity will lose focus.
     */
    @Override
    public void onRewardedVideoAdShowed(Scene scene) {
        // Do not perform heavy tasks till the video ad is going to be closed.
    }

    /**
     * Invoked when the call to show a rewarded video has failed
     * @param error contains the reason for the failure:
     */
    @Override
    public void onRewardedVideoAdShowFailed(Scene scene, Error error) {
        // Video Ad show failed
    }

    /**
     * Invoked when the user clicked on the RewardedVideo ad.
     */
    @Override
    public void onRewardedVideoAdClicked(Scene scene) {
        // Video Ad is clicked
    }

    /**
     * Invoked when the RewardedVideo ad is closed.
     * Your activity will regain focus.
     */
    @Override
    public void onRewardedVideoAdClosed(Scene scene) {
        // Video Ad Closed
    }

    /**
     * Invoked when the RewardedVideo ad start to play.
     * NOTE:You may not receive this callback on some AdNetworks.
     */
    @Override
    public void onRewardedVideoAdStarted(Scene scene) {
        // Video Ad Started
    }

    /**
     * Invoked when the RewardedVideo ad play end.
     * NOTE:You may not receive this callback on some AdNetworks.
     */
    @Override
    public void onRewardedVideoAdEnded(Scene scene) {
        // Video Ad play end
    }

    /**
     * Invoked when the video is completed and the user should be rewarded.
     * If using server-to-server callbacks you may ignore this events and wait
     * for the callback from the OpenMediation server.
     */
    @Override
    public void onRewardedVideoAdRewarded(Scene scene) {
        // Here you can reward the user according to your in-app settings.
    }
});

Step 2. Serve Rewarded Video Ad

Ad Availability

OpenMediation SDK automatic loads ads for you to cache the Rewarded Video Ads during application lifecycle if only SDK is integrated and initiated successfully. By correctly implementing the RewardedVideoListener , you will be notified about the ad availability through the onRewardedVideoAvailabilityChanged callback. 

public void onRewardedVideoAvailabilityChanged(boolean available)

Another way to check if the ad is available is by calling the isReady() function directly. 

public boolean isReady()

Show Video Ad

Once you receive the onRewardedVideoAvailabilityChanged callback, you can invoke the showAd() method to serve a Rewarded Video Ad to your users. The sceneName parameter should be according to the Placement Scene Name list in Placement Settings -> Placement Scenes of OpenMediation Publisher UI.

public void showAd(String sceneName)

//Use empty String as value if you don't need this functionality.
 RewardedVideoAd.showAd("")
 //Or ignore it.
 RewardedVideoAd.showAd()

We do not recommend showing ads in onRewardedVideoAvailabilityChanged callback directly, the Availability event only occurs when the ad availability changes, true or false, which does not necessarily mean it is the right time to serve ad. And showing ads in this callback unrestricted may result in frequent or even continuous ad pop-up, which will cause confusion for users and affect the experience. You should choose when your ads will show based on your application's ad plan.

//if you would like to show ad right after it's was loaded
public void onRewardedVideoAvailabilityChanged(boolean available) {
    if(available) {
        RewardedVideoAd.showAd(sceneName)
    }
}

We strongly recommend checking the ad's availability by isReady method before you show Rewarded Video Ad to your users, as shown in the following code:

//if you would like to show ad when it's required
if (RewardedVideoAd.isReady()) {
    RewardedVideoAd.showAd(sceneName);
}

Capping and Pacing

You can use capping and pacing of scene to improve the user experience in your app by limiting the amount of ads served within a defined timeframe.  You can configure capping and pacing settings for selected scene in placement setting.

Important ! To ensure you don’t show the Rewarded Video button to prompt the user to watch an ad when the placement is capped, you must call the below method to verify if a specific placement has reached its ad limit.

RewardedVideoAd.isSceneCapped(sceneName);

Step 3. Reward the User

The OpenMediation SDK will fire the onRewardedVideoAdRewarded event each time the user successfully completes a video. The RewardedVideoListener will be in place to receive this event so you can reward the user successfully.

Server-to-Server Callbacks

OpenMediation SDK supports the rewarded video ad Server-side Callbacks. You can do this by defining a unique, private endpoint for us , and specify information that you want the OpenMediation server to pass. The way to works is the app on a user’s device will contact OpenMediation servers for validation of a reward. Once a user has been validated by the OpenMediation server, we will send notification to the endpoint defined in your dashboard. Since a user’s device will never be in contact with your server, this method prevents tampering with reward events sent to your endpoint.

Video ExtId

If your Rewarded Video Ad requires server-to-server data interoperability, you need to call setExtId to pass your user identity as below. This parameter is used to verify Rewarded transactions and must be set before calling showAd.

RewardedVideoAd.setExtId(scene, "Your Ext Id");

Configure Rewarded Video Ad Server-side Callback.

And you need to configure Rewarded Video Ad Server-side callback in Advanced settings of Placement. The guide is here.

Endpoint Format

http://yourendpoint.com?variable_name_you_define={content}

{content} - the information that you want the OpenMediation server to pass. The user identity pass to setExtId will be set to {content}.

Done! 
You are now all set to deliver Rewarded Video ads in your app!