Adapter

Kotlin |Java

public abstract class Adapter implements 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
static final @NonNull String	ERROR_MESSAGE_METHOD_NOT_FOUND

Public constructors
Adapter()

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

public static final @NonNull String ERROR_MESSAGE_METHOD_NOT_FOUND

Public constructors

Adapter

public Adapter()

Public methods

getSDKVersionInfo

public abstract @NonNull VersionInfo getSDKVersionInfo()

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

getVersionInfo

public abstract @NonNull VersionInfo getVersionInfo()

Gets the version of the mediation adapter.

initialize

public abstract void initialize(
    @NonNull Context context,
    @NonNull InitializationCompleteCallback callback,
    @NonNull List<@NonNull MediationConfiguration> configurations
)

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

loadAppOpenAd

public void loadAppOpenAd(
    @NonNull MediationAppOpenAdConfiguration adConfiguration,
    @NonNull MediationAdLoadCallback<@NonNull MediationAppOpenAd, @NonNull MediationAppOpenAdCallback> callback
)

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

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

loadBannerAd

public void loadBannerAd(
    @NonNull MediationBannerAdConfiguration adConfiguration,
    @NonNull MediationAdLoadCallback<@NonNull MediationBannerAd, @NonNull MediationBannerAdCallback> callback
)

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

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

loadInterscrollerAd

public void loadInterscrollerAd(
    @NonNull MediationBannerAdConfiguration adConfiguration,
    @NonNull MediationAdLoadCallback<@NonNull MediationInterscrollerAd, @NonNull MediationBannerAdCallback> callback
)

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

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

loadInterstitialAd

public void loadInterstitialAd(
    @NonNull MediationInterstitialAdConfiguration adConfiguration,
    @NonNull MediationAdLoadCallback<@NonNull MediationInterstitialAd, @NonNull MediationInterstitialAdCallback> callback
)

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

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

loadNativeAd

public void loadNativeAd(
    @NonNull MediationNativeAdConfiguration adConfiguration,
    @NonNull MediationAdLoadCallback<@NonNull UnifiedNativeAdMapper, @NonNull MediationNativeAdCallback> callback
)

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

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

loadNativeAdMapper

public void loadNativeAdMapper(
    @NonNull MediationNativeAdConfiguration adConfiguration,
    @NonNull MediationAdLoadCallback<@NonNull NativeAdMapper, @NonNull MediationNativeAdCallback> callback
)

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

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

loadRewardedAd

public void loadRewardedAd(
    @NonNull MediationRewardedAdConfiguration adConfiguration,
    @NonNull MediationAdLoadCallback<@NonNull MediationRewardedAd, @NonNull MediationRewardedAdCallback> callback
)

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

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

loadRewardedInterstitialAd

public void loadRewardedInterstitialAd(
    @NonNull MediationRewardedAdConfiguration adConfiguration,
    @NonNull MediationAdLoadCallback<@NonNull MediationRewardedAd, @NonNull MediationRewardedAdCallback> callback
)

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

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