Fullscreen (Interstitial)

Integrate fullscreen ads

Fullscreen placements are interstitial ads covering the whole screen of the device. Hence, it might be important to tell your app to stop running, e.g. if it is a car gaming app, or to resume when the interstitial was dismissed by the user. You can configure frequency capping for fullscreen placements within the Dashboard (e.g. show not more than 1 impression per hour), so you don’t need to implement frequency capping yourself.

Create Placement

To create an instance of FullscreenPlacement, use the following API:

Java

FullscreenPlacement placement = AATKit.createFullscreenPlacement("<PLACEMENT_NAME>");

Kotlin

val placement = AATKit.createFullscreenPlacement("<PLACEMENT_NAME>")

Listen to Callbacks (Optional)

Through the use of FullscreenPlacementListener, you can listen to the different placement callbacks.

Java

placement.setListener(this);

Kotlin

placement.listener = this

Request Ad

You can load ads for the fullscreen placement either automatically or manually. We strongly recommend using the auto reload for fullscreen ads, because a fullscreen should be ready to present when the app triggers its presentation.

Automatic Reload

To automatically load a fullscreen placement, call:

Java

placement.startAutoReload();

Kotlin

placement.startAutoReload()

This way the fullscreen placement will always aim to have an ad ready. Please also remember to stop the auto-reload when it is no longer needed:

Java

placement.stopAutoReload();

Kotlin

placement.stopAutoReload()

The fullscreen placement fires onHaveAd listener method only once per loaded ad. So, Before starting the auto-reload, you should check for ads from the previous load/auto-reload using the placement has ad API.

Manual Load

To manually load the fullscreen placement, call:

Java

placement.reload();

Kotlin

placement.reload()

Display Ad

We strongly recommend calling show() whenever the user triggers the respective event (e.g. clicks a button, starts the next game, and so on). This will ensure proper fill rate statistics on the Dashboard. Do not call show() only, if an ad was loaded successfully before, otherwise, your fill rate statistics will be 100% all the time.

Call show() when your app shall present the fullscreen ad:

Java

placement.show();

Kotlin

placement.show()

The show() method will return a bool value indicating whether the fullscreen placement could be displayed or not. This means whether the fullscreen placement has a ready fullscreen ad or not.

Ad Info

After loading a fullscreen ad, you can access the loaded ad information by accessing the adInfo property of the fullscreen placement:

Java

AdInfo adInfo = fullscreenPlacement.getAdInfo();

Kotlin

val info = fullscreenPlacement.adInfo

Has Ad

The fullscreen placement provides an API to check if it has a loaded ad.

Java

boolean hasAd = placement.hasAd();

Kotlin

val hasAd = placement.hasAd()

Complete Code Example

Java

private FullscreenPlacement placement = AATKit.createFullscreenPlacement("<PLACEMENT_NAME>");

@Override
protected void onResume() {
    super.onResume();
    // [IMPORTANT] Notify AATKit about activity lifecycle
    AATKit.onActivityResume(this);

    // Set placement listener to listen to the callbacks
    placement.setListener(this);
    // Start autoreloading the placement.
    placement.startAutoReload();
}

@Override
protected void onPause() {
    // [IMPORTANT] Stop placement autoreload
    placement.stopAutoReload();
    // [IMPORTANT] Notify AATKit about activity lifecycle
    AATKit.onActivityPause(this);
    super.onPause();
}

private void startNewGame() {
    // An example for showing the fullscreen ad when the user starts a new game
    placement.show();
}

// FullscreenPlacementListener:
@Override
public void onPauseForAd(@NonNull Placement placement) {
    // Ad has been displayed on the screen
}

@Override
public void onResumeAfterAd(@NonNull Placement placement) {
    // Back to the app
}

@Override
public void onHaveAd(@NonNull Placement placement) {
    // The placement has loaded a new ad
}

@Override
public void onNoAd(@NonNull Placement placement) {
    // The placement could not load a new ad
}

Kotlin

private val placement = createFullscreenPlacement("<PLACEMENT_NAME>")

override fun onResume() {
    super.onResume()
    // [IMPORTANT] Notify AATKit about activity lifecycle
    AATKit.onActivityResume(this)

    // Set placement listener to listen to the callbacks
    placement?.listener = this
    // Start autoreloading the placement.
    placement?.startAutoReload()
}

override fun onPause() {
    // [IMPORTANT] Stop placement autoreload
    placement?.stopAutoReload()
    // [IMPORTANT] Notify AATKit about activity lifecycle
    AATKit.onActivityPause(this)
    super.onPause()
}

private fun startNewGame() {
    // An example for showing the fullscreen ad when the user starts a new game
    placement?.show()
}

// FullscreenPlacementListener:
override fun onPauseForAd(placement: Placement) {
    // Ad has been displayed on the screen
}

override fun onResumeAfterAd(placement: Placement) {
    // Back to the app
}

override fun onHaveAd(placement: Placement) {
    // The placement has loaded a new ad
}

override fun onNoAd(placement: Placement) {
    // The placement could not load a new ad
}