Skip to main content

​
App Open Ad Format

App open ads are full-screen ad format that can be used at the following moments:
  • Display ads during app launch loading screen
  • Display ads when app transitions from background to foreground
App Open Ad Example

​
Integrating Ads

1

Create adUnit

Configure your ad unit using the ad unit ID issued from the dashboard.
val adUnit = DaroAppOpenAdUnit(
    unitId = ${AdUnitId},
    placement = ${placement}, // Name displayed in logs. Can be left empty.
)
2

Create DaroAppOpenAdManager and Load Ad

Create a DaroAppOpenAdManager to preload app open ads, and load the ad.
// Call this code at the onCreate of your Application class.
val appOpenAdManager = DaroAppOpenAdManager.Builder(application)
    .setAdUnit(adUnit)
    .setAppOpenAdLoaderListener(object : DaroAppOpenAdLoaderListener {
        override fun onAdLoadSuccess(ad: DaroAppOpenAd, adInfo: DaroAdInfo) {
            // Ad load success
        }

        override fun onAdLoadFail(error: DaroLoadError) {
            // Ad load failure
        }
    })
    .setAppOpenAdListener(object : DaroAppOpenAdListener {
        override fun onAdImpression(adInfo: DaroAdInfo) {
            // App open ad impression event
        }

        override fun onAdClicked(adInfo: DaroAdInfo) {
            // App open ad click event
        }
        override fun onShown(adInfo: DaroAdInfo) {
            // When app open ad is shown
        }

        override fun onDismiss(adInfo: DaroAdInfo) {
            // When app open ad is dismissed
        }

        override fun onFailedToShow(adInfo: DaroAdInfo, error: DaroAdDisplayFailError) {
            // When app open ad failed to show
        }
    })
    .build()

// Load ad
appOpenAdManager.loadAd()
3

Display App Open Ad

Display the app open ad.
// 1. If you need to call the ad directly from a specific Activity, Fragment, or Composable
appOpenAdManager.showIfAvailable(activity)

// 2. If you need to call it every time the app transitions from background to foreground
// You need to implement it using Application.ActivityLifecycleCallbacks.
class ActivityLifecycleCallbacks : Application.ActivityLifecycleCallbacks {

    override fun onActivityStarted(activity: Activity) {
        // (Note) You must check if an ad is currently being displayed.
        if (!appOpenAdManager.isShowingAd()) {
            appOpenAdManager.showIfAvailable(activity)
        }
    }

    ...
}

application.registerActivityLifecycleCallbacks(ActivityLifecycleCallbacks())
4

Clean Up DaroAppOpenAdManager Resources

Clean up resources when the app open ad is no longer needed.
  appOpenAdManager.destroy()

​
Display Ad on Cold Start

class MyApplication : Application() {

    private lateinit var callbacks: Application.ActivityLifecycleCallbacks
    private lateinit var appOpenAdManager: DaroAppOpenAdManager

    override fun onCreate() {
        super.onCreate()

        val adUnit = DaroAppOpenAdUnit(
            unitId = "your_appopen_unit_id",
            placement = "placement"
        )

        appOpenAdManager = DaroAppOpenAdManager.Builder(this)
            .setAdUnit(adUnit)
            .setAppOpenAdLoaderListener(...)
            .setAppOpenAdListener(...)
            .build()

        appOpenAdManager.loadAd()

        this.callbacks = object : Application.ActivityLifecycleCallbacks {
           override fun onActivityStarted(activity: Activity) {
                if (appOpenAdManager.isShowingAd()) {
                    appOpenAdManager.showIfAvailable()
                }
            }

            ...
        }

        registerActivityLifecycleCallbacks(callbacks)
    }

    // Call when app open ad is no longer needed
    fun destroy() {
        appOpenAdManager.destroy()
    }
}