Rewarded Video Integration for Android

Step 1. Implement the Rewarded Video Listener

The ironSource SDK fires several events to inform you of ad availability and completions so you’ll know when to reward your users.

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

IronSource.setRewardedVideoListener(new RewardedVideoListener() {
    /**
     * Invoked when the RewardedVideo ad view has opened.
     * Your Activity will lose focus. Please avoid performing heavy
     * tasks till the video ad will be closed.
     */
    @Override
    public void onRewardedVideoAdOpened() {
    }
    /*Invoked when the RewardedVideo ad view is about to be closed.
    Your activity will now regain its focus.*/
    @Override
    public void onRewardedVideoAdClosed() {
    }
    /**
     * Invoked when there is a change in the ad availability status.
     *
     * @param - available - value will change to true when rewarded videos are *available.
     *          You can then show the video by calling showRewardedVideo().
     *          Value will change to false when no videos are available.
     */
    @Override
    public void onRewardedVideoAvailabilityChanged(boolean available) {
        //Change the in-app 'Traffic Driver' state according to availability.
    }
    /**
    /**
     * Invoked when the user completed the video and should be rewarded.
     * If using server-to-server callbacks you may ignore this events and wait *for the callback from the ironSource server.
     *
     * @param - placement - the Placement the user completed a video from.
     */
    @Override
    public void onRewardedVideoAdRewarded(Placement placement) {
        /** here you can reward the user according to the given amount.
         String rewardName = placement.getRewardName();
         int rewardAmount = placement.getRewardAmount();
         */
    }
    /* Invoked when RewardedVideo call to show a rewarded video has failed
     * IronSourceError contains the reason for the failure.
     */
    @Override
    public void onRewardedVideoAdShowFailed(IronSourceError error) {
    }
    /*Invoked when the end user clicked on the RewardedVideo ad.
     *Note - This callback is not supported by all ad networks and might not be supported for all ad types
    */
    @Override
   public void onRewardedVideoAdClicked(Placement placement){
   }
    * Note: the events AdStarted and AdEnded below are not available for all supported rewarded video 
       ad networks. Check which events are available per ad network you choose 
       to include in your build.
       We recommend only using events which register to ALL ad networks you 
       include in your build.
    * Invoked when the video ad starts playing.
    */
     @Override
     public void onRewardedVideoAdStarted(){
     }
    /* Invoked when the video ad finishes plating. */
    @Override
    public void onRewardedVideoAdEnded(){
    }
});

Step 2. Show a Video Ad to Your Users

Ad Availability

By correctly implementing the RewardedVideoListener and its functions, you can receive the availability status through the onVideoAvailabilityChanged callback.

public void onVideoAvailabilityChanged(boolean available)

Alternatively, ask for ad availability directly by calling:

boolean available = IronSource.isRewardedVideoAvailable();

Once an Ad Network has an available video you are ready to show this video ad to your users.This is the ideal moment to insert a trigger to encourage your users to watch the video ad.

Ad Placements

With the ironSource Ad Placements tool, you can customize and optimize the Rewarded Video experience. This tool enables you to present videos to your users from different placements depending on the reward. You can use the below function to define the exact Placement you’d like to show an ad from. Navigate to the Ad Placement document for more details.

Serve Video Ad

By calling the showRewardedVideo() method of the ironSource class, you can show a video ad to your users and define the exact Placement you want to show an ad. The Reward settings of this Placement will be pulled from the ironSource server:

IronSource.showRewardedVideo(placementName);

To get details about the specific Reward associated with each Ad Placement, you can call the following:

Placement placement = IronSource.getRewardedVideoPlacementInfo("placementName");
// Null can be returned instead of a placement if the placementName is not valid.
if (placement != null) {
    String rewardName = placement.getRewardName();
    int rewardAmount = placement.getRewardAmount();
}

Capping & Pacing

In addition to ironSource‘s Ad Placements, you can now configure capping and pacing settings for selected placements. Capping and pacing improves the user experience in your app by limiting the amount of ads served within a defined timeframe. Read more about capping and pacing here.

IronSource.isRewardedVideoPlacementCapped("Your Placements");

Dynamic UserID

The Dynamic UserID is a parameter to verify AdRewarded transactions and can be changed throughout the session.  To receive this parameter through the server to server callbacks, it must be set before calling showRewardedVideo. You will receive adynamicUserId parameter in the callback URL with the reward details. 

IronSource.setDynamicUserId("UserID");

Step 3. Reward the User

The ironSource 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.

The Placement object contains both the Reward Name & Reward Amount of the Placement as defined in your ironSource Admin:

public void onRewardedVideoAdRewarded(Placement placement)
{
    //TODO - here you can reward the user according to the given amount
    String rewardName = placement.getRewardName();
    int rewardAmount = placement.getRewardAmount();
}

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