MediationBannerAdapter

Kotlin |Java

interface MediationBannerAdapter : MediationAdapter

---

This interface is deprecated.
Use [com.google.android.gms.ads.mediation.Adapter] instead

Adapter for third party ad networks that support banner ads.

The typical life-cycle for an adapter is to have [requestBannerAd] called once. At this point the adapter should request an ad from the ad network and report to the listener either [MediationBannerListener.onAdLoaded] or [MediationBannerListener.onAdFailedToLoad]. Subsequent requests will be made with a new instance of the adapter. At the end of the life cycle, a best effort is made to call [onDestroy], though this is not guaranteed. Note that [requestBannerAd] is called on the UI thread so all the standard precautions of writing code on that thread apply. In particular, the code should not call any blocking methods.

The adapter is expected to expose events via the [MediationBannerListener] passed in the [requestBannerAd] call.

Adapters should make an effort to disable automatic ad refreshing on the client side. Ads that are refreshed may be ignored, not displayed, and counted incorrectly.

Summary

Public functions
View?	getBannerView() Returns a View that can be rendered to display the ad.
Unit	requestBannerAd(     context: Context,     listener: MediationBannerListener,     serverParameters: Bundle,     adSize: AdSize,     mediationAdRequest: MediationAdRequest,     mediationExtras: Bundle? ) Called by the mediation library to request a banner ad from the adapter.

Inherited functions
From com.google.android.gms.ads.mediation.MediationAdapter Unit onDestroy() Tears down the adapter control. Unit onPause() Called when the application calls onPause on the ad view. Unit onResume() Called when the application calls onResume on the ad view.

Public functions

getBannerView

fun getBannerView(): View?

Returns a View that can be rendered to display the ad.

This must not be null after a requestBannerAd call and before an onDestroy call. It may be null any other time.

requestBannerAd

fun requestBannerAd(
    context: Context,
    listener: MediationBannerListener,
    serverParameters: Bundle,
    adSize: AdSize,
    mediationAdRequest: MediationAdRequest,
    mediationExtras: Bundle?
): Unit

Called by the mediation library to request a banner ad from the adapter.

If the request is successful, the MediationBannerListener.onAdLoaded method should be called.

If the request is unsuccessful, the MediationBannerListener.onAdFailedToLoad method should be called on the listener with an appropriate error cause.

This method is called on the UI thread so all the standard precautions of writing code on that thread apply. In particular your code should not call any blocking methods.

Parameters
context: Context	The Context of the AdView which will contain the banner View. The android.app.Activity is preferred.
listener: MediationBannerListener	Listener to adapter with callbacks for various events
serverParameters: Bundle	Additional parameters defined by the publisher on the mediation server side
adSize: AdSize	The size of the ad to fetch. The ad size returned should have size as close as possible to the size specified in this parameter. If this ad size is not supported the request should fail and MediationBannerListener.onAdFailedToLoad should be called.
mediationAdRequest: MediationAdRequest	Generic parameters for this publisher to use when making his ad request
mediationExtras: Bundle?	Additional parameters set by the publisher on a per-request basis