Adapter

Kotlin |Java

abstract class Adapter : MediationExtrasReceiver

Known direct subclasses

RtbAdapter

RtbAdapter

Mediation adapter that also supports bidding.

---

Adapter for third party ad networks. All loading methods have a default implementation that will gracefully fail if the adapter does not support the format.

Summary

Constants
const String	ERROR_MESSAGE_METHOD_NOT_FOUND

Public constructors
Adapter()

Public functions
abstract VersionInfo	getSDKVersionInfo() Gets the version of the third party SDK built into the app.
abstract VersionInfo	getVersionInfo() Gets the version of the mediation adapter.
abstract Unit	initialize(     context: Context,     callback: InitializationCompleteCallback,     configurations: List<MediationConfiguration> ) Called by the Google Mobile Ads SDK to initialize a third party adapter and SDK.
open Unit	loadAppOpenAd(     adConfiguration: MediationAppOpenAdConfiguration,     callback: MediationAdLoadCallback<MediationAppOpenAd, MediationAppOpenAdCallback> ) Called by the Google Mobile Ads SDK to begin loading a third party app open ad.
open Unit	loadBannerAd(     adConfiguration: MediationBannerAdConfiguration,     callback: MediationAdLoadCallback<MediationBannerAd, MediationBannerAdCallback> ) Called by the Google Mobile Ads SDK to begin loading a third party banner ad given a @see MediationAdConfiguration.
open Unit	loadInterscrollerAd(     adConfiguration: MediationBannerAdConfiguration,     callback: MediationAdLoadCallback<MediationInterscrollerAd, MediationBannerAdCallback> ) Called by the Google Mobile Ads SDK to begin loading a third party interscroller ad given a @see MediationAdConfiguration.
open Unit	loadInterstitialAd(     adConfiguration: MediationInterstitialAdConfiguration,     callback: MediationAdLoadCallback<MediationInterstitialAd, MediationInterstitialAdCallback> ) Called by the Google Mobile Ads SDK to begin loading a third party interstitial ad given a MediationAdConfiguration.
open Unit	loadNativeAd(     adConfiguration: MediationNativeAdConfiguration,     callback: MediationAdLoadCallback<UnifiedNativeAdMapper, MediationNativeAdCallback> ) Called by the Google Mobile Ads SDK to begin loading a third party native ad.
open Unit	loadNativeAdMapper(     adConfiguration: MediationNativeAdConfiguration,     callback: MediationAdLoadCallback<NativeAdMapper, MediationNativeAdCallback> ) Called by the Google Mobile Ads SDK to begin loading a third party native ad.
open Unit	loadRewardedAd(     adConfiguration: MediationRewardedAdConfiguration,     callback: MediationAdLoadCallback<MediationRewardedAd, MediationRewardedAdCallback> ) Called by the Google Mobile Ads SDK to begin loading a third party rewarded ad given a MediationAdConfiguration.
open Unit	loadRewardedInterstitialAd(     adConfiguration: MediationRewardedAdConfiguration,     callback: MediationAdLoadCallback<MediationRewardedAd, MediationRewardedAdCallback> ) Called by the Google Mobile Ads SDK to begin loading a third party rewarded interstitial ad given a MediationAdConfiguration.

Constants

ERROR_MESSAGE_METHOD_NOT_FOUND

const val ERROR_MESSAGE_METHOD_NOT_FOUND: String

Public constructors

Adapter

Adapter()

Public functions

getSDKVersionInfo

abstract fun getSDKVersionInfo(): VersionInfo

Gets the version of the third party SDK built into the app.

getVersionInfo

abstract fun getVersionInfo(): VersionInfo

Gets the version of the mediation adapter.

initialize

abstract fun initialize(
    context: Context,
    callback: InitializationCompleteCallback,
    configurations: List<MediationConfiguration>
): Unit

Called by the Google Mobile Ads SDK to initialize a third party adapter and SDK. This method is invoked shortly after the app initializes the Google Mobile Ads SDK.

Parameters
context: Context	The context the publisher provides in MobileAds.initialize()
callback: InitializationCompleteCallback	Callback to be invoked when the adapter has finished initialization.
configurations: List<MediationConfiguration>	A list of MediationConfiguration objects configured for this adapter in the Google AdMob or Google Ad Manager UI.

loadAppOpenAd

open fun loadAppOpenAd(
    adConfiguration: MediationAppOpenAdConfiguration,
    callback: MediationAdLoadCallback<MediationAppOpenAd, MediationAppOpenAdCallback>
): Unit

Called by the Google Mobile Ads SDK to begin loading a third party app open ad.

