@capacitor-community/admob 8.0.0 → 8.1.0-beta.pr452.sha1e2825933522

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (109) hide show
  1. package/CapacitorCommunityAdmob.podspec +1 -1
  2. package/Package.swift +1 -1
  3. package/README.md +649 -407
  4. package/android/build.gradle +1 -1
  5. package/android/src/main/java/com/getcapacitor/community/admob/AdMob.java +80 -23
  6. package/android/src/main/java/com/getcapacitor/community/admob/appopen/AppOpenAdManager.kt +92 -0
  7. package/android/src/main/java/com/getcapacitor/community/admob/appopen/AppOpenAdPlugin.kt +122 -0
  8. package/android/src/main/java/com/getcapacitor/community/admob/appopen/AppOpenAdPluginEvents.kt +10 -0
  9. package/android/src/main/java/com/getcapacitor/community/admob/banner/BannerAdPluginEvents.kt +2 -1
  10. package/android/src/main/java/com/getcapacitor/community/admob/banner/BannerExecutor.java +207 -33
  11. package/android/src/main/java/com/getcapacitor/community/admob/helpers/FullscreenPluginCallback.kt +7 -2
  12. package/android/src/main/java/com/getcapacitor/community/admob/interstitial/AdInterstitialExecutor.java +21 -3
  13. package/android/src/main/java/com/getcapacitor/community/admob/interstitial/InterstitialAdCallbackAndListeners.kt +12 -2
  14. package/android/src/main/java/com/getcapacitor/community/admob/interstitial/InterstitialAdPluginPluginEvent.kt +1 -0
  15. package/android/src/main/java/com/getcapacitor/community/admob/models/AdMobRevenueData.kt +15 -0
  16. package/android/src/main/java/com/getcapacitor/community/admob/models/AdOptions.java +10 -0
  17. package/android/src/main/java/com/getcapacitor/community/admob/rewarded/AdRewardExecutor.java +20 -3
  18. package/android/src/main/java/com/getcapacitor/community/admob/rewarded/RewardAdPluginEvents.kt +1 -0
  19. package/android/src/main/java/com/getcapacitor/community/admob/rewarded/RewardedAdCallbackAndListeners.kt +14 -4
  20. package/android/src/main/java/com/getcapacitor/community/admob/rewardedinterstitial/AdRewardInterstitialExecutor.java +20 -3
  21. package/android/src/main/java/com/getcapacitor/community/admob/rewardedinterstitial/RewardInterstitialAdPluginEvents.kt +1 -0
  22. package/android/src/main/java/com/getcapacitor/community/admob/rewardedinterstitial/RewardedInterstitialAdCallbackAndListeners.kt +14 -3
  23. package/dist/docs.json +740 -193
  24. package/dist/esm/app-open/app-open-ad-options.interface.d.ts +9 -0
  25. package/dist/esm/app-open/app-open-ad-options.interface.js +2 -0
  26. package/dist/esm/app-open/app-open-ad-options.interface.js.map +1 -0
  27. package/dist/esm/app-open/app-open-ad-plugin-events.enum.d.ts +26 -0
  28. package/dist/esm/app-open/app-open-ad-plugin-events.enum.js +28 -0
  29. package/dist/esm/app-open/app-open-ad-plugin-events.enum.js.map +1 -0
  30. package/dist/esm/app-open/app-open-definitions.interface.d.ts +50 -0
  31. package/dist/esm/app-open/app-open-definitions.interface.js +2 -0
  32. package/dist/esm/app-open/app-open-definitions.interface.js.map +1 -0
  33. package/dist/esm/app-open/index.d.ts +3 -0
  34. package/dist/esm/app-open/index.js +4 -0
  35. package/dist/esm/app-open/index.js.map +1 -0
  36. package/dist/esm/banner/banner-ad-options.interface.d.ts +5 -6
  37. package/dist/esm/banner/banner-ad-plugin-events.enum.d.ts +17 -4
  38. package/dist/esm/banner/banner-ad-plugin-events.enum.js +16 -3
  39. package/dist/esm/banner/banner-ad-plugin-events.enum.js.map +1 -1
  40. package/dist/esm/banner/banner-ad-position.enum.d.ts +3 -3
  41. package/dist/esm/banner/banner-ad-position.enum.js +3 -3
  42. package/dist/esm/banner/banner-ad-size.enum.d.ts +4 -3
  43. package/dist/esm/banner/banner-ad-size.enum.js +4 -3
  44. package/dist/esm/banner/banner-ad-size.enum.js.map +1 -1
  45. package/dist/esm/banner/banner-definitions.interface.d.ts +17 -10
  46. package/dist/esm/banner/banner-size.interface.d.ts +8 -1
  47. package/dist/esm/definitions.d.ts +19 -17
  48. package/dist/esm/definitions.js.map +1 -1
  49. package/dist/esm/index.d.ts +1 -0
  50. package/dist/esm/index.js +1 -0
  51. package/dist/esm/index.js.map +1 -1
  52. package/dist/esm/interstitial/interstitial-ad-plugin-events.enum.d.ts +10 -6
  53. package/dist/esm/interstitial/interstitial-ad-plugin-events.enum.js +9 -5
  54. package/dist/esm/interstitial/interstitial-ad-plugin-events.enum.js.map +1 -1
  55. package/dist/esm/interstitial/interstitial-definitions.interface.d.ts +24 -4
  56. package/dist/esm/reward/reward-ad-options.interface.d.ts +7 -6
  57. package/dist/esm/reward/reward-ad-plugin-events.enum.d.ts +13 -12
  58. package/dist/esm/reward/reward-ad-plugin-events.enum.js +12 -11
  59. package/dist/esm/reward/reward-ad-plugin-events.enum.js.map +1 -1
  60. package/dist/esm/reward/reward-definitions.interface.d.ts +27 -4
  61. package/dist/esm/reward/reward-item.interface.d.ts +3 -4
  62. package/dist/esm/reward-interstitial/reward-interstitial-ad-options.interface.d.ts +7 -6
  63. package/dist/esm/reward-interstitial/reward-interstitial-ad-plugin-events.enum.d.ts +13 -12
  64. package/dist/esm/reward-interstitial/reward-interstitial-ad-plugin-events.enum.js +12 -11
  65. package/dist/esm/reward-interstitial/reward-interstitial-ad-plugin-events.enum.js.map +1 -1
  66. package/dist/esm/reward-interstitial/reward-interstitial-definitions.interface.d.ts +30 -7
  67. package/dist/esm/reward-interstitial/reward-interstitial-item.interface.d.ts +3 -4
  68. package/dist/esm/shared/ad-load-info.interface.d.ts +6 -0
  69. package/dist/esm/shared/ad-mob-revenue-data.interface.d.ts +50 -0
  70. package/dist/esm/shared/ad-mob-revenue-data.interface.js +23 -0
  71. package/dist/esm/shared/ad-mob-revenue-data.interface.js.map +1 -0
  72. package/dist/esm/shared/ad-options.interface.d.ts +9 -11
  73. package/dist/esm/shared/ad-show-options.interface.d.ts +12 -0
  74. package/dist/esm/shared/ad-show-options.interface.js +2 -0
  75. package/dist/esm/shared/ad-show-options.interface.js.map +1 -0
  76. package/dist/esm/shared/admob-error.interface.d.ts +3 -2
  77. package/dist/esm/shared/index.d.ts +2 -0
  78. package/dist/esm/shared/index.js +2 -0
  79. package/dist/esm/shared/index.js.map +1 -1
  80. package/dist/esm/shared/tracking-authorization-status.interface.d.ts +6 -1
  81. package/dist/esm/web.d.ts +13 -4
  82. package/dist/esm/web.js +25 -9
  83. package/dist/esm/web.js.map +1 -1
  84. package/dist/plugin.cjs.js +131 -45
  85. package/dist/plugin.cjs.js.map +1 -1
  86. package/dist/plugin.js +131 -45
  87. package/dist/plugin.js.map +1 -1
  88. package/docs/app-open.md +53 -0
  89. package/docs/banner.md +100 -0
  90. package/docs/configuration.md +21 -0
  91. package/docs/consent.md +80 -0
  92. package/docs/events.md +73 -0
  93. package/docs/interstitial.md +47 -0
  94. package/docs/migration.md +106 -0
  95. package/docs/rewarded.md +135 -0
  96. package/docs/testing.md +60 -0
  97. package/ios/Sources/AdMobPlugin/AdMobPlugin.swift +30 -4
  98. package/ios/Sources/AdMobPlugin/AppOpen/AppOpenAdManager.swift +112 -0
  99. package/ios/Sources/AdMobPlugin/AppOpen/AppOpenAdPlugin.swift +101 -0
  100. package/ios/Sources/AdMobPlugin/AppOpen/AppOpenAdPluginEvents.swift +8 -0
  101. package/ios/Sources/AdMobPlugin/Banner/BannerAdPluginEvents.swift +1 -0
  102. package/ios/Sources/AdMobPlugin/Banner/BannerExecutor.swift +20 -6
  103. package/ios/Sources/AdMobPlugin/Interstitial/AdInterstitialExecutor.swift +41 -5
  104. package/ios/Sources/AdMobPlugin/Interstitial/InterstitialAdPluginEvents.swift +1 -0
  105. package/ios/Sources/AdMobPlugin/Rewarded/AdRewardExecutor.swift +44 -5
  106. package/ios/Sources/AdMobPlugin/Rewarded/RewardAdPluginEvents.swift +1 -0
  107. package/ios/Sources/AdMobPlugin/RewardedInterstitial/AdRewardInterstitialExecutor.swift +45 -6
  108. package/ios/Sources/AdMobPlugin/RewardedInterstitial/RewardInterstitialAdPluginEvents.swift +1 -0
  109. package/package.json +4 -1
package/README.md CHANGED
@@ -1,3 +1,4 @@
1
+ <!-- rdlabo-docs-omit -->
1
2
  <p align="center"><br><img src="https://user-images.githubusercontent.com/236501/85893648-1c92e880-b7a8-11ea-926d-95355b8175c7.png" width="128" height="128" /></p>
2
3
  <h3 align="center">AdMob</h3>
3
4
  <p align="center"><strong><code>@capacitor-community/admob</code></strong></p>
@@ -6,7 +7,11 @@
6
7
  </p>
7
8
 
8
9
  <p align="center">
9
- <img src="https://img.shields.io/maintenance/yes/2025?style=flat-square" />
10
+ <strong><a href="https://docs.rdlabo.dev/projects/capacitor-admob">Read the full documentation</a></strong>
11
+ </p>
12
+
13
+ <p align="center">
14
+ <img src="https://img.shields.io/maintenance/yes/2026?style=flat-square" />
10
15
  <a href="https://www.npmjs.com/package/@capacitor-community/admob"><img src="https://img.shields.io/npm/l/@capacitor-community/admob?style=flat-square" /></a>
11
16
  <br>
12
17
  <a href="https://www.npmjs.com/package/@capacitor-community/admob"><img src="https://img.shields.io/npm/dw/@capacitor-community/admob?style=flat-square" /></a>
@@ -15,10 +20,10 @@
15
20
 
16
21
  ## Maintainers
17
22
 
