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.

This page shows you how to integrate MAX mediation network adapters in your app. Choose which mediated ad networks you want to integrate by checking the boxes below. Then this page will display instructions specific to those networks.

Android

Select the ad networks you want to integrate. Then follow the Android-specific instructions on this page.

Google Ad Manager Google Bidding and Google AdMob InMobi Meta Audience Network Pangle VK Ad Network

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 App IDs

1. Open the Integration Manager (AppLovin > Integration Manager).
2. Install the latest Google bidding and Google AdMob adapter:
   1. Click Install in the Actions column next to Google bidding and Google AdMob in the Mediated Networks section of the Integration Manager.
   2. Click Import in the Import Unity Package dialog.
3. Two new fields for your App IDs will appear in the Mediated Networks section of the Integration Manager. Enter the corresponding values there.

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

To update your Android Gradle plugin and Gradle versions, take the following steps:

1. In Unity, open Project Settings > Player > Android > Publishing Settings > Build.
2. Check Custom Base Gradle Template.
3. Edit the Assets/Plugins/Android/baseProjectTemplate.gradle file.i Set the dependencies to use Gradle build tools version 4.2.0:

   allprojects {
     buildscript {
       dependencies {
         classpath 'com.android.tools.build:gradle:4.2.0'
         «build script dependencies»
       }
     }
   }

4. Download and install Gradle version 6.7.1 or higher.
5. In Unity, open Unity Preferences > External Tools.
6. Set the custom Gradle path so that it points to your newly-updated Gradle installation.

Meta Audience Network SDK Migration

If your project uses the Meta Audience Network Unity SDK, you must be on version 11.0 or later for the MAX Meta Audience Network adapter to function. To migrate from an older version of Meta Audience Network Unity SDK, delete the Assets/FacebookSDK directory, then download and re-import the latest version here.

Meta Audience Network Data Processing Options

If you aren’t using the Meta Audience Network Unity Plugin, follow the instructions here under “Unity SDK, v5.10+ (not using the Audience Network-supplied Unity wrapper)” to add a wrapper for the relevant methods.

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

using AudienceNetwork;
⋮
AdSettings.SetDataProcessingOptions(new string[] { });
⋮
// Initialize MAX SDK

If you want to enable LDU for users and to specify user geography, call SetDataProcessingOptions() like this:

using AudienceNetwork;
⋮
AdSettings.SetDataProcessingOptions(new string[] {"LDU"}, «country», «state»);
⋮
// Initialize MAX SDK

Using Google UMP

If you use Google UMP as your CMP, you can determine whether the user consented to Meta. To do so, use the following code:

bool? hasMetaConsent = MaxSdkUtils.GetAdditionalConsentStatus(89);
if ( hasMetaConsent != null )
{
  // Set Meta Data Processing Options accordingly.
}
else
{
  // AC String is not available on disk. Please check for consent status after the user completes the CMP flow.
}

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.

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 update the Gradle Plugin version to a compatible one, enable the custom base Gradle template:

1. Select Edit > Project Settings….
2. Choose Player and select the tab labeled with the Android icon.
3. Open Publisher Settings and check Custom Base Gradle Template.

The template is located at Assets/Plugins/Android/mainTemplate.gradle for Unity 2019.2 or below, and at Assets/Plugins/Android/baseProjectTemplate.gradle for Unity 2019.3 or above. In that template, update the line below with the appropriate Gradle version:

classpath com.android.tools.build:gradle:«x».«x».«x»

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.

Network Security Configuration File

For Meta Audience Network to function correctly, you must permit cleartext traffic (at least for certain domains) by using Android’s Network Security Configuration feature.

If you use Meta Audience Network, you must permit cleartext traffic for localhost (127.0.0.1). You can accomplish this by creating or editing your network_security_config.xml file.

1. If you have not already created the network_security_config.xml file, create it in Plugins/Android/res/xml/.
2. In your application manifest Assets/Plugins/Android/AndroidManifest.xml (if you don’t have one, you need to create it), add the configuration to your application attribute as follows:

   <?xml version="1.0" encoding="utf-8"?>
   <manifest … >
     <application android:networkSecurityConfig="@xml/network_security_config"
           … >
       ⋮
     </application>
   </manifest>