Parameters
adConfiguration: MediationAppOpenAdConfiguration	The MediationAppOpenAdConfiguration that contains information needed to load the winning ad.
callback: MediationAdLoadCallback<MediationAppOpenAd, MediationAppOpenAdCallback>	A callback to be invoked when the ad finishes loading.

loadBannerAd

open fun loadBannerAd(
    adConfiguration: MediationBannerAdConfiguration,
    callback: MediationAdLoadCallback<MediationBannerAd, MediationBannerAdCallback>
): Unit

Called by the Google Mobile Ads SDK to begin loading a third party banner ad given a @see MediationAdConfiguration.

Parameters
adConfiguration: MediationBannerAdConfiguration	The MediationBannerAdConfiguration that contains information needed to load the winning ad.
callback: MediationAdLoadCallback<MediationBannerAd, MediationBannerAdCallback>	A callback to be invoked when the ad finishes loading.

loadInterscrollerAd

open fun loadInterscrollerAd(
    adConfiguration: MediationBannerAdConfiguration,
    callback: MediationAdLoadCallback<MediationInterscrollerAd, MediationBannerAdCallback>
): Unit

Called by the Google Mobile Ads SDK to begin loading a third party interscroller ad given a @see MediationAdConfiguration.

Parameters
adConfiguration: MediationBannerAdConfiguration	The MediationBannerAdConfiguration that contains information needed to load the winning ad.
callback: MediationAdLoadCallback<MediationInterscrollerAd, MediationBannerAdCallback>	A callback to be invoked when the ad finishes loading.

loadInterstitialAd

open fun loadInterstitialAd(
    adConfiguration: MediationInterstitialAdConfiguration,
    callback: MediationAdLoadCallback<MediationInterstitialAd, MediationInterstitialAdCallback>
): Unit

Called by the Google Mobile Ads SDK to begin loading a third party interstitial ad given a MediationAdConfiguration.

Parameters
adConfiguration: MediationInterstitialAdConfiguration	The MediationInterstitialAdConfiguration that contains information needed to load the winning ad.
callback: MediationAdLoadCallback<MediationInterstitialAd, MediationInterstitialAdCallback>	A callback to be invoked when the ad finishes loading.

loadNativeAd

open fun loadNativeAd(
    adConfiguration: MediationNativeAdConfiguration,
    callback: MediationAdLoadCallback<UnifiedNativeAdMapper, MediationNativeAdCallback>
): Unit

Called by the Google Mobile Ads SDK to begin loading a third party native ad.

Parameters
adConfiguration: MediationNativeAdConfiguration	The MediationNativeAdConfiguration that contains information needed to load the winning ad.
callback: MediationAdLoadCallback<UnifiedNativeAdMapper, MediationNativeAdCallback>	A callback to be invoked when the ad finishes loading.

loadNativeAdMapper

open fun loadNativeAdMapper(
    adConfiguration: MediationNativeAdConfiguration,
    callback: MediationAdLoadCallback<NativeAdMapper, MediationNativeAdCallback>
): Unit

Called by the Google Mobile Ads SDK to begin loading a third party native ad.

Parameters
adConfiguration: MediationNativeAdConfiguration	The MediationNativeAdConfiguration that contains information needed to load the winning ad.
callback: MediationAdLoadCallback<NativeAdMapper, MediationNativeAdCallback>	A callback to be invoked when the ad finishes loading.

loadRewardedAd

open fun loadRewardedAd(
    adConfiguration: MediationRewardedAdConfiguration,
    callback: MediationAdLoadCallback<MediationRewardedAd, MediationRewardedAdCallback>
): Unit

Called by the Google Mobile Ads SDK to begin loading a third party rewarded ad given a MediationAdConfiguration.

Parameters
adConfiguration: MediationRewardedAdConfiguration	The MediationRewardedAdConfiguration that contains information needed to load the winning ad.
callback: MediationAdLoadCallback<MediationRewardedAd, MediationRewardedAdCallback>	The callback to be invoked when the ad finishes loading.

loadRewardedInterstitialAd

open fun loadRewardedInterstitialAd(
    adConfiguration: MediationRewardedAdConfiguration,
    callback: MediationAdLoadCallback<MediationRewardedAd, MediationRewardedAdCallback>
): Unit

Called by the Google Mobile Ads SDK to begin loading a third party rewarded interstitial ad given a MediationAdConfiguration.

Parameters
adConfiguration: MediationRewardedAdConfiguration	The MediationRewardedAdConfiguration that contains information needed to load the winning ad.
callback: MediationAdLoadCallback<MediationRewardedAd, MediationRewardedAdCallback>	A callback to be invoked when the ad finishes loading.