18
- | Maintainer | GitHub | Social | Sponsoring Company |
19
- | ------------------- | ------------------------------------------------ | ----------------------------------------------- | ---------------------------------------------- |
20
- | Masahiko Sakakibara | [rdlabo](https://github.com/rdlabo) | [@rdlabo](https://twitter.com/rdlabo) | RELATION DESIGN LABO, GENERAL INC. ASSOCIATION |
21
- | Saninn Salas Diaz | [Saninn Salas Diaz](https://github.com/distante) | [@SaninnSalas](https://twitter.com/SaninnSalas) | |
23
+ | Maintainer | GitHub | Social | Website |
24
+ | ------------------- | ------------------------------------------------ | ----------------------------------------------- | ----------------------------------------------- |
25
+ | Masahiko Sakakibara | [rdlabo](https://github.com/rdlabo) | [@rdlabo](https://twitter.com/rdlabo) | [rdlabo.dev](https://rdlabo.dev/) |
26
+ | Saninn Salas Diaz | [Saninn Salas Diaz](https://github.com/distante) | [@SaninnSalas](https://twitter.com/SaninnSalas) | — |
22
27
 
23
28
  Maintenance Status: Actively Maintained
24
29
 
@@ -32,52 +37,120 @@ Made with [contributors-img](https://contrib.rocks).
32
37
 
33
38
  ## Demo
34
39
 
35
- [Demo code is here.](https://github.com/capacitor-community/admob/tree/master/demo)
40
+ [Demo code is here.](https://github.com/capacitor-community/admob/tree/main/demo)
36
41
 
37
42
  ### Screenshots
38
43
 
39
- | | Banner | Interstitial | Reward |
40
- | :---------- | :----------------------------------: | :----------------------------------------: | :----------------------------------: |
41
- | **iOS** | ![](demo/screenshots/ios_banner.png) | ![](demo/screenshots/ios_interstitial.png) | ![](demo/screenshots/ios_reward.png) |
42
- | **Android** | ![](demo/screenshots/md_banner.png) | ![](demo/screenshots/md_interstitial.png) | ![](demo/screenshots/md_reward.png) |
44
+ | | Banner | Interstitial | Reward | App Open |
45
+ | :---------- | :----------------------------------: | :----------------------------------------: | :----------------------------------: | :---------------------------------: |
46
+ | **iOS** | ![](demo/screenshots/ios_banner.png) | ![](demo/screenshots/ios_interstitial.png) | ![](demo/screenshots/ios_reward.png) | ![](demo/screenshots/ios_open.png) |
47
+ | **Android** | ![](demo/screenshots/md_banner.png) | ![](demo/screenshots/md_interstitial.png) | ![](demo/screenshots/md_reward.png) | ![](demo/screenshots/md_open.png) |
43
48
 
44
- ## Installation
49
+ <!-- /rdlabo-docs-omit -->
50
+
51
+ ## Overview
52
+
53
+ Capacitor community plugin for native AdMob. This plugin wraps the Google Mobile Ads SDK for iOS and Android so you can display banner, interstitial, rewarded, rewarded interstitial, and app open ads in Capacitor apps.
54
+
55
+ ## Features
56
+
57
+ - Banner ads (including adaptive banners)
58
+ - Interstitial ads
59
+ - Rewarded video ads
60
+ - Rewarded interstitial ads
61
+ - App open ads
62
+ - Google User Messaging Platform (UMP) consent support
63
+ - App Tracking Transparency (iOS tracking permission) helpers
64
+
65
+ ### Choose by advertising goal
66
+
67
+ | Goal | Ad format | Guide |
68
+ | ----------------------------------------------------------------- | ------------------------- | ------------------------------------------ |
69
+ | Keep an ad visible alongside app content | Banner | [Banner Ads](https://docs.rdlabo.dev/projects/capacitor-admob/docs/banner) |
70
+ | Show a full-screen ad at a natural break without granting a reward | Interstitial | [Interstitial Ads](https://docs.rdlabo.dev/projects/capacitor-admob/docs/interstitial) |
71
+ | Offer a dedicated rewarded experience | Rewarded | [Rewarded Ads](https://docs.rdlabo.dev/projects/capacitor-admob/docs/rewarded) |
72
+ | Offer a reward at a natural transition | Rewarded interstitial | [Rewarded Ads](https://docs.rdlabo.dev/projects/capacitor-admob/docs/rewarded) |
73
+ | Monetize an app-open experience | App Open | [App Open Ads](https://docs.rdlabo.dev/projects/capacitor-admob/docs/app-open) |
45
74
 
46
- If you use capacitor 6:
75
+ ## Quick start
47
76
 
77
+ After [Installation](#installation), initialize the SDK, request consent, and show a banner:
78
+
79
+ ```ts
80
+ import { AdMob, AdmobConsentStatus, BannerAdOptions, BannerAdSize, BannerAdPosition } from '@capacitor-community/admob';
81
+
82
+ async function startAdMob() {
83
+ await AdMob.initialize();
84
+
85
+ let consentInfo = await AdMob.requestConsentInfo();
86
+ if (consentInfo.isConsentFormAvailable && consentInfo.status === AdmobConsentStatus.REQUIRED) {
87
+ consentInfo = await AdMob.showConsentForm();
88
+ }
89
+
90
+ if (!consentInfo.canRequestAds) {
91
+ return;
92
+ }
93
+
94
+ const options: BannerAdOptions = {
95
+ adId: 'YOUR_AD_UNIT_ID',
96
+ adSize: BannerAdSize.ADAPTIVE_BANNER,
97
+ position: BannerAdPosition.BOTTOM_CENTER,
98
+ margin: 0,
99
+ };
100
+ await AdMob.showBanner(options);
101
+ }
48
102
  ```
49
- % npm install --save @capacitor-community/admob@6
50
- % npx cap update
103
+
104
+ The banner sits on the native screen above the WebView, so it can cover your HTML. See [Banner Ads](https://docs.rdlabo.dev/projects/capacitor-admob/docs/banner) to inset your layout. Details: [Configuration](https://docs.rdlabo.dev/projects/capacitor-admob/docs/configuration), [Consent](https://docs.rdlabo.dev/projects/capacitor-admob/docs/consent), and the per-format guides.
105
+
106
+ ## Installation
107
+
108
+ This plugin already ships Google Mobile Ads SDK. Install the package, then add your AdMob **application** ID in AndroidManifest / Info.plist. Google's Get started guides for [Android](https://developers.google.com/admob/android/quick-start) and [iOS](https://developers.google.com/admob/ios/quick-start) explain app IDs and SKAdNetwork identifiers (Apple's ad conversion IDs); do not add a second Mobile Ads dependency.
109
+
110
+ This plugin targets `@capacitor-community/admob` **v8** and Capacitor 8. It supports iOS 15 or later and Android API 24 or later.
111
+
112
+ ```bash
113
+ npm install @capacitor-community/admob
114
+ npx cap sync
51
115
  ```
52
116
 
117
+ If you still use Capacitor 7, install `@capacitor-community/admob@7`.
118
+
119
+ ### Google Mobile Ads SDK versions
120
+
121
+ This major version pins Google Mobile Ads SDK **25.4.x** on Android and **13.6.0** on iOS (Swift Package Manager and CocoaPods). Leave those versions unless you have a specific need. Google's [Next-Gen SDK for Android](https://developers.google.com/admob/android/next-gen) waits until the next plugin major. See [Migration](https://docs.rdlabo.dev/projects/capacitor-admob/docs/migration) for the policy behind the pins.
122
+
53
123
  ### Android configuration
54
124
 
55
- In file `android/app/src/main/AndroidManifest.xml`, add the following XML elements under `<manifest><application>` :
125
+ In `android/app/src/main/AndroidManifest.xml`, add the following under `<application>`:
56
126
 
57
127
  ```xml
58
128
  <meta-data
59
- android:name="com.google.android.gms.ads.APPLICATION_ID"
60
- android:value="@string/admob_app_id"/>
129
+ android:name="com.google.android.gms.ads.APPLICATION_ID"
130
+ android:value="@string/admob_app_id" />
61
131
  ```
62
132
 
63
- In file `android/app/src/main/res/values/strings.xml` add the following lines :
133
+ In `android/app/src/main/res/values/strings.xml`:
64
134
 
65
135
  ```xml
66
136
  <string name="admob_app_id">[APP_ID]</string>
67
137
  ```
68
138
 
69
- Don't forget to replace `[APP_ID]` by your AdMob application Id.
139
+ Replace `[APP_ID]` with your AdMob **application** ID, not an ad unit ID.
70
140
 
71
141
  #### Variables
72
142
 
73
- This plugin will use the following project variables (defined in your app's `variables.gradle` file):
143
+ You can leave these unset. Override them in your app's `variables.gradle` only when you need a specific artifact version:
74
144
 
75
- - `playServicesAdsVersion` version of `com.google.android.gms:play-services-ads` (default: `23.0.0`)
76
- - `androidxCoreKTXVersion`: version of `androidx.core:core-ktx` (default: `1.13.0`)
145
+ | Variable | Artifact | Default |
146
+ | ------------------------------ | ------------------------------------------------ | -------- |
147
+ | `playServicesAdsVersion` | `com.google.android.gms:play-services-ads` | `25.4.+` |
148
+ | `userMessagingPlatformVersion` | `com.google.android.ump:user-messaging-platform` | `4.0.0` |
149
+ | `androidxCoreKTXVersion` | `androidx.core:core-ktx` | `1.15.0` |
77
150
 
78
151
  ### iOS configuration
79
152
 
80
- Add the following in the `ios/App/App/info.plist` file inside of the outermost `<dict>`:
153
+ Add the following inside the outermost `<dict>` in `ios/App/App/Info.plist`:
81
154
 
82
155
  ```xml
83
156
  <key>GADIsAdManagerApp</key>
@@ -92,239 +165,40 @@ Add the following in the `ios/App/App/info.plist` file inside of the outermost `
92
165
  </dict>
93
166
  </array>
94
167
  <key>NSUserTrackingUsageDescription</key>
95
- <string>[Why you use NSUserTracking. ex: This identifier will be used to deliver personalized ads to you.]</string>
96
- ```
97
-
98
- Don't forget to replace `[APP_ID]` by your AdMob application Id.
99
-
100
- ## Example
101
-
102
- ### Initialize AdMob
103
-
104
- ```ts
105
- import { AdMob } from '@capacitor-community/admob';
106
-
107
- export async function initialize(): Promise<void> {
108
- await AdMob.initialize();
109
-
110
- const [trackingInfo, consentInfo] = await Promise.all([
111
- AdMob.trackingAuthorizationStatus(),
112
- AdMob.requestConsentInfo(),
113
- ]);
114
-
115
- if (trackingInfo.status === 'notDetermined') {
116
- /**
117
- * If you want to explain TrackingAuthorization before showing the iOS dialog,
118
- * you can show the modal here.
119
- * ex)
120
- * const modal = await this.modalCtrl.create({
121
- * component: RequestTrackingPage,
122
- * });
123
- * await modal.present();
124
- * await modal.onDidDismiss(); // Wait for close modal
125
- **/
126
-
127
- await AdMob.requestTrackingAuthorization();
128
- }
129
-
130
- const authorizationStatus = await AdMob.trackingAuthorizationStatus();
131
- if (
132
- authorizationStatus.status === 'authorized' &&
133
- consentInfo.isConsentFormAvailable &&
134
- consentInfo.status === AdmobConsentStatus.REQUIRED
135
- ) {
136
- await AdMob.showConsentForm();
137
- }
138
- }
168
+ <string>This identifier will be used to deliver personalized ads to you.</string>
139
169
  ```
140
170
 
141
- Send an array of device Ids in `testingDevices` to use production like ads on your specified devices -> https://developers.google.com/admob/android/test-ads#enable_test_devices
142
-
143
- ### User Message Platform (UMP)
144
-
145
- To use UMP, you must [create your GDPR messages](https://support.google.com/admob/answer/10113207?hl=en&ref_topic=10105230&sjid=6731900490614517032-AP).
146
-
147
- You may need to [setup IDFA messages](https://support.google.com/admob/answer/10115027?hl=en), it will work along with GDPR messages and will show when users are not in EEA and UK.
148
-
149
- Example of how to use UMP.
150
-
151
- ```ts
152
- import { AdMob } from '@capacitor-community/admob';
153
-
154
- private canShowAds: boolean | null = null;
155
-
156
- async showConsent() {
157
- let consentInfo = await AdMob.requestConsentInfo();
158
- if (!consentInfo.canRequestAds) {
159
- consentInfo = await AdMob.showConsentForm();
160
- this.canShowAds = consentInfo.canRequestAds;
161
- }
162
- }
163
- ```
164
-
165
- To let users manage their privacy options at any time, show the privacy options form.
166
- ```ts
167
- import { AdMob } from '@capacitor-community/admob';
168
-
169
- showPrivacyOptionsForm() {
170
- AdMob.showPrivacyOptionsForm();
171
- }
172
- ```
173
-
174
- If you testing on real device, you have to set `debugGeography` and add your device ID to `testDeviceIdentifiers`. You can find your device ID with logcat (Android) or XCode (iOS).
175
-
176
- ```ts
177
- const consentInfo = await AdMob.requestConsentInfo({
178
- debugGeography: AdmobConsentDebugGeography.EEA,
179
- testDeviceIdentifiers: ['YOUR_DEVICE_ID'],
180
- });
181
- ```
182
-
183
- **Note**: When testing, if you choose not consent (Manage -> Confirm Choices). The ads may not load/show. Even on testing enviroment. This is normal. It will work on Production so don't worry.
184
-
185
- **Note**: The order in which they are combined with other methods is as follows.
186
-
187
- 1. AdMob.initialize
188
- 2. AdMob.requestConsentInfo
189
- 3. AdMob.showConsentForm (If consent form required )
190
- 3/ AdMob.showBanner
191
-
192
- ### Show Banner
193
-
194
- ```ts
195
- import {
196
- AdMob,
197
- BannerAdOptions,
198
- BannerAdSize,
199
- BannerAdPosition,
200
- BannerAdPluginEvents,
201
- AdMobBannerSize,
202
- } from '@capacitor-community/admob';
203
-
204
- export async function banner(): Promise<void> {
205
- AdMob.addListener(BannerAdPluginEvents.Loaded, () => {
206
- // Subscribe Banner Event Listener
207
- });
208
-
209
- AdMob.addListener(
210
- BannerAdPluginEvents.SizeChanged,
211
- (size: AdMobBannerSize) => {
212
- // Subscribe Change Banner Size
213
- },
214
- );
215
-
216
- const options: BannerAdOptions = {
217
- adId: 'YOUR ADID',
218
- adSize: BannerAdSize.BANNER,
219
- position: BannerAdPosition.BOTTOM_CENTER,
220
- margin: 0,
221
- // isTesting: true
222
- // npa: true
223
- };
224
- AdMob.showBanner(options);
225
- }
226
- ```
171
+ Replace `[APP_ID]` with your AdMob application ID, and describe your actual tracking use in `NSUserTrackingUsageDescription`.
227
172
 
228
- ### Show Interstitial
173
+ The `SKAdNetworkItems` snippet includes Google's own identifier. Add the other IDs from Google's [iOS setup guide](https://developers.google.com/admob/ios/quick-start#update_your_infoplist).
229
174
 
230
- ```ts
231
- import {
232
- AdMob,
233
- AdOptions,
234
- AdLoadInfo,
235
- InterstitialAdPluginEvents,
236
- } from '@capacitor-community/admob';
237
-
238
- export async function interstitial(): Promise<void> {
239
- AdMob.addListener(InterstitialAdPluginEvents.Loaded, (info: AdLoadInfo) => {
240
- // Subscribe prepared interstitial
241
- });
242
-
243
- const options: AdOptions = {
244
- adId: 'YOUR ADID',
245
- // isTesting: true
246
- // npa: true
247
- // immersiveMode: true
248
- };
249
- await AdMob.prepareInterstitial(options);
250
- await AdMob.showInterstitial();
251
- }
252
- ```
175
+ ### Troubleshooting
253
176
 
254
- ### Show RewardVideo
177
+ If CocoaPods cannot resolve `Google-Mobile-Ads-SDK`:
255
178
 
256
- ```ts
257
- import {
258
- AdMob,
259
- RewardAdOptions,
260
- AdLoadInfo,
261
- RewardAdPluginEvents,
262
- AdMobRewardItem,
263
- } from '@capacitor-community/admob';
264
-
265
- export async function rewardVideo(): Promise<void> {
266
- AdMob.addListener(RewardAdPluginEvents.Loaded, (info: AdLoadInfo) => {
267
- // Subscribe prepared rewardVideo
268
- });
269
-
270
- AdMob.addListener(
271
- RewardAdPluginEvents.Rewarded,
272
- (rewardItem: AdMobRewardItem) => {
273
- // Subscribe user rewarded
274
- console.log(rewardItem);
275
- },
276
- );
277
-
278
- const options: RewardAdOptions = {
279
- adId: 'YOUR ADID',
280
- // isTesting: true
281
- // npa: true
282
- // immersiveMode: true
283
- // ssv: {
284
- // userId: "A user ID to send to your SSV"
285
- // customData: JSON.stringify({ ...MyCustomData })
286
- //}
287
- };
288
- await AdMob.prepareRewardVideoAd(options);
289
- const rewardItem = await AdMob.showRewardVideoAd();
290
- }
179
+ ```text
180
+ [error] Error running update: Analyzing dependencies
181
+ [!] CocoaPods could not find compatible versions for pod "Google-Mobile-Ads-SDK":
291
182
  ```
292
183
 
293
- ## Server-side Verification Notice
184
+ Run `pod repo update` in `ios/`, then `npx cap sync ios` again.
294
185
 
295
- SSV callbacks are only fired on Production Adverts, therefore test Ads will not fire off your SSV callback.
186
+ ## Documentation
296
187
 
297
- For E2E tests or just for validating the data in your `RewardAdOptions` work as expected, you can add a custom GET
298
- request to your mock endpoint after the `RewardAdPluginEvents.Rewarded` similar to this:
188
+ Start with [Installation](#installation) above, then [Configuration](https://docs.rdlabo.dev/projects/capacitor-admob/docs/configuration) and [Consent](https://docs.rdlabo.dev/projects/capacitor-admob/docs/consent) before loading ads. Pick an ad format from the table above. The same guides are also on the [documentation site](https://docs.rdlabo.dev/projects/capacitor-admob) (English and Japanese). If you opened this README on npm, use that site for the guides — the `docs/` files live in the GitHub repository. Method signatures are in the API section below.
299
189
 
300
- ```ts
301
- AdMob.addListener(RewardAdPluginEvents.Rewarded, async () => {
302
- // ...
303
- if (ENVIRONMENT_IS_DEVELOPMENT) {
304
- try {
305
- const url =
306
- `https://your-staging-ssv-endpoint` +
307
- new URLSearchParams({
308
- ad_network: 'TEST',
309
- ad_unit: 'TEST',
310
- custom_data: customData, // <-- passed CustomData
311
- reward_amount: 'TEST',
312
- reward_item: 'TEST',
313
- timestamp: 'TEST',
314
- transaction_id: 'TEST',
315
- user_id: userId, // <-- Passed UserID
316
- signature: 'TEST',
317
- key_id: 'TEST',
318
- });
319
- await fetch(url);
320
- } catch (err) {
321
- console.error(err);
322
- }
323
- }
324
- // ...
325
- });
326
- ```
190
+ - [Configuration](https://docs.rdlabo.dev/projects/capacitor-admob/docs/configuration) — `AdMob.initialize` and SDK options.
191
+ - [Consent](https://docs.rdlabo.dev/projects/capacitor-admob/docs/consent) — privacy consent and iOS tracking authorization.
192
+ - [Banner Ads](https://docs.rdlabo.dev/projects/capacitor-admob/docs/banner) — banner options, lifecycle, and events.
193
+ - Full-screen ads:
194
+ - [Interstitial Ads](https://docs.rdlabo.dev/projects/capacitor-admob/docs/interstitial) — load, show, and multiple prepared ads.
195
+ - [Rewarded Ads](https://docs.rdlabo.dev/projects/capacitor-admob/docs/rewarded) — rewarded video, rewarded interstitial, and server-side verification.
196
+ - [App Open Ads](https://docs.rdlabo.dev/projects/capacitor-admob/docs/app-open) — load and present on foreground transitions.
197
+ - [Ad Events](https://docs.rdlabo.dev/projects/capacitor-admob/docs/events) — shared lifecycle events, errors, and revenue data.
198
+ - [Testing](https://docs.rdlabo.dev/projects/capacitor-admob/docs/testing) — demo ad units, test devices, and consent testing.
199
+ - [Migration Guide](https://docs.rdlabo.dev/projects/capacitor-admob/docs/migration) — historical notes when upgrading from older plugin versions.
327
200
 
201
+ <!-- rdlabo-docs-omit -->
328
202
  ## Index
329
203
 
330
204
  <docgen-index>
@@ -334,6 +208,15 @@ AdMob.addListener(RewardAdPluginEvents.Rewarded, async () => {
334
208
  * [`requestTrackingAuthorization()`](#requesttrackingauthorization)
335
209
  * [`setApplicationMuted(...)`](#setapplicationmuted)
336
210
  * [`setApplicationVolume(...)`](#setapplicationvolume)
211
+ * [`loadAppOpen(...)`](#loadappopen)
212
+ * [`showAppOpen(...)`](#showappopen)
213
+ * [`isAppOpenLoaded(...)`](#isappopenloaded)
214
+ * [`addListener(AppOpenAdPluginEvents.Loaded, ...)`](#addlistenerappopenadplugineventsloaded-)
215
+ * [`addListener(AppOpenAdPluginEvents.FailedToLoad, ...)`](#addlistenerappopenadplugineventsfailedtoload-)
216
+ * [`addListener(AppOpenAdPluginEvents.Opened, ...)`](#addlistenerappopenadplugineventsopened-)
217
+ * [`addListener(AppOpenAdPluginEvents.Closed, ...)`](#addlistenerappopenadplugineventsclosed-)
218
+ * [`addListener(AppOpenAdPluginEvents.FailedToShow, ...)`](#addlistenerappopenadplugineventsfailedtoshow-)
219
+ * [`addListener(AppOpenAdPluginEvents.AdImpression, ...)`](#addlistenerappopenadplugineventsadimpression-)
337
220
  * [`showBanner(...)`](#showbanner)
338
221
  * [`hideBanner()`](#hidebanner)
339
222
  * [`resumeBanner()`](#resumebanner)
@@ -344,33 +227,37 @@ AdMob.addListener(RewardAdPluginEvents.Rewarded, async () => {
344
227
  * [`addListener(BannerAdPluginEvents.Opened, ...)`](#addlistenerbanneradplugineventsopened-)
345
228
  * [`addListener(BannerAdPluginEvents.Closed, ...)`](#addlistenerbanneradplugineventsclosed-)
346
229
  * [`addListener(BannerAdPluginEvents.AdImpression, ...)`](#addlistenerbanneradplugineventsadimpression-)
230
+ * [`addListener(BannerAdPluginEvents.AdPaid, ...)`](#addlistenerbanneradplugineventsadpaid-)
347
231
  * [`requestConsentInfo(...)`](#requestconsentinfo)
348
232
  * [`showPrivacyOptionsForm()`](#showprivacyoptionsform)
349
233
  * [`showConsentForm()`](#showconsentform)
350
234
  * [`resetConsentInfo()`](#resetconsentinfo)
351
235
  * [`prepareInterstitial(...)`](#prepareinterstitial)
352
- * [`showInterstitial()`](#showinterstitial)
236
+ * [`showInterstitial(...)`](#showinterstitial)
353
237
  * [`addListener(InterstitialAdPluginEvents.FailedToLoad, ...)`](#addlistenerinterstitialadplugineventsfailedtoload-)
354
238
  * [`addListener(InterstitialAdPluginEvents.Loaded, ...)`](#addlistenerinterstitialadplugineventsloaded-)
355
239
  * [`addListener(InterstitialAdPluginEvents.Dismissed, ...)`](#addlistenerinterstitialadplugineventsdismissed-)
356
240
  * [`addListener(InterstitialAdPluginEvents.FailedToShow, ...)`](#addlistenerinterstitialadplugineventsfailedtoshow-)
357
241
  * [`addListener(InterstitialAdPluginEvents.Showed, ...)`](#addlistenerinterstitialadplugineventsshowed-)
242
+ * [`addListener(InterstitialAdPluginEvents.AdImpression, ...)`](#addlistenerinterstitialadplugineventsadimpression-)
358
243
  * [`prepareRewardVideoAd(...)`](#preparerewardvideoad)
359
- * [`showRewardVideoAd()`](#showrewardvideoad)
244
+ * [`showRewardVideoAd(...)`](#showrewardvideoad)
360
245
  * [`addListener(RewardAdPluginEvents.FailedToLoad, ...)`](#addlistenerrewardadplugineventsfailedtoload-)
361
246
  * [`addListener(RewardAdPluginEvents.Loaded, ...)`](#addlistenerrewardadplugineventsloaded-)
362
247
  * [`addListener(RewardAdPluginEvents.Rewarded, ...)`](#addlistenerrewardadplugineventsrewarded-)
363
248
  * [`addListener(RewardAdPluginEvents.Dismissed, ...)`](#addlistenerrewardadplugineventsdismissed-)
364
249
  * [`addListener(RewardAdPluginEvents.FailedToShow, ...)`](#addlistenerrewardadplugineventsfailedtoshow-)
365
250
  * [`addListener(RewardAdPluginEvents.Showed, ...)`](#addlistenerrewardadplugineventsshowed-)
251
+ * [`addListener(RewardAdPluginEvents.AdImpression, ...)`](#addlistenerrewardadplugineventsadimpression-)
366
252
  * [`prepareRewardInterstitialAd(...)`](#preparerewardinterstitialad)
367
- * [`showRewardInterstitialAd()`](#showrewardinterstitialad)
253
+ * [`showRewardInterstitialAd(...)`](#showrewardinterstitialad)
368
254
  * [`addListener(RewardInterstitialAdPluginEvents.FailedToLoad, ...)`](#addlistenerrewardinterstitialadplugineventsfailedtoload-)
369
255
  * [`addListener(RewardInterstitialAdPluginEvents.Loaded, ...)`](#addlistenerrewardinterstitialadplugineventsloaded-)
370
256
  * [`addListener(RewardInterstitialAdPluginEvents.Rewarded, ...)`](#addlistenerrewardinterstitialadplugineventsrewarded-)
371
257
  * [`addListener(RewardInterstitialAdPluginEvents.Dismissed, ...)`](#addlistenerrewardinterstitialadplugineventsdismissed-)
372
258
  * [`addListener(RewardInterstitialAdPluginEvents.FailedToShow, ...)`](#addlistenerrewardinterstitialadplugineventsfailedtoshow-)
373
259
  * [`addListener(RewardInterstitialAdPluginEvents.Showed, ...)`](#addlistenerrewardinterstitialadplugineventsshowed-)
260
+ * [`addListener(RewardInterstitialAdPluginEvents.AdImpression, ...)`](#addlistenerrewardinterstitialadplugineventsadimpression-)
374
261
  * [Interfaces](#interfaces)
375
262
  * [Type Aliases](#type-aliases)
376
263
  * [Enums](#enums)
@@ -388,11 +275,11 @@ AdMob.addListener(RewardAdPluginEvents.Rewarded, async () => {
388
275
  initialize(options?: AdMobInitializationOptions | undefined) => Promise<void>
389
276
  ```
390
277
 
391
- Initialize AdMob with <a href="#admobinitializationoptions">AdMobInitializationOptions</a>
278
+ Initializes the Google Mobile Ads SDK.
392
279
 
393
- | Param | Type | Description |
394
- | ------------- | --------------------------------------------------------------------------------- | -------------------------------------------------------------------- |
395
- | **`options`** | <code><a href="#admobinitializationoptions">AdMobInitializationOptions</a></code> | <a href="#admobinitializationoptions">AdMobInitializationOptions</a> |
280
+ | Param | Type | Description |
281
+ | ------------- | --------------------------------------------------------------------------------- | ------------------------------------- |
282
+ | **`options`** | <code><a href="#admobinitializationoptions">AdMobInitializationOptions</a></code> | Optional SDK initialization settings. |
396
283
 
397
284
  **Since:** 1.1.2
398
285
 
@@ -405,7 +292,8 @@ Initialize AdMob with <a href="#admobinitializationoptions">AdMobInitializationO
405
292
  trackingAuthorizationStatus() => Promise<TrackingAuthorizationStatusInterface>
406
293
  ```
407
294
 
408
- Confirm requestTrackingAuthorization status (iOS &gt;14)
295
+ Returns the current App Tracking Transparency authorization status on iOS 14 and later.
296
+ Returns `authorized` on earlier iOS versions, Android, and web.
409
297
 
410
298
  **Returns:** <code>Promise&lt;<a href="#trackingauthorizationstatusinterface">TrackingAuthorizationStatusInterface</a>&gt;</code>
411
299
 
@@ -420,7 +308,8 @@ Confirm requestTrackingAuthorization status (iOS &gt;14)
420
308
  requestTrackingAuthorization() => Promise<void>
421
309
  ```
422
310
 
423
- request requestTrackingAuthorization (iOS &gt;14).
311
+ Requests App Tracking Transparency authorization on iOS 14 and later.
312
+ Resolves without taking action on earlier iOS versions, Android, and web.
424
313
 
425
314
  **Since:** 5.2.0
426
315
 
@@ -433,7 +322,7 @@ request requestTrackingAuthorization (iOS &gt;14).
433
322
  setApplicationMuted(options: ApplicationMutedOptions) => Promise<void>
434
323
  ```
435
324
 
436
- Report application mute state to AdMob SDK
325
+ Reports whether the application audio is muted to the Google Mobile Ads SDK.
437
326
 
438
327
  | Param | Type |
439
328
  | ------------- | --------------------------------------------------------------------------- |
@@ -450,7 +339,7 @@ Report application mute state to AdMob SDK
450
339
  setApplicationVolume(options: ApplicationVolumeOptions) => Promise<void>
451
340
  ```
452
341
 
453
- Report application volume to AdMob SDK
342
+ Reports the application audio volume to the Google Mobile Ads SDK.
454
343
 
455
344
  | Param | Type |
456
345
  | ------------- | ----------------------------------------------------------------------------- |
@@ -461,13 +350,170 @@ Report application volume to AdMob SDK
461
350
  --------------------
462
351
 
463
352
 
353
+ ### loadAppOpen(...)
354
+
355
+ ```typescript
356
+ loadAppOpen(options: AppOpenAdOptions) => Promise<AdLoadInfo>
357
+ ```
358
+
359
+ Loads an App Open ad and returns the loaded ad unit ID.
360
+
361
+ | Param | Type |
362
+ | ------------- | ------------------------------------------------------------- |
363
+ | **`options`** | <code><a href="#appopenadoptions">AppOpenAdOptions</a></code> |
364
+
365
+ **Returns:** <code>Promise&lt;<a href="#adloadinfo">AdLoadInfo</a>&gt;</code>
366
+
367
+ --------------------
368
+
369
+
370
+ ### showAppOpen(...)
371
+
372
+ ```typescript
373
+ showAppOpen(options?: AdShowOptions | undefined) => Promise<void>
374
+ ```
375
+
376
+ Shows a loaded App Open ad.
377
+
378
+ | Param | Type | Description |
379
+ | ------------- | ------------------------------------------------------- | -------------------------------------------------------------------------------------- |
380
+ | **`options`** | <code><a href="#adshowoptions">AdShowOptions</a></code> | Optional. Pass { adId } to show a specific prepared ad instead of the most recent one. |
381
+
382
+ --------------------
383
+
384
+
385
+ ### isAppOpenLoaded(...)
386
+
387
+ ```typescript
388
+ isAppOpenLoaded(options?: AdShowOptions | undefined) => Promise<{ value: boolean; }>
389
+ ```
390
+
391
+ Checks whether an App Open ad is loaded.
392
+
393
+ | Param | Type | Description |
394
+ | ------------- | ------------------------------------------------------- | -------------------------------------------------------------------------------------- |
395
+ | **`options`** | <code><a href="#adshowoptions">AdShowOptions</a></code> | Optional. Pass an adId to check a specific prepared ad instead of the most recent one. |
396
+
397
+ **Returns:** <code>Promise&lt;{ value: boolean; }&gt;</code>
398
+
399
+ --------------------
400
+
401
+
402
+ ### addListener(AppOpenAdPluginEvents.Loaded, ...)
403
+
404
+ ```typescript
405
+ addListener(eventName: AppOpenAdPluginEvents.Loaded, listenerFunc: (info: AdLoadInfo) => void) => Promise<PluginListenerHandle>
406
+ ```
407
+
408
+ Listens for App Open ad load events.
409
+
410
+ | Param | Type |
411
+ | ------------------ | ------------------------------------------------------------------------------ |
412
+ | **`eventName`** | <code><a href="#appopenadpluginevents">AppOpenAdPluginEvents.Loaded</a></code> |
413
+ | **`listenerFunc`** | <code>(info: <a href="#adloadinfo">AdLoadInfo</a>) =&gt; void</code> |
414
+
415
+ **Returns:** <code>Promise&lt;<a href="#pluginlistenerhandle">PluginListenerHandle</a>&gt;</code>
416
+
417
+ --------------------
418
+
419
+
420
+ ### addListener(AppOpenAdPluginEvents.FailedToLoad, ...)
421
+
422
+ ```typescript
423
+ addListener(eventName: AppOpenAdPluginEvents.FailedToLoad, listenerFunc: (error: AdMobError) => void) => Promise<PluginListenerHandle>
424
+ ```
425
+
426
+ Listens for App Open ad load failures.
427
+
428
+ | Param | Type |
429
+ | ------------------ | ------------------------------------------------------------------------------------ |
430
+ | **`eventName`** | <code><a href="#appopenadpluginevents">AppOpenAdPluginEvents.FailedToLoad</a></code> |
431
+ | **`listenerFunc`** | <code>(error: <a href="#admoberror">AdMobError</a>) =&gt; void</code> |
432
+
433
+ **Returns:** <code>Promise&lt;<a href="#pluginlistenerhandle">PluginListenerHandle</a>&gt;</code>
434
+
435
+ --------------------
436
+
437
+
438
+ ### addListener(AppOpenAdPluginEvents.Opened, ...)
439
+
440
+ ```typescript
441
+ addListener(eventName: AppOpenAdPluginEvents.Opened, listenerFunc: () => void) => Promise<PluginListenerHandle>
442
+ ```
443
+
444
+ Listens for App Open ad opened events.
445
+
446
+ | Param | Type |
447
+ | ------------------ | ------------------------------------------------------------------------------ |
448
+ | **`eventName`** | <code><a href="#appopenadpluginevents">AppOpenAdPluginEvents.Opened</a></code> |
449
+ | **`listenerFunc`** | <code>() =&gt; void</code> |
450
+
451
+ **Returns:** <code>Promise&lt;<a href="#pluginlistenerhandle">PluginListenerHandle</a>&gt;</code>
452
+
453
+ --------------------
454
+
455
+
456
+ ### addListener(AppOpenAdPluginEvents.Closed, ...)
457
+
458
+ ```typescript
459
+ addListener(eventName: AppOpenAdPluginEvents.Closed, listenerFunc: () => void) => Promise<PluginListenerHandle>
460
+ ```
461
+
462
+ Listens for App Open ad closed events.
463
+
464
+ | Param | Type |
465
+ | ------------------ | ------------------------------------------------------------------------------ |
466
+ | **`eventName`** | <code><a href="#appopenadpluginevents">AppOpenAdPluginEvents.Closed</a></code> |
467
+ | **`listenerFunc`** | <code>() =&gt; void</code> |
468
+
469
+ **Returns:** <code>Promise&lt;<a href="#pluginlistenerhandle">PluginListenerHandle</a>&gt;</code>
470
+
471
+ --------------------
472
+
473
+
474
+ ### addListener(AppOpenAdPluginEvents.FailedToShow, ...)
475
+
476
+ ```typescript
477
+ addListener(eventName: AppOpenAdPluginEvents.FailedToShow, listenerFunc: (error: AdMobError) => void) => Promise<PluginListenerHandle>
478
+ ```
479
+
480
+ Listens for App Open ad show failures.
481
+
482
+ | Param | Type |
483
+ | ------------------ | ------------------------------------------------------------------------------------ |
484
+ | **`eventName`** | <code><a href="#appopenadpluginevents">AppOpenAdPluginEvents.FailedToShow</a></code> |
485
+ | **`listenerFunc`** | <code>(error: <a href="#admoberror">AdMobError</a>) =&gt; void</code> |
486
+
487
+ **Returns:** <code>Promise&lt;<a href="#pluginlistenerhandle">PluginListenerHandle</a>&gt;</code>
488
+
489
+ --------------------
490
+
491
+
492
+ ### addListener(AppOpenAdPluginEvents.AdImpression, ...)
493
+
494
+ ```typescript
495
+ addListener(eventName: AppOpenAdPluginEvents.AdImpression, listenerFunc: (data: AdMobRevenueData) => void) => Promise<PluginListenerHandle>
496
+ ```
497
+
498
+ Listens for App Open impression-level ad revenue events.
499
+
500
+ | Param | Type |
501
+ | ------------------ | ------------------------------------------------------------------------------------ |
502
+ | **`eventName`** | <code><a href="#appopenadpluginevents">AppOpenAdPluginEvents.AdImpression</a></code> |
503
+ | **`listenerFunc`** | <code>(data: <a href="#admobrevenuedata">AdMobRevenueData</a>) =&gt; void</code> |
504
+
505
+ **Returns:** <code>Promise&lt;<a href="#pluginlistenerhandle">PluginListenerHandle</a>&gt;</code>
506
+
507
+ --------------------
508
+
509
+
464
510
  ### showBanner(...)
465
511
 
466
512
  ```typescript
467
513
  showBanner(options: BannerAdOptions) => Promise<void>
468
514
  ```
469
515
 
470
- Show a banner Ad
516
+ Displays a banner ad.
471
517
 
472
518
  | Param | Type | Description |
473
519
  | ------------- | ----------------------------------------------------------- | ---------------------------------- |
@@ -484,7 +530,7 @@ Show a banner Ad
484
530
  hideBanner() => Promise<void>
485
531
  ```
486
532
 
487
- Hide the banner, remove it from screen, but can show it later
533
+ Hides the current banner without destroying it.
488
534
 
489
535
  **Since:** 1.1.2
490
536
 
@@ -497,7 +543,7 @@ Hide the banner, remove it from screen, but can show it later
497
543
  resumeBanner() => Promise<void>
498
544
  ```
499
545
 
500
- Resume the banner, show it after hide
546
+ Shows a previously hidden banner.
501
547
 
502
548
  **Since:** 1.1.2
503
549
 
@@ -510,7 +556,7 @@ Resume the banner, show it after hide
510
556
  removeBanner() => Promise<void>
511
557
  ```
512
558
 
513
- Destroy the banner, remove it from screen.
559
+ Destroys the current banner and removes it from the screen.
514
560
 
515
561
  **Since:** 1.1.2
516
562
 
@@ -523,6 +569,8 @@ Destroy the banner, remove it from screen.
523
569
  addListener(eventName: BannerAdPluginEvents.SizeChanged, listenerFunc: (info: AdMobBannerSize) => void) => Promise<PluginListenerHandle>
524
570
  ```
525
571
 
572
+ Listens for changes to the displayed banner dimensions.
573
+
526
574
  | Param | Type | Description |
527
575
  | ------------------ | --------------------------------------------------------------------------------- | ------------------- |
528
576
  | **`eventName`** | <code><a href="#banneradpluginevents">BannerAdPluginEvents.SizeChanged</a></code> | bannerAdSizeChanged |
@@ -541,7 +589,7 @@ addListener(eventName: BannerAdPluginEvents.SizeChanged, listenerFunc: (info: Ad
541
589
  addListener(eventName: BannerAdPluginEvents.Loaded, listenerFunc: () => void) => Promise<PluginListenerHandle>
542
590
  ```
543
591
 
544
- Notice: request loaded Banner ad
592
+ Listens for banner ad load events.
545
593
 
546
594
  | Param | Type | Description |
547
595
  | ------------------ | ---------------------------------------------------------------------------- | -------------- |
@@ -561,7 +609,7 @@ Notice: request loaded Banner ad
561
609
  addListener(eventName: BannerAdPluginEvents.FailedToLoad, listenerFunc: (info: AdMobError) => void) => Promise<PluginListenerHandle>
562
610
  ```
563
611
 
564
- Notice: request failed Banner ad
612
+ Listens for banner ad load failures.
565
613
 
566
614
  | Param | Type | Description |
567
615
  | ------------------ | ---------------------------------------------------------------------------------- | -------------------- |
@@ -581,7 +629,7 @@ Notice: request failed Banner ad
581
629
  addListener(eventName: BannerAdPluginEvents.Opened, listenerFunc: () => void) => Promise<PluginListenerHandle>
582
630
  ```
583
631
 
584
- Notice: full-screen banner view will be presented in response to the user clicking on an ad.
632
+ Listens for banner overlay opened events.
585
633
 
586
634
  | Param | Type | Description |
587
635
  | ------------------ | ---------------------------------------------------------------------------- | -------------- |
@@ -601,7 +649,7 @@ Notice: full-screen banner view will be presented in response to the user clicki
601
649
  addListener(eventName: BannerAdPluginEvents.Closed, listenerFunc: () => void) => Promise<PluginListenerHandle>
602
650
  ```
603
651
 
604
- Notice: The full-screen banner view will been dismissed.
652
+ Listens for banner overlay closed events.
605
653
 
606
654
  | Param | Type | Description |
607
655
  | ------------------ | ---------------------------------------------------------------------------- | -------------- |
@@ -621,7 +669,7 @@ Notice: The full-screen banner view will been dismissed.
621
669
  addListener(eventName: BannerAdPluginEvents.AdImpression, listenerFunc: () => void) => Promise<PluginListenerHandle>
622
670
  ```
623
671
 
624
- Unimplemented
672
+ Listens for banner impression events.
625
673
 
626
674
  | Param | Type | Description |
627
675
  | ------------------ | ---------------------------------------------------------------------------------- | ------------ |
@@ -635,6 +683,24 @@ Unimplemented
635
683
  --------------------
636
684
 
637
685
 
686
+ ### addListener(BannerAdPluginEvents.AdPaid, ...)
687
+
688
+ ```typescript
689
+ addListener(eventName: BannerAdPluginEvents.AdPaid, listenerFunc: (data: AdMobRevenueData) => void) => Promise<PluginListenerHandle>
690
+ ```
691
+
692
+ Listens for banner impression-level ad revenue events.
693
+
694
+ | Param | Type |
695
+ | ------------------ | -------------------------------------------------------------------------------- |
696
+ | **`eventName`** | <code><a href="#banneradpluginevents">BannerAdPluginEvents.AdPaid</a></code> |
697
+ | **`listenerFunc`** | <code>(data: <a href="#admobrevenuedata">AdMobRevenueData</a>) =&gt; void</code> |
698
+
699
+ **Returns:** <code>Promise&lt;<a href="#pluginlistenerhandle">PluginListenerHandle</a>&gt;</code>
700
+
701
+ --------------------
702
+
703
+
638
704
  ### requestConsentInfo(...)
639
705
 
640
706
  ```typescript
@@ -701,7 +767,7 @@ Resets the UMP SDK state. Call requestConsentInfo function again to allow user m
701
767
  prepareInterstitial(options: AdOptions) => Promise<AdLoadInfo>
702
768
  ```
703
769
 
704
- Prepare interstitial banner
770
+ Loads an interstitial ad and returns the loaded ad unit ID.
705
771
 
706
772
  | Param | Type | Description |
707
773
  | ------------- | ----------------------------------------------- | ---------------------------------- |
@@ -714,13 +780,17 @@ Prepare interstitial banner
714
780
  --------------------
715
781
 
716
782
 
717
- ### showInterstitial()
783
+ ### showInterstitial(...)
718
784
 
719
785
  ```typescript
720
- showInterstitial() => Promise<void>
786
+ showInterstitial(options?: AdShowOptions | undefined) => Promise<void>
721
787
  ```
722
788
 
723
- Show interstitial ad when it’s ready
789
+ Shows a loaded interstitial ad.
790
+
791
+ | Param | Type | Description |
792
+ | ------------- | ------------------------------------------------------- | -------------------------------------------------------------------------------------- |
793
+ | **`options`** | <code><a href="#adshowoptions">AdShowOptions</a></code> | Optional. Pass { adId } to show a specific prepared ad instead of the most recent one. |
724
794
 
725
795
  **Since:** 1.1.2
726
796
 
@@ -733,6 +803,8 @@ Show interstitial ad when it’s ready
733
803
  addListener(eventName: InterstitialAdPluginEvents.FailedToLoad, listenerFunc: (error: AdMobError) => void) => Promise<PluginListenerHandle>
734
804
  ```
735
805
 
806
+ Listens for interstitial ad load failures.
807
+
736
808
  | Param | Type |
737
809
  | ------------------ | ---------------------------------------------------------------------------------------------- |
738
810
  | **`eventName`** | <code><a href="#interstitialadpluginevents">InterstitialAdPluginEvents.FailedToLoad</a></code> |
@@ -749,6 +821,8 @@ addListener(eventName: InterstitialAdPluginEvents.FailedToLoad, listenerFunc: (e
749
821
  addListener(eventName: InterstitialAdPluginEvents.Loaded, listenerFunc: (info: AdLoadInfo) => void) => Promise<PluginListenerHandle>
750
822
  ```
751
823
 
824
+ Listens for interstitial ad load events.
825
+
752
826
  | Param | Type |
753
827
  | ------------------ | ---------------------------------------------------------------------------------------- |
754
828
  | **`eventName`** | <code><a href="#interstitialadpluginevents">InterstitialAdPluginEvents.Loaded</a></code> |
@@ -765,6 +839,8 @@ addListener(eventName: InterstitialAdPluginEvents.Loaded, listenerFunc: (info: A
765
839
  addListener(eventName: InterstitialAdPluginEvents.Dismissed, listenerFunc: () => void) => Promise<PluginListenerHandle>
766
840
  ```
767
841
 
842
+ Listens for interstitial ad dismissed events.
843
+
768
844
  | Param | Type |
769
845
  | ------------------ | ------------------------------------------------------------------------------------------- |
770
846
  | **`eventName`** | <code><a href="#interstitialadpluginevents">InterstitialAdPluginEvents.Dismissed</a></code> |
@@ -781,6 +857,8 @@ addListener(eventName: InterstitialAdPluginEvents.Dismissed, listenerFunc: () =>
781
857
  addListener(eventName: InterstitialAdPluginEvents.FailedToShow, listenerFunc: (error: AdMobError) => void) => Promise<PluginListenerHandle>
782
858
  ```
783
859
 
860
+ Listens for interstitial ad show failures.
861
+
784
862
  | Param | Type |
785
863
  | ------------------ | ---------------------------------------------------------------------------------------------- |
786
864
  | **`eventName`** | <code><a href="#interstitialadpluginevents">InterstitialAdPluginEvents.FailedToShow</a></code> |
@@ -797,6 +875,8 @@ addListener(eventName: InterstitialAdPluginEvents.FailedToShow, listenerFunc: (e
797
875
  addListener(eventName: InterstitialAdPluginEvents.Showed, listenerFunc: () => void) => Promise<PluginListenerHandle>
798
876
  ```
799
877
 
878
+ Listens for interstitial ad shown events.
879
+
800
880
  | Param | Type |
801
881
  | ------------------ | ---------------------------------------------------------------------------------------- |
802
882
  | **`eventName`** | <code><a href="#interstitialadpluginevents">InterstitialAdPluginEvents.Showed</a></code> |
@@ -807,13 +887,31 @@ addListener(eventName: InterstitialAdPluginEvents.Showed, listenerFunc: () => vo
807
887
  --------------------
808
888
 
809
889
 
890
+ ### addListener(InterstitialAdPluginEvents.AdImpression, ...)
891
+
892
+ ```typescript
893
+ addListener(eventName: InterstitialAdPluginEvents.AdImpression, listenerFunc: (data: AdMobRevenueData) => void) => Promise<PluginListenerHandle>
894
+ ```
895
+
896
+ Listens for interstitial impression-level ad revenue events.
897
+
898
+ | Param | Type |
899
+ | ------------------ | ---------------------------------------------------------------------------------------------- |
900
+ | **`eventName`** | <code><a href="#interstitialadpluginevents">InterstitialAdPluginEvents.AdImpression</a></code> |
901
+ | **`listenerFunc`** | <code>(data: <a href="#admobrevenuedata">AdMobRevenueData</a>) =&gt; void</code> |
902
+
903
+ **Returns:** <code>Promise&lt;<a href="#pluginlistenerhandle">PluginListenerHandle</a>&gt;</code>
904
+
905
+ --------------------
906
+
907
+
810
908
  ### prepareRewardVideoAd(...)
811
909
 
812
910
  ```typescript
813
911
  prepareRewardVideoAd(options: RewardAdOptions) => Promise<AdLoadInfo>
814
912
  ```
815
913
 
816
- Prepare a reward video ad
914
+ Loads a rewarded ad and returns the loaded ad unit ID.
817
915
 
818
916
  | Param | Type | Description |
819
917
  | ------------- | ----------------------------------------------------------- | ---------------------------------------------- |
@@ -826,13 +924,17 @@ Prepare a reward video ad
826
924
  --------------------
827
925
 
828
926
 
829
- ### showRewardVideoAd()
927
+ ### showRewardVideoAd(...)
830
928
 
831
929
  ```typescript
832
- showRewardVideoAd() => Promise<AdMobRewardItem>
930
+ showRewardVideoAd(options?: AdShowOptions | undefined) => Promise<AdMobRewardItem>
833
931
  ```
834
932
 
835
- Show a reward video ad
933
+ Shows a loaded rewarded ad and resolves when the user earns the reward.
934
+
935
+ | Param | Type | Description |
936
+ | ------------- | ------------------------------------------------------- | -------------------------------------------------------------------------------------- |
937
+ | **`options`** | <code><a href="#adshowoptions">AdShowOptions</a></code> | Optional. Pass { adId } to show a specific prepared ad instead of the most recent one. |
836
938
 
837
939
  **Returns:** <code>Promise&lt;<a href="#admobrewarditem">AdMobRewardItem</a>&gt;</code>
838
940
 
@@ -847,6 +949,8 @@ Show a reward video ad
847
949
  addListener(eventName: RewardAdPluginEvents.FailedToLoad, listenerFunc: (error: AdMobError) => void) => Promise<PluginListenerHandle>
848
950
  ```
849
951
 
952
+ Listens for rewarded ad load failures.
953
+
850
954
  | Param | Type |
851
955
  | ------------------ | ---------------------------------------------------------------------------------- |
852
956
  | **`eventName`** | <code><a href="#rewardadpluginevents">RewardAdPluginEvents.FailedToLoad</a></code> |
@@ -863,6 +967,8 @@ addListener(eventName: RewardAdPluginEvents.FailedToLoad, listenerFunc: (error:
863
967
  addListener(eventName: RewardAdPluginEvents.Loaded, listenerFunc: (info: AdLoadInfo) => void) => Promise<PluginListenerHandle>
864
968
  ```
865
969
 
970
+ Listens for rewarded ad load events.
971
+
866
972
  | Param | Type |
867
973
  | ------------------ | ---------------------------------------------------------------------------- |
868
974
  | **`eventName`** | <code><a href="#rewardadpluginevents">RewardAdPluginEvents.Loaded</a></code> |
@@ -879,6 +985,8 @@ addListener(eventName: RewardAdPluginEvents.Loaded, listenerFunc: (info: AdLoadI
879
985
  addListener(eventName: RewardAdPluginEvents.Rewarded, listenerFunc: (reward: AdMobRewardItem) => void) => Promise<PluginListenerHandle>
880
986
  ```
881
987
 
988
+ Listens for earned reward events.
989
+
882
990
  | Param | Type |
883
991
  | ------------------ | -------------------------------------------------------------------------------- |
884
992
  | **`eventName`** | <code><a href="#rewardadpluginevents">RewardAdPluginEvents.Rewarded</a></code> |
@@ -895,6 +1003,8 @@ addListener(eventName: RewardAdPluginEvents.Rewarded, listenerFunc: (reward: AdM
895
1003
  addListener(eventName: RewardAdPluginEvents.Dismissed, listenerFunc: () => void) => Promise<PluginListenerHandle>
896
1004
  ```
897
1005
 
1006
+ Listens for rewarded ad dismissed events.
1007
+
898
1008
  | Param | Type |
899
1009
  | ------------------ | ------------------------------------------------------------------------------- |
900
1010
  | **`eventName`** | <code><a href="#rewardadpluginevents">RewardAdPluginEvents.Dismissed</a></code> |
@@ -911,6 +1021,8 @@ addListener(eventName: RewardAdPluginEvents.Dismissed, listenerFunc: () => void)
911
1021
  addListener(eventName: RewardAdPluginEvents.FailedToShow, listenerFunc: (error: AdMobError) => void) => Promise<PluginListenerHandle>
912
1022
  ```
913
1023
 
1024
+ Listens for rewarded ad show failures.
1025
+
914
1026
  | Param | Type |
915
1027
  | ------------------ | ---------------------------------------------------------------------------------- |
916
1028
  | **`eventName`** | <code><a href="#rewardadpluginevents">RewardAdPluginEvents.FailedToShow</a></code> |
@@ -927,6 +1039,8 @@ addListener(eventName: RewardAdPluginEvents.FailedToShow, listenerFunc: (error:
927
1039
  addListener(eventName: RewardAdPluginEvents.Showed, listenerFunc: () => void) => Promise<PluginListenerHandle>
928
1040
  ```
929
1041
 
1042
+ Listens for rewarded ad shown events.
1043
+
930
1044
  | Param | Type |
931
1045
  | ------------------ | ---------------------------------------------------------------------------- |
932
1046
  | **`eventName`** | <code><a href="#rewardadpluginevents">RewardAdPluginEvents.Showed</a></code> |
@@ -937,17 +1051,35 @@ addListener(eventName: RewardAdPluginEvents.Showed, listenerFunc: () => void) =>
937
1051
  --------------------
938
1052
 
939
1053
 
1054
+ ### addListener(RewardAdPluginEvents.AdImpression, ...)
1055
+
1056
+ ```typescript
1057
+ addListener(eventName: RewardAdPluginEvents.AdImpression, listenerFunc: (data: AdMobRevenueData) => void) => Promise<PluginListenerHandle>
1058
+ ```
1059
+
1060
+ Listens for rewarded impression-level ad revenue events.
1061
+
1062
+ | Param | Type |
1063
+ | ------------------ | ---------------------------------------------------------------------------------- |
1064
+ | **`eventName`** | <code><a href="#rewardadpluginevents">RewardAdPluginEvents.AdImpression</a></code> |
1065
+ | **`listenerFunc`** | <code>(data: <a href="#admobrevenuedata">AdMobRevenueData</a>) =&gt; void</code> |
1066
+
1067
+ **Returns:** <code>Promise&lt;<a href="#pluginlistenerhandle">PluginListenerHandle</a>&gt;</code>
1068
+
1069
+ --------------------
1070
+
1071
+
940
1072
  ### prepareRewardInterstitialAd(...)
941
1073
 
942
1074
  ```typescript
943
1075
  prepareRewardInterstitialAd(options: RewardInterstitialAdOptions) => Promise<AdLoadInfo>
944
1076
  ```
945
1077
 
946
- Prepare a reward video ad
1078
+ Loads a rewarded interstitial ad and returns the loaded ad unit ID.
947
1079
 
948
- | Param | Type | Description |
949
- | ------------- | ----------------------------------------------------------------------------------- | ---------------------------------------------- |
950
- | **`options`** | <code><a href="#rewardinterstitialadoptions">RewardInterstitialAdOptions</a></code> | <a href="#rewardadoptions">RewardAdOptions</a> |
1080
+ | Param | Type | Description |
1081
+ | ------------- | ----------------------------------------------------------------------------------- | ---------------------------------------------------------------------- |
1082
+ | **`options`** | <code><a href="#rewardinterstitialadoptions">RewardInterstitialAdOptions</a></code> | <a href="#rewardinterstitialadoptions">RewardInterstitialAdOptions</a> |
951
1083
 
952
1084
  **Returns:** <code>Promise&lt;<a href="#adloadinfo">AdLoadInfo</a>&gt;</code>
953
1085
 
@@ -956,13 +1088,17 @@ Prepare a reward video ad
956
1088
  --------------------
957
1089
 
958
1090
 
959
- ### showRewardInterstitialAd()
1091
+ ### showRewardInterstitialAd(...)
960
1092
 
961
1093
  ```typescript
962
- showRewardInterstitialAd() => Promise<AdMobRewardInterstitialItem>
1094
+ showRewardInterstitialAd(options?: AdShowOptions | undefined) => Promise<AdMobRewardInterstitialItem>
963
1095
  ```
964
1096
 
965
- Show a reward video ad
1097
+ Shows a loaded rewarded interstitial ad and resolves when the user earns the reward.
1098
+
1099
+ | Param | Type | Description |
1100
+ | ------------- | ------------------------------------------------------- | -------------------------------------------------------------------------------------- |
1101
+ | **`options`** | <code><a href="#adshowoptions">AdShowOptions</a></code> | Optional. Pass { adId } to show a specific prepared ad instead of the most recent one. |
966
1102
 
967
1103
  **Returns:** <code>Promise&lt;<a href="#admobrewardinterstitialitem">AdMobRewardInterstitialItem</a>&gt;</code>
968
1104
 
@@ -977,6 +1113,8 @@ Show a reward video ad
977
1113
  addListener(eventName: RewardInterstitialAdPluginEvents.FailedToLoad, listenerFunc: (error: AdMobError) => void) => Promise<PluginListenerHandle>
978
1114
  ```
979
1115
 
1116
+ Listens for rewarded interstitial ad load failures.
1117
+
980
1118
  | Param | Type |
981
1119
  | ------------------ | ---------------------------------------------------------------------------------------------------------- |
982
1120
  | **`eventName`** | <code><a href="#rewardinterstitialadpluginevents">RewardInterstitialAdPluginEvents.FailedToLoad</a></code> |
@@ -993,6 +1131,8 @@ addListener(eventName: RewardInterstitialAdPluginEvents.FailedToLoad, listenerFu
993
1131
  addListener(eventName: RewardInterstitialAdPluginEvents.Loaded, listenerFunc: (info: AdLoadInfo) => void) => Promise<PluginListenerHandle>
994
1132
  ```
995
1133
 
1134
+ Listens for rewarded interstitial ad load events.
1135
+
996
1136
  | Param | Type |
997
1137
  | ------------------ | ---------------------------------------------------------------------------------------------------- |
998
1138
  | **`eventName`** | <code><a href="#rewardinterstitialadpluginevents">RewardInterstitialAdPluginEvents.Loaded</a></code> |
@@ -1009,6 +1149,8 @@ addListener(eventName: RewardInterstitialAdPluginEvents.Loaded, listenerFunc: (i
1009
1149
  addListener(eventName: RewardInterstitialAdPluginEvents.Rewarded, listenerFunc: (reward: AdMobRewardInterstitialItem) => void) => Promise<PluginListenerHandle>
1010
1150
  ```
1011
1151
 
1152
+ Listens for earned reward events.
1153
+
1012
1154
  | Param | Type |
1013
1155
  | ------------------ | -------------------------------------------------------------------------------------------------------- |
1014
1156
  | **`eventName`** | <code><a href="#rewardinterstitialadpluginevents">RewardInterstitialAdPluginEvents.Rewarded</a></code> |
@@ -1025,6 +1167,8 @@ addListener(eventName: RewardInterstitialAdPluginEvents.Rewarded, listenerFunc:
1025
1167
  addListener(eventName: RewardInterstitialAdPluginEvents.Dismissed, listenerFunc: () => void) => Promise<PluginListenerHandle>
1026
1168
  ```
1027
1169
 
1170
+ Listens for rewarded interstitial ad dismissed events.
1171
+
1028
1172
  | Param | Type |
1029
1173
  | ------------------ | ------------------------------------------------------------------------------------------------------- |
1030
1174
  | **`eventName`** | <code><a href="#rewardinterstitialadpluginevents">RewardInterstitialAdPluginEvents.Dismissed</a></code> |
@@ -1041,6 +1185,8 @@ addListener(eventName: RewardInterstitialAdPluginEvents.Dismissed, listenerFunc:
1041
1185
  addListener(eventName: RewardInterstitialAdPluginEvents.FailedToShow, listenerFunc: (error: AdMobError) => void) => Promise<PluginListenerHandle>
1042
1186
  ```
1043
1187
 
1188
+ Listens for rewarded interstitial ad show failures.
1189
+
1044
1190
  | Param | Type |
1045
1191
  | ------------------ | ---------------------------------------------------------------------------------------------------------- |
1046
1192
  | **`eventName`** | <code><a href="#rewardinterstitialadpluginevents">RewardInterstitialAdPluginEvents.FailedToShow</a></code> |
@@ -1057,6 +1203,8 @@ addListener(eventName: RewardInterstitialAdPluginEvents.FailedToShow, listenerFu
1057
1203
  addListener(eventName: RewardInterstitialAdPluginEvents.Showed, listenerFunc: () => void) => Promise<PluginListenerHandle>
1058
1204
  ```
1059
1205
 
1206
+ Listens for rewarded interstitial ad shown events.
1207
+
1060
1208
  | Param | Type |
1061
1209
  | ------------------ | ---------------------------------------------------------------------------------------------------- |
1062
1210
  | **`eventName`** | <code><a href="#rewardinterstitialadpluginevents">RewardInterstitialAdPluginEvents.Showed</a></code> |
@@ -1067,25 +1215,45 @@ addListener(eventName: RewardInterstitialAdPluginEvents.Showed, listenerFunc: ()
1067
1215
  --------------------
1068
1216
 
1069
1217
 
1218
+ ### addListener(RewardInterstitialAdPluginEvents.AdImpression, ...)
1219
+
1220
+ ```typescript
1221
+ addListener(eventName: RewardInterstitialAdPluginEvents.AdImpression, listenerFunc: (data: AdMobRevenueData) => void) => Promise<PluginListenerHandle>
1222
+ ```
1223
+
1224
+ Listens for rewarded interstitial impression-level ad revenue events.
1225
+
1226
+ | Param | Type |
1227
+ | ------------------ | ---------------------------------------------------------------------------------------------------------- |
1228
+ | **`eventName`** | <code><a href="#rewardinterstitialadpluginevents">RewardInterstitialAdPluginEvents.AdImpression</a></code> |
1229
+ | **`listenerFunc`** | <code>(data: <a href="#admobrevenuedata">AdMobRevenueData</a>) =&gt; void</code> |
1230
+
1231
+ **Returns:** <code>Promise&lt;<a href="#pluginlistenerhandle">PluginListenerHandle</a>&gt;</code>
1232
+
1233
+ --------------------
1234
+
1235
+
1070
1236
  ### Interfaces
1071
1237
 
1072
1238
 
1073
1239
  #### AdMobInitializationOptions
1074
1240
 
1075
- | Prop | Type | Description | Default | Since |
1076
- | ---------------------------------- | ----------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------ | ----- |
1077
- | **`testingDevices`** | <code>string[]</code> | An Array of devices IDs that will be marked as tested devices if {@link <a href="#admobinitializationoptions">AdMobInitializationOptions.initializeForTesting</a>} is true (Real Ads will be served to Testing devices, but they will not count as 'real'). | | 1.2.0 |
1078
- | **`initializeForTesting`** | <code>boolean</code> | If set to true, the devices on {@link <a href="#admobinitializationoptions">AdMobInitializationOptions.testingDevices</a>} will be registered to receive test production ads. | <code>false</code> | 1.2.0 |
1079
- | **`tagForChildDirectedTreatment`** | <code>boolean</code> | For purposes of the Children's Online Privacy Protection Act (COPPA), there is a setting called tagForChildDirectedTreatment. | | 3.1.0 |
1080
- | **`tagForUnderAgeOfConsent`** | <code>boolean</code> | When using this feature, a Tag For Users under the Age of Consent in Europe (TFUA) parameter will be included in all future ad requests. | | 3.1.0 |
1081
- | **`maxAdContentRating`** | <code><a href="#maxadcontentrating">MaxAdContentRating</a></code> | As an app developer, you can indicate whether you want Google to treat your content as child-directed when you make an ad request. | | 3.1.0 |
1241
+ | Prop | Type | Description | Default | Since |
1242
+ | ---------------------------------- | ----------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------ | ----- |
1243
+ | **`testingDevices`** | <code>string[]</code> | Device IDs to register as test devices when {@link <a href="#admobinitializationoptions">AdMobInitializationOptions.initializeForTesting</a>} is `true`. Requests from registered devices receive test ads and do not generate invalid traffic. | | 1.2.0 |
1244
+ | **`initializeForTesting`** | <code>boolean</code> | Whether to register {@link <a href="#admobinitializationoptions">AdMobInitializationOptions.testingDevices</a>} as test devices. | <code>false</code> | 1.2.0 |
1245
+ | **`tagForChildDirectedTreatment`** | <code>boolean</code> | For purposes of the Children's Online Privacy Protection Act (COPPA), there is a setting called tagForChildDirectedTreatment. | | 3.1.0 |
1246
+ | **`tagForUnderAgeOfConsent`** | <code>boolean</code> | When using this feature, a Tag For Users under the Age of Consent in Europe (TFUA) parameter will be included in all future ad requests. | | 3.1.0 |
1247
+ | **`maxAdContentRating`** | <code><a href="#maxadcontentrating">MaxAdContentRating</a></code> | The maximum ad content rating applied to all ad requests. Ads with a higher rating are excluded. | | 3.1.0 |
1082
1248
 
1083
1249
 
1084
1250
  #### TrackingAuthorizationStatusInterface
1085
1251
 
1086
- | Prop | Type |
1087
- | ------------ | ------------------------------------------------------------------------ |
1088
- | **`status`** | <code>'authorized' \| 'denied' \| 'notDetermined' \| 'restricted'</code> |
1252
+ The current iOS App Tracking Transparency authorization status.
1253
+
1254
+ | Prop | Type | Description |
1255
+ | ------------ | ------------------------------------------------------------------------ | --------------------------------------------------------------- |
1256
+ | **`status`** | <code>'authorized' \| 'denied' \| 'notDetermined' \| 'restricted'</code> | The authorization status reported by App Tracking Transparency. |
1089
1257
 
1090
1258
 
1091
1259
  #### ApplicationMutedOptions
@@ -1097,47 +1265,48 @@ addListener(eventName: RewardInterstitialAdPluginEvents.Showed, listenerFunc: ()
1097
1265
 
1098
1266
  #### ApplicationVolumeOptions
1099
1267
 
1100
- | Prop | Type | Description | Since |
1101
- | ------------ | ---------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ----- |
1102
- | **`volume`** | <code>0 \| 1 \| 0.1 \| 0.2 \| 0.3 \| 0.4 \| 0.5 \| 0.6 \| 0.7 \| 0.8 \| 0.9</code> | If your app has its own volume controls (such as custom music or sound effect volumes), disclosing app volume to the Google Mobile Ads SDK allows video ads to respect app volume settings. enable set 0.0 - 1.0, any float allowed. | 4.1.1 |
1268
+ | Prop | Type | Description | Since |
1269
+ | ------------ | ---------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----- |
1270
+ | **`volume`** | <code>0 \| 1 \| 0.1 \| 0.2 \| 0.3 \| 0.4 \| 0.5 \| 0.6 \| 0.7 \| 0.8 \| 0.9</code> | If your app has its own volume controls (such as custom music or sound effect volumes), disclosing app volume to the Google Mobile Ads SDK allows video ads to respect app volume settings. Use a supported value from 0.0 (silent) to 1.0 (full volume). | 4.1.1 |
1103
1271
 
1104
1272
 
1105
- #### BannerAdOptions
1273
+ #### AdLoadInfo
1106
1274
 
1107
- This interface extends <a href="#adoptions">AdOptions</a>
1275
+ Information returned after an ad loads successfully.
1108
1276
 
1109
- | Prop | Type | Description | Default | Since |
1110
- | ------------------- | ------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------- | ----- |
1111
- | **`adSize`** | <code><a href="#banneradsize">BannerAdSize</a></code> | Banner Ad Size, defaults to ADAPTIVE_BANNER. IT can be: ADAPTIVE_BANNER, SMART_BANNER, BANNER, MEDIUM_RECTANGLE, FULL_BANNER, LEADERBOARD | <code>ADAPTIVE_BANNER</code> | 3.0.0 |
1112
- | **`position`** | <code><a href="#banneradposition">BannerAdPosition</a></code> | Set Banner Ad position. TOP_CENTER or CENTER or BOTTOM_CENTER | <code>TOP_CENTER</code> | 1.1.2 |
1113
- | **`adId`** | <code>string</code> | The ad unit ID that you want to request | | 1.1.2 |
1114
- | **`isTesting`** | <code>boolean</code> | You can use test mode of ad. | <code>false</code> | 1.1.2 |
1115
- | **`margin`** | <code>number</code> | Margin Banner. Default is 0px; If position is BOTTOM_CENTER, margin is be margin-bottom. If position is TOP_CENTER, margin is be margin-top. | <code>0</code> | 1.1.2 |
1116
- | **`npa`** | <code>boolean</code> | The default behavior of the Google Mobile Ads SDK is to serve personalized ads. Set this to true to request Non-Personalized Ads | <code>false</code> | 1.2.0 |
1117
- | **`immersiveMode`** | <code>boolean</code> | Sets a flag that controls if this interstitial or reward object will be displayed in immersive mode. Call this method before show. During show, if this flag is on and immersive mode is supported, SYSTEM_UI_FLAG_IMMERSIVE_STICKY &SYSTEM_UI_FLAG_HIDE_NAVIGATION will be turned on for interstitial or reward ad. | | 7.0.3 |
1277
+ | Prop | Type | Description |
1278
+ | -------------- | ------------------- | -------------------------------- |
1279
+ | **`adUnitId`** | <code>string</code> | The ad unit ID of the loaded ad. |
1118
1280
 
1119
1281
 
1120
- #### PluginListenerHandle
1282
+ #### AppOpenAdOptions
1121
1283
 
1122
- | Prop | Type |
1123
- | ------------ | ----------------------------------------- |
1124
- | **`remove`** | <code>() =&gt; Promise&lt;void&gt;</code> |
1284
+ Options for loading an App Open ad.
1125
1285
 
1286
+ | Prop | Type | Description |
1287
+ | ---------- | ------------------- | -------------------------------- |
1288
+ | **`adId`** | <code>string</code> | The App Open ad unit ID to load. |
1126
1289
 
1127
- #### AdMobBannerSize
1128
1290
 
1129
- When notice listener of OnAdLoaded, you can get banner size.
1291
+ #### AdShowOptions
1292
+
1293
+ Options for selecting a previously loaded ad to show or inspect.
1130
1294
 
1131
- | Prop | Type |
1132
- | ------------ | ------------------- |
1133
- | **`width`** | <code>number</code> |
1134
- | **`height`** | <code>number</code> |
1295
+ | Prop | Type | Description | Since |
1296
+ | ---------- | ------------------- | ---------------------------------------------------------------------------------------------------------------------- | ----- |
1297
+ | **`adId`** | <code>string</code> | The ad unit ID of a previously prepared ad to target. If omitted, the operation targets the most recently prepared ad. | 8.0.1 |
1298
+
1299
+
1300
+ #### PluginListenerHandle
1301
+
1302
+ | Prop | Type |
1303
+ | ------------ | ----------------------------------------- |
1304
+ | **`remove`** | <code>() =&gt; Promise&lt;void&gt;</code> |
1135
1305
 
1136
1306
 
1137
1307
  #### AdMobError
1138
1308
 
1139
- For more information
1140
- https://developers.google.com/android/reference/com/google/android/gms/ads/AdError
1309
+ An error returned by the Google Mobile Ads SDK.
1141
1310
 
1142
1311
  | Prop | Type | Description |
1143
1312
  | ------------- | ------------------- | -------------------------------------- |
@@ -1145,6 +1314,48 @@ https://developers.google.com/android/reference/com/google/android/gms/ads/AdErr
1145
1314
  | **`message`** | <code>string</code> | Gets the message describing the error. |
1146
1315
 
1147
1316
 
1317
+ #### AdMobRevenueData
1318
+
1319
+ Impression-level ad revenue data emitted by a paid event.
1320
+
1321
+ | Prop | Type | Description |
1322
+ | ------------------ | ------------------------------------------------------------- | ------------------------------------------------------------------------------------------------- |
1323
+ | **`adUnitId`** | <code>string</code> | The ad unit ID associated with the paid event. |
1324
+ | **`valueMicros`** | <code>number</code> | The ad value in micros, where 1,000,000 micros equals one currency unit. |
1325
+ | **`currencyCode`** | <code>string</code> | The ISO 4217 currency code for `valueMicros`. |
1326
+ | **`precision`** | <code><a href="#advalueprecision">AdValuePrecision</a></code> | The precision of the reported ad value. |
1327
+ | **`networkName`** | <code>string</code> | The mediation adapter class name that served the impression, or an empty string when unavailable. |
1328
+ | **`impressionId`** | <code>string</code> | The response identifier associated with the impression, or an empty string when unavailable. |
1329
+
1330
+
1331
+ #### BannerAdOptions
1332
+
1333
+ Options for displaying a banner ad.
1334
+
1335
+ This interface extends <a href="#adoptions">AdOptions</a>.
1336
+
1337
+ | Prop | Type | Description | Default | Since |
1338
+ | ------------------- | ------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------- | ----- |
1339
+ | **`adSize`** | <code><a href="#banneradsize">BannerAdSize</a></code> | The banner size to display. | <code>ADAPTIVE_BANNER</code> | 3.0.0 |
1340
+ | **`position`** | <code><a href="#banneradposition">BannerAdPosition</a></code> | The position where the banner is displayed. | <code>TOP_CENTER</code> | 1.1.2 |
1341
+ | **`adId`** | <code>string</code> | The ad unit ID to load. | | 1.1.2 |
1342
+ | **`isTesting`** | <code>boolean</code> | Whether to request a test ad. | <code>false</code> | 1.1.2 |
1343
+ | **`margin`** | <code>number</code> | The banner margin in logical display units (dp on Android and points on iOS). For `BOTTOM_CENTER`, this is the bottom margin. For `TOP_CENTER`, this is the top margin. | <code>0</code> | 1.1.2 |
1344
+ | **`npa`** | <code>boolean</code> | Whether to request non-personalized ads. | <code>false</code> | 1.2.0 |
1345
+ | **`immersiveMode`** | <code>boolean</code> | Whether to display a full-screen ad in immersive mode on Android. | | 7.0.3 |
1346
+
1347
+
1348
+ #### AdMobBannerSize
1349
+
1350
+ The displayed banner dimensions in logical display units (dp on Android and points on iOS).
1351
+ A hidden, removed, or failed banner can report both dimensions as `0`.
1352
+
1353
+ | Prop | Type | Description |
1354
+ | ------------ | ------------------- | ---------------------------- |
1355
+ | **`width`** | <code>number</code> | The displayed banner width. |
1356
+ | **`height`** | <code>number</code> | The displayed banner height. |
1357
+
1358
+
1148
1359
  #### AdmobConsentInfo
1149
1360
 
1150
1361
  | Prop | Type | Description | Since |
@@ -1164,68 +1375,65 @@ https://developers.google.com/android/reference/com/google/android/gms/ads/AdErr
1164
1375
  | **`tagForUnderAgeOfConsent`** | <code>boolean</code> | Set to `true` to provide the option for the user to accept being shown personalized ads. | <code>false</code> | 5.0.0 |
1165
1376
 
1166
1377
 
1167
- #### AdLoadInfo
1168
-
1169
- | Prop | Type |
1170
- | -------------- | ------------------- |
1171
- | **`adUnitId`** | <code>string</code> |
1172
-
1173
-
1174
1378
  #### AdOptions
1175
1379
 
1176
- | Prop | Type | Description | Default | Since |
1177
- | ------------------- | -------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------ | ----- |
1178
- | **`adId`** | <code>string</code> | The ad unit ID that you want to request | | 1.1.2 |
1179
- | **`isTesting`** | <code>boolean</code> | You can use test mode of ad. | <code>false</code> | 1.1.2 |
1180
- | **`margin`** | <code>number</code> | Margin Banner. Default is 0px; If position is BOTTOM_CENTER, margin is be margin-bottom. If position is TOP_CENTER, margin is be margin-top. | <code>0</code> | 1.1.2 |
1181
- | **`npa`** | <code>boolean</code> | The default behavior of the Google Mobile Ads SDK is to serve personalized ads. Set this to true to request Non-Personalized Ads | <code>false</code> | 1.2.0 |
1182
- | **`immersiveMode`** | <code>boolean</code> | Sets a flag that controls if this interstitial or reward object will be displayed in immersive mode. Call this method before show. During show, if this flag is on and immersive mode is supported, SYSTEM_UI_FLAG_IMMERSIVE_STICKY &SYSTEM_UI_FLAG_HIDE_NAVIGATION will be turned on for interstitial or reward ad. | | 7.0.3 |
1380
+ Common options for requesting an ad.
1381
+
1382
+ | Prop | Type | Description | Default | Since |
1383
+ | ------------------- | -------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------ | ----- |
1384
+ | **`adId`** | <code>string</code> | The ad unit ID to load. | | 1.1.2 |
1385
+ | **`isTesting`** | <code>boolean</code> | Whether to request a test ad. | <code>false</code> | 1.1.2 |
1386
+ | **`margin`** | <code>number</code> | The banner margin in logical display units (dp on Android and points on iOS). For `BOTTOM_CENTER`, this is the bottom margin. For `TOP_CENTER`, this is the top margin. | <code>0</code> | 1.1.2 |
1387
+ | **`npa`** | <code>boolean</code> | Whether to request non-personalized ads. | <code>false</code> | 1.2.0 |
1388
+ | **`immersiveMode`** | <code>boolean</code> | Whether to display a full-screen ad in immersive mode on Android. | | 7.0.3 |
1183
1389
 
1184
1390
 
1185
1391
  #### RewardAdOptions
1186
1392
 
1187
- | Prop | Type | Description | Default | Since |
1188
- | ------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------ | ----- |
1189
- | **`ssv`** | <code><a href="#atleastone">AtLeastOne</a>&lt;{ /** * An optional UserId to pass to your SSV callback function. */ userId: string; /** * An optional custom set of data to pass to your SSV callback function. */ customData: string; }&gt;</code> | If you have enabled SSV in your AdMob Application. You can provide customData or a userId be passed to your callback to do further processing on. *Important* You *HAVE* to define one of them. | | |
1190
- | **`adId`** | <code>string</code> | The ad unit ID that you want to request | | 1.1.2 |
1191
- | **`isTesting`** | <code>boolean</code> | You can use test mode of ad. | <code>false</code> | 1.1.2 |
1192
- | **`margin`** | <code>number</code> | Margin Banner. Default is 0px; If position is BOTTOM_CENTER, margin is be margin-bottom. If position is TOP_CENTER, margin is be margin-top. | <code>0</code> | 1.1.2 |
1193
- | **`npa`** | <code>boolean</code> | The default behavior of the Google Mobile Ads SDK is to serve personalized ads. Set this to true to request Non-Personalized Ads | <code>false</code> | 1.2.0 |
1194
- | **`immersiveMode`** | <code>boolean</code> | Sets a flag that controls if this interstitial or reward object will be displayed in immersive mode. Call this method before show. During show, if this flag is on and immersive mode is supported, SYSTEM_UI_FLAG_IMMERSIVE_STICKY &SYSTEM_UI_FLAG_HIDE_NAVIGATION will be turned on for interstitial or reward ad. | | 7.0.3 |
1393
+ Options for loading a rewarded ad.
1394
+
1395
+ | Prop | Type | Description | Default | Since |
1396
+ | ------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------ | ----- |
1397
+ | **`ssv`** | <code><a href="#atleastone">AtLeastOne</a>&lt;{ /** * A user identifier passed to the SSV callback. */ userId: string; /** * Custom data passed to the SSV callback. */ customData: string; }&gt;</code> | Server-side verification options for the rewarded ad. Provide at least one of `userId` or `customData`. | | |
1398
+ | **`adId`** | <code>string</code> | The ad unit ID to load. | | 1.1.2 |
1399
+ | **`isTesting`** | <code>boolean</code> | Whether to request a test ad. | <code>false</code> | 1.1.2 |
1400
+ | **`margin`** | <code>number</code> | The banner margin in logical display units (dp on Android and points on iOS). For `BOTTOM_CENTER`, this is the bottom margin. For `TOP_CENTER`, this is the top margin. | <code>0</code> | 1.1.2 |
1401
+ | **`npa`** | <code>boolean</code> | Whether to request non-personalized ads. | <code>false</code> | 1.2.0 |
1402
+ | **`immersiveMode`** | <code>boolean</code> | Whether to display a full-screen ad in immersive mode on Android. | | 7.0.3 |
1195
1403
 
1196
1404
 
1197
1405
  #### AdMobRewardItem
1198
1406
 
1199
- For more information
1200
- https://developers.google.com/admob/android/rewarded-video-adapters?hl=en
1407
+ The reward earned by the user after viewing a rewarded ad.
1201
1408
 
1202
- | Prop | Type | Description |
1203
- | ------------ | ------------------- | ------------------------ |
1204
- | **`type`** | <code>string</code> | Rewarded type user got |
1205
- | **`amount`** | <code>number</code> | Rewarded amount user got |
1409
+ | Prop | Type | Description |
1410
+ | ------------ | ------------------- | ------------------------------------------------ |
1411
+ | **`type`** | <code>string</code> | The reward item type configured for the ad unit. |
1412
+ | **`amount`** | <code>number</code> | The reward amount earned by the user. |
1206
1413
 
1207
1414
 
1208
1415
  #### RewardInterstitialAdOptions
1209
1416
 
1210
- | Prop | Type | Description | Default | Since |
1211
- | ------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------ | ----- |
1212
- | **`ssv`** | <code><a href="#atleastone">AtLeastOne</a>&lt;{ /** * An optional UserId to pass to your SSV callback function. */ userId: string; /** * An optional custom set of data to pass to your SSV callback function. */ customData: string; }&gt;</code> | If you have enabled SSV in your AdMob Application. You can provide customData or a userId be passed to your callback to do further processing on. *Important* You *HAVE* to define one of them. | | |
1213
- | **`adId`** | <code>string</code> | The ad unit ID that you want to request | | 1.1.2 |
1214
- | **`isTesting`** | <code>boolean</code> | You can use test mode of ad. | <code>false</code> | 1.1.2 |
1215
- | **`margin`** | <code>number</code> | Margin Banner. Default is 0px; If position is BOTTOM_CENTER, margin is be margin-bottom. If position is TOP_CENTER, margin is be margin-top. | <code>0</code> | 1.1.2 |
1216
- | **`npa`** | <code>boolean</code> | The default behavior of the Google Mobile Ads SDK is to serve personalized ads. Set this to true to request Non-Personalized Ads | <code>false</code> | 1.2.0 |
1217
- | **`immersiveMode`** | <code>boolean</code> | Sets a flag that controls if this interstitial or reward object will be displayed in immersive mode. Call this method before show. During show, if this flag is on and immersive mode is supported, SYSTEM_UI_FLAG_IMMERSIVE_STICKY &SYSTEM_UI_FLAG_HIDE_NAVIGATION will be turned on for interstitial or reward ad. | | 7.0.3 |
1417
+ Options for loading a rewarded interstitial ad.
1418
+
1419
+ | Prop | Type | Description | Default | Since |
1420
+ | ------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------ | ----- |
1421
+ | **`ssv`** | <code><a href="#atleastone">AtLeastOne</a>&lt;{ /** * A user identifier passed to the SSV callback. */ userId: string; /** * Custom data passed to the SSV callback. */ customData: string; }&gt;</code> | Server-side verification options for the rewarded interstitial ad. Provide at least one of `userId` or `customData`. | | |
1422
+ | **`adId`** | <code>string</code> | The ad unit ID to load. | | 1.1.2 |
1423
+ | **`isTesting`** | <code>boolean</code> | Whether to request a test ad. | <code>false</code> | 1.1.2 |
1424
+ | **`margin`** | <code>number</code> | The banner margin in logical display units (dp on Android and points on iOS). For `BOTTOM_CENTER`, this is the bottom margin. For `TOP_CENTER`, this is the top margin. | <code>0</code> | 1.1.2 |
1425
+ | **`npa`** | <code>boolean</code> | Whether to request non-personalized ads. | <code>false</code> | 1.2.0 |
1426
+ | **`immersiveMode`** | <code>boolean</code> | Whether to display a full-screen ad in immersive mode on Android. | | 7.0.3 |
1218
1427
 
1219
1428
 
1220
1429
  #### AdMobRewardInterstitialItem
1221
1430
 
1222
- For more information
1223
- https://developers.google.com/admob/android/rewarded-video-adapters?hl=en
1431
+ The reward earned by the user after viewing a rewarded interstitial ad.
1224
1432
 
1225
- | Prop | Type | Description |
1226
- | ------------ | ------------------- | ------------------------ |
1227
- | **`type`** | <code>string</code> | Rewarded type user got |
1228
- | **`amount`** | <code>number</code> | Rewarded amount user got |
1433
+ | Prop | Type | Description |
1434
+ | ------------ | ------------------- | ------------------------------------------------ |
1435
+ | **`type`** | <code>string</code> | The reward item type configured for the ad unit. |
1436
+ | **`amount`** | <code>number</code> | The reward amount earned by the user. |
1229
1437
 
1230
1438
 
1231
1439
  ### Type Aliases
@@ -1256,38 +1464,61 @@ From T, pick a set of properties whose keys are in the union K
1256
1464
  | **`MatureAudience`** | <code>'MatureAudience'</code> | Content suitable only for mature audiences. |
1257
1465
 
1258
1466
 
1467
+ #### AppOpenAdPluginEvents
1468
+
1469
+ | Members | Value | Description |
1470
+ | ------------------ | ------------------------------------ | --------------------------------------------------------------------- |
1471
+ | **`Loaded`** | <code>'appOpenAdLoaded'</code> | Emits when an App Open ad has loaded. |
1472
+ | **`FailedToLoad`** | <code>'appOpenAdFailedToLoad'</code> | Emits when an App Open ad fails to load. |
1473
+ | **`Opened`** | <code>'appOpenAdOpened'</code> | Emits when an App Open ad is shown. |
1474
+ | **`Closed`** | <code>'appOpenAdClosed'</code> | Emits when an App Open ad is dismissed. |
1475
+ | **`FailedToShow`** | <code>'appOpenAdFailedToShow'</code> | Emits when a loaded App Open ad fails to show. |
1476
+ | **`AdImpression`** | <code>'appOpenAdImpression'</code> | Emits impression-level ad revenue data when a paid event is recorded. |
1477
+
1478
+
1479
+ #### AdValuePrecision
1480
+
1481
+ | Members | Value | Description |
1482
+ | ----------------------- | -------------- | --------------------------------------------------- |
1483
+ | **`Unknown`** | <code>0</code> | The ad value precision is unknown. |
1484
+ | **`Estimated`** | <code>1</code> | The ad value is estimated from aggregated data. |
1485
+ | **`PublisherProvided`** | <code>2</code> | The ad value was provided by the publisher. |
1486
+ | **`Precise`** | <code>3</code> | The ad value is the precise value paid for this ad. |
1487
+
1488
+
1259
1489
  #### BannerAdSize
1260
1490
 
1261
- | Members | Value | Description |
1262
- | ---------------------- | ------------------------------- | --------------------------------------------------------------------------------------------------- |
1263
- | **`BANNER`** | <code>'BANNER'</code> | Mobile Marketing Association (MMA) banner ad size (320x50 density-independent pixels). |
1264
- | **`FULL_BANNER`** | <code>'FULL_BANNER'</code> | Interactive Advertising Bureau (IAB) full banner ad size (468x60 density-independent pixels). |
1265
- | **`LARGE_BANNER`** | <code>'LARGE_BANNER'</code> | Large banner ad size (320x100 density-independent pixels). |
1266
- | **`MEDIUM_RECTANGLE`** | <code>'MEDIUM_RECTANGLE'</code> | Interactive Advertising Bureau (IAB) medium rectangle ad size (300x250 density-independent pixels). |
1267
- | **`LEADERBOARD`** | <code>'LEADERBOARD'</code> | Interactive Advertising Bureau (IAB) leaderboard ad size (728x90 density-independent pixels). |
1268
- | **`ADAPTIVE_BANNER`** | <code>'ADAPTIVE_BANNER'</code> | A dynamically sized banner that is full-width and auto-height. |
1269
- | **`SMART_BANNER`** | <code>'SMART_BANNER'</code> | |
1491
+ | Members | Value | Description |
1492
+ | ---------------------- | ------------------------------- | ------------------------------------------------------------------------------------------------------------------------ |
1493
+ | **`BANNER`** | <code>'BANNER'</code> | Mobile Marketing Association (MMA) banner ad size (320x50 density-independent pixels). |
1494
+ | **`FULL_BANNER`** | <code>'FULL_BANNER'</code> | Interactive Advertising Bureau (IAB) full banner ad size (468x60 density-independent pixels). |
1495
+ | **`LARGE_BANNER`** | <code>'LARGE_BANNER'</code> | Large banner ad size (320x100 density-independent pixels). |
1496
+ | **`MEDIUM_RECTANGLE`** | <code>'MEDIUM_RECTANGLE'</code> | Interactive Advertising Bureau (IAB) medium rectangle ad size (300x250 density-independent pixels). |
1497
+ | **`LEADERBOARD`** | <code>'LEADERBOARD'</code> | Interactive Advertising Bureau (IAB) leaderboard ad size (728x90 density-independent pixels). |
1498
+ | **`ADAPTIVE_BANNER`** | <code>'ADAPTIVE_BANNER'</code> | A dynamically sized banner that is full-width and auto-height. |
1499
+ | **`SMART_BANNER`** | <code>'SMART_BANNER'</code> | A legacy smart banner sized to the screen width. Retained for compatibility; use `ADAPTIVE_BANNER` for new integrations. |
1270
1500
 
1271
1501
 
1272
1502
  #### BannerAdPosition
1273
1503
 
1274
- | Members | Value | Description |
1275
- | ------------------- | ---------------------------- | ----------------------------------------- |
1276
- | **`TOP_CENTER`** | <code>'TOP_CENTER'</code> | Banner position be top-center |
1277
- | **`CENTER`** | <code>'CENTER'</code> | Banner position be center |
1278
- | **`BOTTOM_CENTER`** | <code>'BOTTOM_CENTER'</code> | Banner position be bottom-center(default) |
1504
+ | Members | Value | Description |
1505
+ | ------------------- | ---------------------------- | -------------------------------------------------------- |
1506
+ | **`TOP_CENTER`** | <code>'TOP_CENTER'</code> | Positions the banner at the top center of the screen. |
1507
+ | **`CENTER`** | <code>'CENTER'</code> | Positions the banner at the center of the screen. |
1508
+ | **`BOTTOM_CENTER`** | <code>'BOTTOM_CENTER'</code> | Positions the banner at the bottom center of the screen. |
1279
1509
 
1280
1510
 
1281
1511
  #### BannerAdPluginEvents
1282
1512
 
1283
- | Members | Value | Description |
1284
- | ------------------ | ----------------------------------- | ------------------------------------------------------------------------------------------------------ |
1285
- | **`SizeChanged`** | <code>"bannerAdSizeChanged"</code> | |
1286
- | **`Loaded`** | <code>"bannerAdLoaded"</code> | |
1287
- | **`FailedToLoad`** | <code>"bannerAdFailedToLoad"</code> | |
1288
- | **`Opened`** | <code>"bannerAdOpened"</code> | Open "Adsense" Event after user click banner |
1289
- | **`Closed`** | <code>"bannerAdClosed"</code> | Close "Adsense" Event after user click banner |
1290
- | **`AdImpression`** | <code>"bannerAdImpression"</code> | Similarly, this method should be called when an impression is recorded for the ad by the mediated SDK. |
1513
+ | Members | Value | Description |
1514
+ | ------------------ | ----------------------------------- | --------------------------------------------------------------------- |
1515
+ | **`SizeChanged`** | <code>"bannerAdSizeChanged"</code> | Emits when the displayed banner size changes. |
1516
+ | **`Loaded`** | <code>"bannerAdLoaded"</code> | Emits when a banner ad has loaded. |
1517
+ | **`FailedToLoad`** | <code>"bannerAdFailedToLoad"</code> | Emits when a banner ad fails to load. |
1518
+ | **`Opened`** | <code>"bannerAdOpened"</code> | Emits when a banner opens an overlay after the user taps it. |
1519
+ | **`Closed`** | <code>"bannerAdClosed"</code> | Emits when the banner overlay is closed. |
1520
+ | **`AdImpression`** | <code>"bannerAdImpression"</code> | Emits when an impression is recorded for the banner ad. |
1521
+ | **`AdPaid`** | <code>"bannerAdPaid"</code> | Emits impression-level ad revenue data when a paid event is recorded. |
1291
1522
 
1292
1523
 
1293
1524
  #### AdmobConsentStatus
@@ -1322,49 +1553,60 @@ From T, pick a set of properties whose keys are in the union K
1322
1553
 
1323
1554
  #### InterstitialAdPluginEvents
1324
1555
 
1325
- | Members | Value | Description |
1326
- | ------------------ | ----------------------------------------- | -------------------------------------------------------------------------------------- |
1327
- | **`Loaded`** | <code>'interstitialAdLoaded'</code> | Emits after trying to prepare and Interstitial, when it is loaded and ready to be show |
1328
- | **`FailedToLoad`** | <code>'interstitialAdFailedToLoad'</code> | Emits after trying to prepare and Interstitial, when it could not be loaded |
1329
- | **`Showed`** | <code>'interstitialAdShowed'</code> | Emits when the Interstitial ad is visible to the user |
1330
- | **`FailedToShow`** | <code>'interstitialAdFailedToShow'</code> | Emits when the Interstitial ad is failed to show |
1331
- | **`Dismissed`** | <code>'interstitialAdDismissed'</code> | Emits when the Interstitial ad is not visible to the user anymore. |
1556
+ | Members | Value | Description |
1557
+ | ------------------ | ----------------------------------------- | --------------------------------------------------------------------- |
1558
+ | **`Loaded`** | <code>'interstitialAdLoaded'</code> | Emits when an interstitial ad has loaded and is ready to show. |
1559
+ | **`FailedToLoad`** | <code>'interstitialAdFailedToLoad'</code> | Emits when an interstitial ad fails to load. |
1560
+ | **`Showed`** | <code>'interstitialAdShowed'</code> | Emits when an interstitial ad is shown. |
1561
+ | **`FailedToShow`** | <code>'interstitialAdFailedToShow'</code> | Emits when a loaded interstitial ad fails to show. |
1562
+ | **`Dismissed`** | <code>'interstitialAdDismissed'</code> | Emits when an interstitial ad is dismissed. |
1563
+ | **`AdImpression`** | <code>'interstitialAdImpression'</code> | Emits impression-level ad revenue data when a paid event is recorded. |
1332
1564
 
1333
1565
 
1334
1566
  #### RewardAdPluginEvents
1335
1567
 
1336
- | Members | Value | Description |
1337
- | ------------------ | -------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
1338
- | **`Loaded`** | <code>'onRewardedVideoAdLoaded'</code> | Emits after trying to prepare a RewardAd and the Video is loaded and ready to be show |
1339
- | **`FailedToLoad`** | <code>'onRewardedVideoAdFailedToLoad'</code> | Emits after trying to prepare a RewardAd when it could not be loaded |
1340
- | **`Showed`** | <code>'onRewardedVideoAdShowed'</code> | Emits when the AdReward video is visible to the user |
1341
- | **`FailedToShow`** | <code>'onRewardedVideoAdFailedToShow'</code> | Emits when the AdReward video is failed to show |
1342
- | **`Dismissed`** | <code>'onRewardedVideoAdDismissed'</code> | Emits when the AdReward video is not visible to the user anymore. **Important**: This has nothing to do with the reward it self. This event will emits in this two cases: 1. The user starts the video ad but close it before the reward emit. 2. The user start the video and see it until end, then gets the reward and after that the ad is closed. |
1343
- | **`Rewarded`** | <code>'onRewardedVideoAdReward'</code> | Emits when user get rewarded from AdReward |
1568
+ | Members | Value | Description |
1569
+ | ------------------ | -------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
1570
+ | **`Loaded`** | <code>'onRewardedVideoAdLoaded'</code> | Emits when a rewarded ad has loaded and is ready to show. |
1571
+ | **`FailedToLoad`** | <code>'onRewardedVideoAdFailedToLoad'</code> | Emits when a rewarded ad fails to load. |
1572
+ | **`Showed`** | <code>'onRewardedVideoAdShowed'</code> | Emits when a rewarded ad is shown. |
1573
+ | **`FailedToShow`** | <code>'onRewardedVideoAdFailedToShow'</code> | Emits when a loaded rewarded ad fails to show. |
1574
+ | **`Dismissed`** | <code>'onRewardedVideoAdDismissed'</code> | Emits when a rewarded ad is dismissed. This event does not indicate whether the user earned a reward. Listen for `Rewarded` separately before granting the reward. |
1575
+ | **`Rewarded`** | <code>'onRewardedVideoAdReward'</code> | Emits when the user earns the advertised reward. |
1576
+ | **`AdImpression`** | <code>'onRewardedVideoAdImpression'</code> | Emits impression-level ad revenue data when a paid event is recorded. |
1344
1577
 
1345
1578
 
1346
1579
  #### RewardInterstitialAdPluginEvents
1347
1580
 
1348
- | Members | Value | Description |
1349
- | ------------------ | --------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
1350
- | **`Loaded`** | <code>'onRewardedInterstitialAdLoaded'</code> | Emits after trying to prepare a RewardAd and the Video is loaded and ready to be show |
1351
- | **`FailedToLoad`** | <code>'onRewardedInterstitialAdFailedToLoad'</code> | Emits after trying to prepare a RewardAd when it could not be loaded |
1352
- | **`Showed`** | <code>'onRewardedInterstitialAdShowed'</code> | Emits when the AdReward video is visible to the user |
1353
- | **`FailedToShow`** | <code>'onRewardedInterstitialAdFailedToShow'</code> | Emits when the AdReward video is failed to show |
1354
- | **`Dismissed`** | <code>'onRewardedInterstitialAdDismissed'</code> | Emits when the AdReward video is not visible to the user anymore. **Important**: This has nothing to do with the reward it self. This event will emits in this two cases: 1. The user starts the video ad but close it before the reward emit. 2. The user start the video and see it until end, then gets the reward and after that the ad is closed. |
1355
- | **`Rewarded`** | <code>'onRewardedInterstitialAdReward'</code> | Emits when user get rewarded from AdReward |
1581
+ | Members | Value | Description |
1582
+ | ------------------ | --------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
1583
+ | **`Loaded`** | <code>'onRewardedInterstitialAdLoaded'</code> | Emits when a rewarded interstitial ad has loaded and is ready to show. |
1584
+ | **`FailedToLoad`** | <code>'onRewardedInterstitialAdFailedToLoad'</code> | Emits when a rewarded interstitial ad fails to load. |
1585
+ | **`Showed`** | <code>'onRewardedInterstitialAdShowed'</code> | Emits when a rewarded interstitial ad is shown. |
1586
+ | **`FailedToShow`** | <code>'onRewardedInterstitialAdFailedToShow'</code> | Emits when a loaded rewarded interstitial ad fails to show. |
1587
+ | **`Dismissed`** | <code>'onRewardedInterstitialAdDismissed'</code> | Emits when a rewarded interstitial ad is dismissed. This event does not indicate whether the user earned a reward. Listen for `Rewarded` separately before granting the reward. |
1588
+ | **`Rewarded`** | <code>'onRewardedInterstitialAdReward'</code> | Emits when the user earns the advertised reward. |
1589
+ | **`AdImpression`** | <code>'onRewardedInterstitialAdImpression'</code> | Emits impression-level ad revenue data when a paid event is recorded. |
1356
1590
 
1357
1591
  </docgen-api>
1358
1592
 
1359
- ## TROUBLE SHOOTING
1593
+ ## Prerelease channels
1594
+
1595
+ An open, non-draft pull request can be published to the npm `beta` dist-tag after its `Validation` and `Package Candidate` workflows pass. A repository owner or maintainer must add a comment whose entire body is:
1596
+
1597
+ ```text
1598
+ /beta
1599
+ ```
1600
+
1601
+ The request authorizes only the pull request head SHA that existed when the comment was added. The workflow revalidates the owner or maintainer permission and head SHA immediately before publishing. Any new commit requires CI to pass again and a fresh owner or maintainer `/beta` comment. Fork pull requests are supported. Pull requests that change a release-gating workflow cannot be beta-published until those workflow changes land on `main`.
1360
1602
 
1361
- ### If you have error:
1603
+ Beta versions use `<base>-beta.pr<PR number>.sha<12-character SHA>`. The candidate is built in a read-only workflow without npm publishing credentials. The privileged release workflow publishes only the validated immutable package artifact with lifecycle scripts disabled. A notification failure cannot invalidate a successful npm publish.
1362
1604
 
1363
- > [error] Error running update: Analyzing dependencies
1364
- > [!] CocoaPods could not find compatible versions for pod "Google-Mobile-Ads-SDK":
1605
+ When a pull request is merged into `main`, it is automatically published to `beta` only after the required CI and `Package Candidate` succeed for that exact merge commit. Direct pushes to `main` do not publish a candidate.
1365
1606
 
1366
- You should run `pod repo update` ;
1607
+ Only `npm run release` creates a release tag. Stable `vX.Y.Z` tags publish to npm `latest`; revision/prerelease tags publish to `next`. Neither `beta` nor `next` publishing changes the npm `latest` dist-tag.
1367
1608
 
1368
1609
  ## License
1369
1610
 
1370
1611
  Capacitor AdMob is [MIT licensed](./LICENSE).
1612
+ <!-- /rdlabo-docs-omit -->