Skip to content

interstitial

Francisco Dias edited this page Sep 19, 2024 · 6 revisions

Interstitial

This module contains all functions that handle managing interstitial ads.

Functions

This module offers a collection of functions designed to address specific tasks and provide utilities for various purposes. Explore the available functions to make the most of the functionalities provided by this module.



Back To Top

ironsource_interstitial_init

This function initialises the ironSource SDK for the Interstitial ad unit.

This function operates asynchronously, which means that it does not immediately return the requested result. Instead, upon completion of the task, it will trigger the Social Async Event.


Syntax:

ironsource_interstitial_init()



Returns:

N/A


Triggers:

Social Async Event

Key Type Description
type String The value "ironsource_interstitial_init"



Back To Top

ironsource_interstitial_load

Loads an interstitial ad.

This function operates asynchronously, which means that it does not immediately return the requested result. Instead, upon completion of the task, it will trigger the Social Async Event.


Syntax:

ironsource_interstitial_load()



Returns:

N/A


Triggers:

Social Async Event

If the interstitial loaded successfully:

Key Type Description
type String The value "ironsource_interstitial_ready"

If the interstitial failed to load

Key Type Description
type String The value "ironsource_interstitial_load_failed"
error String The error message.



Back To Top

ironsource_interstitial_is_capped

Checks if the interstitial ad for the specified placement is capped.


Syntax:

ironsource_interstitial_is_capped(placement_name)
Argument Type Description
placement_name String The name of the ad placement.



Returns:

Boolean




Back To Top

ironsource_interstitial_show

Shows the interstitial ad for the specified placement if it is ready.

This function operates asynchronously, which means that it does not immediately return the requested result. Instead, upon completion of the task, it will trigger the Social Async Event.


Syntax:

ironsource_interstitial_show(placement_name)
Argument Type Description
placement_name String The name of the ad placement.



Returns:

N/A


Triggers:

Social Async Event

If the interstitial showed successfully:

Key Type Description
type String The value "ironsource_interstitial_show_succeeded"

If the interstitial failed to show:

Key Type Description
type String The value "ironsource_interstitial_show_failed"

If the interstitial was clicked:

Key Type Description
type String The value "ironsource_interstitial_clicked"

If the interstitial was opened:

Key Type Description
type String The value "ironsource_interstitial_opened"

If the interstitial was closed:

Key Type Description
type String The value "ironsource_interstitial_closed"



Back To Top

ironsource_interstitial_is_ready

Checks if the interstitial ad is ready to be shown.


Syntax:

ironsource_interstitial_is_ready()



Returns:

Boolean