App open ads

App open ad is a special advertising format for monetizing your app's splash screens. The ads can be dismissed at any time and are designed to display when users bring your app to the foreground, either at launch or when returning it from the background.

This guide will show how to integrate ads served when opening an Android app. In addition to code examples and instructions, it contains format-specific recommendations and links to additional resources.

Restriction

App open ads can only be placed in an application with a vertical orientation. For horizontal orientation, the ads will not be selected.

Layout

App open ads include a Go to the app button so users know they're in your app and can close the ad. Here's an example of what an ad looks like:

Prerequisite

  1. Follow the SDK integration steps described in Quick start.
  2. Initialize your ad SDK in advance.
  3. Make sure you're running the latest Yandex Mobile Ads SDK version. If you're using mediation, make sure you're also running the latest version of the unified build.

Terms and definitions

  • Cold start is starting an app which is not in the RAM, creating a new app session.
  • Hot start is switching the app from background mode, when the app is paused in the RAM, to foreground mode.

Implementation

  1. Initialize the SDK at app start.
  2. Create and set up the AppOpenAdLoader ad loader object.
  3. Set the AppOpenAdLoadListener callback method listener for notifications when ads load successfully or unsuccessfully.
  4. Load the ad using the loadAd(AdRequestConfiguration) method.
  5. Use LifecycleEventObserver to handle app status changes and display app open ads.
  6. Before rendering the ad, set the AppOpenAdEventListener ad callback method listener.
  7. Render the ad using the show(Activity) method.
  8. Release the resources.

Main steps

  1. Initialize the SDK at app start.

    MobileAds.initialize(this) {
    // Now you can use ads
}

    MobileAds.initialize(this, () -> {
    // Now you can use ads
});

  2. Create and set up the AppOpenAdLoader ad loader object.

    You will need the ad unit ID from the Partner Interface (AD_UNIT_ID).

    You can expand the ad request parameters through AdRequestConfiguration.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 section.

    val appOpenAdLoader: AppOpenAdLoader = AppOpenAdLoader(application)
val AD_UNIT_ID = "R-M-XXXXXX-Y" // for debugging, you can use "demo-appopenad-yandex"
val adRequestConfiguration = AdRequestConfiguration.Builder(AD_UNIT_ID).build()

    final AppOpenAdLoader appOpenAdLoader = AppOpenAdLoader(application);
final String AD_UNIT_ID = "R-M-XXXXXX-Y"; // for debugging, you can use "demo-appopenad-yandex"
final AdRequestConfiguration adRequestConfiguration = new AdRequestConfiguration.Builder(AD_UNIT_ID).build();

  3. Set the AppOpenAdLoadListener callback method listener for notifications when ads load successfully or unsuccessfully.

    val appOpenAdLoadListener = object : AppOpenAdLoadListener {
   override fun onAdLoaded(appOpenAd: AppOpenAd) {
       // The ad was loaded successfully. You can now show the ad.
       this@Activity.appOpenAd = appOpenAd
   }

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

appOpenAdLoader.setAdLoadListener(appOpenAdLoadListener)

    AppOpenAdLoadListener appOpenAdLoadListener = new AppOpenAdLoadListener() {
    @Override
    public void onAdLoaded(@NonNull final AppOpenAd appOpenAd) {
        // The ad was loaded successfully. You can now show the ad.
        mAppOpenAd = appOpenAd;
    }

    @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.
    }
};

appOpenAdLoader.setAdLoadListener(appOpenAdLoadListener);

  4. Load the ad using the loadAd(AdRequestConfiguration) method.

    appOpenAdLoader.loadAd(adRequestConfiguration)

    appOpenAdLoader.loadAd(adRequestConfiguration);

  5. Use LifecycleEventObserver to handle app status changes and display app open ads.

    val processLifecycleObserver = DefaultProcessLifecycleObserver(
    onProcessCameForeground = ::showAppOpenAd
)
ProcessLifecycleOwner.get().lifecycle.addObserver(processLifecycleObserver)

    final DefaultProcessLifecycleObserver processLifecycleObserver = new DefaultProcessLifecycleObserver() {
    @Override
    public void onProcessCameForeground() {
        showAppOpenAd();
    }
}

ProcessLifecycleOwner.get().getLifecycle().addObserver(processLifecycleObserver);

  6. Before rendering the ad, set the AppOpenAdEventListener ad callback method listener.

    private inner class AdEventListener : AppOpenAdEventListener {
    override fun onAdShown() {
        // Called when ad is shown.
    }

    override fun onAdFailedToShow(adError: AdError) {
        // Called when ad failed to show.
    }

    override fun onAdDismissed() {
        // Called when ad is dismissed.
        // Clean resources after dismiss and preload new ad.
        clearAppOpenAd()
        loadAppOpenAd()
    }

    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.
        // Get Impression Level Revenue Data in argument.
    }
}

