Skip to main content
Version: 3.2.0

Rewarded Video

Rewarded video is a user-initiated ad type. It allows end-users to get in-app rewards or other benefits in exchange for viewing a video ad.

You can use our demo app as a reference project.

Demo App

Check If Ad Is Loaded​

You can check whether or not an ad is loaded at a certain moment. This method returns a boolean value, representing the rewarded video ad loading status.

Appodeal.IsLoaded(AppodealAdType.RewardedVideo);
Check Ad Loading Status

We recommend you always check whether an ad is available before trying to show it.

Example:

if(Appodeal.IsLoaded(AppodealAdType.RewardedVideo)) {
    Appodeal.Show(AppodealShowStyle.RewardedVideo);
}

Display​

To show a rewarded video ad, you need to call the following method:

Appodeal.Show(AppodealShowStyle.RewardedVideo);

Manual Caching​

If you need more control of rewarded video ads loading use manual caching. Manual caching for rewarded video can be useful to improve display rate or decrease SDK loads when several ad types are cached.

  1. To disable automatic caching for rewarded video, use the code below before the SDK initialization:
Appodeal.SetAutoCache(AppodealAdType.RewardedVideo, false);
  1. To cache rewarded video ad manually use the following method:
Appodeal.Cache(AppodealAdType.RewardedVideo);

Callbacks​

The callbacks are used to track different events in the lifecycle of an ad, e.g. when an ad was clicked on or closed. Follow the steps below to implement them:

Subscribe to the desired rewarded video event using one of the options from this guide. (you can subscribe to any number of events you want)

AppodealCallbacks.RewardedVideo.OnLoaded += (sender, args) => { };

You will find all existing rewarded video events in the example below:

public void SomeMethod()
{
    AppodealCallbacks.RewardedVideo.OnLoaded += OnRewardedVideoLoaded;
    AppodealCallbacks.RewardedVideo.OnFailedToLoad += OnRewardedVideoFailedToLoad;
    AppodealCallbacks.RewardedVideo.OnShown += OnRewardedVideoShown;
    AppodealCallbacks.RewardedVideo.OnShowFailed += OnRewardedVideoShowFailed;
    AppodealCallbacks.RewardedVideo.OnClosed += OnRewardedVideoClosed;
    AppodealCallbacks.RewardedVideo.OnFinished += OnRewardedVideoFinished;
    AppodealCallbacks.RewardedVideo.OnClicked += OnRewardedVideoClicked;
    AppodealCallbacks.RewardedVideo.OnExpired += OnRewardedVideoExpired;
 }

#region RewardedVideoAd Callbacks

//Called when rewarded video was loaded (precache flag shows if the loaded ad is precache).
private void OnRewardedVideoLoaded(object sender, AdLoadedEventArgs e)
{
    Debug.Log($"[APDUnity] [Callback] OnRewardedVideoLoaded(bool isPrecache:{e.IsPrecache})");
}

// Called when rewarded video failed to load
private void OnRewardedVideoFailedToLoad(object sender, EventArgs e)
{
    Debug.Log("[APDUnity] [Callback] OnRewardedVideoFailedToLoad()");
}

// Called when rewarded video was loaded, but cannot be shown (internal network errors, placement settings, etc.)
private void OnRewardedVideoShowFailed(object sender, EventArgs e)
{
    Debug.Log("[APDUnity] [Callback] OnRewardedVideoShowFailed()");
}

// Called when rewarded video is shown
private void OnRewardedVideoShown(object sender, EventArgs e)
{
    Debug.Log("[APDUnity] [Callback] OnRewardedVideoShown()");
}

// Called when rewarded video is closed
private void OnRewardedVideoClosed(object sender, RewardedVideoClosedEventArgs e)
{
    Debug.Log($"[APDUnity] [Callback] OnRewardedVideoClosed(bool finished:{e.Finished})");
}

// Called when rewarded video is viewed until the end
private void OnRewardedVideoFinished(object sender, RewardedVideoFinishedEventArgs e)
{
    Debug.Log($"[APDUnity] [Callback] OnRewardedVideoFinished(double amount:{e.Amount}, string name:{e.Currency})");

}

// Called when rewarded video is clicked
private void OnRewardedVideoClicked(object sender, EventArgs e)
{
    Debug.Log("[APDUnity] [Callback] OnRewardedVideoClicked()");
}

//Called when rewarded video is expired and can not be shown
private void OnRewardedVideoExpired(object sender, EventArgs e)
{
    Debug.Log("[APDUnity] [Callback] OnRewardedVideoExpired()");
}

#endregion
Unity Main Thread

All callbacks are called on native main threads that do not match the main thread of the Unity. If you need to receive callbacks in the main Unity thread follow our Callback Usage Guide.

Placements​

Appodeal SDK allows you to tag each impression with different placement. To use placements, you need to create placements in Appodeal Dashboard. Read more about placements.

To show an ad with placement, you have to call show method with specifying placement's name:

Appodeal.Show(AppodealShowStyle.RewardedVideo, "placementName");

If the loaded ad can’t be shown for a specific placement, nothing will be shown. If auto caching is enabled, sdk will start to cache another ad, which can affect display rate. To save the loaded ad for future use (for instance, for another placement) check if the ad can be shown before calling show method:

if(Appodeal.CanShow(AppodealAdType.RewardedVideo, "placementName")) {
    Appodeal.Show(AppodealShowStyle.RewardedVideo, "placementName");
}

You can configure your impression logic for each placement.

If you have no placements, or call Appodeal.Show() method with a placement that does not exist, the impression will be tagged with default placement name and its settings will be applied.

Placement settings affect ONLY ad presentation, not loading or caching.

Server-to-Server Callbacks​

To secure your apps economy we offer S2S reward callbacks. To validate each reward, you need to set up a callback URL on your server that will receive the reward information. We will pass the user data to your callback URL, which you will need to validate and adjust the user balance accordingly.

  1. Create the reward callback URL on your server that will receive the reward information.

  2. Fill the created URL and the encryption key in the app settings in your dashboard.

  3. The reward callback will be sent to your URL using GET request with two parameters:

{http:/example.com/reward}?data1={data1}&data2={data2}

  1. Your URL should decrypt the data and validate it.

  2. Check impression_id for uniqueness and store it in your system to prevent duplicate transactions.

To set user ID, use the following method before SDK initialization:

Appodeal.SetUserId("user#123");

We offer sample scripts in Go, PHP, Ruby, Java, Node.js, Python 3 and C# to decrypt the data. If you need samples in other languages, please contact our support team and we will provide them to you.

Sample in PHP: reward.php.

Sample in Ruby: reward.rb.

Sample in Java: reward.java.

Sample in Node.js: reward.js.

Sample in Python 3: reward.py.

Sample in C#: reward.cs.

Sample in Go: reward.go.

Getting Reward Data For A Specific Placement​

To get reward data and notify your users of it before the video ad is shown, use this method. It returns KeyValuePair with the currency type and amount of the reward.

Appodeal.GetRewardParameters("placementName");

Get Predicted eCPM​

This method returns expected eCPM for a currently cached advertisement. The amount is calculated based on historical data for the current ad unit.

Appodeal.GetPredictedEcpm(AppodealAdType.RewardedVideo);

Mute Video Ads​

This method will take effect only on Android platform

You can mute video ads if calls are muted on the device. For muting you need to call the following method before initializing the SDK.

Appodeal.MuteVideosIfCallsMuted(true);