Rewarded ads
Rewarded ads are a popular fullscreen ad format where users receive incentives for viewing ads.
The display of this ad type is activated by the user, for instance, to receive a bonus or additional life in a game.
High user motivation makes this ad format the most popular and profitable in free apps.
Appearance
This guide covers the process of integrating rewarded ads into React Native apps. Besides code samples and instructions, it also contains format-specific recommendations and links to additional resources.
Prerequisite
- Follow the Yandex Mobile Ads React Native plugin integration steps described under Quick start.
- Make sure that you have the latest version of the Yandex Mobile Ads React Native plugin. If you're using mediation, update to the most recent single build version.
Implementation
Key steps for integrating rewarded ads:
- Create and configure a
RewardedAdLoader. - Set up the parameters for loading ads using an
AdRequestConfigurationobject. - Load the
RewardedAdobject. - Set the ad's callback functions.
- Display the
RewardedAdobject. - Reward the user for viewing the ad.
Features of rewarded ad integration
If the loadAd method 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.
Loading ads
To load your rewarded ads, create a RewardedAdLoader object. To do this, call the RewardedAdLoader.create() method.
To create an AdRequestConfiguration class instance, you'll need the placement ID from the Boost (adUnitId).
You can also expand ad request parameters by providing information about the user's interests, page context, location, and other additional data when creating the AdRequestConfiguration object. Adding extra context to ad requests can greatly improve ad relevance. To learn more, see Ad targeting.
To load your rewarded ad, call the loadAd method of the RewardedAdLoader class object.
The example below shows how to load a rewarded ad:
let loader = await RewardedAdLoader.create()
.catch((error) => {
// Handle error gracefully
return;
});
if (!loader) {
return;
}
let adRequestConfiguration = new AdRequestConfiguration({
adUnitId: 'R-M-XXXXXX-Y', // for debug you can use 'demo-rewarded-yandex'
age: '20',
contextQuery: 'context-query',
contextTags: ['context-tag'],
gender: Gender.Female,
location: new Location(55.734202, 37.588063),
});
let ad = await loader.loadAd(adRequestConfiguration)
.then((ad) => {
// Ad loaded successfully
return ad;
})
.catch((error) => {
// Handle error gracefully
return;
});
Displaying ads
Rewarded ads are an incentivized ad format that allows users to earn rewards by viewing ads. These rewards may include extra lives or the ability to advance to the next level in a game. The reward format is determined by the app itself.
To track a rewarded ad's lifecycle and reward events, set callback functions for the RewardedAd class object.
To display a rewarded ad, use the show() method:
ad.onAdShown = () => {
console.log('Did show');
};
ad.onAdFailedToShow = (error) => {
console.log(`Did fail to show with error: ${JSON.stringify(error)}`);
};
ad.onAdClicked = () => {
console.log('Did click');
};
ad.onAdDismissed = () => {
console.log('Did dismiss');
};
ad.onAdImpression = (impressionData) => {
console.log(`Did track impression: ${JSON.stringify(impressionData)}`);
};
ad.onRewarded = (reward) => {
console.log(`Did reward: ${JSON.stringify(reward)}`);
}
ad.show();
Testing rewarded ad integration
Using demo ad units for ad testing
We recommend using test ads to test your rewarded ad integration and your app itself.
To make sure that test ads are returned for each ad request, we created a special demo ad placement ID designed to help you test your ad integration.
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 interface Boost.
For the list of all available demo ad placement IDs, see Demo ad units for testing.
Testing ad integration
You can test your rewarded ad integration using the SDK's built-in analyzer.
The tool checks makes sure your rewarded ads are integrated properly and outputs a detailed report to the log. To view the report, search 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 you're having problems integrating rewarded ads, you'll get a detailed report on the issues and recommendations for how to fix them.
Using demo ad units for ad testing
We recommend using test ads to test your ad integration and your app itself.
To make sure that test ads are returned for each ad request, we created a special demo ad placement ID designed to help you test your ad integration.
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 interface Boost.
For the list of all available demo ad placement IDs, see Demo ad units for testing.
Testing ad integration
You can test your ad integration using the native Console tool.
To view detailed logs, call the MobileAds class's enableLogging method.
MobileAds.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 the loadAd method in advance to instantly show the ad when it's needed.
To begin preloading the next ad immediately after serving the current one, you can link 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 ensure caching benefits your app, monitor the “Show rate” or “View rate” metrics in the Boost 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.