|
| 1 | +# AdMob App Open |
| 2 | + |
| 3 | +{>> Non-Visible component<<} |
| 4 | + |
| 5 | +| Category | Requires | Version | |
| 6 | +|:--------:|:-------:|:--------:| |
| 7 | +|**Monetization > Advertising**|<span class="chip chip-any">API 21, Android 5.0 Lollipop</span>|<span class="chip chip-number">1</span>| |
| 8 | + |
| 9 | +## Overview |
| 10 | + |
| 11 | +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. |
| 12 | + |
| 13 | +??? example "Permissions" |
| 14 | + * [com.google.android.gms.permission.AD_ID](https://developer.android.com/reference/android/Manifest.permission.html#com.google.android.gms.permission.AD_ID) |
| 15 | + * [android.permission.INTERNET](https://developer.android.com/reference/android/Manifest.permission.html#INTERNET) |
| 16 | + * [android.permission.ACCESS_NETWORK_STATE](https://developer.android.com/reference/android/Manifest.permission.html#ACCESS_NETWORK_STATE) |
| 17 | + * [android.permission.ACCESS_ADSERVICES_AD_ID](https://developer.android.com/reference/android/Manifest.permission.html#ACCESS_ADSERVICES_AD_ID) |
| 18 | + * [android.permission.ACCESS_ADSERVICES_ATTRIBUTION](https://developer.android.com/reference/android/Manifest.permission.html#ACCESS_ADSERVICES_ATTRIBUTION) |
| 19 | + * [android.permission.ACCESS_ADSERVICES_TOPICS](https://developer.android.com/reference/android/Manifest.permission.html#ACCESS_ADSERVICES_TOPICS) |
| 20 | + |
| 21 | +## Events |
| 22 | + |
| 23 | +### Ad Clicked |
| 24 | + |
| 25 | +Called when the user clicks on the ad. |
| 26 | + |
| 27 | +<div class="block" ai2-block="event" not-rendered="true" value="%7B%22componentName%22:%20%22AdMob%20App%20Open%22,%20%22name%22:%20%22Ad%20Clicked%22,%20%22param%22:%20%5B%5D%7D"></div> |
| 28 | + |
| 29 | +### Ad Dismissed Full Screen Content |
| 30 | + |
| 31 | +Called when the ad is closed, and the user is returned to the app. |
| 32 | + |
| 33 | +<div class="block" ai2-block="event" not-rendered="true" value="%7B%22componentName%22:%20%22AdMob%20App%20Open%22,%20%22name%22:%20%22Ad%20Dismissed%20Full%20Screen%20Content%22,%20%22param%22:%20%5B%5D%7D"></div> |
| 34 | + |
| 35 | +### Ad Failed To Load |
| 36 | + |
| 37 | +Called when an ad request fails to load. The error code and message provide more details on the failure. |
| 38 | + |
| 39 | +<div class="block" ai2-block="event" not-rendered="true" value="%7B%22componentName%22:%20%22AdMob%20App%20Open%22,%20%22name%22:%20%22Ad%20Failed%20To%20Load%22,%20%22param%22:%20%5B%22error%20Code%22,%20%22error%20Message%22%5D%7D"></div> |
| 40 | + |
| 41 | +| Params | []() | |
| 42 | +|--------|------| |
| 43 | +|error Code|<span class="chip chip-number">Number</span>| |
| 44 | +|error Message|<span class="chip chip-text">Text</span>| |
| 45 | + |
| 46 | +### Ad Failed To Show Full Screen Content |
| 47 | + |
| 48 | +Called when the ad fails to show in full screen. The error code and message provide more details on the failure. |
| 49 | + |
| 50 | +<div class="block" ai2-block="event" not-rendered="true" value="%7B%22componentName%22:%20%22AdMob%20App%20Open%22,%20%22name%22:%20%22Ad%20Failed%20To%20Show%20Full%20Screen%20Content%22,%20%22param%22:%20%5B%22error%20Code%22,%20%22error%20Message%22%5D%7D"></div> |
| 51 | + |
| 52 | +| Params | []() | |
| 53 | +|--------|------| |
| 54 | +|error Code|<span class="chip chip-number">Number</span>| |
| 55 | +|error Message|<span class="chip chip-text">Text</span>| |
| 56 | + |
| 57 | +### Ad Impression |
| 58 | + |
| 59 | +Called when an ad impression has been recorded. |
| 60 | + |
| 61 | +<div class="block" ai2-block="event" not-rendered="true" value="%7B%22componentName%22:%20%22AdMob%20App%20Open%22,%20%22name%22:%20%22Ad%20Impression%22,%20%22param%22:%20%5B%5D%7D"></div> |
| 62 | + |
| 63 | +### Ad Loaded |
| 64 | + |
| 65 | +Called when an ad has been successfully loaded and is ready to be shown. |
| 66 | + |
| 67 | +<div class="block" ai2-block="event" not-rendered="true" value="%7B%22componentName%22:%20%22AdMob%20App%20Open%22,%20%22name%22:%20%22Ad%20Loaded%22,%20%22param%22:%20%5B%5D%7D"></div> |
| 68 | + |
| 69 | +### Ad Showed Full Screen Content |
| 70 | + |
| 71 | +Called when the ad is displayed on the screen, covering the app's content. |
| 72 | + |
| 73 | +<div class="block" ai2-block="event" not-rendered="true" value="%7B%22componentName%22:%20%22AdMob%20App%20Open%22,%20%22name%22:%20%22Ad%20Showed%20Full%20Screen%20Content%22,%20%22param%22:%20%5B%5D%7D"></div> |
| 74 | + |
| 75 | +## Methods |
| 76 | + |
| 77 | +### Load Ad |
| 78 | + |
| 79 | +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. |
| 80 | + |
| 81 | +<div class="block" ai2-block="method" not-rendered="true" value="%7B%22componentName%22:%20%22AdMob%20App%20Open%22,%20%22name%22:%20%22Load%20Ad%22,%20%22output%22:%20false,%20%22param%22:%20%5B%5D%7D"></div> |
| 82 | + |
| 83 | +### Show App Open Ad |
| 84 | + |
| 85 | +Shows the loaded app open ad. This will do nothing if the ad has not been loaded yet. |
| 86 | + |
| 87 | +<div class="block" ai2-block="method" not-rendered="true" value="%7B%22componentName%22:%20%22AdMob%20App%20Open%22,%20%22name%22:%20%22Show%20App%20Open%20Ad%22,%20%22output%22:%20false,%20%22param%22:%20%5B%5D%7D"></div> |
| 88 | + |
| 89 | +## Properties |
| 90 | + |
| 91 | +### Ad Enabled |
| 92 | + |
| 93 | +<span style="user-select: none; white-space:pre-wrap;"><span class="chip chip-boolean">Boolean</span> <span class="chip chip-boolean">Default: <i>True</i></span> :heavy_minus_sign: <span class="chip chip-rw">Read</span> <span class="chip chip-rw">Write</span> - <span class="chip chip-bd">Designer</span> <span class="chip chip-bd">Blocks</span></span> |
| 94 | + |
| 95 | +Specifies whether ads should be enabled. If set to false, no ads will be loaded or shown. |
| 96 | + |
| 97 | +<div class="block" ai2-block="property" not-rendered="true" value="%7B%22componentName%22:%20%22AdMob%20App%20Open%22,%20%22name%22:%20%22Ad%20Enabled%22,%20%22getter%22:%20true%7D"></div> |
| 98 | +<div class="block" ai2-block="property" not-rendered="true" value="%7B%22componentName%22:%20%22AdMob%20App%20Open%22,%20%22name%22:%20%22Ad%20Enabled%22,%20%22getter%22:%20false%7D"></div> |
| 99 | + |
| 100 | +### Ad Unit ID |
| 101 | + |
| 102 | +<span style="user-select: none; white-space:pre-wrap;"><span class="chip chip-text">Text</span> <span class="chip chip-text">Default: <i>ca-app-pub-3940256099942544/9257395921</i></span> :heavy_minus_sign: <span class="chip chip-rw">Write</span> - <span class="chip chip-bd">Designer</span></span> |
| 103 | + |
| 104 | +Property for AdUnitID |
| 105 | + |
| 106 | +### Auto Load On Initialize |
| 107 | + |
| 108 | +<span style="user-select: none; white-space:pre-wrap;"><span class="chip chip-boolean">Boolean</span> <span class="chip chip-boolean">Default: <i>True</i></span> :heavy_minus_sign: <span class="chip chip-rw">Read</span> <span class="chip chip-rw">Write</span> - <span class="chip chip-bd">Designer</span> <span class="chip chip-bd">Blocks</span></span> |
| 109 | + |
| 110 | +If enabled, the component will automatically load an ad when the app starts. |
| 111 | + |
| 112 | +<div class="block" ai2-block="property" not-rendered="true" value="%7B%22componentName%22:%20%22AdMob%20App%20Open%22,%20%22name%22:%20%22Auto%20Load%20On%20Initialize%22,%20%22getter%22:%20true%7D"></div> |
| 113 | +<div class="block" ai2-block="property" not-rendered="true" value="%7B%22componentName%22:%20%22AdMob%20App%20Open%22,%20%22name%22:%20%22Auto%20Load%20On%20Initialize%22,%20%22getter%22:%20false%7D"></div> |
| 114 | + |
| 115 | +### Is Ad Available |
| 116 | + |
| 117 | +<span style="user-select: none; white-space:pre-wrap;"><span class="chip chip-boolean">Boolean</span> :heavy_minus_sign: <span class="chip chip-rw">Read</span> - <span class="chip chip-bd">Blocks</span></span> |
| 118 | + |
| 119 | +Returns true if an ad is loaded and available to be shown. |
| 120 | + |
| 121 | +<div class="block" ai2-block="property" not-rendered="true" value="%7B%22componentName%22:%20%22AdMob%20App%20Open%22,%20%22name%22:%20%22Is%20Ad%20Available%22,%20%22getter%22:%20true%7D"></div> |
| 122 | + |
| 123 | +### Test Mode |
| 124 | + |
| 125 | +<span style="user-select: none; white-space:pre-wrap;"><span class="chip chip-boolean">Boolean</span> <span class="chip chip-boolean">Default: <i>False</i></span> :heavy_minus_sign: <span class="chip chip-rw">Write</span> - <span class="chip chip-bd">Designer</span></span> |
| 126 | + |
| 127 | +If enabled, test ads will be shown. This should be used during development to avoid generating false impressions. Always enabled when in companion. |
0 commit comments