Building a custom adapter

You can write a custom adapter if you want to support an ad network that is not listed in the AppLovin MAX mediation matrix. The following instructions show you how to do this.

Testing

You can test your custom adapter by using the MAX Demo App (see SDK integration guides > Platform > Testing networks). To get an ad request, raise the CPM of your placement in the waterfall.

Troubleshooting

If your custom adapter does not appear in the waterfall as you expect, use the following troubleshooting checklist:

1. Disable Test Mode (see SDK integration guides > Platform > Testing networks > Test mode)
2. Make sure that the app package name, ad unit, and SDK key all match.
3. Test with a physical device.
4. Set the CPM of the custom network high enough that it can win in the waterfall.

Banner ads

1. Implement the MaxAdViewAdapter interface in your com.mycompanyname.MyNetworkMediationAdapter class.
2. Override the loadAdViewAd() method which requests an ad. Call the parameters.getThirdPartyAdPlacementId() method to get the placement ID you need for your ad logic.
3. Call the appropriate MaxAdViewAdapterListener methods. They notify the AppLovin MAX SDK about banner lifecycle events:
   • When an ad loads, call MaxAdViewAdapterListener.onAdViewAdLoaded().
   • When an ad load fails, call MaxAdViewAdapterListener.onAdViewAdLoadFailed() with an appropriate MaxAdapterError.
   • Optionally, call the following banner lifecycle event notifications as appropriate: onAdViewAdClicked(), onAdViewAdCollapsed(), onAdViewAdDisplayed(), onAdViewAdDisplayFailed(), onAdViewAdExpanded(), onAdViewAdHidden().

Interstitials

1. Implement the MaxInterstitialAdapter interface in your com.mycompanyname.MyNetworkMediationAdapter class.
2. Override the loadInterstitialAd() method which requests an ad. Call the parameters.getThirdPartyAdPlacementId() method to get the placement ID you need for your ad logic.
3. Override the showInterstitialAd() method which shows the loaded ad. Call the parameters.getThirdPartyAdPlacementId() method to get the placement ID you need for your ad logic. If the ad is not ready, call MaxInterstitialAdapterListener.onInterstitialAdDisplayFailed( MaxAdapterError.AD_NOT_READY ).
4. Call the appropriate MaxInterstitialAdapterListener methods. They notify the AppLovin MAX SDK about interstitial lifecycle events:
   • When an ad loads, call MaxInterstitialAdapterListener.onInterstitialAdLoaded().
   • When an ad load fails, call MaxInterstitialAdapterListener.onInterstitialAdLoadFailed() with an appropriate MaxAdapterError.
   • When an ad is hidden, call MaxInterstitialAdapterListener.onInterstitialAdHidden().
   • Optionally, call the following interstitial lifecycle event notifications as appropriate: onInterstitialAdClicked(), onInterstitialAdDisplayFailed().

Rewarded ads

1. Implement the MaxRewardedAdapter interface in your com.mycompanyname.MyNetworkMediationAdapter class.
2. Override the loadRewardedAd() method which requests an ad. Call the parameters.getThirdPartyAdPlacementId() method to get the placement ID you need for your ad logic.
3. Override the showRewardedAd() method which shows the loaded ad. Call the parameters.getThirdPartyAdPlacementId() method to get the placement ID you need for your ad logic. If the ad is not ready, call MaxRewardedAdapterListener.onRewardedAdDisplayFailed( MaxAdapterError.AD_NOT_READY ).
4. Call the appropriate MaxRewardedAdapterListener methods. They notify the AppLovin MAX SDK about rewarded video lifecycle events:
   • When an ad loads, call MaxRewardedAdapterListener.onRewardedAdLoaded().
   • When an ad load fails, call MaxRewardedAdapterListener.onRewardedAdLoadFailed() with an appropriate MaxAdapterError.
   • When an ad starts playing, call MaxRewardedAdapterListener.onRewardedAdDisplayed().
   • If a reward should be presented to the user, call MaxRewardedAdapterListener.onUserRewarded() with an appropriate MaxReward amount and currency. If no amount is available, default to MaxReward.DEFAULT_AMOUNT. AppLovin recommends that you call this immediately before MaxRewardedAdapterListener.onRewardedAdHidden().
   • When an ad is hidden, call MaxRewardedAdapterListener.onRewardedAdHidden().
   • Optionally, call the following rewarded video lifecycle event notification as appropriate: onRewardedAdClicked().

