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.

Initialization

1. Import the namespaces:

using AppodealStack.Monetization.Api;
using AppodealStack.Monetization.Common;

2. Add the following code within the Start() method of your main scene’s MonoBehavior:

Appodeal.Initialize("YOUR_APPODEAL_APP_KEY", AppodealAdType.RewardedVideo, this);

Initialization method requires 2 parameters:

appKey - appKey is generated when you add an application to Appodeal.
adType - Ad types can be combined using "|" operator. For example, AppodealAdType.Interstitial | AppodealAdType.RewardedVideo.

By default, auto caching is enabled: Appodeal SDK starts to load rewarded video right away after the initialization method is called. The next rewarded video ad starts to load after the previous one was shown.

1. Import the namespaces:

using AppodealAds.Unity.Api;
using AppodealAds.Unity.Common;

2. Add the following code within the Start() method of your main scene’s MonoBehavior:

Appodeal.initialize("YOUR_APPODEAL_APP_KEY", Appodeal.REWARDED_VIDEO, this);

Initialization method requires 3 parameters:

appKey - appKey is generated when you add an application to Appodeal.
adType - Ad types can be combined using "|" operator. For example, AppodealAdType.Interstitial | AppodealAdType.RewardedVideo.

Manual Сaching

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.

To disable automatic caching for rewarded videos use the code below before the SDK initialization:

Appodeal.SetAutoCache(AppodealAdType.RewardedVideo, false);

To cache rewarded video use:

Appodeal.Cache(AppodealAdType.RewardedVideo);

Display

To display rewarded video, you need to call the following code in the activity:

Appodeal.Show(AppodealShowStyle.RewardedVideo);

Check If Ad Is Loaded

You can check status of loading before showing. This method return a boolean value indicating whether the rewarded video is loaded.

Appodeal.IsLoaded(AppodealAdType.RewardedVideo);

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);	
}

Placements

Appodeal SDK allows you to tag each impression with different placement. For using 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 like this in your activity:

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”);
}

Appodeal.show(Appodeal.REWARDED_VIDEO, “placementName”);

if(Appodeal.canShow(Appodeal.REWARDED_VIDEO, “placementName”)){
	Appodeal.show(Appodeal.REWARDED_VIDEO, “placementName”);
}

You can configure your impression logic for each placement.

If you have no placements, or call Appodeal.show with a placement that does not exist, the impression will be tagged with 'default' placement and its settings will be applied.

Important!

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

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. To implement them, you need to follow below steps:

Subscribe to the desired Rewarded Video event using one of the options from this guide. (you can subscribe to any event you want)
You can use callbacks as shown below after:

public void YourMethod()
{
	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("RewardedVideo loaded");  
}
// Called when rewarded video failed to load
private void OnRewardedVideoFailedToLoad(object sender, EventArgs e)
{
	Debug.Log("RewardedVideo failed to load");   
}
// Called when rewarded video was loaded, but cannot be shown (internal network errors, placement settings, or incorrect creative)
private void OnRewardedVideoShowFailed(object sender, EventArgs e)
{
	Debug.Log("RewardedVideo show failed");
}
// Called when rewarded video is shown
private void OnRewardedVideoShown(object sender, EventArgs e)
{
	Debug.Log("RewardedVideo shown");   
}
// Called when rewarded video is closed
private void OnRewardedVideoClosed(object sender, RewardedVideoClosedEventArgs e)
{
	Debug.Log("RewardedVideo closed");
}
// Called when rewarded video is viewed until the end
private void OnRewardedVideoFinished(object sender, RewardedVideoFinishedEventArgs e)
{
	Debug.Log("RewardedVideo finished");
}
// Called when reward video is clicked
private void OnRewardedVideoClicked(object sender, EventArgs e)
{
	Debug.Log("RewardedVideo clicked");
}
//Called when rewarded video is expired and can not be shown
private void OnRewardedVideoExpired(object sender, EventArgs e)
{
	Debug.Log("RewardedVideo expired");
}
#endregion

