Rewarded Video Ads

Overview

Rewarded video ads are a great way to offer users an incentive to stay engaged in your app, while earning more ad revenue. The reward generally comes in the form of in-game currency (gold, coins, power-ups) and is distributed to the user after a successful video completion.

MoPub’s mediation solution officially supports rewarded videos from popular ad networks. We give you the flexibility to work with these popular ad networks without any extra integration with network SDKs. We recommend placing rewarded video ads where your users are already engaging with in-app purchases or in locations where users may be seeking an in-app reward, such as the end of a game or at currency redemption points. Once your users have finished watching the video ad, you can designate the reward they will receive.

Getting Started

  • Before integrating rewarded video ads in your app, you’ll need to go through the steps in our Getting Started Guide, create an account on MoPub, and integrate the SDK into your project.
  • Add a rewarded video ad unit to your app in the MoPub dashboard.
  • If you use mediation, make sure you have added the ad network SDKs and the corresponding adapters you wish to use to your app.

Basic Integration

1. Initialize the MoPub SDK

Initialize the MoPub SDK on app launches. You can typically do that in your Activity’s onCreate(). Note: If you have been using the MoPubRewardedVideos.initializeRewardedVideo() API, it has been deprecated in the 5.0.0 SDK release, so make sure to start using the new initialization API.

You do not need to explicitly initialize any mediated rewarded video network SDKs via their APIs — the MoPub SDK properly handles that logic on your behalf.

2. Request and cache the rewarded video

Cache a rewarded video for the given ad unit ID (often a placement within the app, e.g. game-over screen or in-app store):

MoPubRewardedVideos.loadRewardedVideo("YOUR_AD_UNIT_ID");

3. Show the rewarded video

Check if the rewarded video has been fully cached by calling MoPub.hasRewardedVideo(String adUnitId) before offering to display it to the user.

Show the rewarded video when the user clicks to watch it:

MoPubRewardedVideos.showRewardedVideo("YOUR_AD_UNIT_ID");

4. Optional: Integrate lifecycle callbacks

Network SDKs need to be notified of changes in the activity lifecycle so they can keep track of the current activity and load/show rewarded videos. For example, you can add lifecycle callbacks to all of your activities (including your Launcher Activity) that will load or show rewarded videos.

Important note for specific networks:

  • For AdColony and Vungle rewarded videos, the only required lifecycle callbacks are onCreate, onPause, and onResume.
  • Chartboost rewarded videos require the full set below.
  • For additional help on Tapjoy integration, check here
  • Unity only requires onCreate and onResume. (see Integrate With the Activity Lifecycle)
public class MainActivity extends Activity {
    @Override
    public void onCreate(Bundle savedInstanceState) {
       super.onCreate(savedInstanceState);
       MoPub.onCreate(this);
       // ...
    }

    @Override
    public void onPause() {
        super.onPause();
        MoPub.onPause(this);
    }

    @Override
    public void onResume() {
        super.onResume();
        MoPub.onResume(this);
    }

    // The following methods are required for Chartboost rewarded video mediation
    @Override
    public void onStart() {
        super.onStart();
        MoPub.onStart(this);
    }

    @Override
    public void onRestart() {
        super.onRestart();
        MoPub.onRestart(this);
    }

    @Override
    public void onStop() {
        super.onStop();
        MoPub.onStop(this);
    }

    @Override
    public void onDestroy() {
        super.onDestroy();
        MoPub.onDestroy(this);
    }

    @Override
    public void onBackPressed() {
        super.onBackPressed();
        MoPub.onBackPressed(this);
    }
}

Optional: Set a rewarded video listener

You can set a rewarded video listener to receive relevant callbacks.

public class MainActivity extends Activity {
    private MoPubRewardedVideoListener rewardedVideoListener;

    @Override
    public void onCreate(Bundle savedInstanceState) {
        super.onCreate(savedInstanceState);

        MoPub.onCreate(this);

        rewardedVideoListener = new MoPubRewardedVideoListener() {
            @Override
            public void onRewardedVideoLoadSuccess(String adUnitId) {
                // Called when the video for the given adUnitId has loaded. At this point you should be able to call MoPubRewardedVideos.showRewardedVideo(String) to show the video.
            }
            @Override
            public void onRewardedVideoLoadFailure(String adUnitId, MoPubErrorCode errorCode) {
                // Called when a video fails to load for the given adUnitId. The provided error code will provide more insight into the reason for the failure to load.
            }

            @Override
            public void onRewardedVideoStarted(String adUnitId) {
                // Called when a rewarded video starts playing.
            }

            @Override
            public void onRewardedVideoPlaybackError(String adUnitId, MoPubErrorCode errorCode) {
                //  Called when there is an error during video playback.
            }

            @Override
            public void onRewardedVideoClosed(String adUnitId) {
                // Called when a rewarded video is closed. At this point your application should resume.
            }

            @Override
            public void onRewardedVideoCompleted(Set<String> adUnitIds, MoPubReward reward) {
                // Called when a rewarded video is completed and the user should be rewarded.
                // You can query the reward object with boolean isSuccessful(), String getLabel(), and int getAmount().
            }
        };

        MoPubRewardedVideos.setRewardedVideoListener(rewardedVideoListener);
    }
}

Advanced Use Cases

Mediation Settings

Mediation settings enable you to pass in third-party network specific settings and can be provided as additional parameters during the rewarded video initialization call. For Vungle, during Unity and Chartboost mediation, this is the only mechanism by which a user ID or customer ID can be specified in networks’ server-side callbacks.

Each subclass of CustomEventRewardedVideo specifies its own implementation of mediation settings with its own constructor. For instructions on how to pass in your mediation settings, follow the instructions to do so when initializing the MoPub SDK.

Mediated Network Pre-initialization

Passing in a list of rewarded video network classes that extend from CustomEventRewardedVideo will automatically try to pre-initialize those rewarded networks, in the order passed in, with the last cached initialization parameters for each network. If no cached initialization parameters are found for a network, pre-initialization for that network is skipped.

By pre-initializing the network SDKs, this gives the network the necessary lead time between SDK initialization and ad request to ensure a successful ad request. Every successful call to MoPubRewardedVideo.loadRewardedVideo() will update the initialization parameters in the cache for that network.

To utilize the rewarded video pre-initialization API, follow the instructions to do so when initializing the MoPub SDK. To opt out of the pre-initialization API, simply pass in an empty list.

Note: The existing on-demand network SDK initialization can be combined with this partial pre-initialization call.

Passing Custom Data

There may be cases where your reward server will need additional information to determine an appropriate reward for the user. When the rewarded video is presented, the app can call MoPubRewardedVideos.showRewardedVideo(String adUnitId, String customData) – the second parameter is an optional String containing custom data. The optional custom data will be sent as part of the URL in the server-to-server callback.

Considerations:

  • It is recommended that the custom data String not exceed 8kb in size as this will significantly degrade performance. Try to keep the custom data payload as small as possible.
  • Custom data will only be passed if the ad unit has been setup with a server side callback.

In addition to specifying the custom data at presentation time, the server-side callback URL in the MoPub dashboard will also need to include a query parameter that uses the %%CUSTOM_DATA%% macro. For example:

https://www.your.com/reward?custom_data=%%CUSTOM_DATA%%

Known Limitations

  • Making concurrent ad requests using the same ad unit IDs is not recommended.

Last updated October 10, 2018

TWITTER, MOPUB, and the Bird logo are trademarks of Twitter, Inc. or its affiliates. All third party logos and trademarks included are the property of their respective owners.

© 2018 MoPub Inc.