CustomEventInterstitial

Kotlin |Java

interface CustomEventInterstitial : CustomEvent

A custom event that supports interstitial ads.

The typical life-cycle for a custom event is to have requestInterstitialAd called once. At this point the adapter should request an ad and report either onAdLoaded or onAdFailedToLoad to the listener. Subsequent requests will be made with a new instance of the custom event. At the end of the life cycle, a best effort is made to call onDestroy, though this is not guaranteed. Note that requestInterstitialAd 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 custom event is expected to forward events via the CustomEventInterstitialListener passed in the requestInterstitialAd call. All parameters necessary to make an ad request should be passed in the serverParameter, MediationAdRequest, and customEventExtras parameters.

Summary

Public functions
`Unit`	`requestInterstitialAd( context: Context!, listener: CustomEventInterstitialListener!, serverParameter: String?, mediationAdRequest: MediationAdRequest!, customEventExtras: Bundle? )` Called by the mediation library to request an interstitial.
`Unit`	`showInterstitial()` Show the interstitial.

Inherited functions

From com.google.android.gms.ads.mediation.customevent.CustomEvent

`Unit`	`onDestroy()` Tears down the adapter control.
`Unit`	`onPause()` Called when the application calls `pause`.
`Unit`	`onResume()` Called when the application calls `resume`.

Public functions

requestInterstitialAd

fun requestInterstitialAd(
    context: Context!,
    listener: CustomEventInterstitialListener!,
    serverParameter: String?,
    mediationAdRequest: MediationAdRequest!,
    customEventExtras: Bundle?
): Unit

Called by the mediation library to request an interstitial.

If the request is successful, onAdLoaded should be called.

If the request is unsuccessful, onAdFailedToLoad 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 that requested the custom event interstitial. An `android.app.Activity` is preferred.
`listener: CustomEventInterstitialListener!`	Listener to custom event with callbacks for various events.
`serverParameter: String?`	The string configured in the publisher UI as the parameter for the custom event.
`mediationAdRequest: MediationAdRequest!`	Generic targeting parameters to use when requesting an interstitial.
`customEventExtras: Bundle?`	A `Bundle` of parameters set by the publisher on a per-request basis.

showInterstitial

fun showInterstitial(): Unit

Show the interstitial. This may be called any time after a call to onAdLoaded.