InterstitialAd

Kotlin |Java

abstract class InterstitialAd

Known direct subclasses

AdManagerInterstitialAd

AdManagerInterstitialAd

A full page ad experience at natural transition points such as a page change, an app launch, or a game level load for Google Ad Manager publishers.

A full page ad experience at natural transition points such as a page change, an app launch, or a game level load. Interstitials use a close button that removes the ad from the user's experience.

Sample code:

public class MyActivity extends Activity {
    private InterstitialAd interstitialAd;
    private Button nextLevelButton;
    private TextView textView;

    @Override
    public void onCreate(Bundle savedInstanceState) {
        super.onCreate(savedInstanceState);

        // Create a full screen content callback.
        FullScreenContentCallback fullScreenContentCallback = new FullScreenContentCallback() {
            @Override
            public void onAdDismissedFullScreenContent() {
               interstitialAd = null;
               // Proceed to the next level.
               goToNextLevel();
            }
        };

        // Load an interstitial ad. When a natural transition in the app occurs (such as a level
        // ending in a game), show the interstitial. In this simple example, the press of a
        // button is used instead.
        //
        // If the button is clicked before the interstitial is loaded, the user should proceed to
        // the next part of the app (in this case, the next level).
        //
        // If the interstitial is finished loading, the user will view the interstitial before
        // proceeding.
        InterstitialAd.load(
            this,
            "myAdUnitId",
            new AdRequest.Builder().build(),
            new InterstitialAdLoadCallback() {
                @Override
                public void onAdLoaded(@NonNull InterstitialAd ad) {
                    interstitialAd = ad;
                    interstitialAd.setFullScreenContentCallback(fullScreenContentCallback);
                }

                @Override
                public void onAdFailedToLoad(@NonNull LoadAdError adError) {
                    // Code to be executed when an ad request fails.
                }
            });

        // Create the button to go to the next level.
        nextLevelButton = new Button(this);
        nextLevelButton.setText("Next Level");
        nextLevelButton.setOnClickListener(new View.OnClickListener() {
            @Override
            public void onClick(View view) {
                // Show the interstitial if it is ready. Otherwise, proceed to the next level
                // without ever showing it.
                if (interstitialAd != null) {
                    interstitialAd.show(MyActivity.this);
                } else {
                    // Proceed to the next level.
                    goToNextLevel();
                }
            }
        });

        // Add the next level button to the layout.
        LinearLayout layout = new LinearLayout(this);
        layout.setOrientation(LinearLayout.VERTICAL);
        layout.addView(nextLevelButton);

        // Create a TextView to display the current level.
        textView = new TextView(this);
        textView.setText("Level 1");
        layout.addView(textView);

        setContentView(layout);
    }

    public void goToNextLevel() {
        // Show the next level, and disable the next level button since there are no more levels.
        nextLevelButton.setEnabled(false);
        textView.setText("Level 2");
    }
}

Summary

Public constructors
`InterstitialAd()`

Public functions
`abstract String`	`getAdUnitId()` Returns the ad unit ID.
`abstract FullScreenContentCallback?`	`getFullScreenContentCallback()` Gets the `FullScreenContentCallback` for this `InterstitialAd`.
`abstract OnPaidEventListener?`	`getOnPaidEventListener()` Gets the `OnPaidEventListener` for this `InterstitialAd`.
`abstract ResponseInfo`	`getResponseInfo()` Returns the `ResponseInfo` object for the loaded ad.
`java-static Boolean`	`isAdAvailable(context: Context, adUnitId: String)` This function is deprecated. Use isAdAvailable instead.
`java-static Unit`	`load( context: Context, adUnitId: String, adRequest: AdRequest, loadCallback: InterstitialAdLoadCallback )` Loads an `InterstitialAd`.
`java-static InterstitialAd?`	`pollAd(context: Context, adUnitId: String)` This function is deprecated. Use pollAd instead.
`abstract Unit`	`setFullScreenContentCallback( fullScreenContentCallback: FullScreenContentCallback? )` Registers a callback to be invoked when ads show and dismiss full screen content.
`abstract Unit`	`setImmersiveMode(immersiveModeEnabled: Boolean)` Sets a flag that controls if this interstitial object will be displayed in immersive mode.
`abstract Unit`	`setOnPaidEventListener(listener: OnPaidEventListener?)` Registers a callback to be invoked when this ad is estimated to have earned money.
`abstract Unit`	`show(activity: Activity)` Shows the interstitial ad.

Public constructors

InterstitialAd

InterstitialAd()

Public functions

getAdUnitId

abstract fun getAdUnitId(): String

Returns the ad unit ID.

getFullScreenContentCallback

abstract fun getFullScreenContentCallback(): FullScreenContentCallback?

Gets the FullScreenContentCallback for this InterstitialAd.

getOnPaidEventListener

abstract fun getOnPaidEventListener(): OnPaidEventListener?

Gets the OnPaidEventListener for this InterstitialAd.

getResponseInfo

abstract fun getResponseInfo(): ResponseInfo

Returns the ResponseInfo object for the loaded ad. Returns null until the ad successfully loads.

isAdAvailable

java-static fun isAdAvailable(context: Context, adUnitId: String): Boolean

Returns true if there is an available interstitial ad loaded from startPreload.

load

java-static fun load(
    context: Context,
    adUnitId: String,
    adRequest: AdRequest,
    loadCallback: InterstitialAdLoadCallback
): Unit

Loads an InterstitialAd.

Parameters
`context: Context`	An activity or application context.
`adUnitId: String`	The ad unit ID.
`adRequest: AdRequest`	An ad request with targeting information.
`loadCallback: InterstitialAdLoadCallback`	A callback to be invoked when an interstitial ad finishes loading.

pollAd

java-static fun pollAd(context: Context, adUnitId: String): InterstitialAd?

Retrieves the next interstitial ad loaded from startPreload, or null if no ad is available.

setFullScreenContentCallback

abstract fun setFullScreenContentCallback(
    fullScreenContentCallback: FullScreenContentCallback?
): Unit

Registers a callback to be invoked when ads show and dismiss full screen content.

setImmersiveMode

abstract fun setImmersiveMode(immersiveModeEnabled: Boolean): Unit

Sets a flag that controls if this interstitial object will be displayed in immersive mode. Call this method before show. During show, if this flag is on and immersive mode is supported, SYSTEM_UI_FLAG_IMMERSIVE_STICKY &SYSTEM_UI_FLAG_HIDE_NAVIGATION will be turned on for interstitial ad.

setOnPaidEventListener

abstract fun setOnPaidEventListener(listener: OnPaidEventListener?): Unit

Registers a callback to be invoked when this ad is estimated to have earned money.

show

abstract fun show(activity: Activity): Unit

Shows the interstitial ad.

Parameters
`activity: Activity`	An `Activity` context from which to present the ad.