Rewarded video - user-initiated ads where users can earn in-app rewards in exchange for viewing a video ad.
1. Manual Caching
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.
To disable automatic caching for Rewarded Video, use the code below before the SDK initialization:
To cache Rewarded Video use:
2. Check if Rewarded Video is loaded
You can check status of loading before showing. This method return a boolean value indicating whether the Rewarded Video is loaded.
3. Display rewarded video
4. Rewarded Video 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.
If you have no placements, or call Appodeal.show with placement that do not exist, the impression will be tagged with 'default' placement and its settings will be applied.
Placement settings affect ONLY ad presentation, not loading or caching.
5. Use rewarded video 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 get them, you need to set the delegate as follows:
Now you can use the following callback methods:
6. Server-to-server (S2S) rewarded video callbacks
To secure your apps economy we offer S2S reward callbacks. To validate each reward you need to setup a callback URL on your server that will receive the reward information. We will pass the user data to your callback URL that 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:4. Your URL should decrypt the data and validate it.
impression_id for uniqueness and store it in your system to prevent the duplication of transactions.
To set user ID, use the
Appodeal.getUserSettings(this).setUserId("User#123") method before the SDK initialization.
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 it 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.
7. Get reward data for a specific placement
To get reward details (currency, name and amount) for any placement, use the
rewardForPlacement:(NSString *)placement method:
8. Get Predicted eCPM
This method return expected eCPM for cached ad. Amount is calculated based on historical data for the current ad unit.
9. Check if Rewarded Video was initialized
true, if Rewarded Video was initialized.
10. Check if autocache is enabled for Rewarded Video
true, if autocache is enabled for Rewarded Video.