1. Extend your class with IRewardedVideoAdListener:

YourClassName : IRewardedVideoAdListener;

2. Then call the following method before SDK initialization:

Appodeal.SetRewardedVideoCallbacks(this);

3. Now you can use the following callback methods within your public class :

#region Rewarded Video callback handlers

//Called when rewarded video was loaded (precache flag shows if the loaded ad is precache).
public void OnRewardedVideoLoaded(bool isPrecache) 
{ 
	Debug.Log("Video loaded"); 
} 

// Called when rewarded video failed to load
public void OnRewardedVideoFailedToLoad() 
{ 
	Debug.Log("Video failed"); 
} 

// Called when rewarded video was loaded, but cannot be shown (internal network errors, placement settings, or incorrect creative)
public void OnRewardedVideoShowFailed() 
{ 
	Debug.Log("Video show failed"); 
} 

// Called when rewarded video is shown
public void OnRewardedVideoShown() 
{ 
	Debug.Log("Video shown"); 
} 

// Called when reward video is clicked
public void OnRewardedVideoClicked()
{ 
	Debug.Log("Video clicked"); 
} 

// Called when rewarded video is closed
public void OnRewardedVideoClosed(bool finished) 
{ 
	Debug.Log("Video closed"); 
}

// Called when rewarded video is viewed until the end
public void OnRewardedVideoFinished(double amount, string name) 
{ 
	Debug.Log("Reward: " + amount + " " + name); 
}

//Called when rewarded video is expired and can not be shown
public void OnRewardedVideoExpired() 
{ 
	Debug.Log("Video expired"); 
}
 
#endregion

1. Extend your class with IRewardedVideoAdListener:

YourClassName : IRewardedVideoAdListener;

2. Then call the following method before SDK initialization:

Appodeal.setRewardedVideoCallbacks(this);

3. Now you can use the following callback methods within your public class :

#region Rewarded Video callback handlers

//Called when rewarded video was loaded (precache flag shows if the loaded ad is precache).
public void onRewardedVideoLoaded(bool isPrecache) 
{ 
	Debug.Log("Video loaded"); 
} 

// Called when rewarded video failed to load
public void onRewardedVideoFailedToLoad() 
{ 
	Debug.Log("Video failed"); 
} 

// Called when rewarded video was loaded, but cannot be shown (internal network errors, placement settings, or incorrect creative)
public void onRewardedVideoShowFailed() 
{ 
	Debug.Log("Video show failed"); 
} 

// Called when rewarded video is shown
public void onRewardedVideoShown() 
{ 
	Debug.Log("Video shown"); 
} 

// Called when reward video is clicked
public void onRewardedVideoClicked()
{ 
	Debug.Log("Video clicked"); 
} 

// Called when rewarded video is closed
public void onRewardedVideoClosed(bool finished) 
{ 
	Debug.Log("Video closed"); 
}

// Called when rewarded video is viewed until the end
public void onRewardedVideoFinished(double amount, string name) 
{ 
	Debug.Log("Reward: " + amount + " " + name); 
}

//Called when rewarded video is expired and can not be shown
public void onRewardedVideoExpired() 
{ 
	Debug.Log("Video expired"); 
}
 
#endregion

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.

Server-To-Server Callbacks

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

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

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

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

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

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

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

To set user ID use Appodeal.SetUserId("User#123") method before the SDK initialization.

We offer sample script 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 and we will provide it for 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.

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

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

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

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

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

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

To set user ID use Appodeal.setUserId("User#123") method before the SDK initialization.

We offer sample script 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 and we will provide it for 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.

Get 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 return expected eCPM for cached ad. Amount is calculated based on historical data for the current ad unit.

Appodeal.GetPredictedEcpm(AppodealAdType.RewardedVideo);

Mute Video Ads (Android Only)

You can mute video ads if calls is muted on the device. For muting you need to call the following code before the initialization method

Appodeal.MuteVideosIfCallsMuted(true);