--- metadata: - name: generator content: Diplodoc Platform v5.50.6 alternate: - https://ads.yandex.com/helpcenter/en/dev/android/interstitial.md - https://ads.yandex.com/helpcenter/pt/dev/android/interstitial.md - https://ads.yandex.com/helpcenter/ru/dev/android/interstitial.md - https://ads.yandex.com/helpcenter/zh/dev/android/interstitial.md --- > **Documentation Index:** Fetch the complete configuration index at https://ads.yandex.com/helpcenter/en/llms.txt # Interstitial advertising Interstitial advertising is a full-screen ad format embedded within the app content during natural pauses, such as transitioning between game levels or completing a target action. When the app renders an interstitial ad, the user has two options: click the ad and proceed to the advertiser site or close the ad and go back to the app. In interstitial ads, user attention is fully focused on the ads, which is why the impression cost is higher. {% cut "Appearance" %} {% endcut %} This guide will show how to integrate interstitial ads into Android apps. In addition to code examples and instructions, it contains format-specific recommendations and links to additional resources. ## Prerequisite {#pre} 1. Follow the SDK integration steps described under [Quick start](https://ads.yandex.com/helpcenter/en/dev/android/quick-start.md). 2. First, you need to [initialize](https://ads.yandex.com/helpcenter/en/dev/android/quick-start.md#init) the advertising SDK. 3. Make sure you have the [latest Yandex Mobile Ads SDK version](https://ads.yandex.com/helpcenter/en/dev/android/changelog-android.md). If you're using mediation, update to the most recent [single build version](https://ads.yandex.com/helpcenter/en/dev/android/changelog-android.md). ## Implementation {#implement} 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](https://ads.yandex.com/helpcenter/en/dev/android/target-adfox.md) if you're using Adfox. * Register the `InterstitialAdEventListener` listener for ad event callback methods. * Render the `InterstitialAd`. ## Features of interstitial ads integration {#features} 1. All calls to Yandex Mobile Ads SDK methods must be made from the main thread. 2. If you received an error in the `onAdFailedToLoad()` callback, don't try to load a new ad again. If there's no other option, limit the number of ad load retries. That will help avoid constant unsuccessful requests and connection issues when limitations arise. 3. 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. 4. We recommend using a single instance of `InterstitialAdLoader` for all ad loads to improve performance. ## Loading ads {#load} 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'll need the ad unit ID from the Yandex Advertising Network interface (adUnitId). You can expand the ad request parameters through `AdRequest.Builder()` by passing user interests, contextual app data, location details, or other data. Delivering additional contextual data in the request can significantly improve your ad quality. Read more in the [Ad Targeting](https://ads.yandex.com/helpcenter/en/dev/android/target.md) section. 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: {% list tabs %} - Kotlin ```kotlin 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 the SDK as early as possible, for example in Application.onCreate or Activity.onCreate interstitialAdLoader = InterstitialAdLoader(this).apply { setAdLoadListener(object : InterstitialAdLoadListener { override fun onAdLoaded(ad: InterstitialAd) { interstitialAd = ad // The ad was loaded successfully. You can now show the 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. } }) } loadInterstitialAd() } private fun loadInterstitialAd() { val adRequest = AdRequest.Builder("your-ad-unit-id").build() interstitialAdLoader?.loadAd(adRequest) } } ``` - Java ```java 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); mInterstitialAdLoader.setAdLoadListener(new InterstitialAdLoadListener() { @Override public void onAdLoaded(@NonNull final InterstitialAd interstitialAd) { mInterstitialAd = interstitialAd; // The ad was loaded successfully. You can now show the 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. } }); loadInterstitialAd(); } private void loadInterstitialAd() { if (mInterstitialAdLoader != null ) { final AdRequest adRequest = new AdRequest.Builder("your-ad-unit-id").build(); mInterstitialAdLoader.loadAd(adRequest); } } } ``` {% endlist %} If you serve ads through Adfox, then after the banner ad response, the `campaignId`, `bannerId`, and `placeId` data can be accessed from the `interstitialAdLoader` objects using the `adAttributes` property of the `AdAttributes` type. ## Ad rendering {#ad-view} Interstitial ads should be displayed during natural pauses in the app's operation. One good option is inserting interstitial ads between game levels or after a conversion (for example, when a file has been downloaded). Before rendering the ad, set the `InterstitialAdEventListener` ad callback method listener. To render an ad, you'll need to pass the Activity to the show method of the loaded ad: {% list tabs %} - Kotlin ```kotlin 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 an 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) } } ``` - Java ```java 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 an 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); } } ``` {% endlist %} ## Releasing resources {#destroy} Don't store links to previously rendered ads. Call `setAdEventListener(null)` for previously rendered ads. Call `setAdLoadListener(null)` for the loader if it's no longer used. That releases the resources and prevents memory leaks. {% list tabs %} - Kotlin ```kotlin override fun onDestroy() { super.onDestroy() interstitialAdLoader?.setAdLoadListener(null) interstitialAdLoader = null destroyInterstitialAd() } private fun destroyInterstitialAd() { interstitialAd?.setAdEventListener(null) interstitialAd = null } ``` - Java ```java @Override protected void onDestroy() { super.onDestroy(); if (mInterstitialAdLoader != null) { mInterstitialAdLoader.setAdLoadListener(null); mInterstitialAdLoader = null; } destroyInterstitialAd(); } private void destroyInterstitialAd() { if (mInterstitialAd != null) { mInterstitialAd.setAdEventListener(null); mInterstitialAd = null; } } ``` {% endlist %} ## Testing interstitial ad integration {#test} ### Using demo ad units for ad testing {#demo-blocks} Use test ads to check your interstitial ad integration and the app itself. To make sure that test ads are returned for each ad request, you can use a special demo ad placement ID. Demo adUnitId: `demo-interstitial-yandex`. {% note warning %} Before publishing your app in the store, make sure to replace the demo placement ID with the real ID you obtained in the Yandex Advertising Network interface. {% endnote %} For the list of all available demo ad placement IDs, see [Demo ad units for testing](https://ads.yandex.com/helpcenter/en/dev/android/demo-blocks.md). ### Testing ad integration {#test-int} You can check if your interstitial ads are integrated correctly using the SDK's built-in analyzer. A detailed report with the test results will appear in the log. To view the report, search for the keyword “YandexAds” in [Logcat](https://developer.android.com/studio/command-line/logcat), a tool for debugging Android apps. ```bash adb logcat -v brief '*:S YandexAds' ``` If the integration is successful, the following message is returned: ```bash adb logcat -v brief '*:S YandexAds' mobileads$ adb logcat -v brief '*:S YandexAds' I/YandexAds(13719): [Integration] Ad type interstitial was integrated successfully ``` If there are any interstitial ad integration issues, you'll get a detailed issue report and troubleshooting recommendations. ## Additional resources {#resources} * Link to [GitHub](https://github.com/yandexmobile/yandex-ads-sdk-android).