CustomEventInterstitial | Android Developers

Quicknav Quicknav
Links

- Google Play Developer Console
- Android Developers Blog
- About Android

Android Sites

- Android.com
- Android Developers
- Android Open Source Project

Language
close

- - About
  - Wear
  - TV
  - Auto
- - Get Started
  - Devices
  - Style
  - Patterns
  - Building Blocks
  - Downloads
  - Videos
- - Training
  - API Guides
  - Reference
  - Tools
  - Google Services
  - Samples
- - Google Play
  - Essentials
  - Get Users
  - Engage & Retain
  - Monetize
  - Tools & Reference
  - Developer Stories

## Results

Loading...
Summary: Methods | Inherited Methods | [Expand All]
public interface

# CustomEventInterstitial

implements CustomEvent

com.google.android.gms.ads.mediation.customevent.CustomEventInterstitial

## Class Overview

A custom event that supports interstitial ads.

The typical life-cycle for a custom event is to have `requestInterstitialAd(Context, CustomEventInterstitialListener, String, MediationAdRequest, Bundle)` called once. At this point the adapter should request an ad and report either `onAdLoaded()` or `onAdFailedToLoad(int)` 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(Context, CustomEventInterstitialListener, String, MediationAdRequest, Bundle)` 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(Context, CustomEventInterstitialListener, String, MediationAdRequest, Bundle)` call. All parameters necessary to make an ad request should be passed in the `serverParameter`, `MediationAdRequest`, and `customEventExtras` parameters.

## Summary

Public Methods
abstract void | requestInterstitialAd(Context context, CustomEventInterstitialListener listener, String serverParameter, MediationAdRequest mediationAdRequest, Bundle customEventExtras) Called by the mediation library to request an interstitial.
abstract void | showInterstitial() Show the interstitial.

[Expand] Inherited Methods
From interface com.google.android.gms.ads.mediation.customevent.CustomEvent
abstract void | onDestroy() Tears down the adapter control.
abstract void | onPause() Called when the application calls `pause()`.
abstract void | onResume() Called when the application calls `resume()`.

## Public Methods

#### public abstract void requestInterstitialAd (Context context, CustomEventInterstitialListener listener, String serverParameter, MediationAdRequest mediationAdRequest, Bundle customEventExtras)

Called by the mediation library to request an interstitial.

If the request is successful, `onAdLoaded()` should be called.

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

#### public abstract void showInterstitial ()

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