Rewarded ads

Rewarded ads are a popular fullscreen ad format where users receive incentives for viewing ads.

Ad impressions are opt-in: for example, users can initiate them to get game bonuses or extra lives.

Strong user motivation makes this ad format the most popular and profitable adoption in free apps.

This guide shows how to integrate rewarded ads into Compose Multiplatform apps. In addition to code samples and instructions, it contains format-specific recommendations and links to additional resources.

Prerequisite

1. Follow the process in Quick start to integrate the Yandex Mobile Ads Compose Multiplatform Plugin.
2. Make sure you're running the latest Yandex Mobile Ads Compose Multiplatform Plugin version. If you're using mediation, make sure you're running the latest version of the unified build.

Implementation

Key steps for integrating rewarded ads:

1. Create the ad loader with rememberRewardedAdLoader().
2. Load the ad through the suspend function loadAd().
3. Optionally set RewardedAdEventListener on the loaded ad before calling show().
4. Show the ad using show().

Features of rewarded ad integration

If loading fails in your error handling, don't try to load a new ad again immediately. If there's no other option, limit the number of ad load retries. That will help avoid constant unsuccessful requests when limitations arise.

Loading ads

Use rememberRewardedAdLoader() and loadAd with an AdRequest that contains your adUnitId from the Yandex Advertising Network interface. On load failure, loadAd throws AdLoadException from com.yandex.mobile.ads.kmp.common.

You can expand the request through AdRequest (targeting, parameters, preferredTheme, and so on). Delivering additional contextual data in the request can significantly improve your ad quality. Read more in the Ad Targeting section.

Example of loading a rewarded ad:

@Composable
fun RewardedBlock(adUnitId: String) {
    val loader = rememberRewardedAdLoader()
    val scope = rememberCoroutineScope()
    var rewardedAd by remember { mutableStateOf<RewardedAd?>(null) }
    var isLoading by remember { mutableStateOf(false) }

    Button(
        onClick = {
            isLoading = true
            scope.launch {
                try {
                    rewardedAd = loader.loadAd(AdRequest(adUnitId = adUnitId))
                } catch (e: AdLoadException) {
                    // Load error: e.error (AdRequestError). Unbounded retries are discouraged.
                }
                isLoading = false
            }
        },
        enabled = !isLoading,
    ) {
        Text(if (isLoading) "Loading..." else "Load rewarded")
    }

    Button(
        onClick = { rewardedAd?.show() },
        enabled = rewardedAd != null,
    ) {
        Text("Show rewarded")
    }
}

For debugging, you can use 'demo-rewarded-yandex' as adUnitId.

Ad rendering

Rewarded advertising is an incentive-based ad format: users receive a reward after viewing the ad (an extra life, advancing to the next level, and so on). The reward is determined by your app.

To track the rewarded ad lifecycle and issue rewards, set RewardedAdEventListener on the RewardedAd instance before calling show().

val ad = rewardedAd ?: return
ad.setAdEventListener(
    object : RewardedAdEventListener {
        override fun onAdShown() {
            // Called when an ad is shown.
        }

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

        override fun onAdDismissed() {
            // Called when ad is dismissed. Preload the next rewarded ad if appropriate.
        }

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

        override fun onRewarded(reward: Reward) {
            // Grant currency: reward.type, reward.amount
        }
    },
)
ad.show()

Releasing resources

After onAdDismissed or onAdFailedToShow, drop references to the ad object and, if needed, start loading the next creative. Do not keep strong references to ads that have already been shown.

Testing the rewarded ad integration

Android

iOS

Using demo ad units for ad testing

Use test ads to check your rewarded 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-rewarded-yandex.

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.

For the list of all available demo ad placement IDs, see Demo ad units for testing.

Testing ad integration

You can check if your rewarded 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, a tool for debugging Android apps.

adb logcat -v brief '*:S YandexAds'

If the integration is successful, the following message is returned:

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

If there are any rewarded ad integration issues, you'll get a detailed issue report and troubleshooting recommendations.

Using demo ad units for ad testing

We recommend using test ads to test your ad integration 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-rewarded-yandex.

Warning

Before publishing your app to the store, make sure you replace the demo ad unit ID with a real one obtained from the Yandex Advertising Network 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 test your ad integration using the native Console tool.

To view detailed logs, call the YandexAds class's enableLogging method.

YandexAds.enableLogging()

To view SDK logs, go to the Console tool and set Subsystem = com.mobile.ads.ads.sdk. You can also filter logs by category and error level.

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

Tips

Ad preloading

Loading an ad may take several seconds, depending on the number of ad networks connected in mobile mediation and the user's internet speed. We recommend preloading ads before displaying them.

Call loadAd in advance to display the loaded ad at the right moment.

To start loading the next ad right after serving the current one, bind this process to the onAdDismissed event.

If you cache ads on too many screens that are unlikely to be shown, your ad effectiveness could drop. For example, if users complete 2-3 game levels per session, you shouldn't cache ads for 6-7 screens. Your ad viewability could decrease otherwise, and the advertising system might deprioritize your app.

To make sure you're finding a good balance for your app, track the "Share of impressions" or "Share of visible impressions" metric in the Yandex Advertising Network interface. If it's under 20%, you should probably revise your caching algorithm. The higher the percentage of impressions, the better.

Additional resources

• Link to GitHub.