Skip to content

offerwall

Francisco Dias edited this page May 5, 2023 · 7 revisions

Offerwall

This module contains all functions that handle managing offerwall 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_offerwall_init

This function initialises the ironSource SDK for the Offerwall 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_offerwall_init()

Returns:

N/A


Triggers:

Social Async Event

Triggered when Offerwall initialization starts.

Key Type Description
type string The value "ironsource_offerwall_init"

Triggered when there is a change in the Offerwall availability status.

Key Type Description
type string The value "ironsource_offerwall_availability_changed"
available boolean The value will change to true when Offerwall is available.
You can then show the offerwall by calling ironsource_offerwall_show.



Back To Top

ironsource_offerwall_get_credits

Call this function to check if the Steam API was correctly initialised.

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_offerwall_get_credits()

Returns:

N/A


Triggers:

Social Async Event

Triggered when the function call succeeds

Key Type Description
type string The value "ironsource_offerwall_credited"
credits real The number of credits the user has earned.
total_credits real The total number of credits ever earned by the user.
total_credits_flag boolean In some cases, ironSource won’t be able to provide the exact number of credits since the last event. In this case the credits will be equal to the total_credits, and this flag will be true.

Triggered when the method ironsource_offerwall_get_credits fails to retrieve the user's credit balance info.

Key Type Description
type string The value "ironsource_offerwall_credits_failed"



Back To Top

ironsource_offerwall_show

Shows the Offerwall to the user if it's currently available.

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_offerwall_show()

Returns:

N/A


Triggers:

Social Async Event

Triggered when the Offerwall successfully loads for the user.

Key Type Description
type string The value "ironsource_offerwall_opened"

Triggered when the method ironsource_offerwall_show is called and the OfferWall fails to load.

Key Type Description
type string The value "ironsource_offerwall_show_failed"
error string The error message.

Triggered when the user is about to return to the application after closing the Offerwall.

Key Type Description
type string The value "ironsource_offerwall_closed"



Back To Top

ironsource_offerwall_set_client_side_callbacks

Call this function to check if the Steam API was correctly initialised.


Syntax:

ironsource_offerwall_set_client_side_callbacks()

Returns:

N/A



Clone this wiki locally