Interstitial Integration for Android

The ironSource Interstitial is a full-screen ad unit, usually served at natural transition points during the app lifecycle. We support both static and video interstitials. You can also serve interstitials through the ironSource Mediation platform.

Step 1. Implement the Listener

The ironSource SDK fires several events to inform you of Interstitial Activity. The SDK will notify your delegate of all possible events listed below:

IronSource.setInterstitialListener(new InterstitialListener() {
    /**
     Invoked when Interstitial Ad is ready to be shown after load function was called.
     */
    @Override
    public void onInterstitialAdReady() {
    }
    /**
     invoked when there is no Interstitial Ad available after calling load function.
     */
    @Override
    public void onInterstitialAdLoadFailed(IronSourceError error) {
    }
    /**
     Invoked when the Interstitial Ad Unit is opened
     */
    @Override
    public void onInterstitialAdOpened() {
    }
    /*
     * Invoked when the ad is closed and the user is about to return to the application.
     */
    @Override
    public void onInterstitialAdClosed() {
    }
    /**
     * Invoked when Interstitial ad failed to show.
     // @param error - An object which represents the reason of showInterstitial failure.
     */
    @Override
    public void onInterstitialAdShowFailed(IronSourceError error) {
    }
    /*
     * Invoked when the end user clicked on the interstitial ad.
     * Note - This callback is not supported by all ad networks and might not be supported for all ad types
     */
    @Override
    public void onInterstitialAdClicked() {
    }
   /** Invoked right before the Interstitial screen is about to open. 
       NOTE - This event is available only for some of the networks. You should NOT treat this event as an interstitial impression,
       but rather use InterstitialAdOpenedEvent */ 
    @Override 
    public void onInterstitialAdShowSucceeded() { 
    }
})

Step 2. Load Interstitial Ad

We recommend requesting an Interstitial Ad a short while before you plan on showing it to your users as the loading process can take time.
To request an interstitial ad, call the following method:

IronSource.loadInterstitial();

Step 3. Check Ad Availability

After you call the loadInterstitial in Step 2, you will be notified when the ad is loaded and ready to be shown to your user through the delegate with the method onInterstitialAdReady which will inform you about ad availability.

public void onInterstitialReady(){}

In addition, you can also ask for the ad availability directly by calling the following function:

 boolean isInterstitialReady();

Once the Interstitial ad is available you will be able to show the ad to your users. With ironSource’s Ad Placements, you can customize and optimize the Interstitial experience. This tool enables you to present Interstitial ads to your users in different places, i.e. app launch, between levels, etc. You can use the function in the next step to define the exact Placement you’d like to show an ad from. In addition, to receive details about a specific Ad Placement, you can call the following:

InterstitialPlacement getInterstitialPlacementInfo(String placementName)

In addition to ironSource’s Ad Placements, you can now configure capping and pacing settings for selected placements. Capping and pacing improve the user experience in your app by limiting the number of ads served within a defined timeframe.

We recommend calling the following to verify if a placement is capped before you serve the Interstitial to your user:

IronSource.isInterstitialPlacementCapped(placementName)

Navigate to the Ad Placement document for more details.

Step 4. Show Interstitial Ad

Once you receive the onInterstitialAdReady callback, you are ready to show an Interstitial Ad to your users. Invoke the following method to serve an Interstitial ad to your users:

IronSource.showInterstitial(placementName);

Done!
You can now deliver ironSource Interstitial Ads on your app!