Advanced Settings

Ad Placements

You can set a placement name for each ad unit (for example, “Rewarded VideoLevels”, “INTER_levelEnd”, or “RewardedVideoCoinStore”). This can help you aggregate statistics for different placement categories. The following snippets show you how to set the placement name for various ad formats.

Banners / MRECs

Note

For banners and MRECs you must set the placement name before you load the banner or MREC.

Java

adView.setPlacement( "«placement»" );
adView.loadAd();

Kotlin

adView.setPlacement( "«placement»" )
adView.loadAd()

Interstitials

Java

interstitial.showAd( "«placement»" );

Kotlin

interstitial.showAd( "«placement»" )

Rewarded Ads

Java

rewardedAd.showAd( "«placement»" );

Kotlin

rewardedAd.showAd( "«placement»" )

Native Ads

Java

nativeAdLoader.setPlacement( "«placement»" );

Kotlin

nativeAdLoader.setPlacement( "«placement»" )

Native Ads (Ad Placer)

Java

MaxAdPlacerSettings settings = new MaxAdPlacerSettings( "«ad-unit-ID»" );
settings.setPlacement( "«placement»" );

Kotlin

val settings = MaxAdPlacerSettings( "«ad-unit-ID»" )
settings.placement = "«placement»"

Mute Audio

You can mute audio for some mediated SDK networks when you launch your app. The networks that support this functionality via the AppLovin SDK are Google bidding and Google AdMob, AppLovin, DT Exchange, Google Ad Manager, LINE, Mintegral, Tencent, and Verve. For other networks, consult your network’s account team to learn whether this functionality is available and how to access it.

Note

DT Exchange allows you to mute audio only for interstitial ads.

The following code snippets show how you mute audio on those networks that support this feature:

Java

AppLovinSdk sdk = AppLovinSdk.getInstance( context );
sdk.getSettings().setMuted( true );  // to mute
sdk.getSettings().setMuted( false ); // to unmute

Kotlin

val sdk = AppLovinSdk.getInstance( context )
sdk.settings.setMuted( true )  // to mute
sdk.settings.setMuted( false ) // to unmute

Caution

Set the mute state before you load ads. Some networks (like Google bidding and Google AdMob) return muted or unmuted videos depending on what the mute state is before ad load.

Enable Verbose Logging

Enable verbose logs by setting a boolean flag in the settings object of the SDK:

Programmatically

Java

AppLovinSdk.getInstance( context ).getSettings().setVerboseLogging( true );

Kotlin

AppLovinSdk.getInstance( context ).settings.setVerboseLogging( true )

Android Manifest

You can also enable verbose logging by editing your application’s Android Manifest file. Add a <meta-data> element like the following:

<application>
⋮
  <meta-data android:name="applovin.sdk.verbose_logging" android:value="true" />
⋮
</application>

Verification

To verify that you enabled verbose logs successfully, check for the line that reads Verbose Logging On: true in the initialization section of the AppLovin SDK logs:

AppLovin SDK
Version: 11.4.2
⋮
Verbose Logging On: true
⋮

AppLovin SDK tags its logs with the tag “/AppLovinSdk: [AppLovinSdk]”.

Creative ID and Network Name

You can retrieve the creative ID and the network name of displayed ads from various mediated networks. Refer to the Creative Debugger documentation for more information.

DSP Name

To retrieve the name of the DSP for a MAX ad served from AppLovin Exchange, call the ad’s getDspName() method:

Java

@Override
public void onAdLoaded(final MaxAd ad)
{
  System.out.println( "AppLovin Exchange DSP name: " + ad.getDspName() );
}

Kotlin

override fun onAdLoaded(maxAd: MaxAd)
{
  println( "AppLovin Exchange DSP Name: " + maxAd.getDspName() )
}

Impression-Level User Revenue API

Starting in SDK version 10.3.0, you can access impression-level user revenue data on the client side. You can use this data to compare different sources and campaigns. You can also access this data by using the MAX User Revenue API. MMPs who want to access this data should review the Impression-Level User Revenue API for MMPs documentation.

