Preparing Mediated Networks

Caution

When you integrate third-party SDKs into your Mobile Property, you are solely responsible for such integrations. You and the third-party SDK provider must ensure compliant data processing and treatment of any user-based or device-based privacy choices or flags.

Android

You can download and integrate the MAX mediation adapters into your app in two ways:

Gradle

AppLovin recommends that you integrate adapters this way. AppLovin’s adapters’ POM files automatically integrate the mediated network’s SDK and its dependencies.

Open Source Adapters

If you require more flexibility in the integration, you can integrate AppLovin’s open source adapters. You are responsible for integrating the mediated SDKs and their dependencies. You can find these adapters in the AppLovn-MAX-SDK-Android GitHub repository.

Caution

Do not change the adapter’s name or package name. If you do so, the MAX SDK cannot recognize the adapter and ads will not load.

Gradle

Choose which mediated ad networks you want to integrate by checking the boxes below. When you check those boxes, this page displays instructions specific to those networks.

This page also creates a customized UPL for you. Copy the customized UPL below into AppLovinMAX_UPL_Android.xml.

BidMachine Chartboost DT Exchange Google Ad Manager Google Bidding and Google AdMob HyprMX InMobi ironSource Liftoff Monetize LINE Maio Meta Audience Network Mintegral MobileFuse Moloco Ogury Pangle Smaato Unity Ads Verve VK Ad Network Yandex

<AARImports>
    <insertValue value="com.applovin.mediation,bidmachine-adapter,+" /> <insertNewline/>
    <insertValue value="com.applovin.mediation,chartboost-adapter,+" /> <insertNewline/>
    <insertValue value="com.google.android.gms,play-services-base,16.1.0" /> <insertNewline/>
    <insertValue value="com.applovin.mediation,fyber-adapter,+" /> <insertNewline/>
    <insertValue value="com.applovin.mediation,google-ad-manager-adapter,+" /> <insertNewline/>
    <insertValue value="com.applovin.mediation,google-adapter,+" /> <insertNewline/>
    <insertValue value="com.applovin.mediation,hyprmx-adapter,+" /> <insertNewline/>
    <insertValue value="com.applovin.mediation,inmobi-adapter,+" /> <insertNewline/>
    <insertValue value="com.squareup.picasso,picasso,2.71828" /> <insertNewline/>
    <insertValue value="androidx.recyclerview,recyclerview,1.1.0" /> <insertNewline/>
    <insertValue value="com.applovin.mediation,ironsource-adapter,+" /> <insertNewline/>
    <insertValue value="com.applovin.mediation,vungle-adapter,+" /> <insertNewline/>
    <insertValue value="com.applovin.mediation,line-adapter,+" /> <insertNewline/>
    <insertValue value="com.applovin.mediation,maio-adapter,+" /> <insertNewline/>
    <insertValue value="com.applovin.mediation,facebook-adapter,+" /> <insertNewline/>
    <insertValue value="com.applovin.mediation,mintegral-adapter,+" /> <insertNewline/>
    <insertValue value="com.applovin.mediation,mobilefuse-adapter,+" /> <insertNewline/>
    <insertValue value="com.applovin.mediation,moloco-adapter,+" /> <insertNewline/>
    <insertValue value="com.applovin.mediation,ogury-presage-adapter,+" /> <insertNewline/>
    <insertValue value="com.applovin.mediation,bytedance-adapter,+" /> <insertNewline/>
    <insertValue value="com.applovin.mediation,smaato-adapter,+" /> <insertNewline/>
    <insertValue value="com.applovin.mediation,unityads-adapter,+" /> <insertNewline/>
    <insertValue value="com.applovin.mediation,verve-adapter,+" /> <insertNewline/>
    <insertValue value="com.applovin.mediation,mytarget-adapter,+" /> <insertNewline/>
    <insertValue value="com.applovin.mediation,yandex-adapter,+" /> <insertNewline/>
</AARImports>

<buildGradleAdditions>
    <insert>
        allprojects {
            // You may add any additional repositories for other ad networks here
            repositories {
                maven { url "https://artifactory.bidmachine.io/bidmachine" }
                maven { url "https://cboost.jfrog.io/artifactory/chartboost-ads/" }
                maven { url "https://android-sdk.is.com" }
                maven { url "https://imobile-maio.github.io/maven" }
                maven { url "https://dl-maven-android.mintegral.com/repository/mbridge_android_sdk_oversea" }
                maven { url "https://maven.ogury.co" }
                maven { url "https://artifact.bytedance.com/repository/pangle" }
                maven { url "https://s3.amazonaws.com/smaato-sdk-releases/" }
                maven { url "https://verve.jfrog.io/artifactory/verve-gradle-release" }
            }
        }
    </insert>
</buildGradleAdditions>

Update aar-imports.txt

Several network SDKs require a newer version of Google Play Services than the one included by default with Unreal Engine. You must update the aar-imports.txt for the Unreal Engine version you’re using. For example, to update the dependency versions for Unreal Engine 4.27 on macOS, modify the file located at /Users/Shared/Epic Games/UE_4.27/Engine/Build/Android/Java/aar-imports.txt.

⋮
com.google.android.gms,play-services-auth,16.0.1
com.google.android.gms,play-services-games,17.0.0
com.google.android.gms,play-services-nearby,16.0.0
com.google.android.gms,play-services-plus,16.0.0

Meta Audience Network Data Processing Options

If you do not want to enable Limited Data Use (LDU) mode, pass SetDataProcessingOptions() an empty string array:

⋮
<gameActivityImportAdditions>
  ⋮
  import com.facebook.ads.AdSettings;
</gameActivityImportAdditions>

