Adapter

abstract class Adapter : MediationExtrasReceiver

Known direct subclasses
RtbAdapter

Mediation adapter that also supports open 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

Public constructors

Public functions

abstract VersionInfo!

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

abstract VersionInfo!

Returns the version of the mediation adapter.

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

Called by the Google Mobile Ads SDK to initialize a third party adapter and SDK.

Unit

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

Unit

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

Unit

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

Unit

This function is deprecated.

Use loadNativeAdMapper instead.

Unit

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

Unit

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

Unit

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

Public constructors

Adapter

Adapter()

Public functions

getSDKVersionInfo

abstract fun getSDKVersionInfo(): VersionInfo!

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

getVersionInfo

abstract fun getVersionInfo(): VersionInfo!

Returns the version of the mediation adapter.

initialize

abstract fun initialize(
    context: Context!,
    callback: InitializationCompleteCallback!,
    configurations: (Mutable)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 initialize

callback: InitializationCompleteCallback!

Callback to be invoked when the adapter has finished initialization.

configurations: (Mutable)List<MediationConfiguration!>!

A list of MediationConfiguration objects configured for this adapter in the Google AdMob or Google Ad Manager UI.

loadAppOpenAd

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.

Used to load the winning ad from a mediation request.

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

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

Used to load the winning ad from a mediation request.

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.

loadInterstitialAd

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

Used to load the winning ad from a mediation request.

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

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

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

Used to load the winning ad from a mediation request.

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

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

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

Used to load the winning ad from a mediation request.

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 native ad finishes loading.

loadRewardedAd

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

Used to load the winning ad from a mediation request.

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.

loadRewardedInterstitialAd

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

Used to load the winning ad from a mediation request.

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.