Interstitial ads

A fullscreen ad format, interstitial ads are integrated in the app content at natural breaks, such as when the user transitions to the next game level or completes a conversion action.

Note

Examples showing how all the format types work are available in the demo project.

Entity	Description
`onAdFailedToLoad`	If `onAdFailedToLoad()` returns an error, don't attempt to load a new ad again using the same method.
`InterstitialAdEventListener`	Don't save links to previously displayed ads. Call `setAdEventListener(null)` for previously displayed ads. Call `setAdLoadListener(null)` for the loader if you're no longer using it. This frees up resources and prevents memory leaks.
`adUnitId`	Use: Development mode to work with demo ad units. Production mode to work with `R-M-XXXXXX-Y` (for the actual ID, check the Yandex Advertising Network interface). `R-M-XXXXXX-Y` is a template for your actual ad unit ID that will be used to receive various creatives.

Implementation

Key steps for integrating interstitial ads:

Create and configure the InterstitialAdLoader ad loader.
Register the listener for ad load callback methods: InterstitialAdLoadListener.
Load the ad.
Pass additional settings if you're using Adfox.
Register an InterstitialAdEventListener to listen for ad event callbacks.
Display the InterstitialAd object.

Features of interstitial ad integration

All calls to Yandex Mobile Ads SDK methods must be made from the main thread.
If the onAdFailedToLoad() callback returns an error, don't try to load a new ad again. If there's no other option, limit the number of ad load retries. This will help avoid constant unsuccessful requests and connection issues if there are limitations.
We recommend maintaining a strong reference to the loader and ad throughout the lifecycle of the screen that hosts interactions with the ad to avoid cleanup by the garbage cleaner.
We recommend using a single instance of InterstitialAdLoader for all ad loads to improve performance.

Loading ads

To upload interstitial ads, create and set up the InterstitialAdLoader object.

For that, you'll need Activity or Application Context.

To notify when ads load or fail to load, set the InterstitialAdLoadListener callback method listener for the InterstitialAdLoader object.

To load an ad, you need the ad placement ID obtained in the Yandex Advertising Network interface (adUnitId).

You can extend ad request parameters with the AdRequest.Builder() class to include information about the user's interests, page context, location, and other additional data in the ad request. Adding extra context to ad requests can greatly improve ad relevance.

Once the ad is loaded (by calling the onAdLoaded(interstitialAd: InterstitialAd) method), save the link to the loaded InterstitialAd before its display is completed.

The following example shows how to load an interstitial ad from Activity:

Kotlin

Java

class InterstitialAdActivity : AppCompatActivity(R.layout.activity_interstitial_ad) {
    private var interstitialAd: InterstitialAd? = null
    private var interstitialAdLoader: InterstitialAdLoader? = null
    private lateinit var binding: ActivityInterstitialAdBinding

    override fun onCreate(savedInstanceState: Bundle?) {
        super.onCreate(savedInstanceState)
        binding = ActivityInterstitialAdBinding.inflate(layoutInflater)
        setContentView(binding.root)

        // Interstitial ads loading should occur after initialization of the SDK.
        // Initialize SDK as early as possible, for example in Application.onCreate or Activity.onCreate
        interstitialAdLoader = InterstitialAdLoader(this)
        loadInterstitialAd()
    }

    private fun loadInterstitialAd() {
        val adRequest = AdRequest.Builder("your-ad-unit-id").build()
        interstitialAdLoader?.loadAd(adRequest, object : InterstitialAdLoadListener {
            override fun onAdLoaded(ad: InterstitialAd) {
                interstitialAd = ad
                // The ad was loaded successfully. Now you can show loaded ad.
            }

            override fun onAdFailedToLoad(adRequestError: AdRequestError) {
                // Ad failed to load with AdRequestError.
                // Attempting to load a new ad from the onAdFailedToLoad() method is strongly discouraged.
            }
        })
    }
}

public class InterstitialAdActivity extends AppCompatActivity {
    @Nullable
    private InterstitialAd mInterstitialAd = null;
    @Nullable
    private InterstitialAdLoader mInterstitialAdLoader = null;
    private ActivityInterstitialAdBinding mBinding;

    public InterstitialAdActivity() {
        super(R.layout.activity_interstitial_ad);
    }