See also

• “Take Ad-Revenue Attribution to the Next Level With MAX” from AppLovin’s Blog
• “Three Ways You Can Measure User-Level Ad Revenue with MAX” from AppLovin’s Blog

You can share impression-level ad revenue data with your mobile measurement partner of choice, such as Adjust for all supported networks.

You can retrieve the revenue amount in all ad lifecycle callbacks. Do this by creating a MaxAdRevenueListener, implementing its onAdRevenuePaid() method, and passing that listener to setRevenueListener(). The following example shows how to implement such an “ad revenue paid” callback:

Java

@Override
void onAdRevenuePaid(final MaxAd ad)
{
  double revenue = ad.getRevenue(); // In USD

  // Miscellaneous data
  String countryCode = AppLovinSdk.getInstance( context ).getConfiguration().getCountryCode(); // "US" for the United States, etc - Note: Do not confuse this with currency code which is "USD"
  String networkName = ad.getNetworkName(); // Display name of the network that showed the ad
  String adUnitId = ad.getAdUnitId(); // The MAX Ad Unit ID
  MaxAdFormat adFormat = ad.getFormat(); // The ad format of the ad (e.g. BANNER, MREC, INTERSTITIAL, REWARDED)
  String placement = ad.getPlacement(); // The placement this ad's postbacks are tied to
  String networkPlacement = ad.getNetworkPlacement(); // The placement ID from the network that showed the ad
}

Kotlin

override fun onAdRevenuePaid(ad: MaxAd)
{
  val revenue = ad.revenue // In USD

  // Miscellaneous data
  val countryCode = AppLovinSdk.getInstance( context ).configuration.countryCode // "US" for the United States, etc - Note: Do not confuse this with currency code which is "USD"
  val networkName = ad.networkName // Display name of the network that showed the ad
  val adUnitId = ad.adUnitId // The MAX Ad Unit ID
  val adFormat = ad.format // The ad format of the ad (e.g. BANNER, MREC, INTERSTITIAL, REWARDED)
  val placement = ad.placement // The placement this ad's postbacks are tied to
  val networkPlacement = ad.networkPlacement // The placement ID from the network that showed the ad
}

Note

The value of ad.getRevenue()/ad.revenue may be -1in the case of an error.

You can also retrieve a precision evaluation for the revenue value, as shown in the following example:

Java

String revenuePrecision = ad.getRevenuePrecision();

Kotlin

val revenuePrecision = ad.revenuePrecision

This precision takes one of the following values:

"publisher_defined"

the revenue amount is the price assigned by the publisher

"exact"

the revenue amount is the result of a real-time auction

"estimated"

the revenue amount is based on Auto-CPM or FB Bidding estimates

"undefined"

no revenue amount is defined and there is not enough data to estimate

""

revenue and precision are not valid (for example, in test mode)

Establishing Ad Request Callbacks

To listen for when an ad request is made, set a MaxAdRequestListener, implement its onAdRequestStarted() method, and pass that listener to setRequestListener(). The following example shows how to implement such an “ad request started” callback:

Java

@Override
public void onAdRequestStarted(final String adUnitId)
{
  // Ad request started here
}

Kotlin

override fun onAdRequestStarted(adUnitId: String)
{
  // Ad request started here
}

Selective Init

You can initialize the SDK with specific ad units. If you do so, the SDK only initializes those networks that you have configured for the ad units you specify. If you do not specify any ad units, the SDK assumes the current session needs all of your ad units. In such a case it initializes all networks that you have configured for those ad units. The following example shows how you implement this feature:

Java

AppLovinSdkSettings settings = new AppLovinSdkSettings( context );
List<String> adUnitIds = new ArrayList<>();
adUnitIds.add( "«ad-unit-ID-1»" );
adUnitIds.add( "«ad-unit-ID-2»" );
settings.setInitializationAdUnitIds( adUnitIds );