private val appOpenAdEventListener = AdEventListener()
appOpenAd?.setAdEventListener(appOpenAdEventListener)

    AppOpenAdEventListener appOpenAdEventListener = new AppOpenAdEventListener() {
   @Override
   public void onAdShown() {
       // Called when ad is shown.
   }

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

   @Override
   public void onAdDismissed() {
       // Called when ad is dismissed.
       // Clean resources after dismiss and preload new ad.
       clearAppOpenAd();
       loadAppOpenAd();
   }

   @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.
   }
};

if (mAppOpenAd != null) {
   mAppOpenAd.setAdEventListener(appOpenAdEventListener);
}

  7. Render the ad using the show method.

    private fun showAppOpenAd() {
    appOpenAd?.show(activity)
}

    private void showAppOpenAd() {
    if (mAppOpenAd != null) {
       mAppOpenAd.show(activity);
    }
}

  8. Release the resources.

    That prevents memory leaks.

    private fun clearAppOpenAd() {
    appOpenAd?.setAdEventListener(null)
    appOpenAd = null
}

    private void clearAppOpenAd() {
    if (mAppOpenAd != null) {
        mAppOpenAd.setAdEventListener(null);
        mAppOpenAd = null;
    }
}

Features of app open ad integration

  1. All calls to Yandex Mobile Ads SDK methods must be made from the main thread.
  2. Loading can take a while, so don't increase the cold start time if the ad hasn't loaded.
  3. Pre-load the ad for subsequent display during hot starts.
  4. We discourage you loading app open ads and other ad formats in parallel during the app launch because the app might be downloading operational data at that time. That could overload the device and the internet connection, making the ad load longer.
  5. If you received an error in the onAdFailedToLoad() callback, do not try to load a new ad again. If you must do so, limit the number of ad reload attempts. That will help avoid constant unsuccessful requests and connection issues when limitations arise.

Testing ad integration at launch

Using demo ad units for ad testing

We recommend using test ads to test your integration for app open ads and your app itself.

To guarantee that test ads are returned for every ad request, we created a special demo ad placement ID. Use it to check your ad integration.

Demo adUnitId: demo-appopenad-yandex.

Warning

Before publishing your app in the store, make sure to replace the demo ad placement ID with a real one obtained from the Partner Interface.

You can find the list of available demo ad placement IDs in the Demo ad units for testing section.

Testing ad integration

You can check your integration of app open ads using the SDK's built-in analyzer.

The tool makes sure your app open ads are integrated properly and outputs a detailed report to the log. To view the report, search for the "YandexAds" keyword in the Logcat tool for Android app debugging.

adb logcat -v brief '*:S YandexAds'

If the integration is successful, you'll see this message:

adb logcat -v brief '*:S YandexAds'
mobileads$ adb logcat -v brief '*:S YandexAds'
I/YandexAds(13719): [Integration] Ad type App Open Ad was integrated successfully

If you're having problems integrating ads, you'll get a detailed report on the issues and recommendations for how to fix them.

Recommendations

  1. Don't render your app open ad before the splash screen.

    By displaying the splash screen, you enhance the user's app experience, making it more seamless and enjoyable. That will keep the user from being surprised or confused, making them sure they opened the right app. On the same screen, you can warn users about the upcoming ad. Use a loading indicator or simply a text message telling the user they will resume viewing app content after the ad.

  2. If there's a delay between requesting and rendering the ad, the user might briefly open your app and then unexpectedly see an ad unrelated to the contents. That can negatively impact the user experience, so it is worth avoiding. One solution is to use the splash screen before displaying the main app content and start ad rendering from this screen. If the app opens some content after the splash screen, you're better off not rendering the ad.

  3. Wait until new users open the app and use it a few times before rendering an app open ad. Only render the ad to users who have met certain criteria in the app (for example, passed a certain level, opened the app a certain number of times, or are not participating in rewarded offers). Don't render the ad immediately after the app is installed.

  4. Regulate ad render frequency based on app user behavior. Don't render the ad at every cold/hot app start.

  5. Only render the ad if your app has been in the background for a certain period of time (for example, 30 seconds, two minutes, 15 minutes).

  6. Make sure you run thorough tests since each app is unique and requires a special approach to maximize revenue without reducing retention or time spent in the app. User behavior and engagement can change over time, so we recommend periodically testing the strategies you use for your app open ads.

Additional resources

Previous
Advanced integration (InStream API)
Next
Ad feed