<gameActivityOnCreateAdditions>
  <insert>
    AdSettings.setDataProcessingOptions( new String[] {} );
  </insert>
</gameActivityOnCreateAdditions>

To enable LDU for users and specify user geography, call SetDataProcessingOptions() in a form like this:

<gameActivityOnCreateAdditions>
  <insert>
    AdSettings.setDataProcessingOptions( new String[] {"LDU"}, «country», «state» );
  </insert>
</gameActivityOnCreateAdditions>

Meta Audience Network Data Processing Options for Users in California

To learn how to implement Meta Audience Network’s “Limited Data Use” flag in California, read the Meta for Developers documentation.

Note

Developers and publishers who use Google AdSense, AdManager, or AdMob must use a consent management platform (CMP) that is certified by Google. The CMP must integrate with IAB’s Transparency and Consent Framework when you serve ads to users in the European Economic Area (EEA) or the UK. See Privacy: “TCF v2 Consent” for more information.

Add Your Google Bidding and Google AdMob / Google Ad Manager App ID

In your app’s AppLovinMAX_UPL_Android.xml, add your Google bidding and Google AdMob App ID under the androidManifestUpdates tag. In the example below, replace «your-admob-app-id» with your Google bidding and Google AdMob App ID.

<androidManifestUpdates>
⋮
    <addElements tag="application">
        <meta-data
        android:name="com.google.android.gms.ads.APPLICATION_ID"
        android:value="«your-admob-app-id»" />
    </addElements>
⋮
</androidManifestUpdates>

compileSdkVersion

You set the compileSdkVersion of your app in build.gradle.

Google Mobile Ads SDK versions 20.5.0 and newer require that you set compileSdkVersion to 31.

Google Mobile Ads SDK version 20.4.0.1 is the most recent version that still supports setting compileSdkVersion to 30.

Gradle Errors

Google AdMob requires Android Gradle plugin version 4.2.0 or higher and Gradle version 6.7.1 or higher. If you see the following error, update your Android Gradle plugin and Gradle versions:

AAPT: error: unexpected element <property> found in <manifest><application>.

Enable Google Ad Manager

In your app’s AppLovinMAX_UPL_Android.xml, add a <meta-data> tag inside the application tag. The example below shows the correct attributes of this tag.

<androidManifestUpdates>
⋮
  <addElements tag="application">
    <meta-data
        android:name="com.google.android.gms.ads.AD_MANAGER_APP"
        android:value="true" />
  </addElements>
⋮
</androidManifestUpdates>

Android Manifest Merging Errors

Several network SDKs use the <queries> element in their bundled Android Manifest files. If you use an incompatible version of the Android Gradle plugin, this causes one of the following build errors:

Google Bidding and Google AdMob / InMobi / Pangle

com.android.builder.internal.aapt.v2.Aapt2Exception: Android resource linking failed
error: unexpected element <queries> found in <manifest>.

Meta Audience Network / VK Ad Network

Missing 'package' key attribute on element package at [:com.my.target.mytarget-sdk-5.11.3:]
AndroidManifest Validation failed

To fix this error, upgrade to one of the following versions of the Android Gradle plugin. These versions support the <queries> element:

Caution

Upgrade the Android Gradle Plugin, not the Gradle Build Tools.

Current Android Gradle Plugin Version	Version that Supports <queries> Element
4.1.*	All
4.0.*	4.0.1+
3.6.*	3.6.4+
3.5.*	3.5.4+
3.4.*	3.4.3+
3.3.*	3.3.3+

To upgrade the Android Gradle plugin, follow these instructions:

1. Navigate to the directory for your version of the Unreal Engine. For example, Unreal Engine 4.27 on macOS can be found at /Users/Shared/Epic Games/UE_4.27/.
2. In Engine/Source/Programs/UnrealBuildTool/Platform/Android/UEDeployAndroid.cs, update the value for ANDROID_TOOLS_BUILD_GRADLE_VERSION (replace «X.X.X» with the appropriate version number):

   private const string ANDROID_TOOLS_BUILD_GRADLE_VERSION = "com.android.tools.build:gradle:«X.X.X»";

3. In Engine/Build/Android/Java/gradle/build.gradle update the following line (replace «X.X.X» with the appropriate version number):

   classpath project.hasProperty('ANDROID_TOOLS_BUILD_GRADLE_VERSION') ? project.property('ANDROID_TOOLS_BUILD_GRADLE_VERSION') : 'com.android.tools.build:gradle:«X.X.X»'

iOS

Unreal Engine requires that you manually integrate third-party frameworks for iOS. It does not support dependency managers like CocoaPods. The MAX Unreal GitHub repository includes a Python script — install_pods.py — to assist with automatically installing dependencies from a Podfile. This script downloads AppLovin adapters and third-party dependencies, and configures your project with build settings to link them.

Note

This script may not be able to automatically configure third-party SDKs for certain networks. If so, you must integrate them manually.

Requirements

• Python 3.6+
• CocoaPods

Tip

Ensure that you’re using the latest version of CocoaPods. You can check your version by issuing the following command:

pod --version

To update CocoaPods, run one of the following commands:

Homebrew

brew upgrade cocoapods

RubyGems

sudo gem install cocoapods

Instructions

1. Download install_pods.py from AppLovin’s MAX Unreal GitHub repository.
2. Copy this script into the Source/ThirdParty/IOS/ directory of the AppLovin MAX Unreal plugin.
3. Create a Podfile in that directory for the adapters you want to integrate.
4. Run install_pods.py to download the adapters and dependencies. Follow any additional instructions from the script to complete installation.
5. Follow the instructions in Preparing Mediated Networks (iOS). Add any necessary changes to Info.plist in AppLovinMAX_UPL_IOS.xml.