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.

Banner

MaxSdk.CreateBanner(«ad-unit-ID», «position»);
MaxSdk.SetBannerPlacement(«ad-unit-ID», "«placement»");

MREC

MaxSdk.CreateMRec(«ad-unit-ID», «position»);
MaxSdk.SetMRecPlacement(«ad-unit-ID», "«placement»");

Interstitial

MaxSdk.ShowInterstitial(«ad-unit-ID», "«placement»");

Rewarded

MaxSdk.ShowRewardedAd(«ad-unit-ID», "«placement»");

Note

For banners and MRECs you must set the placement name immediately after you create the banner or MREC.

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:

mute

MaxSdk.SetMuted(true);

unmute

MaxSdk.SetMuted(false);

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 with the following call:

MaxSdk.SetVerboseLogging(true);

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

You can retrieve the name of the DSP for a MAX ad served from AppLovin Exchange via the ad’s DspName property:

private void OnInterstitialLoadedEvent(string adUnitId, MaxSdkBase.AdInfo adInfo)
{
  Debug.Log("AppLovin Exchange DSP Name: " + adInfo.DspName);
}

Impression-Level User Revenue API

Starting in Unity Plugin 4.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.

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. The following example shows how to do this within the “ad revenue paid” callback:

// Attach callbacks based on the ad format(s) you are using
MaxSdkCallbacks.Interstitial.OnAdRevenuePaidEvent += OnAdRevenuePaidEvent;
MaxSdkCallbacks.Rewarded.OnAdRevenuePaidEvent += OnAdRevenuePaidEvent;
MaxSdkCallbacks.Banner.OnAdRevenuePaidEvent += OnAdRevenuePaidEvent;
MaxSdkCallbacks.MRec.OnAdRevenuePaidEvent += OnAdRevenuePaidEvent;
⋮
private void OnAdRevenuePaidEvent(string adUnitId, MaxSdkBase.AdInfo adInfo)
{
  double revenue = adInfo.Revenue;

  // Miscellaneous data
  string countryCode = MaxSdk.GetSdkConfiguration().CountryCode; // "US" for the United States, etc - Note: Do not confuse this with currency code which is "USD"
  string networkName = adInfo.NetworkName; // Display name of the network that showed the ad
  string adUnitIdentifier = adInfo.AdUnitIdentifier; // The MAX Ad Unit ID
  string placement = adInfo.Placement; // The placement this ad's postbacks are tied to
  string networkPlacement = adInfo.NetworkPlacement; // The placement ID from the network that showed the ad
}

Note

The value of Revenue may be -1 in the case of an error.

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

string revenuePrecision = adInfo.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)

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. If so, it initializes all networks that you have configured for them.) The following example shows how you implement this feature:

MaxSdkCallbacks.OnSdkInitializedEvent += (MaxSdkBase.SdkConfiguration config) => {
  ⋮
};

MaxSdk.InitializeSdk(new[]{"«ad-unit-ID-1»", "«ad-unit-ID-2»"});

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 Unity plugin version 4.3.13.

AdLoadState Values

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

Example

private void OnInterstitialLoadedEvent(string adUnitId, MaxSdkBase.AdInfo adInfo)
{
  print("Waterfall Name: " + adInfo.WaterfallInfo.Name + " and Test Name: " + adInfo.WaterfallInfo.TestName);
  print("Waterfall latency was: " + adInfo.WaterfallInfo.LatencyMillis + " milliseconds");

  string waterfallInfoStr = "";
  foreach (var networkResponse in adInfo.WaterfallInfo.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;
    }
  }
  print(waterfallInfoStr);
}

private void OnInterstitialLoadFailedEvent(string adUnitId, MaxSdkBase.ErrorInfo errorInfo)
{
  print("Waterfall Name: " + errorInfo.WaterfallInfo.Name + " and Test Name: " + errorInfo.WaterfallInfo.TestName);
  print("Waterfall latency was: " + errorInfo.WaterfallInfo.LatencyMillis + " milliseconds");

  foreach (var networkResponse in errorInfo.WaterfallInfo.NetworkResponses)
  {
    print("Network -> " + networkResponse.MediatedNetwork +
          "\n...latency: " + networkResponse.LatencyMillis + " milliseconds" +
          "\n...credentials: " + networkResponse.Credentials +
          "\n...error: " + networkResponse.Error);
  }
}

Output

Waterfall Name: Default Waterfall and Test Name: Control
Waterfall latency was: 10176 milliseconds

Network -> [MediatedNetworkInfo name: Fyber, adapterClassName: ALInnteractiveMediationAdapter, adapterVersion: 8.1.1.0, sdkVersion: 8.1.1.0]
    ...latency: 1542 milliseconds
    ...credentials: System.Collections.Generic.Dictionary`2[System.String,System.Object]
    ...error: [ErrorInfo code: -5200, message: Unspecified Error, adLoadFailure: Load failed - Failed to load Interstitial ad]

Network -> [MediatedNetworkInfo name: AppLovin, adapterClassName: ALAppLovinMediationAdapter, adapterVersion: 10.3.7, sdkVersion: 10.3.7]
...adLoadState: AdLoaded
...latency: 245 milliseconds
...credentials: System.Collections.Generic.Dictionary`2[System.String,System.Object]

Customize Banner / MREC Ad Refresh

You can customize banner and MREC ad refresh intervals directly in your integration, just as you can configure them in the Ad Unit UI. The minimum refresh interval is 10 seconds. The maximum refresh interval is 120 seconds. Values outside of these limits are ignored. The following code sample shows you how to customize these refresh intervals:

MaxSdk.SetBannerExtraParameter(«ad-unit-ID», "ad_refresh_seconds", «ad-refresh-rate»)
MaxSdk.SetMRecExtraParameter(«ad-unit-ID», "ad_refresh_seconds", «ad-refresh-rate»)