Native ads

1. Implement the MaxNativeAdAdapter interface in your com.mycompanyname.MyNetworkMediationAdapter class.
2. Override the loadNativeAd() method which requests an ad.
3. Call the appropriate MaxNativeAdAdapterListener methods. They notify the AppLovin MAX SDK about native ad lifecycle events:
   • When an ad loads, call MaxNativeAdAdapterListener.onNativeAdLoaded().
   • When an ad load fails, call MaxNativeAdAdapterListener.onNativeAdLoadFailed() with an appropriate MaxAdapterError.
   • When an ad displays, call MaxNativeAdAdapterListener.onNativeAdDisplayed().
   • When the user clicks an ad, call MaxNativeAdAdapterListener.onNativeAdClicked().

Privacy

MAX offers two boolean flags that indicate whether the user provides privacy consent. They are Boolean objects. Their value is null if the user has indicated neither consent or no consent. MAX passes the parameters object into each method. To get the value of the privacy flags, use the following methods of the parameters object:

MaxAdapterParameters.hasUserConsent() : for the GDPR consent flag. To determine if GDPR applies to the user, read the SDK integration guides > Platform > Overview > Privacy page of this documentation.

MaxAdapterParameters.isDoNotSell() : for the multi-state targeted advertising consent flag. AppLovin does not have an API that indicates whether the user belongs in a region to which this applies.

Banner ads

1. Implement the MAAdViewAdapter protocol in your MyNetworkMediationAdapter class.
2. Implement the - (void)loadAdViewAdForParameters:(id<MAAdapterResponseParameters>)parameters adFormat:(MAAdFormat *)adFormat andNotify:(id<MAAdViewAdapterDelegate>)delegate method which requests an ad. Call the parameters.thirdPartyAdPlacementIdentifier method to get the Placement ID you need for your ad logic.
3. Call the appropriate MAAdViewAdapterDelegate methods. They notify the AppLovin MAX SDK about banner lifecycle events:
   • When an ad loads, call -[MAAdViewAdapterDelegate didLoadAdForAdView].
   • When an ad load fails, call -[MAAdViewAdapterDelegate didFailToLoadAdViewAdWithError:] with an appropriate MAAdapterError.
   • Optionally, call the following banner lifecycle event notifications as appropriate: didClickAdViewAd, didCollapseAdViewAd, didDisplayAdViewAd, didExpandAdViewAd, didFailToDisplayAdViewAdWithError, didHideAdViewAd.

Interstitials

1. Implement the MAInterstitialAdapter protocol in your MyNetworkMediationAdapter class.
2. Declare the - (void)loadInterstitialAdForParameters:(id<MAAdapterResponseParameters>)parameters andNotify:(id<MAInterstitialAdapterDelegate>)delegate method which requests an ad. Call the parameters.thirdPartyAdPlacementIdentifier method to get the placement ID you need for your ad logic.
3. Declare the - (void)showInterstitialAdForParameters:(id<MAAdapterResponseParameters>)parameters andNotify:(id<MAInterstitialAdapterDelegate>)delegate method which shows the loaded ad. Call the parameters.thirdPartyAdPlacementIdentifier method to get the placement ID you need for your ad logic. If the ad is not ready, call -[MAInterstitialAdapterDelegate didFailToDisplayInterstitialAdWithError: MAAdapterError.adNotReady].
4. Call the appropriate MAInterstitialAdapterDelegate methods. They notify the AppLovin MAX SDK about interstitial lifecycle events:
   • When an ad loads, call -[MAInterstitialAdapterDelegate didLoadInterstitialAd:].
   • When an ad load fails, call -[MAInterstitialAdapterDelegate didFailToLoadInterstitialAdWithError:] with an appropriate MAAdapterError.
   • When an ad displays, call -[MAInterstitialAdapterDelegate didDisplayInterstitialAd].
   • When an ad is hidden, call -[MAInterstitialAdapterDelegate didHideInterstitialAd:].
   • Optionally, call the following interstitial lifecycle event notifications as appropriate: didClickInterstitialAd, didFailToDisplayInterstitialAdWithError.

