A list of all Actions, Conditions and Expressions supported in this addon.
banner ad (Android | IOS)
-
Actions
Load Banner ( adUnitId {0}, position {1}, size {2}, pos {3}, width {4}, autoShow {5}).
(Platform ANDROID and IOS) Load banner
Remove Banner
Must be reloaded to display again, (Platform ANDROID and IOS)
Show Banner Ad
Show Banner Ad, (Platform ANDROID and IOS)
Hide Banner Ad
Can be re-displayed without having to be reloaded, (Platform ANDROID and IOS)
-
Conditions
On Banner ad clicked
On Banner ad clicked
On Banner ad closed
On Banner ad closed
On Banner ad failed to load
On Banner ad failed to load
On Banner ad impression
On Banner ad impression
On Banner ad loaded
On Banner ad loaded
On Banner ad opened
On Banner ad opened
On Banner Revenue
On Banner Revenue
interstitial ad (Android | IOS)
-
Actions
Load Interstitial (adUnitId {0}, Auto show {1}).
Load an interstitial ad to be shown. (Platform ANDROID and IOS)
Show Interstitial
Show Interstitial, (Platform ANDROID and IOS)
-
Conditions
On Interstitial ad loaded
On Interstitial ad loaded
On Interstitial failed load
On Interstitial ad failed to load
On Interstitial ad clicked
On Interstitial ad clicked
On Interstitial ad dismissed
On Interstitial ad dismissed fullscreen content
On Interstitial failed show
On Interstitial ad failed to show fullscreen content
On Interstitial ad impression
On Interstitial ad impression
On Interstitial Failed Show
on Ad Failed To Show FullScreen Content
this is the display text
this is the description
rewarded ad (Android | IOS)
-
Actions
Load Rewarded (adUnitId {0}, Auto show {1}).
Load an Rewarded Ad ad to be shown. (Platform ANDROID and IOS)
Show Rewarded
Show Rewarded Ad, (Platform ANDROID and IOS)
-
Conditions
On Rewarded ad failed to load
On Rewarded ad failed to load
On Rewarded ad loaded
On Rewarded ad loaded
On Rewarded ad clicked
On Rewarded ad clicked
On Rewarded ad dismissed
On Rewarded ad dismissed
On Rewarded ad failed to show
On Rewarded ad failed to show
On Rewarded ad impression
On Rewarded ad impression
On Rewarded ad showed
On Rewarded ad showed
On Rewarded Completed
The user earned the reward
On Rewarded Revenue
On Rewarded Revenue
On Rewarded Ad Skip
On Rewarded Ad Skip
rewarded interstitial ad (Android | IOS)
-
Actions
Load Rewarded Interstitial (adUnitId {0}, Auto show {1}).
Load an interstitial ad to be shown. (Platform ANDROID and IOS)
Show Rewarded Interstitial
Show Rewarded Interstitial Ad, (Platform ANDROID and IOS)
-
Conditions
On Rewarded interstitial ad loaded
On Rewarded interstitial ad loaded
On Rewarded interstitial failed load
On Rewarded interstitial ad failed to load
On Rewarded interstitial clicked
On Rewarded interstitial ad clicked
On Rewarded interstitial dismissed
On Rewarded interstitial ad dismissed
On Rewarded interstitial failed show
On Rewarded interstitial ad failed to show
On Rewarded interstitial impression
On Rewarded interstitial ad impression
On Rewarded interstitial showed
On Rewarded interstitial ad showed
On Rewarded interstitial Completed
The user earned the reward
On Rewarded interstitial Revenue
On Rewarded interstitial Revenue
On Rewarded interstitial Ad Skip
On Rewarded interstitial Ad Skip
.consent SDK (UMP) (Android | IOS)
-
Actions
Get Consent Status
(Platform ANDROID and IOS), Set tag for under age of consent. false means users are not under
Consent Reset
(Platform ANDROID and IOS), You should also call reset() if you decide to remove the UMP SDK completely from your project.
Show Privacy Options Form
(Platform ANDROID and IOS), Some consent forms require the user to modify their consent at any time. Adhere to the following steps to implement a privacy options button if required.
-
Conditions
On Get Consent Status
On Get Consent Status success
On consent status obtained
User consent obtained. Personalized vs non-personalized undefined, Constant Value: 3
-
Expressions
ConsentStatus
NOT_REQUIRED = 1, OBTAINED =3, REQUIRED = 2, UNKNOWN = 0
app open ad (Android | IOS)
-
Actions
Load App Open Ad (adUnitId {0}, Auto show {1}).
Load App Open Ad, (Platform ANDROID and IOS)
Show App Open Ad
Show App Open Ad, (Platform ANDROID and IOS)
-
Conditions
On App Open Ad Loaded
On App Open Ad Loaded
On App Open Ad Failed Loaded
On App Open Ad Failed Loaded
On App Open Ad Dismissed
On App Open Ad Dismissed
On App Open Ad Failed Show
On App Open Ad Failed Show
On App Open Ad Show
On App Open Ad Show
On App Open Ad Revenue
On App Open Ad Revenue
advanced topics (Android | IOS)
-
Actions
Global Settings, {0}, {1}, {2}, {3}, {4}, {5}, {6}
Global Settings, (Platform ANDROID and IOS)
Targeting, {0}, {1}, {2}
(Platform ANDROID and IOS), This guide explains how to provide targeting information to an ad request.
.iab tcf SDK (CMP) (Android | IOS)
-
Actions
Get IAB TFC
How to read consent choices, (Platform ANDROID and IOS)
-
Conditions
On Get IAB TFC
On Get IAB TFC Success
On Get IAB TFC Error
On Get IAB TFC Error
On TCString Expired
This plugin automatically deletes TCString after 360 days
-
Expressions
GdprApplies
An integer (0 or 1) indicating whether the user is in the EEA
PurposeConsents
A string of 0's and 1's up to 10 entries long indicating whether the user provided consent for the 10 different purposes
TcString
Full encoded TC string
.gdpr idfa (IOS only)
-
Actions
Request IDFA ATT
(Platform IOS), This guide outlines the steps required to support the IDFA message as part of the UMP SDK.
-
Conditions
On Get Idfa Status
On Get GDPR Idfa Status success
-
Expressions
IdfaStatus
NotDetermined = 0, Restricted = 1, Authorized = 3, Denied = 2
.admob sdk initialization
-
Actions
Sdk Initialization (SdkType {0})
recommendation: AdMob ump att
-
Conditions
On Sdk Initialization
On Sdk Initialization
.consent Optional
-
Conditions
On consent info update success
On consent info update success
On consent info update failure
On consent info update failure
On consent status not required
User consent not required, Constant Value: 1
On consent status required
User consent required but not yet obtained, is Consent Form Available = the code auto, load Consent Form and consent Form show, Constant Value: 2
On consent status unknown
Consent status is unknown, Constant Value: 0
On consent form not available
on Consent Form Not Available
On Show Privacy Options Form
On Show Privacy Options Form success
On Show Privacy Options Form Error
On Show Privacy Options Form Error
debug
-
Expressions
EventResponse
DEBUG Event Response
ResponseInfo
Retrieve information about the ad response
error
impression level ad revenue (Android)
-
Expressions
AdInfoMicros
The ad's value in micro-units, where 1,000,000 micro-units equal one unit of the currency.
AdInfoCurrency
The value's ISO 4217 currency code.
AdInfoPrecision
The precision type of the reported ad value.
AdInfoAdUnitId
Admob Ad adUnitId
for debugging
-
Expressions
GetResponseid
The response identifier is a unique identifier for the ad response. This identifier can be used to identify and block the ad in the Ads Review Center (ARC).
GetAdapterResponses
Returns the list of AdapterResponseInfo containing metadata for each adapter included in the ad response. Can be used to debug the waterfall mediation and bidding execution. The order of the list matches the order of the mediation waterfall for this ad request.
GetLoadedAdapter
Returns the AdapterResponseInfo corresponding to the adapter that loaded the ad.
GetResponseExtras
Returns extra information about the ad response. Extras may returns the following keys
BundleExtra
Bundle Extra