Preparing mediated networks

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.

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.

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 customizes a Gradle script for you. Copy the customized Gradle script below to your app-level build.gradle.

  • Amazon
  • BidMachine
  • BIGO Ads
  • 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
  • PubMatic
  • Smaato
  • Unity Ads
  • Verve
  • VK Ad Network
  • Yandex
  • YSO Network
  • // build.gradle
    repositories {
        google()
        mavenCentral()
        maven { url "https://artifactory.bidmachine.io/bidmachine" }
        maven { url "https://cboost.jfrog.io/artifactory/chartboost-ads/" }
        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://repo.pubmatic.com/artifactory/public-repos" }
        maven { url "https://s3.amazonaws.com/smaato-sdk-releases/" }
        maven { url "https://verve.jfrog.io/artifactory/verve-gradle-release" }
        maven { url "https://ysonetwork.s3.eu-west-3.amazonaws.com/sdk/android" }
    
    }
    
    dependencies {
        implementation 'com.applovin:applovin-sdk:+'
        implementation 'com.applovin.mediation:amazon-tam-adapter:+'
        implementation 'com.amazon.android:aps-sdk:+'
        implementation 'com.applovin.mediation:bidmachine-adapter:+'
        implementation 'com.applovin.mediation:bigoads-adapter:+'
        implementation 'com.applovin.mediation:chartboost-adapter:+'
        implementation 'com.google.android.gms:play-services-base:16.1.0'
        implementation 'com.applovin.mediation:fyber-adapter:+'
        implementation 'com.applovin.mediation:google-ad-manager-adapter:+'
        implementation 'com.applovin.mediation:google-adapter:+'
        implementation 'com.applovin.mediation:hyprmx-adapter:+'
        implementation 'com.applovin.mediation:inmobi-adapter:+'
        implementation 'com.squareup.picasso:picasso:2.8'
        implementation 'androidx.recyclerview:recyclerview:1.1.0'
        implementation 'com.applovin.mediation:ironsource-adapter:+'
        implementation 'com.applovin.mediation:vungle-adapter:+'
        implementation 'com.applovin.mediation:line-adapter:+'
        implementation 'com.applovin.mediation:maio-adapter:+'
        implementation 'com.applovin.mediation:facebook-adapter:+'
        implementation 'com.applovin.mediation:mintegral-adapter:+'
        implementation 'com.applovin.mediation:mobilefuse-adapter:+'
        implementation 'com.applovin.mediation:moloco-adapter:+'
        implementation 'com.applovin.mediation:ogury-presage-adapter:+'
        implementation 'com.applovin.mediation:bytedance-adapter:+'
        implementation 'com.applovin.mediation:pubmatic-adapter:+'
        implementation 'com.applovin.mediation:smaato-adapter:+'
        implementation 'com.applovin.mediation:unityads-adapter:+'
        implementation 'com.applovin.mediation:verve-adapter:+'
        implementation 'com.applovin.mediation:mytarget-adapter:+'
        implementation 'com.applovin.mediation:yandex-adapter:+'
        implementation 'com.applovin.mediation:yso-network-adapter:+'
    
    }

    Migrating to AndroidX

    Integrate AndroidX libraries into your project. Refer to the Migrate to AndroidX guide for more information on how to migrate your project.

    Developers and publishers who use Google AdSense, AdManager, or AdMob must use a consent management platform (CMP) that Google certifies. 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 AndroidManifest.xml, add a <meta-data> tag inside the <application> tag. The example below shows you the correct attributes of this tag. Replace «your-admob-app-id» with your Google bidding and Google AdMob / Google Ad Manager App ID.

    <?xml version="1.0" encoding="utf-8"?>
    <manifest … >
      <application … >
        <meta-data
          android:name="com.google.android.gms.ads.APPLICATION_ID"
          android:value="«your-admob-app-id»"/>
        ⋮
      </application>
    </manifest>

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

    compileSdkVersion

    Google Mobile Ads SDK versions 23.1.0 and newer require a compileSdkVersion of at least 34.

    Set the compileSdkVersion to 34 or higher in your app’s build.gradle.

    Refer to the Google Mobile Ads SDK Release Notes for the latest compileSdkVersion requirements.

    Initialize the Amazon SDK

    The Amazon Publisher Services SDK requires that you initialize it outside MAX SDK:

    // Amazon requires an 'Activity' instance
    AdRegistration.getInstance( "AMAZON_APP_ID", this );
    AdRegistration.setMRAIDSupportedVersions( new String[] { "1.0", "2.0", "3.0" } );
    AdRegistration.setMRAIDPolicy( MRAIDPolicy.CUSTOM );

    Load a banner or MREC ad from Amazon’s SDK

    To integrate Amazon ads into MAX, you must load the Amazon ad first. Before you load the MAX ad, pass the DTBAdResponse or AdError into the instance of MaxAdView. You can do this by calling MaxAdView#setLocalExtraParameter().

    For auto-refreshing banner ads, you only need to load the ad one time.

    class ExampleActivity
            extends Activity
    {
      ⋮
    
      private void loadAd()
      {
        String amazonAdSlotId;
        MaxAdFormat adFormat;
    
        if ( AppLovinSdkUtils.isTablet( getApplicationContext() ) )
        {
          amazonAdSlotId = "«Amazon-leader-slot-ID»";
          adFormat = MaxAdFormat.LEADER;
        }
        else
        {
          amazonAdSlotId = "«Amazon-banner-slot-ID»";
          adFormat = MaxAdFormat.BANNER;
        }
    
        // Raw size will be 320x50 for BANNERs on phones, and 728x90 for LEADERs on tablets
        AppLovinSdkUtils.Size rawSize = adFormat.getSize();
        DTBAdSize size = new DTBAdSize( rawSize.getWidth(), rawSize.getHeight(), amazonAdSlotId );
    
        DTBAdRequest adLoader = new DTBAdRequest( getApplicationContext(), new DTBAdNetworkInfo( ApsAdNetwork.MAX ) );
        adLoader.setSizes( size );
        adLoader.loadAd( new DTBAdCallback()
        {
          @Override
          public void onSuccess(@NonNull final DTBAdResponse dtbAdResponse)
          {
            // 'adView' is your instance of MaxAdView
            adView.setLocalExtraParameter( "amazon_ad_response", dtbAdResponse );
            adView.loadAd();
          }
    
          @Override
          public void onFailure(@NonNull final AdError adError)
          {
            // 'adView' is your instance of MaxAdView
            adView.setLocalExtraParameter( "amazon_ad_error", adError );
            adView.loadAd();
          }
        } );
      }
    }

    Load an interstitial ad from Amazon’s SDK

    To integrate Amazon interstitial ads into MAX, you must load the Amazon ad first. Before you load the MAX ad, pass the DTBAdResponse or AdError into the instance of MaxInterstitialAd. You can do this by calling MaxInterstitialAd#setLocalExtraParameter().

    You must load and pass the Amazon DTBAdResponse or DTBAdErrorInfo into the MaxInterstitialAd instance only once per session.

    class ExampleActivity
           extends Activity
    {
      private static MaxInterstitialAd interstitialAd; // static to ensure only one instance exists
      private static boolean           isFirstLoad = true;
    
      private void loadAd()
      {
        if ( isFirstLoad )
        {
          isFirstLoad = false;
    
          if ( interstitialAd == null )
          {
            interstitialAd = new MaxInterstitialAd( "«MAX-inter-ad-unit-ID»" );
          }
    
          DTBAdRequest adLoader = new DTBAdRequest( getApplicationContext(), new DTBAdNetworkInfo( ApsAdNetwork.MAX ) );
          adLoader.setSizes( new DTBAdSize.DTBInterstitialAdSize( "«Amazon-inter-slot-ID»" ) );
          adLoader.loadAd( new DTBAdCallback()
          {
            @Override
            public void onSuccess(@NonNull final DTBAdResponse dtbAdResponse)
            {
              // 'interstitialAd' is your instance of MaxInterstitialAd
              interstitialAd.setLocalExtraParameter( "amazon_ad_response", dtbAdResponse );
              interstitialAd.loadAd();
            }
    
            @Override
            public void onFailure(@NonNull final AdError adError)
            {
              // 'interstitialAd' is your instance of MaxInterstitialAd
              interstitialAd.setLocalExtraParameter( "amazon_ad_error", adError );
              interstitialAd.loadAd();
            }
          } );
        }
        else
        {
          interstitialAd.loadAd();
        }
      }
    }

    Load a video interstitial ad from Amazon’s SDK

    To integrate Amazon video interstitial ads into MAX, you must load the Amazon ad first. Before you load the MAX ad, pass the DTBAdResponse or AdError into the instance of MaxInterstitialAd. You can do this by calling MaxInterstitialAd#setLocalExtraParameter().

    You must load and pass the DTBAdResponse or DTBAdErrorInfo into the MaxInterstitialAd instance only once per session.

    class ExampleActivity
           extends Activity
    {
      private static MaxInterstitialAd interstitialAd; // static to ensure only one instance exists
      private static boolean           isFirstLoad = true;
    
      private void loadAd()
      {
        if ( isFirstLoad )
        {
          isFirstLoad = false;
    
          if ( interstitialAd == null )
          {
            interstitialAd = new MaxInterstitialAd( "«MAX-inter-ad-unit-ID»" );
          }
    
          DTBAdRequest adLoader = new DTBAdRequest( getApplicationContext(), new DTBAdNetworkInfo( ApsAdNetwork.MAX ) );
    
          // Switch video player width and height values(320, 480) depending on device orientation
          adLoader.setSizes( new DTBAdSize.DTBVideo(320, 480, "«Amazon-video-inter-slot-ID»") );
          adLoader.loadAd( new DTBAdCallback()
          {
            @Override
            public void onSuccess(@NonNull final DTBAdResponse dtbAdResponse)
            {
              // 'interstitialAd' is your instance of MaxInterstitialAd
              interstitialAd.setLocalExtraParameter( "amazon_ad_response", dtbAdResponse );
              interstitialAd.loadAd();
            }
    
            @Override
            public void onFailure(@NonNull final AdError adError)
            {
              // 'interstitialAd' is your instance of MaxInterstitialAd
              interstitialAd.setLocalExtraParameter( "amazon_ad_error", adError );
              interstitialAd.loadAd();
            }
          } );
        }
        else
        {
          interstitialAd.loadAd();
        }
      }
    }

    Load a rewarded video ad from Amazon’s SDK

    To integrate Amazon rewarded videos into MAX, first load the Amazon ad. Before you load the MAX ad, pass the DTBAdResponse or AdError into the instance of MaxRewardedAd. You can do this by calling MaxRewardedAd#setLocalExtraParameter().

    You must load and pass the DTBAdResponse or AdError into the MaxRewardedAd instance only once per session.

    class ExampleActivity
            extends Activity
    {
      private static MaxRewardedAd rewardedAd; // static to ensure only one instance exists
      private static boolean       isFirstLoad = true;
    
      private void loadAd()
      {
        if ( isFirstLoad )
        {
          isFirstLoad = false;
    
          if ( rewardedAd == null )
          {
            rewardedAd = MaxRewardedAd.getInstance( "«MAX-rewarded-ad-unit-ID»" );
          }
    
          DTBAdRequest adLoader = new DTBAdRequest( getApplicationContext(), new DTBAdNetworkInfo( ApsAdNetwork.MAX ) );
    
          // Switch video player width and height values(320, 480) depending on device orientation
          adLoader.setSizes( new DTBAdSize.DTBVideo( 320, 480, "«Amazon-video-rewarded-slot-ID»" ) );
          adLoader.loadAd( new DTBAdCallback()
          {
            @Override
            public void onSuccess(@NonNull final DTBAdResponse dtbAdResponse)
            {
              // 'rewardedAd' is your instance of MaxRewardedAd
              rewardedAd.setLocalExtraParameter( "amazon_ad_response", dtbAdResponse );
              rewardedAd.loadAd();
            }
    
            @Override
            public void onFailure(@NonNull final AdError adError)
            {
              // 'rewardedAd' is your instance of MaxRewardedAd
              rewardedAd.setLocalExtraParameter( "amazon_ad_error", adError );
              rewardedAd.loadAd();
            }
          } );
        }
        else
        {
          rewardedAd.loadAd();
        }
      }
    }

    Testing Amazon Publisher Services

    AppLovin recommends that you enable test mode for Amazon’s SDK. This allows you to receive test ads. Enable test mode by making the following calls:

    AdRegistration.enableTesting( true );
    AdRegistration.enableLogging( true );

    You can filter your waterfalls such that they contain only Amazon ads. To do this, navigate to Select Live Network in the Mediation Debugger and select the Amazon network.

    Meta Audience Network data processing options

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

    import com.facebook.ads.AdSettings;
    ⋮
    AdSettings.setDataProcessingOptions( new String[] {} );
    ⋮
    // Initialize MAX SDK

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

    import com.facebook.ads.AdSettings;
    ⋮
    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 has consented to Meta or not. To do so, use code like the following:

    Boolean hasMetaConsent = AppLovinPrivacySettings.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, visit the Meta for Developers documentation.

    Obfuscation

    If you use code obfuscation or resource shrinking, follow Pangle’s Obfuscation guidelines.

    Android manifest merging errors

    Some network SDKs include 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:

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

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

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

    Current Android Gradle plugin versionVersion 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+

    Adapter network information

    Loading…


    Was this article helpful?
    Was this article helpful?
    search