AppLovinSdk sdk = AppLovinSdk.getInstance( settings, context );
sdk.setMediationProvider( "max" );
sdk.initializeSdk( new AppLovinSdk.SdkInitializationListener() {
  @Override
  public void onSdkInitialized(final AppLovinSdkConfiguration config) {
    ⋮
  }
} );

Kotlin

val settings = AppLovinSdkSettings( context )
settings.initializationAdUnitIds = arrayListOf( "«ad-unit-ID-1»", "«ad-unit-ID-2»" )

val sdk = AppLovinSdk.getInstance( settings, context );
sdk.mediationProvider = "max"
sdk.initializeSdk({ config ->
  ⋮
})

Caution

When you use selective init, any ad units that you do not explicitly specify are excluded from serving ads for the current session.

Note

Selective init has no effect when Test Mode is enabled.

Waterfall Information API

The Waterfall Information API tells you about the current waterfall for an ad (one that has loaded or failed to load). The API returns the ad load state, latency, credentials, and mediated network information for each ad in the waterfall. If an ad in the waterfall fails to load, the API provides error information.

This API is supported as of Android SDK version 10.3.5.

AdLoadState Values

value	explanation
0	Ad Load Not Attempted
1	Ad Loaded
2	Ad Failed To Load

Example

Java

@Override
public void onAdLoaded(final MaxAd ad)
{
  MaxAdWaterfallInfo waterfall = ad.getWaterfall();
  if ( waterfall == null ) return;
  System.out.println( "Waterfall Name: " + waterfall.getName() + " and Test Name: " + waterfall.getTestName() );
  System.out.println( "Waterfall latency was: " + waterfall.getLatencyMillis() + " milliseconds" );

  String waterfallInfoStr;
  for ( MaxNetworkResponseInfo networkResponse : waterfall.getNetworkResponses() )
  {
    waterfallInfoStr = "Network -> " + networkResponse.getMediatedNetwork() +
            "\n...adLoadState: " + networkResponse.getAdLoadState() +
            "\n...latency: " + networkResponse.getLatencyMillis() + " milliseconds" +
            "\n...credentials: " + networkResponse.getCredentials();
    if ( networkResponse.getError() != null )
    {
      waterfallInfoStr += "\n...error: " + networkResponse.getError();
    }
    System.out.println( waterfallInfoStr );
  }
}

@Override
public void onAdLoadFailed(final String adUnitId, final MaxError error)
{
  MaxAdWaterfallInfo waterfall = error.getWaterfall();
  if ( waterfall == null ) return;
  System.out.println( "Waterfall Name: " + waterfall.getName() + " and Test Name: " + waterfall.getTestName() );
  System.out.println( "Waterfall latency was: " + waterfall.getLatencyMillis() + " milliseconds" );

  for ( MaxNetworkResponseInfo networkResponse : waterfall.getNetworkResponses() )
  {
    System.out.println( "Network -> " + networkResponse.getMediatedNetwork() +
                        "...latency: " + networkResponse.getLatencyMillis() +
                        "...credentials: " + networkResponse.getCredentials() + " milliseconds" +
                        "...error: " + networkResponse.getError() );
  }
}

Kotlin

override fun onAdLoaded(ad: MaxAd?) {
  val waterfall = ad?.waterfall ?: return
  println( "Waterfall Name: " + waterfall.name + " and Test Name: " + waterfall.testName )
  println( "Waterfall latency was: " + waterfall.latencyMillis + " milliseconds" )

  var waterfallInfoStr: String
  for ( networkResponse in waterfall.networkResponses ) {
    waterfallInfoStr = "Network -> ${ networkResponse.mediatedNetwork }" +
          "\n...adLoadState: ${ networkResponse.adLoadState }" +
          "\n...latency: ${ networkResponse.latencyMillis } milliseconds" +
          "\n...credentials: ${ networkResponse.credentials }"
    if ( networkResponse.error != null ) {
      waterfallInfoStr += "\n...error: ${ networkResponse.error }"
    }
    println( waterfallInfoStr )
  }
}

