Home





Rewarded Ads

Rewarded Ads are usually full-screen video ads which users can view to receive a reward inside the app, like an additional in-game currency or a health bonus for example.


Blocks

is rewarded ad ready

boolean is rewarded ad ready()

Check if an ad from any of the included SDK providers is ready to be shown.

Return Value:

Returns true if any ad is ready, false otherwise. When app is not Enhanced, always returns true.

is rewarded ad ready for placement

boolean is rewarded ad ready for placement(
    text placement
)

Check if an ad from any of the included SDK providers is ready to be shown.

Parameters:

text  placement - Specifies the internal placement of the ad (from the Enhance mediation editor).

Return Value:

Returns true if any ad is ready, false otherwise. When app is not Enhanced, always returns true.

show rewarded ad

void show rewarded ad()

Display an ad if any is currently available. The ad provider is selected based on your app's mediation settings.

show rewarded ad with placement

void show rewarded ad with placement(
    text placement
)

Display an ad if any is currently available. The ad provider is selected based on your app's mediation settings.

Parameters:

text  placement - Specifies the internal placement of the ad (from the Enhance mediation editor).

on reward granted

on reward granted()

Called when an ad is finished and a reward is granted to the user. As parameters, this function will receive the reward's type, and its value as an integer (if applicable, depending on ad network's configuration).

on reward declined

on reward declined()

Called when a reward is declined (e.g. user closed the ad before it finished displaying).

on reward unavailable

on reward unavailable()

Called when a reward is unavailable for an unknown reason and cannot be granted.

last reward type

text last reward type()

Type of the last granted reward. Either "ITEM" or "COINS".

last reward value

number last reward value()

Value of the last granted reward. Only applicable if the reward's type is "COINS".