    @Override
    protected void onCreate(@Nullable Bundle savedInstanceState) {
        super.onCreate(savedInstanceState);
        mBinding = ActivityInterstitialAdBinding.inflate(getLayoutInflater());
        setContentView(mBinding.getRoot());

        // Interstitial ads loading should occur after initialization of the SDK.
        // Initialize SDK as early as possible, for example in Application.onCreate or Activity.onCreate
        mInterstitialAdLoader = new InterstitialAdLoader(this);
        loadInterstitialAd();
    }

    private void loadInterstitialAd() {
        if (mInterstitialAdLoader != null) {
            final AdRequest adRequest =
                new AdRequest.Builder("your-ad-unit-id").build();
            mInterstitialAdLoader.loadAd(adRequest, new InterstitialAdLoadListener() {
                @Override
                public void onAdLoaded(@NonNull final InterstitialAd interstitialAd) {
                    mInterstitialAd = interstitialAd;
                    // The ad was loaded successfully. Now you can show loaded ad.
                }

                @Override
                public void onAdFailedToLoad(@NonNull final AdRequestError adRequestError) {
                    // Ad failed to load with AdRequestError.
                    // Attempting to load a new ad from the onAdFailedToLoad() method is strongly discouraged.
                }
            });
        }
    }
}

Displaying ads

Interstitial ads should be displayed during natural pauses in the app's usage. A good example of this would be impressions between game levels or when a user completes an action, such as downloading a file.

Before displaying ads, set an InterstitialAdEventListener to listen for ad event callbacks.

To render an ad, you'll need to pass the Activity to the show method of the loaded ad:

Kotlin

Java

private fun showAd() {
    interstitialAd?.apply {
        setAdEventListener(object : InterstitialAdEventListener {
            override fun onAdShown() {
                // Called when ad is shown.
            }
            override fun onAdFailedToShow(adError: AdError) {
                // Called when an InterstitialAd failed to show.
                // Clean resources after Ad dismissed
                interstitialAd?.setAdEventListener(null)
                interstitialAd = null

                // Now you can preload the next interstitial ad.
                loadInterstitialAd()
            }
            override fun onAdDismissed() {
                // Called when ad is dismissed.
                // Clean resources after Ad dismissed
                interstitialAd?.setAdEventListener(null)
                interstitialAd = null

                // Now you can preload the next interstitial ad.
                loadInterstitialAd()
           }
            override fun onAdClicked() {
                // Called when a click is recorded for an ad.
            }
            override fun onAdImpression(impressionData: ImpressionData?) {
                // Called when an impression is recorded for an ad.
            }
        })
        show(this@Activity)
    }
}

private void showAd() {
    if (mInterstitialAd != null) {
        mInterstitialAd.setAdEventListener(new InterstitialAdEventListener() {
            @Override
            public void onAdShown() {
                // Called when ad is shown.
            }

            @Override
            public void onAdFailedToShow(@NonNull final AdError adError) {
                // Called when an InterstitialAd failed to show.
            }

            @Override
            public void onAdDismissed() {
                // Called when ad is dismissed.
                // Clean resources after Ad dismissed
                if (mInterstitialAd != null) {
                    mInterstitialAd.setAdEventListener(null);
                    mInterstitialAd = null;
                }

                // Now you can preload the next interstitial ad.
                loadInterstitialAd();
            }

            @Override
            public void onAdClicked() {
                // Called when a click is recorded for an ad.
            }

            @Override
            public void onAdImpression(@Nullable final ImpressionData impressionData) {
                // Called when an impression is recorded for an ad.
            }
        });
        mInterstitialAd.show(this);
    }
}

Releasing resources

Don't store links to previously rendered ads. Call setAdEventListener(null) for previously rendered ads. That releases the resources and prevents memory leaks.

Kotlin

Java

override fun onDestroy() {
    super.onDestroy()
    interstitialAdLoader = null
    destroyInterstitialAd()
}

private fun destroyInterstitialAd() {
    interstitialAd?.setAdEventListener(null)
    interstitialAd = null
}

@Override
protected void onDestroy() {
    super.onDestroy();
    mInterstitialAdLoader = null;
    destroyInterstitialAd();
}

private void destroyInterstitialAd() {
    if (mInterstitialAd != null) {
        mInterstitialAd.setAdEventListener(null);
        mInterstitialAd = null;
    }
}

Checking integration

Build and run your project. You can check if the SDK integration is successful by searching the YandexAds keyword in Logcat:

[Integration] Ad type interstitial was integrated successfully

Was the article helpful?

Native ads

Banner