A list of all Actions, Conditions and Expressions supported in this addon.
0. General
-
Actions
Show consent form if required {0}
Displays the consent form to the user
Set ad sounds muted to {0}
Indicates if the application’s audio is muted. Affects initial mute state for fullscreen ads. Use this method only if your application has its own volume controls (e.g., custom music or sound effect muting).
-
Conditions
On consent form dismissed
Triggered when the consent form is dismissed after CAS initialization or manual consent form show.
On consent required
Triggered when user consent is required after CAS initialization or manual consent form show.
On consent not required
Triggered when user consent is not required after CAS initialization or manual consent flow show..
Is consent required
Checks if user consent is required.
-
Expressions
InitializationError
Gets the initialization error message if any.
UserCountryCode
Gets the user's country ISO 2 code based on their IP address. For example: 'US' or '--' if unknown.
ConsentStatus
Gets the current status of the consent form: 'Unknown', 'Obtained' 'Not required', 'Unavailable', 'Internal error', 'Network error', 'Invalid context', 'Still presenting'
ErrorMessage
When in a failure (load/show) condition, an error message related to it.
1. Banner Ads
-
Actions
Load {0} banner ad with limits ({1}, {2})
Loads a banner ad with specified size. The ad will not be displayed on the screen until the show action is performed. This action works asynchronously, and you can use the 'Wait for previous actions to complete' action to wait until the ad has been loaded or failed to load.
Show banner ad at {0} with offset ({1}, {2})
Displays the banner ad at the specified position with optional offsets. The banner’s position can be changed at any time by performing this action with new parameters.
Hide banner ad
Hides the currently displayed banner ad.
Destroy banner ad
Destroys the banner ad instance and frees up resources. To resume working with ads, use the load ad action.
-
Conditions
On banner ad loaded
Triggered when a banner ad is successfully loaded.
On banner ad failed to load
Triggered when a banner ad fails to load.
On banner ad clicked
Triggered when a banner ad is clicked.
Is banner ad loaded
Checks if a banner ad is loaded.
2. MREC Ads
-
Actions
Load MREC ad
Loads a medium rectangle (MREC) ad. The ad will not be displayed on the screen until the show action is performed. This action works asynchronously, and you can use the 'Wait for previous actions to complete' action to wait until the ad has been loaded or failed to load.
Show MREC ad at at {0} with offset ({1}, {2})
Displays the MREC ad at the specified position with optional offsets. The ad position can be changed at any time by performing this action with new parameters.
Hide MREC ad
Hides the currently displayed MREC ad.
Destroy MREC ad
Destroys the MREC ad instance and frees up resources. To resume working with ads, use the load ad action.
-
Conditions
On MREC ad loaded
Triggered when a medium rectangle (MREC) ad is successfully loaded.
On MREC ad failed to load
Triggered when a medium rectangle (MREC) ad fails to load.
On MREC ad clicked
Triggered when a medium rectangle (MREC) ad is clicked.
Is MREC ad loaded
Checks if a medium rectangle (MREC) ad is loaded.
3. AppOpen Ads
-
Actions
Load AppOpen ad
Loads an AppOpen ad. This action works asynchronously, and you can use the 'Wait for previous actions to complete' action to wait until the ad has been loaded or failed to load.
Show AppOpen ad
Displays the AppOpen ad. There is no need to check whether the ad is loaded before showing it. This action works asynchronously, and you can use the 'Wait for previous actions to complete' action to wait until the ad has been dismissed or failed to show.
Destroy AppOpen ad
Destroys the app open ad instance and frees up resources. To resume working with ads, use the load ad action.
-
Conditions
On app open ad loaded
Triggered when an app open ad is successfully loaded.
On app open ad failed to load
Triggered when an app open ad fails to load.
On app open ad failed to show
Triggered when an app open ad fails to show.
On app open ad showed
Triggered when an app open ad is shown.
On app open ad clicked
Triggered when an app open ad is clicked.
On app open ad dismissed
Triggered when an app open ad is dismissed.
Is app open ad loaded
Checks if an app open ad is loaded.
4. Interstitial Ads
-
Actions
Load interstitial ad
Loads an Interstitial ad. This action works asynchronously, and you can use the 'Wait for previous actions to complete' action to wait until the ad has been loaded or failed to load.
Show interstitial ad
Displays the interstitial ad. There is no need to check whether the ad is loaded before showing it. This action works asynchronously, and you can use the 'Wait for previous actions to complete' action to wait until the ad has been dismissed or failed to show.
Destroy interstitial ad
Destroys the Interstitial ad instance and frees up resources. To resume working with ads, use the load ad action.
-
Conditions
On interstitial ad loaded
Triggered when an interstitial ad is successfully loaded.
On interstitial ad failed to load
Triggered when an interstitial ad fails to load.
On interstitial ad failed to show
Triggered when an interstitial ad fails to show.
On interstitial ad showed
Triggered when an interstitial ad is shown.
On interstitial ad clicked
Triggered when an interstitial ad is clicked.
On interstitial ad dismissed
Triggered when an interstitial ad is dismissed.
Is interstitial ad loaded
Checks if an interstitial ad is loaded.
5. Rewarded Ads
-
Actions
Load rewarded ad
Loads a rewarded ad. This action works asynchronously, and you can use the 'Wait for previous actions to complete' action to wait until the ad has been loaded or failed to load.
Show rewarded ad
Displays the rewarded ad. Use the 'On Ad User Earned Reward' trigger to reward the user. There is no need to check whether the ad is loaded before showing it. This action works asynchronously, and you can use the 'Wait for previous actions to complete' action to wait until the ad has been dismissed or failed to show.
Destroy rewarded ad
Destroys the rewarded ad instance and frees up resources. To resume working with ads, call the load ad action.
-
Conditions
On rewarded ad loaded
Triggered when a rewarded ad is successfully loaded.
On rewarded ad failed to load
Triggered when a rewarded ad fails to load.
On rewarded ad failed to show
Triggered when a rewarded ad fails to show.
On rewarded ad showed
Triggered when a rewarded ad is shown.
On rewarded ad clicked
Triggered when a rewarded ad is clicked.
On rewarded ad dismissed
Triggered when a rewarded ad is dismissed.
On rewarded ad user earned reward
Triggered when the user earns a reward from a rewarded ad.
On rewarded ad canceled by user
Triggered when the user cancel a rewarded ad and must not earn reward.
Is rewarded ad loaded
Checks if a rewarded ad is loaded.