Rewarded ads

1. Implement the MARewardedAdapter protocol in your MyNetworkMediationAdapter class.
2. Declare the - (void)loadRewardedAdForParameters:(id<MAAdapterResponseParameters>)parameters andNotify:(id<MARewardedAdapterDelegate>)delegate; method which requests an ad. Call the parameters.thirdPartyAdPlacementIdentifier method to get the placement ID you need for your ad logic.
3. Declare the - (void)showRewardedAdForParameters:(id<MAAdapterResponseParameters>)parameters andNotify:(id<MARewardedAdapterDelegate>)delegate; method which shows the loaded ad. Call the parameters.thirdPartyAdPlacementIdentifier method to get the placement ID you need for your ad logic. If the ad is not ready, call -[MARewardedAdapterDelegate didFailToDisplayRewardedAdWithError: MAAdapterError.adNotReady].
4. Call the appropriate MARewardedAdapterDelegate methods. They notify the AppLovin MAX SDK about rewarded video lifecycle events:
   • When an ad loads, call -[MARewardedAdapterDelegate didLoadRewardedAd:].
   • When an ad load fails, call -[MARewardedAdapterDelegate didFailToLoadRewardedAdWithError:] with an appropriate MAAdapterError.
   • When an ad starts playing, call -[MARewardedAdapterDelegate didDisplayRewardedAd:].
   • If a reward should be presented to the user, call -[MARewardedAdapterDelegate didRewardUserWithReward:] with an appropriate MAReward amount and currency. If no amount is available, default to MAReward.defaultAmount. AppLovin recommends that you call this immediately before -[MARewardedAdapterDelegate didHideRewardedAd:].
   • When an ad is hidden, call -[MARewardedAdapterDelegate didHideRewardedAd:].
   • Optionally, call the following rewarded video lifecycle event notification as appropriate: didClickRewardedAd.

Native ads

1. Implement the MANativeAdAdapter protocol in your MyNetworkMediationAdapter class.
2. Implement the - (void)loadNativeAdForParameters:(id<MAAdapterResponseParameters>)parameters andNotify:(id<MANativeAdAdapterDelegate>)delegate; method which requests an ad.
3. Call the appropriate MANativeAdAdapterDelegate methods. They notify the AppLovin MAX SDK about native ad lifecycle events:
   • When an ad loads, call -[MANativeAdAdapterDelegate didLoadAdForNativeAd:].
   • When an ad load fails, call -[MANativeAdAdapterDelegate didFailToLoadNativeAdWithError:] with an appropriate MAAdapterError.
   • When an ad displays, call -[MANativeAdAdapterDelegate didDisplayNativeAdWithExtraInfo:].
   • When the user clicks an ad, call -[MANativeAdAdapterDelegate didClickNativeAd:].

Privacy

MAX offers two boolean flags that indicate whether the user provides privacy consent. They are NSNumber objects. Their value is nil if the user has indicated neither consent or no consent. MAX passes the parameters object into each method. To get the value of the privacy flags, use the following APIs of the parameters object:

-[MAAdapterParameters hasUserConsent] : for the GDPR consent flag. To determine if GDPR applies to the user, read the SDK integration guides > Platform > Overview > Privacy page of this documentation.

-[MAAdapterParameters isDoNotSell] : for the multi-state targeted advertising consent flag. AppLovin does not have an API that indicates whether the user belongs in a region to which this applies.