AdMob App Open¶
Non-Visible componentCategory | Requires | Version |
---|---|---|
Monetization > Advertising | API 21, Android 5.0 Lollipop | 1 |
Overview¶
A component for displaying app open advertisements from Google AdMob. App Open ads are full-screen ads that display when users bring an app to the foreground. They are typically used to display ads when a user returns to your app after leaving it, such as returning from the home screen or another app. To use this component, you must provide a valid Ads App ID (inside Project settings > Monetization > Google Ads App ID) and Ad Unit ID from your AdMob account. It is recommended to use Test Mode during development to avoid generating invalid ad traffic.
Permissions
Events¶
Ad Clicked¶
Called when the user clicks on the ad.
Ad Dismissed Full Screen Content¶
Called when the ad is closed, and the user is returned to the app.
Ad Failed To Load¶
Called when an ad request fails to load. The error code and message provide more details on the failure.
Params | |
---|---|
error Code | Number |
error Message | Text |
Ad Failed To Show Full Screen Content¶
Called when the ad fails to show in full screen. The error code and message provide more details on the failure.
Params | |
---|---|
error Code | Number |
error Message | Text |
Ad Impression¶
Called when an ad impression has been recorded.
Ad Loaded¶
Called when an ad has been successfully loaded and is ready to be shown.
Ad Showed Full Screen Content¶
Called when the ad is displayed on the screen, covering the app's content.
Methods¶
Load Ad¶
Initiates a request to load a new app open ad. This will not do anything if an ad is already loading or if ads are disabled.
Show App Open Ad¶
Shows the loaded app open ad. This will do nothing if the ad has not been loaded yet.
Properties¶
Ad Enabled¶
Boolean Default: True Read Write - Designer Blocks
Specifies whether ads should be enabled. If set to false, no ads will be loaded or shown.
Ad Unit ID¶
Text Default: ca-app-pub-3940256099942544/9257395921 Write - Designer
Property for AdUnitID
Auto Load On Initialize¶
Boolean Default: True Read Write - Designer Blocks
If enabled, the component will automatically load an ad when the app starts.
Is Ad Available¶
Boolean Read - Blocks
Returns true if an ad is loaded and available to be shown.
Test Mode¶
Boolean Default: False Write - Designer
If enabled, test ads will be shown. This should be used during development to avoid generating false impressions. Always enabled when in companion.