override fun onAdLoadFailed(adUnitId: String?, error: MaxError?) {
  val waterfall = error?.waterfall ?: return
  println( "Waterfall Name: " + waterfall.name + " and Test Name: " + waterfall.testName )
  println( "Waterfall latency was: " + waterfall.latencyMillis + " milliseconds" )

  for ( networkResponse in waterfall.networkResponses ) {
    println( "Network -> ${ networkResponse.mediatedNetwork }" +
             "...latency: ${ networkResponse.latencyMillis } milliseconds" +
             "...credentials: ${ networkResponse.credentials }" +
             "...error: ${ networkResponse.error }" )
  }
}

Output

Waterfall Name: Default Waterfall and Test Name: Control
Waterfall latency was: 6668 milliseconds
Network -> MaxMediatedNetworkInfo{name=ironSource, adapterClassName=com.applovin.mediation.adapters.IronSourceMediationAdapter, adapterVersion=7.1.10.1.0, sdkVersion=7.1.10.1}
    ...adLoadState: FAILED_TO_LOAD
    ...latency: 1542 milliseconds
    ...credentials: Bundle[{app_key=88a0872d, placement_id=0}]
    ...error: MaxAdapterError{errorCode=-5200, errorMessage="Unspecified Error", thirdPartySdkErrorCode=510, thirdPartySdkErrorMessage="Load failed - Failed to load Interstitial ad"}

Network -> MaxMediatedNetworkInfo{name=Mintegral, adapterClassName=com.applovin.mediation.adapters.MintegralMediationAdapter, adapterVersion=15.7.61.0, sdkVersion=MAL_15.7.61}
    ...adLoadState: AD_LOADED
    ...latency: 4676 milliseconds
    ...credentials: Bundle[{app_id=118244, app_key=57205cd060e7e051e5bcccaae6bd2b64, placement_id=515486}]

Network -> MaxMediatedNetworkInfo{name=ironSource, adapterClassName=com.applovin.mediation.adapters.IronSourceMediationAdapter, adapterVersion=7.1.10.1.0, sdkVersion=7.1.10.1}
    ...adLoadState: AD_LOAD_NOT_ATTEMPTED
    ...latency: -1 milliseconds
    ...credentials: Bundle[{app_key=88a0872d, placement_id=1171359}]

Note

If the waterfall is empty, MaxError.getWaterfall() returns null. If so, you cannot interrogate the waterfall properties. However, you can retrieve the ad load latency for an empty waterfall by means of the getRequestLatencyMillis() method:

Java

@Override
public void onAdLoaded(final MaxAd ad)
{
  System.out.println("Successful ad load latency: " + ad.getRequestLatencyMillis() + " ms");
}

@Override
public void onAdLoadFailed(final String adUnitId, final MaxError error)
{
  System.out.println("Failed ad load latency: " + error.getRequestLatencyMillis() + " ms");
}

Kotlin

override fun onAdLoaded(ad: MaxAd)
{
  println( "Successful ad load latency: " + ad.getRequestLatencyMillis() + " ms" )
}

override fun onAdLoadFailed(adUnitId: String, error: MaxError)
{
  println( "Failed ad load latency: " + error.getRequestLatencyMillis() + " ms" )
}

Customize Banner / MREC Ad Refresh

You can customize banner and MREC ad refresh intervals via the API, just as you can configure them in the Ad Unit UI. The minimum and maximum refresh intervals allowed are 10 seconds and 120 seconds, respectively. Values outside of these limits are ignored. The following code samples show you how to customize these refresh intervals:

Java

// Where adView is an instance of MaxAdView
adView.setExtraParameter( "ad_refresh_seconds", «ad-refresh-rate» );

Kotlin

// Where adView is an instance of MaxAdView
adView.setExtraParameter( "ad_refresh_seconds", «ad-refresh-rate» )