Integration Yandex Mediation
Warning
Be sure to update to the latest adapter versions (Yandex Mediation). Otherwise, errors from improper adapter integration might occur, preventing the ad from being served.
Prerequisites
To prepare your app, follow the steps described in the next sections.
App requirements
- Use Android Studio 2021 or higher.
- Check that your app's build file uses the following values:
- minSdkVersion 21 or higher.
- compileSdkVersion 31 or higher.
- To load any type of ad, Android version 4.1 or higher is required.
- Video ads are only served for devices with Android 5 or higher.
- Use iOS 13 or higher.
- Use Xcode 16.4 or higher.
Set up the app in your Boost account
Register your app as a Boost app by following these steps:
Connecting the Yandex Mobile Ads Compose Multiplatform library
To integrate Yandex Mobile Ads SDK into your Compose Multiplatform app, add the Yandex Mobile Ads Compose Multiplatform dependency to your common module and include the native iOS SDK via CocoaPods.
Gradle
Declare the artifact in commonMain within the common module's build.gradle.kts file:
commonMain.dependencies {
implementation("com.yandex.ads.multiplatform:mobileads-compose:8.3.0")
}
iOS (CocoaPods)
Add the YandexMobileAds pod to your iOS app's Podfile (for example, iosApp/Podfile). The target name must match the target in Xcode:
source 'https://cdn.cocoapods.org/'
platform :ios, '13.0'
target 'iosApp' do
use_frameworks!
pod 'YandexMobileAds', '8.3.0'
end
Install pods from the directory where your Podfile is located:
cd iosApp && pod install
Platform-specific setup
Permission to use the advertising ID
Advertising IDs are unique IDs provided by Google Play services. They're used to serve ads to users who consent to personalized ads. Users can opt out of personalized ads or reset the ID in the settings. In this case, ad networks can't use it to serve relevant ads.
You can remove the permission, if necessary. For example, you may need to do this if a policy, such as the Families Policy, doesn't allow using the ID to serve ads.
To prevent the permission from being added to your app's main manifest, add the following to the AndroidManifest.xml file:
<manifest>
<application>
<uses-permission android:name="com.google.android.gms.permission.AD_ID" tools:node="remove"/>
</application>
</manifest>
Warning
Lack of permission and access to the ID may impact your revenue, because your app may serve less relevant ads.
COPPA setup
You can set up these policies using the AndroidManifest.file or right before initializing the SDK manually.
If you've chosen automatic initialization, add the following code to the AndroidManifest.xml file to notify the Yandex Mobile Ads SDK when the app user is a child:
<manifest>
<application>
<!-- Disable the use of child's personal data for app monetization. -->
<meta-data
android:name="@string/yandex_mobileads_age_restricted_user"
android:value="true" />
</application>
</manifest>
SKAdNetwork support
Add the ad network identifiers to your app's Info.plist file. For more information, see SKAdNetwork.
Enabling mediation
Connecting individual adapters
Warning
Be sure to update to the latest adapter versions (Yandex Mobile Mediation). Otherwise, errors from improper adapter integration might occur, preventing the ad from being served.
To connect individual adapters, enable the Yandex Ads SDK, then follow the specific instructions for each adapter:
-
Set up mediation in the Boost interface.
-
Add the YandexMobileAds dependency to the
androidMain.dependenciesblock in thebuild.gradle.ktsfile at the app level:androidMain.dependencies { ... implementation("com.yandex.android:mobileads:x.x.x") // Specify the supported version // Adapter dependencies Yandex Mediation. } -
Add support for Java 8 to the
build.gradlefile of your app's Android module:android { compileOptions { sourceCompatibility JavaVersion.VERSION_1_8 targetCompatibility JavaVersion.VERSION_1_8 } } -
Add this code to the
build.gradlefile in your app's Android module:// IronSource maven { url 'https://android-sdk.is.com/' } // Pangle maven { url 'https://artifact.bytedance.com/repository/pangle' } // Tapjoy maven { url "https://sdk.tapjoy.com/" } // BidMachine maven { url 'https://artifactory.bidmachine.io/bidmachine' } // Mintegral maven { url "https://dl-maven-android.mintegral.com/repository/mbridge_android_sdk_oversea" } // Chartboost maven { url "https://cboost.jfrog.io/artifactory/chartboost-ads/" } // AppNext maven { url "https://dl.appnext.com/" } -
Set up permission to use an advertising ID (for apps using SDK versions older than 4.5.0).
How to set up permission to use the ad ID
Advertising IDs are unique IDs provided by Google Play services. They're used to serve ads to users who consent to personalized ads. Users can opt out of personalized ads or reset the ID in the settings. In this case, ad networks can't use it to serve relevant ads.
If your app uses a Yandex Mobile Ads SDK version lower than 4.5.0, add the com.google.android.gms.permission.AD_ID permission to your app's AndroidManifest.xml file:
<manifest> <application> <!-- For apps targeting Android 13 or higher & Yandex Mobile Ads SDK versions lower than 4.5.0 --> <uses-permission android:name="com.google.android.gms.permission.AD_ID"/> </application> </manifest>Starting with version 4.5.0, Yandex Mobile Ads SDK adds the com.google.android.gms.permission.AD_ID permission by default. This means you don't need to specify it in your app's main manifest. With this permission, you can use the advertising ID to serve more relevant ads from ad networks.
You can remove the permission, if necessary. For example, you may need to do this if a policy, such as the Families Policy, doesn't allow using the ID to serve ads.
To prevent the permission from being added to your app's main manifest, add the following to the AndroidManifest.xml file:
<manifest> <application> <uses-permission android:name="com.google.android.gms.permission.AD_ID" tools:node="remove"/> </application> </manifest>Warning
Lack of permission and access to the ID may impact your revenue, because your app may serve less relevant ads.
-
Connect the required adapters separately using the appropriate packages.
To connect individual adapters, enable the Yandex Ads SDK, then follow the specific instructions for each adapter:
-
Set up mediation in the Boost interface.
-
Add the
YandexMobileAdslibrary to your Podfile.pod 'YandexMobileAds', 'x.x.x' // add supported version -
Connect the required adapters separately using the appropriate libraries.
Initializing the Yandex Mobile Ads SDK library
Successfully initializing the Yandex Mobile Ads SDK is a prerequisite for correctly integrating the library.
By default, the SDK for Android is initialized automatically on app startup. This speeds up ad loading and thus increases your monetization revenue.
By default, the SDK for iOS is initialized automatically before loading an ad. However, manual initialization can speed up the loading of the first ad, increasing your monetization revenue.
Call YandexAds.initialize() before loading any ads — for example, from your root composable using LaunchedEffect:
import com.yandex.mobile.ads.kmp.YandexAds
@Composable
fun App() {
LaunchedEffect(Unit) {
YandexAds.initialize()
}
// ...
}
If you need to set up privacy policies for personal data in your app, make sure to do this before initializing the Yandex Mobile Ads SDK.
You can set up these policies using the AndroidManifest.file or right before initializing the SDK manually.