3. In the res/xml/network_security_config.xml file, add sections that permit cleartext traffic for the networks that require this:

   <?xml version="1.0" encoding="utf-8"?>
   <network-security-config>
   
     <domain-config cleartextTrafficPermitted="true">
   
       <!-- For Meta Audience Network, this permits cleartext traffic to localhost: -->
       <domain includeSubdomains="true">127.0.0.1</domain>
       <!-- End Meta Audience Network section -->
   
     </domain-config>
   </network-security-config>

iOS

Select the ad networks you want to integrate. Then follow the iOS-specific instructions on this page.

Google Bidding and Google AdMob Meta Audience Network Pangle

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 App IDs

Open the Integration Manager (AppLovin > Integration Manager) and install the latest Google bidding and Google AdMob adapter:

1. Click Install in the Actions column next to Google bidding and Google AdMob in the Mediated Networks section of the Integration Manager.
2. Click Import in the Import Unity Package dialog.
3. Two new fields for your App IDs will appear in the Mediated Networks section of the Integration Manager. Enter the corresponding values there.

Meta Audience Network SDK Migration

If your project uses the Meta Audience Network Unity SDK, you must be on version 11.0 or later for the MAX Meta Audience Network adapter to function. To migrate from an older version of Meta Audience Network Unity SDK, delete the Assets/FacebookSDK directory, then download and re-import the latest version here.

Meta Audience Network Data Processing Options

If you aren’t using the Meta Audience Network Unity Plugin, you can follow the instructions here under “Unity SDK, v5.10+ (not using the Audience Network-supplied Unity wrapper)” to add a wrapper for the relevant methods.

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

using AudienceNetwork;
⋮
AdSettings.SetDataProcessingOptions(new string[] { });
⋮
// Initialize MAX SDK

If you want to enable LDU for users and to specify user geography, call SetDataProcessingOptions() like this:

using AudienceNetwork;
⋮
AdSettings.SetDataProcessingOptions(new string[] {"LDU"}, «country», «state»);
⋮
// Initialize MAX SDK

Using Google UMP

If you use Google UMP as your CMP, you can determine whether the user consented to Meta. To do so, use the following code:

bool? hasMetaConsent = MaxSdkUtils.GetAdditionalConsentStatus(89);
if ( hasMetaConsent != null )
{
  // Set Meta Data Processing Options accordingly.
}
else
{
  // AC String is not available on disk. Please check for consent status after the user completes the CMP flow.
}

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.

Meta Preparing For iOS 14.5 and Above

Version 6.2.1 of Audience Network SDK introduced the following important requirement:

• Implement the setAdvertiserTrackingEnabled flag, irrespective of the use of mediation. This informs Meta whether to use the data to deliver personalized ads.

MaxSdkCallbacks.OnSdkInitializedEvent += (MaxSdkBase.SdkConfiguration sdkConfiguration) => {

#if UNITY_IOS || UNITY_IPHONE || UNITY_EDITOR
  if (MaxSdkUtils.CompareVersions(UnityEngine.iOS.Device.systemVersion, "14.5") != MaxSdkUtils.VersionComparisonResult.Lesser)
  {
    // Note that App transparency tracking authorization can be checked via `sdkConfiguration.AppTrackingStatus` for Unity Editor and iOS targets
    // 1. Set Meta ATE flag here, THEN
  }
#endif

  // 2. Load ads
};

Note

Starting from Pangle iOS adapter version 4.9.1.0.0, Pangle is no longer available in Chinese Mainland. To monetize Chinese Mainland traffic, set up the CSJ network and add the CSJ adapter. For global traffic that excludes Chinese Mainland, you can continue to use Pangle for monetization.

SKAdNetwork

The Integration Manager automatically integrates SKAdNetwork IDs of integrated networks on your behalf.

Note

To integrate Amazon for Unity, refer to the Amazon Publisher Services Integration Instructions page.

Integration Manager

You can access the AppLovin Integration Manager from your Unity IDE. It allows you to install or upgrade mediation adapters and the mediation plugin itself.

To launch the Integration Manager, select AppLovin > Integration Manager from the Unity menu bar.

This displays a pop up window with a list of available mediation networks. You can Install or Upgrade ad networks by clicking buttons in the Action column.

Manual Download