@capacitor-community/admob 8.0.1 → 8.1.0

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 (87) hide show
  1. package/CapacitorCommunityAdmob.podspec +1 -1
  2. package/Package.swift +1 -1
  3. package/README.md +470 -186
  4. package/android/build.gradle +1 -1
  5. package/android/src/main/java/com/getcapacitor/community/admob/appopen/AppOpenAdManager.kt +7 -1
  6. package/android/src/main/java/com/getcapacitor/community/admob/appopen/AppOpenAdPlugin.kt +26 -8
  7. package/android/src/main/java/com/getcapacitor/community/admob/appopen/AppOpenAdPluginEvents.kt +1 -0
  8. package/android/src/main/java/com/getcapacitor/community/admob/banner/BannerAdPluginEvents.kt +2 -1
  9. package/android/src/main/java/com/getcapacitor/community/admob/banner/BannerExecutor.java +79 -29
  10. package/android/src/main/java/com/getcapacitor/community/admob/helpers/FullscreenPluginCallback.kt +7 -2
  11. package/android/src/main/java/com/getcapacitor/community/admob/interstitial/AdInterstitialExecutor.java +21 -3
  12. package/android/src/main/java/com/getcapacitor/community/admob/interstitial/InterstitialAdCallbackAndListeners.kt +12 -2
  13. package/android/src/main/java/com/getcapacitor/community/admob/interstitial/InterstitialAdPluginPluginEvent.kt +1 -0
  14. package/android/src/main/java/com/getcapacitor/community/admob/models/AdMobRevenueData.kt +15 -0
  15. package/android/src/main/java/com/getcapacitor/community/admob/rewarded/AdRewardExecutor.java +20 -3
  16. package/android/src/main/java/com/getcapacitor/community/admob/rewarded/RewardAdPluginEvents.kt +1 -0
  17. package/android/src/main/java/com/getcapacitor/community/admob/rewarded/RewardedAdCallbackAndListeners.kt +14 -4
  18. package/android/src/main/java/com/getcapacitor/community/admob/rewardedinterstitial/AdRewardInterstitialExecutor.java +20 -3
  19. package/android/src/main/java/com/getcapacitor/community/admob/rewardedinterstitial/RewardInterstitialAdPluginEvents.kt +1 -0
  20. package/android/src/main/java/com/getcapacitor/community/admob/rewardedinterstitial/RewardedInterstitialAdCallbackAndListeners.kt +14 -3
  21. package/dist/docs.json +511 -178
  22. package/dist/esm/app-open/app-open-ad-options.interface.d.ts +6 -0
  23. package/dist/esm/app-open/app-open-ad-plugin-events.enum.d.ts +20 -1
  24. package/dist/esm/app-open/app-open-ad-plugin-events.enum.js +19 -0
  25. package/dist/esm/app-open/app-open-ad-plugin-events.enum.js.map +1 -1
  26. package/dist/esm/app-open/app-open-definitions.interface.d.ts +31 -8
  27. package/dist/esm/banner/banner-ad-options.interface.d.ts +5 -6
  28. package/dist/esm/banner/banner-ad-plugin-events.enum.d.ts +17 -4
  29. package/dist/esm/banner/banner-ad-plugin-events.enum.js +16 -3
  30. package/dist/esm/banner/banner-ad-plugin-events.enum.js.map +1 -1
  31. package/dist/esm/banner/banner-ad-position.enum.d.ts +3 -3
  32. package/dist/esm/banner/banner-ad-position.enum.js +3 -3
  33. package/dist/esm/banner/banner-ad-size.enum.d.ts +4 -3
  34. package/dist/esm/banner/banner-ad-size.enum.js +4 -3
  35. package/dist/esm/banner/banner-ad-size.enum.js.map +1 -1
  36. package/dist/esm/banner/banner-definitions.interface.d.ts +17 -10
  37. package/dist/esm/banner/banner-size.interface.d.ts +8 -1
  38. package/dist/esm/definitions.d.ts +17 -16
  39. package/dist/esm/definitions.js.map +1 -1
  40. package/dist/esm/interstitial/interstitial-ad-plugin-events.enum.d.ts +10 -6
  41. package/dist/esm/interstitial/interstitial-ad-plugin-events.enum.js +9 -5
  42. package/dist/esm/interstitial/interstitial-ad-plugin-events.enum.js.map +1 -1
  43. package/dist/esm/interstitial/interstitial-definitions.interface.d.ts +24 -4
  44. package/dist/esm/reward/reward-ad-options.interface.d.ts +7 -6
  45. package/dist/esm/reward/reward-ad-plugin-events.enum.d.ts +13 -12
  46. package/dist/esm/reward/reward-ad-plugin-events.enum.js +12 -11
  47. package/dist/esm/reward/reward-ad-plugin-events.enum.js.map +1 -1
  48. package/dist/esm/reward/reward-definitions.interface.d.ts +27 -4
  49. package/dist/esm/reward/reward-item.interface.d.ts +3 -4
  50. package/dist/esm/reward-interstitial/reward-interstitial-ad-options.interface.d.ts +7 -6
  51. package/dist/esm/reward-interstitial/reward-interstitial-ad-plugin-events.enum.d.ts +13 -12
  52. package/dist/esm/reward-interstitial/reward-interstitial-ad-plugin-events.enum.js +12 -11
  53. package/dist/esm/reward-interstitial/reward-interstitial-ad-plugin-events.enum.js.map +1 -1
  54. package/dist/esm/reward-interstitial/reward-interstitial-definitions.interface.d.ts +30 -7
  55. package/dist/esm/reward-interstitial/reward-interstitial-item.interface.d.ts +3 -4
  56. package/dist/esm/shared/ad-load-info.interface.d.ts +6 -0
  57. package/dist/esm/shared/ad-mob-revenue-data.interface.d.ts +50 -0
  58. package/dist/esm/shared/ad-mob-revenue-data.interface.js +23 -0
  59. package/dist/esm/shared/ad-mob-revenue-data.interface.js.map +1 -0
  60. package/dist/esm/shared/ad-options.interface.d.ts +9 -11
  61. package/dist/esm/shared/ad-show-options.interface.d.ts +12 -0
  62. package/dist/esm/shared/ad-show-options.interface.js +2 -0
  63. package/dist/esm/shared/ad-show-options.interface.js.map +1 -0
  64. package/dist/esm/shared/admob-error.interface.d.ts +3 -2
  65. package/dist/esm/shared/index.d.ts +2 -0
  66. package/dist/esm/shared/index.js +2 -0
  67. package/dist/esm/shared/index.js.map +1 -1
  68. package/dist/esm/shared/tracking-authorization-status.interface.d.ts +6 -1
  69. package/dist/esm/web.d.ts +6 -6
  70. package/dist/esm/web.js +11 -6
  71. package/dist/esm/web.js.map +1 -1
  72. package/dist/plugin.cjs.js +109 -42
  73. package/dist/plugin.cjs.js.map +1 -1
  74. package/dist/plugin.js +109 -42
  75. package/dist/plugin.js.map +1 -1
  76. package/ios/Sources/AdMobPlugin/AppOpen/AppOpenAdManager.swift +12 -1
  77. package/ios/Sources/AdMobPlugin/AppOpen/AppOpenAdPlugin.swift +40 -10
  78. package/ios/Sources/AdMobPlugin/AppOpen/AppOpenAdPluginEvents.swift +1 -0
  79. package/ios/Sources/AdMobPlugin/Banner/BannerAdPluginEvents.swift +1 -0
  80. package/ios/Sources/AdMobPlugin/Banner/BannerExecutor.swift +14 -0
  81. package/ios/Sources/AdMobPlugin/Interstitial/AdInterstitialExecutor.swift +41 -5
  82. package/ios/Sources/AdMobPlugin/Interstitial/InterstitialAdPluginEvents.swift +1 -0
  83. package/ios/Sources/AdMobPlugin/Rewarded/AdRewardExecutor.swift +44 -5
  84. package/ios/Sources/AdMobPlugin/Rewarded/RewardAdPluginEvents.swift +1 -0
  85. package/ios/Sources/AdMobPlugin/RewardedInterstitial/AdRewardInterstitialExecutor.swift +45 -6
  86. package/ios/Sources/AdMobPlugin/RewardedInterstitial/RewardInterstitialAdPluginEvents.swift +1 -0
  87. package/package.json +1 -1
package/README.md CHANGED
@@ -6,7 +6,7 @@
6
6
  </p>
7
7
 
8
8
  <p align="center">
9
- <img src="https://img.shields.io/maintenance/yes/2025?style=flat-square" />
9
+ <img src="https://img.shields.io/maintenance/yes/2026?style=flat-square" />
10
10
  <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
11
  <br>
12
12
  <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>
@@ -32,7 +32,7 @@ Made with [contributors-img](https://contrib.rocks).
32
32
 
33
33
  ## Demo
34
34
 
35
- [Demo code is here.](https://github.com/capacitor-community/admob/tree/master/demo)
35
+ [Demo code is here.](https://github.com/capacitor-community/admob/tree/main/demo)
36
36
 
37
37
  ### Screenshots
38
38
 
@@ -43,13 +43,21 @@ Made with [contributors-img](https://contrib.rocks).
43
43
 
44
44
  ## Installation
45
45
 
46
- If you use capacitor 6:
46
+ If you use Capacitor 7:
47
47
 
48
48
  ```
49
- % npm install --save @capacitor-community/admob@6
49
+ % npm install --save @capacitor-community/admob@7
50
50
  % npx cap update
51
51
  ```
52
52
 
53
+ ### Google Mobile Ads SDK compatibility
54
+
55
+ To preserve behavior for users of the current major version, this plugin continues to use Google Mobile Ads SDK APIs that are deprecated but still supported. Replacing those APIs can change banner sizing and age-restricted treatment behavior, so that migration is deferred until the next major release.
56
+
57
+ Migration to the [GMA Next-Gen SDK for Android](https://developers.google.com/admob/android/next-gen) is also deferred until the next major release because it requires breaking changes to SDK initialization, ad requests, and mediation integration.
58
+
59
+ Android continues to use GMA SDK (Legacy) 25.4.x. On iOS, both Swift Package Manager and CocoaPods are fixed to GMA SDK 13.6.0 until CocoaPods support is removed in the next major release.
60
+
53
61
  ### Android configuration
54
62
 
55
63
  In file `android/app/src/main/AndroidManifest.xml`, add the following XML elements under `<manifest><application>` :
@@ -72,8 +80,8 @@ Don't forget to replace `[APP_ID]` by your AdMob application Id.
72
80
 
73
81
  This plugin will use the following project variables (defined in your app's `variables.gradle` file):
74
82
 
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`)
83
+ - `playServicesAdsVersion` version of `com.google.android.gms:play-services-ads` (default: `25.4.+`)
84
+ - `androidxCoreKTXVersion`: version of `androidx.core:core-ktx` (default: `1.15.0`)
77
85
 
78
86
  ### iOS configuration
79
87
 
@@ -102,7 +110,7 @@ Don't forget to replace `[APP_ID]` by your AdMob application Id.
102
110
  ### Initialize AdMob
103
111
 
104
112
  ```ts
105
- import { AdMob } from '@capacitor-community/admob';
113
+ import { AdMob, AdmobConsentStatus } from '@capacitor-community/admob';
106
114
 
107
115
  export async function initialize(): Promise<void> {
108
116
  await AdMob.initialize();
@@ -174,6 +182,8 @@ showPrivacyOptionsForm() {
174
182
  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
183
 
176
184
  ```ts
185
+ import { AdMob, AdmobConsentDebugGeography } from '@capacitor-community/admob';
186
+
177
187
  const consentInfo = await AdMob.requestConsentInfo({
178
188
  debugGeography: AdmobConsentDebugGeography.EEA,
179
189
  testDeviceIdentifiers: ['YOUR_DEVICE_ID'],
@@ -196,12 +206,13 @@ import {
196
206
  AdMob,
197
207
  AppOpenAdPluginEvents,
198
208
  AppOpenAdOptions,
209
+ AdLoadInfo,
199
210
  } from '@capacitor-community/admob';
200
211
 
201
212
  export async function showAppOpenAd(): Promise<void> {
202
213
  // listen to events
203
- AdMob.addListener(AppOpenAdPluginEvents.Loaded, () => {
204
- console.log('App Open Ad loaded');
214
+ AdMob.addListener(AppOpenAdPluginEvents.Loaded, (info: AdLoadInfo) => {
215
+ console.log('App Open Ad loaded', info.adUnitId);
205
216
  });
206
217
  AdMob.addListener(AppOpenAdPluginEvents.FailedToLoad, (error) => {
207
218
  console.log('Failed to load App Open Ad', error);
@@ -219,10 +230,10 @@ export async function showAppOpenAd(): Promise<void> {
219
230
  const options: AppOpenAdOptions = {
220
231
  adId: 'YOUR_AD_UNIT_ID',
221
232
  };
222
- await AdMob.loadAppOpen(options);
223
- const { value } = await AdMob.isAppOpenLoaded();
233
+ const { adUnitId } = await AdMob.loadAppOpen(options);
234
+ const { value } = await AdMob.isAppOpenLoaded({ adId: adUnitId });
224
235
  if (value) {
225
- await AdMob.showAppOpen();
236
+ await AdMob.showAppOpen({ adId: adUnitId });
226
237
  }
227
238
  }
228
239
  ```
@@ -262,6 +273,30 @@ export async function banner(): Promise<void> {
262
273
  }
263
274
  ```
264
275
 
276
+ ### Impression-level ad revenue
277
+
278
+ Full-screen ad formats emit revenue data through their `AdImpression` event. Banners use the separate `AdPaid` event.
279
+
280
+ ```ts
281
+ import {
282
+ AdMob,
283
+ AdMobRevenueData,
284
+ BannerAdPluginEvents,
285
+ InterstitialAdPluginEvents,
286
+ } from '@capacitor-community/admob';
287
+
288
+ AdMob.addListener(
289
+ InterstitialAdPluginEvents.AdImpression,
290
+ (data: AdMobRevenueData) => {
291
+ console.log(data);
292
+ },
293
+ );
294
+
295
+ AdMob.addListener(BannerAdPluginEvents.AdPaid, (data: AdMobRevenueData) => {
296
+ console.log(data);
297
+ });
298
+ ```
299
+
265
300
  ### Show Interstitial
266
301
 
267
302
  ```ts
@@ -285,6 +320,16 @@ export async function interstitial(): Promise<void> {
285
320
  };
286
321
  await AdMob.prepareInterstitial(options);
287
322
  await AdMob.showInterstitial();
323
+
324
+ // You can also prepare multiple interstitials and show a specific one by passing its adId:
325
+ await AdMob.prepareInterstitial({ adId: 'ca-app-pub-xxx/interstitial-1' });
326
+ await AdMob.prepareInterstitial({ adId: 'ca-app-pub-xxx/interstitial-2' });
327
+
328
+ // Show a specific prepared ad
329
+ await AdMob.showInterstitial({ adId: 'ca-app-pub-xxx/interstitial-1' });
330
+
331
+ // Or omit adId to show the most recently prepared one (default behavior)
332
+ await AdMob.showInterstitial();
288
333
  }
289
334
  ```
290
335
 
@@ -324,6 +369,30 @@ export async function rewardVideo(): Promise<void> {
324
369
  };
325
370
  await AdMob.prepareRewardVideoAd(options);
326
371
  const rewardItem = await AdMob.showRewardVideoAd();
372
+
373
+ // You can also prepare multiple reward ads and show a specific one by passing its adId:
374
+ await AdMob.prepareRewardVideoAd({ adId: 'ca-app-pub-xxx/reward-1' });
375
+ await AdMob.prepareRewardVideoAd({ adId: 'ca-app-pub-xxx/reward-2' });
376
+
377
+ // Show a specific prepared ad
378
+ const reward = await AdMob.showRewardVideoAd({ adId: 'ca-app-pub-xxx/reward-1' });
379
+
380
+ // Or omit adId to show the most recently prepared one (default behavior)
381
+ const reward2 = await AdMob.showRewardVideoAd();
382
+ }
383
+ ```
384
+
385
+ ### Show Rewarded Interstitial
386
+
387
+ ```ts
388
+ import { AdMob, RewardInterstitialAdOptions } from '@capacitor-community/admob';
389
+
390
+ export async function rewardInterstitial(): Promise<void> {
391
+ const options: RewardInterstitialAdOptions = {
392
+ adId: 'YOUR ADID',
393
+ };
394
+ const { adUnitId } = await AdMob.prepareRewardInterstitialAd(options);
395
+ await AdMob.showRewardInterstitialAd({ adId: adUnitId });
327
396
  }
328
397
  ```
329
398
 
@@ -372,13 +441,14 @@ AdMob.addListener(RewardAdPluginEvents.Rewarded, async () => {
372
441
  * [`setApplicationMuted(...)`](#setapplicationmuted)
373
442
  * [`setApplicationVolume(...)`](#setapplicationvolume)
374
443
  * [`loadAppOpen(...)`](#loadappopen)
375
- * [`showAppOpen()`](#showappopen)
376
- * [`isAppOpenLoaded()`](#isappopenloaded)
444
+ * [`showAppOpen(...)`](#showappopen)
445
+ * [`isAppOpenLoaded(...)`](#isappopenloaded)
377
446
  * [`addListener(AppOpenAdPluginEvents.Loaded, ...)`](#addlistenerappopenadplugineventsloaded-)
378
447
  * [`addListener(AppOpenAdPluginEvents.FailedToLoad, ...)`](#addlistenerappopenadplugineventsfailedtoload-)
379
448
  * [`addListener(AppOpenAdPluginEvents.Opened, ...)`](#addlistenerappopenadplugineventsopened-)
380
449
  * [`addListener(AppOpenAdPluginEvents.Closed, ...)`](#addlistenerappopenadplugineventsclosed-)
381
450
  * [`addListener(AppOpenAdPluginEvents.FailedToShow, ...)`](#addlistenerappopenadplugineventsfailedtoshow-)
451
+ * [`addListener(AppOpenAdPluginEvents.AdImpression, ...)`](#addlistenerappopenadplugineventsadimpression-)
382
452
  * [`showBanner(...)`](#showbanner)
383
453
  * [`hideBanner()`](#hidebanner)
384
454
  * [`resumeBanner()`](#resumebanner)
@@ -389,33 +459,37 @@ AdMob.addListener(RewardAdPluginEvents.Rewarded, async () => {
389
459
  * [`addListener(BannerAdPluginEvents.Opened, ...)`](#addlistenerbanneradplugineventsopened-)
390
460
  * [`addListener(BannerAdPluginEvents.Closed, ...)`](#addlistenerbanneradplugineventsclosed-)
391
461
  * [`addListener(BannerAdPluginEvents.AdImpression, ...)`](#addlistenerbanneradplugineventsadimpression-)
462
+ * [`addListener(BannerAdPluginEvents.AdPaid, ...)`](#addlistenerbanneradplugineventsadpaid-)
392
463
  * [`requestConsentInfo(...)`](#requestconsentinfo)
393
464
  * [`showPrivacyOptionsForm()`](#showprivacyoptionsform)
394
465
  * [`showConsentForm()`](#showconsentform)
395
466
  * [`resetConsentInfo()`](#resetconsentinfo)
396
467
  * [`prepareInterstitial(...)`](#prepareinterstitial)
397
- * [`showInterstitial()`](#showinterstitial)
468
+ * [`showInterstitial(...)`](#showinterstitial)
398
469
  * [`addListener(InterstitialAdPluginEvents.FailedToLoad, ...)`](#addlistenerinterstitialadplugineventsfailedtoload-)
399
470
  * [`addListener(InterstitialAdPluginEvents.Loaded, ...)`](#addlistenerinterstitialadplugineventsloaded-)
400
471
  * [`addListener(InterstitialAdPluginEvents.Dismissed, ...)`](#addlistenerinterstitialadplugineventsdismissed-)
401
472
  * [`addListener(InterstitialAdPluginEvents.FailedToShow, ...)`](#addlistenerinterstitialadplugineventsfailedtoshow-)
402
473
  * [`addListener(InterstitialAdPluginEvents.Showed, ...)`](#addlistenerinterstitialadplugineventsshowed-)
474
+ * [`addListener(InterstitialAdPluginEvents.AdImpression, ...)`](#addlistenerinterstitialadplugineventsadimpression-)
403
475
  * [`prepareRewardVideoAd(...)`](#preparerewardvideoad)
404
- * [`showRewardVideoAd()`](#showrewardvideoad)
476
+ * [`showRewardVideoAd(...)`](#showrewardvideoad)
405
477
  * [`addListener(RewardAdPluginEvents.FailedToLoad, ...)`](#addlistenerrewardadplugineventsfailedtoload-)
406
478
  * [`addListener(RewardAdPluginEvents.Loaded, ...)`](#addlistenerrewardadplugineventsloaded-)
407
479
  * [`addListener(RewardAdPluginEvents.Rewarded, ...)`](#addlistenerrewardadplugineventsrewarded-)
408
480
  * [`addListener(RewardAdPluginEvents.Dismissed, ...)`](#addlistenerrewardadplugineventsdismissed-)
409
481
  * [`addListener(RewardAdPluginEvents.FailedToShow, ...)`](#addlistenerrewardadplugineventsfailedtoshow-)
410
482
  * [`addListener(RewardAdPluginEvents.Showed, ...)`](#addlistenerrewardadplugineventsshowed-)
483
+ * [`addListener(RewardAdPluginEvents.AdImpression, ...)`](#addlistenerrewardadplugineventsadimpression-)
411
484
  * [`prepareRewardInterstitialAd(...)`](#preparerewardinterstitialad)
412
- * [`showRewardInterstitialAd()`](#showrewardinterstitialad)
485
+ * [`showRewardInterstitialAd(...)`](#showrewardinterstitialad)
413
486
  * [`addListener(RewardInterstitialAdPluginEvents.FailedToLoad, ...)`](#addlistenerrewardinterstitialadplugineventsfailedtoload-)
414
487
  * [`addListener(RewardInterstitialAdPluginEvents.Loaded, ...)`](#addlistenerrewardinterstitialadplugineventsloaded-)
415
488
  * [`addListener(RewardInterstitialAdPluginEvents.Rewarded, ...)`](#addlistenerrewardinterstitialadplugineventsrewarded-)
416
489
  * [`addListener(RewardInterstitialAdPluginEvents.Dismissed, ...)`](#addlistenerrewardinterstitialadplugineventsdismissed-)
417
490
  * [`addListener(RewardInterstitialAdPluginEvents.FailedToShow, ...)`](#addlistenerrewardinterstitialadplugineventsfailedtoshow-)
418
491
  * [`addListener(RewardInterstitialAdPluginEvents.Showed, ...)`](#addlistenerrewardinterstitialadplugineventsshowed-)
492
+ * [`addListener(RewardInterstitialAdPluginEvents.AdImpression, ...)`](#addlistenerrewardinterstitialadplugineventsadimpression-)
419
493
  * [Interfaces](#interfaces)
420
494
  * [Type Aliases](#type-aliases)
421
495
  * [Enums](#enums)
@@ -433,11 +507,11 @@ AdMob.addListener(RewardAdPluginEvents.Rewarded, async () => {
433
507
  initialize(options?: AdMobInitializationOptions | undefined) => Promise<void>
434
508
  ```
435
509
 
436
- Initialize AdMob with <a href="#admobinitializationoptions">AdMobInitializationOptions</a>
510
+ Initializes the Google Mobile Ads SDK.
437
511
 
438
- | Param | Type | Description |
439
- | ------------- | --------------------------------------------------------------------------------- | -------------------------------------------------------------------- |
440
- | **`options`** | <code><a href="#admobinitializationoptions">AdMobInitializationOptions</a></code> | <a href="#admobinitializationoptions">AdMobInitializationOptions</a> |
512
+ | Param | Type | Description |
513
+ | ------------- | --------------------------------------------------------------------------------- | ------------------------------------- |
514
+ | **`options`** | <code><a href="#admobinitializationoptions">AdMobInitializationOptions</a></code> | Optional SDK initialization settings. |
441
515
 
442
516
  **Since:** 1.1.2
443
517
 
@@ -450,7 +524,8 @@ Initialize AdMob with <a href="#admobinitializationoptions">AdMobInitializationO
450
524
  trackingAuthorizationStatus() => Promise<TrackingAuthorizationStatusInterface>
451
525
  ```
452
526
 
453
- Confirm requestTrackingAuthorization status (iOS &gt;14)
527
+ Returns the current App Tracking Transparency authorization status on iOS 14 and later.
528
+ Returns `authorized` on earlier iOS versions, Android, and web.
454
529
 
455
530
  **Returns:** <code>Promise&lt;<a href="#trackingauthorizationstatusinterface">TrackingAuthorizationStatusInterface</a>&gt;</code>
456
531
 
@@ -465,7 +540,8 @@ Confirm requestTrackingAuthorization status (iOS &gt;14)
465
540
  requestTrackingAuthorization() => Promise<void>
466
541
  ```
467
542
 
468
- request requestTrackingAuthorization (iOS &gt;14).
543
+ Requests App Tracking Transparency authorization on iOS 14 and later.
544
+ Resolves without taking action on earlier iOS versions, Android, and web.
469
545
 
470
546
  **Since:** 5.2.0
471
547
 
@@ -478,7 +554,7 @@ request requestTrackingAuthorization (iOS &gt;14).
478
554
  setApplicationMuted(options: ApplicationMutedOptions) => Promise<void>
479
555
  ```
480
556
 
481
- Report application mute state to AdMob SDK
557
+ Reports whether the application audio is muted to the Google Mobile Ads SDK.
482
558
 
483
559
  | Param | Type |
484
560
  | ------------- | --------------------------------------------------------------------------- |
@@ -495,7 +571,7 @@ Report application mute state to AdMob SDK
495
571
  setApplicationVolume(options: ApplicationVolumeOptions) => Promise<void>
496
572
  ```
497
573
 
498
- Report application volume to AdMob SDK
574
+ Reports the application audio volume to the Google Mobile Ads SDK.
499
575
 
500
576
  | Param | Type |
501
577
  | ------------- | ----------------------------------------------------------------------------- |
@@ -509,36 +585,46 @@ Report application volume to AdMob SDK
509
585
  ### loadAppOpen(...)
510
586
 
511
587
  ```typescript
512
- loadAppOpen(options: AppOpenAdOptions) => Promise<void>
588
+ loadAppOpen(options: AppOpenAdOptions) => Promise<AdLoadInfo>
513
589
  ```
514
590
 
515
- Load an App Open ad
591
+ Loads an App Open ad and returns the loaded ad unit ID.
516
592
 
517
593
  | Param | Type |
518
594
  | ------------- | ------------------------------------------------------------- |
519
595
  | **`options`** | <code><a href="#appopenadoptions">AppOpenAdOptions</a></code> |
520
596
 
597
+ **Returns:** <code>Promise&lt;<a href="#adloadinfo">AdLoadInfo</a>&gt;</code>
598
+
521
599
  --------------------
522
600
 
523
601
 
524
- ### showAppOpen()
602
+ ### showAppOpen(...)
525
603
 
526
604
  ```typescript
527
- showAppOpen() => Promise<void>
605
+ showAppOpen(options?: AdShowOptions | undefined) => Promise<void>
528
606
  ```
529
607
 
530
- Shows the App Open ad if loaded
608
+ Shows a loaded App Open ad.
609
+
610
+ | Param | Type | Description |
611
+ | ------------- | ------------------------------------------------------- | -------------------------------------------------------------------------------------- |
612
+ | **`options`** | <code><a href="#adshowoptions">AdShowOptions</a></code> | Optional. Pass { adId } to show a specific prepared ad instead of the most recent one. |
531
613
 
532
614
  --------------------
533
615
 
534
616
 
535
- ### isAppOpenLoaded()
617
+ ### isAppOpenLoaded(...)
536
618
 
537
619
  ```typescript
538
- isAppOpenLoaded() => Promise<{ value: boolean; }>
620
+ isAppOpenLoaded(options?: AdShowOptions | undefined) => Promise<{ value: boolean; }>
539
621
  ```
540
622
 
541
- Check if the App Open ad is loaded
623
+ Checks whether an App Open ad is loaded.
624
+
625
+ | Param | Type | Description |
626
+ | ------------- | ------------------------------------------------------- | -------------------------------------------------------------------------------------- |
627
+ | **`options`** | <code><a href="#adshowoptions">AdShowOptions</a></code> | Optional. Pass an adId to check a specific prepared ad instead of the most recent one. |
542
628
 
543
629
  **Returns:** <code>Promise&lt;{ value: boolean; }&gt;</code>
544
630
 
@@ -548,13 +634,15 @@ Check if the App Open ad is loaded
548
634
  ### addListener(AppOpenAdPluginEvents.Loaded, ...)
549
635
 
550
636
  ```typescript
551
- addListener(eventName: AppOpenAdPluginEvents.Loaded, listenerFunc: () => void) => Promise<PluginListenerHandle>
637
+ addListener(eventName: AppOpenAdPluginEvents.Loaded, listenerFunc: (info: AdLoadInfo) => void) => Promise<PluginListenerHandle>
552
638
  ```
553
639
 
640
+ Listens for App Open ad load events.
641
+
554
642
  | Param | Type |
555
643
  | ------------------ | ------------------------------------------------------------------------------ |
556
644
  | **`eventName`** | <code><a href="#appopenadpluginevents">AppOpenAdPluginEvents.Loaded</a></code> |
557
- | **`listenerFunc`** | <code>() =&gt; void</code> |
645
+ | **`listenerFunc`** | <code>(info: <a href="#adloadinfo">AdLoadInfo</a>) =&gt; void</code> |
558
646
 
559
647
  **Returns:** <code>Promise&lt;<a href="#pluginlistenerhandle">PluginListenerHandle</a>&gt;</code>
560
648
 
@@ -567,6 +655,8 @@ addListener(eventName: AppOpenAdPluginEvents.Loaded, listenerFunc: () => void) =
567
655
  addListener(eventName: AppOpenAdPluginEvents.FailedToLoad, listenerFunc: (error: AdMobError) => void) => Promise<PluginListenerHandle>
568
656
  ```
569
657
 
658
+ Listens for App Open ad load failures.
659
+
570
660
  | Param | Type |
571
661
  | ------------------ | ------------------------------------------------------------------------------------ |
572
662
  | **`eventName`** | <code><a href="#appopenadpluginevents">AppOpenAdPluginEvents.FailedToLoad</a></code> |
@@ -583,6 +673,8 @@ addListener(eventName: AppOpenAdPluginEvents.FailedToLoad, listenerFunc: (error:
583
673
  addListener(eventName: AppOpenAdPluginEvents.Opened, listenerFunc: () => void) => Promise<PluginListenerHandle>
584
674
  ```
585
675
 
676
+ Listens for App Open ad opened events.
677
+
586
678
  | Param | Type |
587
679
  | ------------------ | ------------------------------------------------------------------------------ |
588
680
  | **`eventName`** | <code><a href="#appopenadpluginevents">AppOpenAdPluginEvents.Opened</a></code> |
@@ -599,6 +691,8 @@ addListener(eventName: AppOpenAdPluginEvents.Opened, listenerFunc: () => void) =
599
691
  addListener(eventName: AppOpenAdPluginEvents.Closed, listenerFunc: () => void) => Promise<PluginListenerHandle>
600
692
  ```
601
693
 
694
+ Listens for App Open ad closed events.
695
+
602
696
  | Param | Type |
603
697
  | ------------------ | ------------------------------------------------------------------------------ |
604
698
  | **`eventName`** | <code><a href="#appopenadpluginevents">AppOpenAdPluginEvents.Closed</a></code> |
@@ -615,6 +709,8 @@ addListener(eventName: AppOpenAdPluginEvents.Closed, listenerFunc: () => void) =
615
709
  addListener(eventName: AppOpenAdPluginEvents.FailedToShow, listenerFunc: (error: AdMobError) => void) => Promise<PluginListenerHandle>
616
710
  ```
617
711
 
712
+ Listens for App Open ad show failures.
713
+
618
714
  | Param | Type |
619
715
  | ------------------ | ------------------------------------------------------------------------------------ |
620
716
  | **`eventName`** | <code><a href="#appopenadpluginevents">AppOpenAdPluginEvents.FailedToShow</a></code> |
@@ -625,13 +721,31 @@ addListener(eventName: AppOpenAdPluginEvents.FailedToShow, listenerFunc: (error:
625
721
  --------------------
626
722
 
627
723
 
724
+ ### addListener(AppOpenAdPluginEvents.AdImpression, ...)
725
+
726
+ ```typescript
727
+ addListener(eventName: AppOpenAdPluginEvents.AdImpression, listenerFunc: (data: AdMobRevenueData) => void) => Promise<PluginListenerHandle>
728
+ ```
729
+
730
+ Listens for App Open impression-level ad revenue events.
731
+
732
+ | Param | Type |
733
+ | ------------------ | ------------------------------------------------------------------------------------ |
734
+ | **`eventName`** | <code><a href="#appopenadpluginevents">AppOpenAdPluginEvents.AdImpression</a></code> |
735
+ | **`listenerFunc`** | <code>(data: <a href="#admobrevenuedata">AdMobRevenueData</a>) =&gt; void</code> |
736
+
737
+ **Returns:** <code>Promise&lt;<a href="#pluginlistenerhandle">PluginListenerHandle</a>&gt;</code>
738
+
739
+ --------------------
740
+
741
+
628
742
  ### showBanner(...)
629
743
 
630
744
  ```typescript
631
745
  showBanner(options: BannerAdOptions) => Promise<void>
632
746
  ```
633
747
 
634
- Show a banner Ad
748
+ Displays a banner ad.
635
749
 
636
750
  | Param | Type | Description |
637
751
  | ------------- | ----------------------------------------------------------- | ---------------------------------- |
@@ -648,7 +762,7 @@ Show a banner Ad
648
762
  hideBanner() => Promise<void>
649
763
  ```
650
764
 
651
- Hide the banner, remove it from screen, but can show it later
765
+ Hides the current banner without destroying it.
652
766
 
653
767
  **Since:** 1.1.2
654
768
 
@@ -661,7 +775,7 @@ Hide the banner, remove it from screen, but can show it later
661
775
  resumeBanner() => Promise<void>
662
776
  ```
663
777
 
664
- Resume the banner, show it after hide
778
+ Shows a previously hidden banner.
665
779
 
666
780
  **Since:** 1.1.2
667
781
 
@@ -674,7 +788,7 @@ Resume the banner, show it after hide
674
788
  removeBanner() => Promise<void>
675
789
  ```
676
790
 
677
- Destroy the banner, remove it from screen.
791
+ Destroys the current banner and removes it from the screen.
678
792
 
679
793
  **Since:** 1.1.2
680
794
 
@@ -687,6 +801,8 @@ Destroy the banner, remove it from screen.
687
801
  addListener(eventName: BannerAdPluginEvents.SizeChanged, listenerFunc: (info: AdMobBannerSize) => void) => Promise<PluginListenerHandle>
688
802
  ```
689
803
 
804
+ Listens for changes to the displayed banner dimensions.
805
+
690
806
  | Param | Type | Description |
691
807
  | ------------------ | --------------------------------------------------------------------------------- | ------------------- |
692
808
  | **`eventName`** | <code><a href="#banneradpluginevents">BannerAdPluginEvents.SizeChanged</a></code> | bannerAdSizeChanged |
@@ -705,7 +821,7 @@ addListener(eventName: BannerAdPluginEvents.SizeChanged, listenerFunc: (info: Ad
705
821
  addListener(eventName: BannerAdPluginEvents.Loaded, listenerFunc: () => void) => Promise<PluginListenerHandle>
706
822
  ```
707
823
 
708
- Notice: request loaded Banner ad
824
+ Listens for banner ad load events.
709
825
 
710
826
  | Param | Type | Description |
711
827
  | ------------------ | ---------------------------------------------------------------------------- | -------------- |
@@ -725,7 +841,7 @@ Notice: request loaded Banner ad
725
841
  addListener(eventName: BannerAdPluginEvents.FailedToLoad, listenerFunc: (info: AdMobError) => void) => Promise<PluginListenerHandle>
726
842
  ```
727
843
 
728
- Notice: request failed Banner ad
844
+ Listens for banner ad load failures.
729
845
 
730
846
  | Param | Type | Description |
731
847
  | ------------------ | ---------------------------------------------------------------------------------- | -------------------- |
@@ -745,7 +861,7 @@ Notice: request failed Banner ad
745
861
  addListener(eventName: BannerAdPluginEvents.Opened, listenerFunc: () => void) => Promise<PluginListenerHandle>
746
862
  ```
747
863
 
748
- Notice: full-screen banner view will be presented in response to the user clicking on an ad.
864
+ Listens for banner overlay opened events.
749
865
 
750
866
  | Param | Type | Description |
751
867
  | ------------------ | ---------------------------------------------------------------------------- | -------------- |
@@ -765,7 +881,7 @@ Notice: full-screen banner view will be presented in response to the user clicki
765
881
  addListener(eventName: BannerAdPluginEvents.Closed, listenerFunc: () => void) => Promise<PluginListenerHandle>
766
882
  ```
767
883
 
768
- Notice: The full-screen banner view will been dismissed.
884
+ Listens for banner overlay closed events.
769
885
 
770
886
  | Param | Type | Description |
771
887
  | ------------------ | ---------------------------------------------------------------------------- | -------------- |
@@ -785,7 +901,7 @@ Notice: The full-screen banner view will been dismissed.
785
901
  addListener(eventName: BannerAdPluginEvents.AdImpression, listenerFunc: () => void) => Promise<PluginListenerHandle>
786
902
  ```
787
903
 
788
- Unimplemented
904
+ Listens for banner impression events.
789
905
 
790
906
  | Param | Type | Description |
791
907
  | ------------------ | ---------------------------------------------------------------------------------- | ------------ |
@@ -799,6 +915,24 @@ Unimplemented
799
915
  --------------------
800
916
 
801
917
 
918
+ ### addListener(BannerAdPluginEvents.AdPaid, ...)
919
+
920
+ ```typescript
921
+ addListener(eventName: BannerAdPluginEvents.AdPaid, listenerFunc: (data: AdMobRevenueData) => void) => Promise<PluginListenerHandle>
922
+ ```
923
+
924
+ Listens for banner impression-level ad revenue events.
925
+
926
+ | Param | Type |
927
+ | ------------------ | -------------------------------------------------------------------------------- |
928
+ | **`eventName`** | <code><a href="#banneradpluginevents">BannerAdPluginEvents.AdPaid</a></code> |
929
+ | **`listenerFunc`** | <code>(data: <a href="#admobrevenuedata">AdMobRevenueData</a>) =&gt; void</code> |
930
+
931
+ **Returns:** <code>Promise&lt;<a href="#pluginlistenerhandle">PluginListenerHandle</a>&gt;</code>
932
+
933
+ --------------------
934
+
935
+
802
936
  ### requestConsentInfo(...)
803
937
 
804
938
  ```typescript
@@ -865,7 +999,7 @@ Resets the UMP SDK state. Call requestConsentInfo function again to allow user m
865
999
  prepareInterstitial(options: AdOptions) => Promise<AdLoadInfo>
866
1000
  ```
867
1001
 
868
- Prepare interstitial banner
1002
+ Loads an interstitial ad and returns the loaded ad unit ID.
869
1003
 
870
1004
  | Param | Type | Description |
871
1005
  | ------------- | ----------------------------------------------- | ---------------------------------- |
@@ -878,13 +1012,17 @@ Prepare interstitial banner
878
1012
  --------------------
879
1013
 
880
1014
 
881
- ### showInterstitial()
1015
+ ### showInterstitial(...)
882
1016
 
883
1017
  ```typescript
884
- showInterstitial() => Promise<void>
1018
+ showInterstitial(options?: AdShowOptions | undefined) => Promise<void>
885
1019
  ```
886
1020
 
887
- Show interstitial ad when it’s ready
1021
+ Shows a loaded interstitial ad.
1022
+
1023
+ | Param | Type | Description |
1024
+ | ------------- | ------------------------------------------------------- | -------------------------------------------------------------------------------------- |
1025
+ | **`options`** | <code><a href="#adshowoptions">AdShowOptions</a></code> | Optional. Pass { adId } to show a specific prepared ad instead of the most recent one. |
888
1026
 
889
1027
  **Since:** 1.1.2
890
1028
 
@@ -897,6 +1035,8 @@ Show interstitial ad when it’s ready
897
1035
  addListener(eventName: InterstitialAdPluginEvents.FailedToLoad, listenerFunc: (error: AdMobError) => void) => Promise<PluginListenerHandle>
898
1036
  ```
899
1037
 
1038
+ Listens for interstitial ad load failures.
1039
+
900
1040
  | Param | Type |
901
1041
  | ------------------ | ---------------------------------------------------------------------------------------------- |
902
1042
  | **`eventName`** | <code><a href="#interstitialadpluginevents">InterstitialAdPluginEvents.FailedToLoad</a></code> |
@@ -913,6 +1053,8 @@ addListener(eventName: InterstitialAdPluginEvents.FailedToLoad, listenerFunc: (e
913
1053
  addListener(eventName: InterstitialAdPluginEvents.Loaded, listenerFunc: (info: AdLoadInfo) => void) => Promise<PluginListenerHandle>
914
1054
  ```
915
1055
 
1056
+ Listens for interstitial ad load events.
1057
+
916
1058
  | Param | Type |
917
1059
  | ------------------ | ---------------------------------------------------------------------------------------- |
918
1060
  | **`eventName`** | <code><a href="#interstitialadpluginevents">InterstitialAdPluginEvents.Loaded</a></code> |
@@ -929,6 +1071,8 @@ addListener(eventName: InterstitialAdPluginEvents.Loaded, listenerFunc: (info: A
929
1071
  addListener(eventName: InterstitialAdPluginEvents.Dismissed, listenerFunc: () => void) => Promise<PluginListenerHandle>
930
1072
  ```
931
1073
 
1074
+ Listens for interstitial ad dismissed events.
1075
+
932
1076
  | Param | Type |
933
1077
  | ------------------ | ------------------------------------------------------------------------------------------- |
934
1078
  | **`eventName`** | <code><a href="#interstitialadpluginevents">InterstitialAdPluginEvents.Dismissed</a></code> |
@@ -945,6 +1089,8 @@ addListener(eventName: InterstitialAdPluginEvents.Dismissed, listenerFunc: () =>
945
1089
  addListener(eventName: InterstitialAdPluginEvents.FailedToShow, listenerFunc: (error: AdMobError) => void) => Promise<PluginListenerHandle>
946
1090
  ```
947
1091
 
1092
+ Listens for interstitial ad show failures.
1093
+
948
1094
  | Param | Type |
949
1095
  | ------------------ | ---------------------------------------------------------------------------------------------- |
950
1096
  | **`eventName`** | <code><a href="#interstitialadpluginevents">InterstitialAdPluginEvents.FailedToShow</a></code> |
@@ -961,6 +1107,8 @@ addListener(eventName: InterstitialAdPluginEvents.FailedToShow, listenerFunc: (e
961
1107
  addListener(eventName: InterstitialAdPluginEvents.Showed, listenerFunc: () => void) => Promise<PluginListenerHandle>
962
1108
  ```
963
1109
 
1110
+ Listens for interstitial ad shown events.
1111
+
964
1112
  | Param | Type |
965
1113
  | ------------------ | ---------------------------------------------------------------------------------------- |
966
1114
  | **`eventName`** | <code><a href="#interstitialadpluginevents">InterstitialAdPluginEvents.Showed</a></code> |
@@ -971,13 +1119,31 @@ addListener(eventName: InterstitialAdPluginEvents.Showed, listenerFunc: () => vo
971
1119
  --------------------
972
1120
 
973
1121
 
1122
+ ### addListener(InterstitialAdPluginEvents.AdImpression, ...)
1123
+
1124
+ ```typescript
1125
+ addListener(eventName: InterstitialAdPluginEvents.AdImpression, listenerFunc: (data: AdMobRevenueData) => void) => Promise<PluginListenerHandle>
1126
+ ```
1127
+
1128
+ Listens for interstitial impression-level ad revenue events.
1129
+
1130
+ | Param | Type |
1131
+ | ------------------ | ---------------------------------------------------------------------------------------------- |
1132
+ | **`eventName`** | <code><a href="#interstitialadpluginevents">InterstitialAdPluginEvents.AdImpression</a></code> |
1133
+ | **`listenerFunc`** | <code>(data: <a href="#admobrevenuedata">AdMobRevenueData</a>) =&gt; void</code> |
1134
+
1135
+ **Returns:** <code>Promise&lt;<a href="#pluginlistenerhandle">PluginListenerHandle</a>&gt;</code>
1136
+
1137
+ --------------------
1138
+
1139
+
974
1140
  ### prepareRewardVideoAd(...)
975
1141
 
976
1142
  ```typescript
977
1143
  prepareRewardVideoAd(options: RewardAdOptions) => Promise<AdLoadInfo>
978
1144
  ```
979
1145
 
980
- Prepare a reward video ad
1146
+ Loads a rewarded ad and returns the loaded ad unit ID.
981
1147
 
982
1148
  | Param | Type | Description |
983
1149
  | ------------- | ----------------------------------------------------------- | ---------------------------------------------- |
@@ -990,13 +1156,17 @@ Prepare a reward video ad
990
1156
  --------------------
991
1157
 
992
1158
 
993
- ### showRewardVideoAd()
1159
+ ### showRewardVideoAd(...)
994
1160
 
995
1161
  ```typescript
996
- showRewardVideoAd() => Promise<AdMobRewardItem>
1162
+ showRewardVideoAd(options?: AdShowOptions | undefined) => Promise<AdMobRewardItem>
997
1163
  ```
998
1164
 
999
- Show a reward video ad
1165
+ Shows a loaded rewarded ad and resolves when the user earns the reward.
1166
+
1167
+ | Param | Type | Description |
1168
+ | ------------- | ------------------------------------------------------- | -------------------------------------------------------------------------------------- |
1169
+ | **`options`** | <code><a href="#adshowoptions">AdShowOptions</a></code> | Optional. Pass { adId } to show a specific prepared ad instead of the most recent one. |
1000
1170
 
1001
1171
  **Returns:** <code>Promise&lt;<a href="#admobrewarditem">AdMobRewardItem</a>&gt;</code>
1002
1172
 
@@ -1011,6 +1181,8 @@ Show a reward video ad
1011
1181
  addListener(eventName: RewardAdPluginEvents.FailedToLoad, listenerFunc: (error: AdMobError) => void) => Promise<PluginListenerHandle>
1012
1182
  ```
1013
1183
 
1184
+ Listens for rewarded ad load failures.
1185
+
1014
1186
  | Param | Type |
1015
1187
  | ------------------ | ---------------------------------------------------------------------------------- |
1016
1188
  | **`eventName`** | <code><a href="#rewardadpluginevents">RewardAdPluginEvents.FailedToLoad</a></code> |
@@ -1027,6 +1199,8 @@ addListener(eventName: RewardAdPluginEvents.FailedToLoad, listenerFunc: (error:
1027
1199
  addListener(eventName: RewardAdPluginEvents.Loaded, listenerFunc: (info: AdLoadInfo) => void) => Promise<PluginListenerHandle>
1028
1200
  ```
1029
1201
 
1202
+ Listens for rewarded ad load events.
1203
+
1030
1204
  | Param | Type |
1031
1205
  | ------------------ | ---------------------------------------------------------------------------- |
1032
1206
  | **`eventName`** | <code><a href="#rewardadpluginevents">RewardAdPluginEvents.Loaded</a></code> |
@@ -1043,6 +1217,8 @@ addListener(eventName: RewardAdPluginEvents.Loaded, listenerFunc: (info: AdLoadI
1043
1217
  addListener(eventName: RewardAdPluginEvents.Rewarded, listenerFunc: (reward: AdMobRewardItem) => void) => Promise<PluginListenerHandle>
1044
1218
  ```
1045
1219
 
1220
+ Listens for earned reward events.
1221
+
1046
1222
  | Param | Type |
1047
1223
  | ------------------ | -------------------------------------------------------------------------------- |
1048
1224
  | **`eventName`** | <code><a href="#rewardadpluginevents">RewardAdPluginEvents.Rewarded</a></code> |
@@ -1059,6 +1235,8 @@ addListener(eventName: RewardAdPluginEvents.Rewarded, listenerFunc: (reward: AdM
1059
1235
  addListener(eventName: RewardAdPluginEvents.Dismissed, listenerFunc: () => void) => Promise<PluginListenerHandle>
1060
1236
  ```
1061
1237
 
1238
+ Listens for rewarded ad dismissed events.
1239
+
1062
1240
  | Param | Type |
1063
1241
  | ------------------ | ------------------------------------------------------------------------------- |
1064
1242
  | **`eventName`** | <code><a href="#rewardadpluginevents">RewardAdPluginEvents.Dismissed</a></code> |
@@ -1075,6 +1253,8 @@ addListener(eventName: RewardAdPluginEvents.Dismissed, listenerFunc: () => void)
1075
1253
  addListener(eventName: RewardAdPluginEvents.FailedToShow, listenerFunc: (error: AdMobError) => void) => Promise<PluginListenerHandle>
1076
1254
  ```
1077
1255
 
1256
+ Listens for rewarded ad show failures.
1257
+
1078
1258
  | Param | Type |
1079
1259
  | ------------------ | ---------------------------------------------------------------------------------- |
1080
1260
  | **`eventName`** | <code><a href="#rewardadpluginevents">RewardAdPluginEvents.FailedToShow</a></code> |
@@ -1091,6 +1271,8 @@ addListener(eventName: RewardAdPluginEvents.FailedToShow, listenerFunc: (error:
1091
1271
  addListener(eventName: RewardAdPluginEvents.Showed, listenerFunc: () => void) => Promise<PluginListenerHandle>
1092
1272
  ```
1093
1273
 
1274
+ Listens for rewarded ad shown events.
1275
+
1094
1276
  | Param | Type |
1095
1277
  | ------------------ | ---------------------------------------------------------------------------- |
1096
1278
  | **`eventName`** | <code><a href="#rewardadpluginevents">RewardAdPluginEvents.Showed</a></code> |
@@ -1101,17 +1283,35 @@ addListener(eventName: RewardAdPluginEvents.Showed, listenerFunc: () => void) =>
1101
1283
  --------------------
1102
1284
 
1103
1285
 
1286
+ ### addListener(RewardAdPluginEvents.AdImpression, ...)
1287
+
1288
+ ```typescript
1289
+ addListener(eventName: RewardAdPluginEvents.AdImpression, listenerFunc: (data: AdMobRevenueData) => void) => Promise<PluginListenerHandle>
1290
+ ```
1291
+
1292
+ Listens for rewarded impression-level ad revenue events.
1293
+
1294
+ | Param | Type |
1295
+ | ------------------ | ---------------------------------------------------------------------------------- |
1296
+ | **`eventName`** | <code><a href="#rewardadpluginevents">RewardAdPluginEvents.AdImpression</a></code> |
1297
+ | **`listenerFunc`** | <code>(data: <a href="#admobrevenuedata">AdMobRevenueData</a>) =&gt; void</code> |
1298
+
1299
+ **Returns:** <code>Promise&lt;<a href="#pluginlistenerhandle">PluginListenerHandle</a>&gt;</code>
1300
+
1301
+ --------------------
1302
+
1303
+
1104
1304
  ### prepareRewardInterstitialAd(...)
1105
1305
 
1106
1306
  ```typescript
1107
1307
  prepareRewardInterstitialAd(options: RewardInterstitialAdOptions) => Promise<AdLoadInfo>
1108
1308
  ```
1109
1309
 
1110
- Prepare a reward video ad
1310
+ Loads a rewarded interstitial ad and returns the loaded ad unit ID.
1111
1311
 
1112
- | Param | Type | Description |
1113
- | ------------- | ----------------------------------------------------------------------------------- | ---------------------------------------------- |
1114
- | **`options`** | <code><a href="#rewardinterstitialadoptions">RewardInterstitialAdOptions</a></code> | <a href="#rewardadoptions">RewardAdOptions</a> |
1312
+ | Param | Type | Description |
1313
+ | ------------- | ----------------------------------------------------------------------------------- | ---------------------------------------------------------------------- |
1314
+ | **`options`** | <code><a href="#rewardinterstitialadoptions">RewardInterstitialAdOptions</a></code> | <a href="#rewardinterstitialadoptions">RewardInterstitialAdOptions</a> |
1115
1315
 
1116
1316
  **Returns:** <code>Promise&lt;<a href="#adloadinfo">AdLoadInfo</a>&gt;</code>
1117
1317
 
@@ -1120,13 +1320,17 @@ Prepare a reward video ad
1120
1320
  --------------------
1121
1321
 
1122
1322
 
1123
- ### showRewardInterstitialAd()
1323
+ ### showRewardInterstitialAd(...)
1124
1324
 
1125
1325
  ```typescript
1126
- showRewardInterstitialAd() => Promise<AdMobRewardInterstitialItem>
1326
+ showRewardInterstitialAd(options?: AdShowOptions | undefined) => Promise<AdMobRewardInterstitialItem>
1127
1327
  ```
1128
1328
 
1129
- Show a reward video ad
1329
+ Shows a loaded rewarded interstitial ad and resolves when the user earns the reward.
1330
+
1331
+ | Param | Type | Description |
1332
+ | ------------- | ------------------------------------------------------- | -------------------------------------------------------------------------------------- |
1333
+ | **`options`** | <code><a href="#adshowoptions">AdShowOptions</a></code> | Optional. Pass { adId } to show a specific prepared ad instead of the most recent one. |
1130
1334
 
1131
1335
  **Returns:** <code>Promise&lt;<a href="#admobrewardinterstitialitem">AdMobRewardInterstitialItem</a>&gt;</code>
1132
1336
 
@@ -1141,6 +1345,8 @@ Show a reward video ad
1141
1345
  addListener(eventName: RewardInterstitialAdPluginEvents.FailedToLoad, listenerFunc: (error: AdMobError) => void) => Promise<PluginListenerHandle>
1142
1346
  ```
1143
1347
 
1348
+ Listens for rewarded interstitial ad load failures.
1349
+
1144
1350
  | Param | Type |
1145
1351
  | ------------------ | ---------------------------------------------------------------------------------------------------------- |
1146
1352
  | **`eventName`** | <code><a href="#rewardinterstitialadpluginevents">RewardInterstitialAdPluginEvents.FailedToLoad</a></code> |
@@ -1157,6 +1363,8 @@ addListener(eventName: RewardInterstitialAdPluginEvents.FailedToLoad, listenerFu
1157
1363
  addListener(eventName: RewardInterstitialAdPluginEvents.Loaded, listenerFunc: (info: AdLoadInfo) => void) => Promise<PluginListenerHandle>
1158
1364
  ```
1159
1365
 
1366
+ Listens for rewarded interstitial ad load events.
1367
+
1160
1368
  | Param | Type |
1161
1369
  | ------------------ | ---------------------------------------------------------------------------------------------------- |
1162
1370
  | **`eventName`** | <code><a href="#rewardinterstitialadpluginevents">RewardInterstitialAdPluginEvents.Loaded</a></code> |
@@ -1173,6 +1381,8 @@ addListener(eventName: RewardInterstitialAdPluginEvents.Loaded, listenerFunc: (i
1173
1381
  addListener(eventName: RewardInterstitialAdPluginEvents.Rewarded, listenerFunc: (reward: AdMobRewardInterstitialItem) => void) => Promise<PluginListenerHandle>
1174
1382
  ```
1175
1383
 
1384
+ Listens for earned reward events.
1385
+
1176
1386
  | Param | Type |
1177
1387
  | ------------------ | -------------------------------------------------------------------------------------------------------- |
1178
1388
  | **`eventName`** | <code><a href="#rewardinterstitialadpluginevents">RewardInterstitialAdPluginEvents.Rewarded</a></code> |
@@ -1189,6 +1399,8 @@ addListener(eventName: RewardInterstitialAdPluginEvents.Rewarded, listenerFunc:
1189
1399
  addListener(eventName: RewardInterstitialAdPluginEvents.Dismissed, listenerFunc: () => void) => Promise<PluginListenerHandle>
1190
1400
  ```
1191
1401
 
1402
+ Listens for rewarded interstitial ad dismissed events.
1403
+
1192
1404
  | Param | Type |
1193
1405
  | ------------------ | ------------------------------------------------------------------------------------------------------- |
1194
1406
  | **`eventName`** | <code><a href="#rewardinterstitialadpluginevents">RewardInterstitialAdPluginEvents.Dismissed</a></code> |
@@ -1205,6 +1417,8 @@ addListener(eventName: RewardInterstitialAdPluginEvents.Dismissed, listenerFunc:
1205
1417
  addListener(eventName: RewardInterstitialAdPluginEvents.FailedToShow, listenerFunc: (error: AdMobError) => void) => Promise<PluginListenerHandle>
1206
1418
  ```
1207
1419
 
1420
+ Listens for rewarded interstitial ad show failures.
1421
+
1208
1422
  | Param | Type |
1209
1423
  | ------------------ | ---------------------------------------------------------------------------------------------------------- |
1210
1424
  | **`eventName`** | <code><a href="#rewardinterstitialadpluginevents">RewardInterstitialAdPluginEvents.FailedToShow</a></code> |
@@ -1221,6 +1435,8 @@ addListener(eventName: RewardInterstitialAdPluginEvents.FailedToShow, listenerFu
1221
1435
  addListener(eventName: RewardInterstitialAdPluginEvents.Showed, listenerFunc: () => void) => Promise<PluginListenerHandle>
1222
1436
  ```
1223
1437
 
1438
+ Listens for rewarded interstitial ad shown events.
1439
+
1224
1440
  | Param | Type |
1225
1441
  | ------------------ | ---------------------------------------------------------------------------------------------------- |
1226
1442
  | **`eventName`** | <code><a href="#rewardinterstitialadpluginevents">RewardInterstitialAdPluginEvents.Showed</a></code> |
@@ -1231,25 +1447,45 @@ addListener(eventName: RewardInterstitialAdPluginEvents.Showed, listenerFunc: ()
1231
1447
  --------------------
1232
1448
 
1233
1449
 
1450
+ ### addListener(RewardInterstitialAdPluginEvents.AdImpression, ...)
1451
+
1452
+ ```typescript
1453
+ addListener(eventName: RewardInterstitialAdPluginEvents.AdImpression, listenerFunc: (data: AdMobRevenueData) => void) => Promise<PluginListenerHandle>
1454
+ ```
1455
+
1456
+ Listens for rewarded interstitial impression-level ad revenue events.
1457
+
1458
+ | Param | Type |
1459
+ | ------------------ | ---------------------------------------------------------------------------------------------------------- |
1460
+ | **`eventName`** | <code><a href="#rewardinterstitialadpluginevents">RewardInterstitialAdPluginEvents.AdImpression</a></code> |
1461
+ | **`listenerFunc`** | <code>(data: <a href="#admobrevenuedata">AdMobRevenueData</a>) =&gt; void</code> |
1462
+
1463
+ **Returns:** <code>Promise&lt;<a href="#pluginlistenerhandle">PluginListenerHandle</a>&gt;</code>
1464
+
1465
+ --------------------
1466
+
1467
+
1234
1468
  ### Interfaces
1235
1469
 
1236
1470
 
1237
1471
  #### AdMobInitializationOptions
1238
1472
 
1239
- | Prop | Type | Description | Default | Since |
1240
- | ---------------------------------- | ----------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------ | ----- |
1241
- | **`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 |
1242
- | **`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 |
1243
- | **`tagForChildDirectedTreatment`** | <code>boolean</code> | For purposes of the Children's Online Privacy Protection Act (COPPA), there is a setting called tagForChildDirectedTreatment. | | 3.1.0 |
1244
- | **`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 |
1245
- | **`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 |
1473
+ | Prop | Type | Description | Default | Since |
1474
+ | ---------------------------------- | ----------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------ | ----- |
1475
+ | **`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 |
1476
+ | **`initializeForTesting`** | <code>boolean</code> | Whether to register {@link <a href="#admobinitializationoptions">AdMobInitializationOptions.testingDevices</a>} as test devices. | <code>false</code> | 1.2.0 |
1477
+ | **`tagForChildDirectedTreatment`** | <code>boolean</code> | For purposes of the Children's Online Privacy Protection Act (COPPA), there is a setting called tagForChildDirectedTreatment. | | 3.1.0 |
1478
+ | **`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 |
1479
+ | **`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 |
1246
1480
 
1247
1481
 
1248
1482
  #### TrackingAuthorizationStatusInterface
1249
1483
 
1250
- | Prop | Type |
1251
- | ------------ | ------------------------------------------------------------------------ |
1252
- | **`status`** | <code>'authorized' \| 'denied' \| 'notDetermined' \| 'restricted'</code> |
1484
+ The current iOS App Tracking Transparency authorization status.
1485
+
1486
+ | Prop | Type | Description |
1487
+ | ------------ | ------------------------------------------------------------------------ | --------------------------------------------------------------- |
1488
+ | **`status`** | <code>'authorized' \| 'denied' \| 'notDetermined' \| 'restricted'</code> | The authorization status reported by App Tracking Transparency. |
1253
1489
 
1254
1490
 
1255
1491
  #### ApplicationMutedOptions
@@ -1261,16 +1497,36 @@ addListener(eventName: RewardInterstitialAdPluginEvents.Showed, listenerFunc: ()
1261
1497
 
1262
1498
  #### ApplicationVolumeOptions
1263
1499
 
1264
- | Prop | Type | Description | Since |
1265
- | ------------ | ---------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ----- |
1266
- | **`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 |
1500
+ | Prop | Type | Description | Since |
1501
+ | ------------ | ---------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----- |
1502
+ | **`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 |
1503
+
1504
+
1505
+ #### AdLoadInfo
1506
+
1507
+ Information returned after an ad loads successfully.
1508
+
1509
+ | Prop | Type | Description |
1510
+ | -------------- | ------------------- | -------------------------------- |
1511
+ | **`adUnitId`** | <code>string</code> | The ad unit ID of the loaded ad. |
1267
1512
 
1268
1513
 
1269
1514
  #### AppOpenAdOptions
1270
1515
 
1271
- | Prop | Type |
1272
- | ---------- | ------------------- |
1273
- | **`adId`** | <code>string</code> |
1516
+ Options for loading an App Open ad.
1517
+
1518
+ | Prop | Type | Description |
1519
+ | ---------- | ------------------- | -------------------------------- |
1520
+ | **`adId`** | <code>string</code> | The App Open ad unit ID to load. |
1521
+
1522
+
1523
+ #### AdShowOptions
1524
+
1525
+ Options for selecting a previously loaded ad to show or inspect.
1526
+
1527
+ | Prop | Type | Description | Since |
1528
+ | ---------- | ------------------- | ---------------------------------------------------------------------------------------------------------------------- | ----- |
1529
+ | **`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 |
1274
1530
 
1275
1531
 
1276
1532
  #### PluginListenerHandle
@@ -1282,8 +1538,7 @@ addListener(eventName: RewardInterstitialAdPluginEvents.Showed, listenerFunc: ()
1282
1538
 
1283
1539
  #### AdMobError
1284
1540
 
1285
- For more information
1286
- https://developers.google.com/android/reference/com/google/android/gms/ads/AdError
1541
+ An error returned by the Google Mobile Ads SDK.
1287
1542
 
1288
1543
  | Prop | Type | Description |
1289
1544
  | ------------- | ------------------- | -------------------------------------- |
@@ -1291,29 +1546,46 @@ https://developers.google.com/android/reference/com/google/android/gms/ads/AdErr
1291
1546
  | **`message`** | <code>string</code> | Gets the message describing the error. |
1292
1547
 
1293
1548
 
1549
+ #### AdMobRevenueData
1550
+
1551
+ Impression-level ad revenue data emitted by a paid event.
1552
+
1553
+ | Prop | Type | Description |
1554
+ | ------------------ | ------------------------------------------------------------- | ------------------------------------------------------------------------------------------------- |
1555
+ | **`adUnitId`** | <code>string</code> | The ad unit ID associated with the paid event. |
1556
+ | **`valueMicros`** | <code>number</code> | The ad value in micros, where 1,000,000 micros equals one currency unit. |
1557
+ | **`currencyCode`** | <code>string</code> | The ISO 4217 currency code for `valueMicros`. |
1558
+ | **`precision`** | <code><a href="#advalueprecision">AdValuePrecision</a></code> | The precision of the reported ad value. |
1559
+ | **`networkName`** | <code>string</code> | The mediation adapter class name that served the impression, or an empty string when unavailable. |
1560
+ | **`impressionId`** | <code>string</code> | The response identifier associated with the impression, or an empty string when unavailable. |
1561
+
1562
+
1294
1563
  #### BannerAdOptions
1295
1564
 
1296
- This interface extends <a href="#adoptions">AdOptions</a>
1565
+ Options for displaying a banner ad.
1297
1566
 
1298
- | Prop | Type | Description | Default | Since |
1299
- | ------------------- | ------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------- | ----- |
1300
- | **`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 |
1301
- | **`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 |
1302
- | **`adId`** | <code>string</code> | The ad unit ID that you want to request | | 1.1.2 |
1303
- | **`isTesting`** | <code>boolean</code> | You can use test mode of ad. | <code>false</code> | 1.1.2 |
1304
- | **`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 |
1305
- | **`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 |
1306
- | **`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 |
1567
+ This interface extends <a href="#adoptions">AdOptions</a>.
1568
+
1569
+ | Prop | Type | Description | Default | Since |
1570
+ | ------------------- | ------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------- | ----- |
1571
+ | **`adSize`** | <code><a href="#banneradsize">BannerAdSize</a></code> | The banner size to display. | <code>ADAPTIVE_BANNER</code> | 3.0.0 |
1572
+ | **`position`** | <code><a href="#banneradposition">BannerAdPosition</a></code> | The position where the banner is displayed. | <code>TOP_CENTER</code> | 1.1.2 |
1573
+ | **`adId`** | <code>string</code> | The ad unit ID to load. | | 1.1.2 |
1574
+ | **`isTesting`** | <code>boolean</code> | Whether to request a test ad. | <code>false</code> | 1.1.2 |
1575
+ | **`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 |
1576
+ | **`npa`** | <code>boolean</code> | Whether to request non-personalized ads. | <code>false</code> | 1.2.0 |
1577
+ | **`immersiveMode`** | <code>boolean</code> | Whether to display a full-screen ad in immersive mode on Android. | | 7.0.3 |
1307
1578
 
1308
1579
 
1309
1580
  #### AdMobBannerSize
1310
1581
 
1311
- When notice listener of OnAdLoaded, you can get banner size.
1582
+ The displayed banner dimensions in logical display units (dp on Android and points on iOS).
1583
+ A hidden, removed, or failed banner can report both dimensions as `0`.
1312
1584
 
1313
- | Prop | Type |
1314
- | ------------ | ------------------- |
1315
- | **`width`** | <code>number</code> |
1316
- | **`height`** | <code>number</code> |
1585
+ | Prop | Type | Description |
1586
+ | ------------ | ------------------- | ---------------------------- |
1587
+ | **`width`** | <code>number</code> | The displayed banner width. |
1588
+ | **`height`** | <code>number</code> | The displayed banner height. |
1317
1589
 
1318
1590
 
1319
1591
  #### AdmobConsentInfo
@@ -1335,68 +1607,65 @@ When notice listener of OnAdLoaded, you can get banner size.
1335
1607
  | **`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 |
1336
1608
 
1337
1609
 
1338
- #### AdLoadInfo
1339
-
1340
- | Prop | Type |
1341
- | -------------- | ------------------- |
1342
- | **`adUnitId`** | <code>string</code> |
1343
-
1344
-
1345
1610
  #### AdOptions
1346
1611
 
1347
- | Prop | Type | Description | Default | Since |
1348
- | ------------------- | -------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------ | ----- |
1349
- | **`adId`** | <code>string</code> | The ad unit ID that you want to request | | 1.1.2 |
1350
- | **`isTesting`** | <code>boolean</code> | You can use test mode of ad. | <code>false</code> | 1.1.2 |
1351
- | **`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 |
1352
- | **`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 |
1353
- | **`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 |
1612
+ Common options for requesting an ad.
1613
+
1614
+ | Prop | Type | Description | Default | Since |
1615
+ | ------------------- | -------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------ | ----- |
1616
+ | **`adId`** | <code>string</code> | The ad unit ID to load. | | 1.1.2 |
1617
+ | **`isTesting`** | <code>boolean</code> | Whether to request a test ad. | <code>false</code> | 1.1.2 |
1618
+ | **`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 |
1619
+ | **`npa`** | <code>boolean</code> | Whether to request non-personalized ads. | <code>false</code> | 1.2.0 |
1620
+ | **`immersiveMode`** | <code>boolean</code> | Whether to display a full-screen ad in immersive mode on Android. | | 7.0.3 |
1354
1621
 
1355
1622
 
1356
1623
  #### RewardAdOptions
1357
1624
 
1358
- | Prop | Type | Description | Default | Since |
1359
- | ------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------ | ----- |
1360
- | **`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. | | |
1361
- | **`adId`** | <code>string</code> | The ad unit ID that you want to request | | 1.1.2 |
1362
- | **`isTesting`** | <code>boolean</code> | You can use test mode of ad. | <code>false</code> | 1.1.2 |
1363
- | **`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 |
1364
- | **`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 |
1365
- | **`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 |
1625
+ Options for loading a rewarded ad.
1626
+
1627
+ | Prop | Type | Description | Default | Since |
1628
+ | ------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------ | ----- |
1629
+ | **`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`. | | |
1630
+ | **`adId`** | <code>string</code> | The ad unit ID to load. | | 1.1.2 |
1631
+ | **`isTesting`** | <code>boolean</code> | Whether to request a test ad. | <code>false</code> | 1.1.2 |
1632
+ | **`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 |
1633
+ | **`npa`** | <code>boolean</code> | Whether to request non-personalized ads. | <code>false</code> | 1.2.0 |
1634
+ | **`immersiveMode`** | <code>boolean</code> | Whether to display a full-screen ad in immersive mode on Android. | | 7.0.3 |
1366
1635
 
1367
1636
 
1368
1637
  #### AdMobRewardItem
1369
1638
 
1370
- For more information
1371
- https://developers.google.com/admob/android/rewarded-video-adapters?hl=en
1639
+ The reward earned by the user after viewing a rewarded ad.
1372
1640
 
1373
- | Prop | Type | Description |
1374
- | ------------ | ------------------- | ------------------------ |
1375
- | **`type`** | <code>string</code> | Rewarded type user got |
1376
- | **`amount`** | <code>number</code> | Rewarded amount user got |
1641
+ | Prop | Type | Description |
1642
+ | ------------ | ------------------- | ------------------------------------------------ |
1643
+ | **`type`** | <code>string</code> | The reward item type configured for the ad unit. |
1644
+ | **`amount`** | <code>number</code> | The reward amount earned by the user. |
1377
1645
 
1378
1646
 
1379
1647
  #### RewardInterstitialAdOptions
1380
1648
 
1381
- | Prop | Type | Description | Default | Since |
1382
- | ------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------ | ----- |
1383
- | **`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. | | |
1384
- | **`adId`** | <code>string</code> | The ad unit ID that you want to request | | 1.1.2 |
1385
- | **`isTesting`** | <code>boolean</code> | You can use test mode of ad. | <code>false</code> | 1.1.2 |
1386
- | **`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 |
1387
- | **`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 |
1388
- | **`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 |
1649
+ Options for loading a rewarded interstitial ad.
1650
+
1651
+ | Prop | Type | Description | Default | Since |
1652
+ | ------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------ | ----- |
1653
+ | **`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`. | | |
1654
+ | **`adId`** | <code>string</code> | The ad unit ID to load. | | 1.1.2 |
1655
+ | **`isTesting`** | <code>boolean</code> | Whether to request a test ad. | <code>false</code> | 1.1.2 |
1656
+ | **`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 |
1657
+ | **`npa`** | <code>boolean</code> | Whether to request non-personalized ads. | <code>false</code> | 1.2.0 |
1658
+ | **`immersiveMode`** | <code>boolean</code> | Whether to display a full-screen ad in immersive mode on Android. | | 7.0.3 |
1389
1659
 
1390
1660
 
1391
1661
  #### AdMobRewardInterstitialItem
1392
1662
 
1393
- For more information
1394
- https://developers.google.com/admob/android/rewarded-video-adapters?hl=en
1663
+ The reward earned by the user after viewing a rewarded interstitial ad.
1395
1664
 
1396
- | Prop | Type | Description |
1397
- | ------------ | ------------------- | ------------------------ |
1398
- | **`type`** | <code>string</code> | Rewarded type user got |
1399
- | **`amount`** | <code>number</code> | Rewarded amount user got |
1665
+ | Prop | Type | Description |
1666
+ | ------------ | ------------------- | ------------------------------------------------ |
1667
+ | **`type`** | <code>string</code> | The reward item type configured for the ad unit. |
1668
+ | **`amount`** | <code>number</code> | The reward amount earned by the user. |
1400
1669
 
1401
1670
 
1402
1671
  ### Type Aliases
@@ -1429,47 +1698,59 @@ From T, pick a set of properties whose keys are in the union K
1429
1698
 
1430
1699
  #### AppOpenAdPluginEvents
1431
1700
 
1432
- | Members | Value |
1433
- | ------------------ | ------------------------------------ |
1434
- | **`Loaded`** | <code>'appOpenAdLoaded'</code> |
1435
- | **`FailedToLoad`** | <code>'appOpenAdFailedToLoad'</code> |
1436
- | **`Opened`** | <code>'appOpenAdOpened'</code> |
1437
- | **`Closed`** | <code>'appOpenAdClosed'</code> |
1438
- | **`FailedToShow`** | <code>'appOpenAdFailedToShow'</code> |
1701
+ | Members | Value | Description |
1702
+ | ------------------ | ------------------------------------ | --------------------------------------------------------------------- |
1703
+ | **`Loaded`** | <code>'appOpenAdLoaded'</code> | Emits when an App Open ad has loaded. |
1704
+ | **`FailedToLoad`** | <code>'appOpenAdFailedToLoad'</code> | Emits when an App Open ad fails to load. |
1705
+ | **`Opened`** | <code>'appOpenAdOpened'</code> | Emits when an App Open ad is shown. |
1706
+ | **`Closed`** | <code>'appOpenAdClosed'</code> | Emits when an App Open ad is dismissed. |
1707
+ | **`FailedToShow`** | <code>'appOpenAdFailedToShow'</code> | Emits when a loaded App Open ad fails to show. |
1708
+ | **`AdImpression`** | <code>'appOpenAdImpression'</code> | Emits impression-level ad revenue data when a paid event is recorded. |
1709
+
1710
+
1711
+ #### AdValuePrecision
1712
+
1713
+ | Members | Value | Description |
1714
+ | ----------------------- | -------------- | --------------------------------------------------- |
1715
+ | **`Unknown`** | <code>0</code> | The ad value precision is unknown. |
1716
+ | **`Estimated`** | <code>1</code> | The ad value is estimated from aggregated data. |
1717
+ | **`PublisherProvided`** | <code>2</code> | The ad value was provided by the publisher. |
1718
+ | **`Precise`** | <code>3</code> | The ad value is the precise value paid for this ad. |
1439
1719
 
1440
1720
 
1441
1721
  #### BannerAdSize
1442
1722
 
1443
- | Members | Value | Description |
1444
- | ---------------------- | ------------------------------- | --------------------------------------------------------------------------------------------------- |
1445
- | **`BANNER`** | <code>'BANNER'</code> | Mobile Marketing Association (MMA) banner ad size (320x50 density-independent pixels). |
1446
- | **`FULL_BANNER`** | <code>'FULL_BANNER'</code> | Interactive Advertising Bureau (IAB) full banner ad size (468x60 density-independent pixels). |
1447
- | **`LARGE_BANNER`** | <code>'LARGE_BANNER'</code> | Large banner ad size (320x100 density-independent pixels). |
1448
- | **`MEDIUM_RECTANGLE`** | <code>'MEDIUM_RECTANGLE'</code> | Interactive Advertising Bureau (IAB) medium rectangle ad size (300x250 density-independent pixels). |
1449
- | **`LEADERBOARD`** | <code>'LEADERBOARD'</code> | Interactive Advertising Bureau (IAB) leaderboard ad size (728x90 density-independent pixels). |
1450
- | **`ADAPTIVE_BANNER`** | <code>'ADAPTIVE_BANNER'</code> | A dynamically sized banner that is full-width and auto-height. |
1451
- | **`SMART_BANNER`** | <code>'SMART_BANNER'</code> | |
1723
+ | Members | Value | Description |
1724
+ | ---------------------- | ------------------------------- | ------------------------------------------------------------------------------------------------------------------------ |
1725
+ | **`BANNER`** | <code>'BANNER'</code> | Mobile Marketing Association (MMA) banner ad size (320x50 density-independent pixels). |
1726
+ | **`FULL_BANNER`** | <code>'FULL_BANNER'</code> | Interactive Advertising Bureau (IAB) full banner ad size (468x60 density-independent pixels). |
1727
+ | **`LARGE_BANNER`** | <code>'LARGE_BANNER'</code> | Large banner ad size (320x100 density-independent pixels). |
1728
+ | **`MEDIUM_RECTANGLE`** | <code>'MEDIUM_RECTANGLE'</code> | Interactive Advertising Bureau (IAB) medium rectangle ad size (300x250 density-independent pixels). |
1729
+ | **`LEADERBOARD`** | <code>'LEADERBOARD'</code> | Interactive Advertising Bureau (IAB) leaderboard ad size (728x90 density-independent pixels). |
1730
+ | **`ADAPTIVE_BANNER`** | <code>'ADAPTIVE_BANNER'</code> | A dynamically sized banner that is full-width and auto-height. |
1731
+ | **`SMART_BANNER`** | <code>'SMART_BANNER'</code> | A legacy smart banner sized to the screen width. Retained for compatibility; use `ADAPTIVE_BANNER` for new integrations. |
1452
1732
 
1453
1733
 
1454
1734
  #### BannerAdPosition
1455
1735
 
1456
- | Members | Value | Description |
1457
- | ------------------- | ---------------------------- | ----------------------------------------- |
1458
- | **`TOP_CENTER`** | <code>'TOP_CENTER'</code> | Banner position be top-center |
1459
- | **`CENTER`** | <code>'CENTER'</code> | Banner position be center |
1460
- | **`BOTTOM_CENTER`** | <code>'BOTTOM_CENTER'</code> | Banner position be bottom-center(default) |
1736
+ | Members | Value | Description |
1737
+ | ------------------- | ---------------------------- | -------------------------------------------------------- |
1738
+ | **`TOP_CENTER`** | <code>'TOP_CENTER'</code> | Positions the banner at the top center of the screen. |
1739
+ | **`CENTER`** | <code>'CENTER'</code> | Positions the banner at the center of the screen. |
1740
+ | **`BOTTOM_CENTER`** | <code>'BOTTOM_CENTER'</code> | Positions the banner at the bottom center of the screen. |
1461
1741
 
1462
1742
 
1463
1743
  #### BannerAdPluginEvents
1464
1744
 
1465
- | Members | Value | Description |
1466
- | ------------------ | ----------------------------------- | ------------------------------------------------------------------------------------------------------ |
1467
- | **`SizeChanged`** | <code>"bannerAdSizeChanged"</code> | |
1468
- | **`Loaded`** | <code>"bannerAdLoaded"</code> | |
1469
- | **`FailedToLoad`** | <code>"bannerAdFailedToLoad"</code> | |
1470
- | **`Opened`** | <code>"bannerAdOpened"</code> | Open "Adsense" Event after user click banner |
1471
- | **`Closed`** | <code>"bannerAdClosed"</code> | Close "Adsense" Event after user click banner |
1472
- | **`AdImpression`** | <code>"bannerAdImpression"</code> | Similarly, this method should be called when an impression is recorded for the ad by the mediated SDK. |
1745
+ | Members | Value | Description |
1746
+ | ------------------ | ----------------------------------- | --------------------------------------------------------------------- |
1747
+ | **`SizeChanged`** | <code>"bannerAdSizeChanged"</code> | Emits when the displayed banner size changes. |
1748
+ | **`Loaded`** | <code>"bannerAdLoaded"</code> | Emits when a banner ad has loaded. |
1749
+ | **`FailedToLoad`** | <code>"bannerAdFailedToLoad"</code> | Emits when a banner ad fails to load. |
1750
+ | **`Opened`** | <code>"bannerAdOpened"</code> | Emits when a banner opens an overlay after the user taps it. |
1751
+ | **`Closed`** | <code>"bannerAdClosed"</code> | Emits when the banner overlay is closed. |
1752
+ | **`AdImpression`** | <code>"bannerAdImpression"</code> | Emits when an impression is recorded for the banner ad. |
1753
+ | **`AdPaid`** | <code>"bannerAdPaid"</code> | Emits impression-level ad revenue data when a paid event is recorded. |
1473
1754
 
1474
1755
 
1475
1756
  #### AdmobConsentStatus
@@ -1504,37 +1785,40 @@ From T, pick a set of properties whose keys are in the union K
1504
1785
 
1505
1786
  #### InterstitialAdPluginEvents
1506
1787
 
1507
- | Members | Value | Description |
1508
- | ------------------ | ----------------------------------------- | -------------------------------------------------------------------------------------- |
1509
- | **`Loaded`** | <code>'interstitialAdLoaded'</code> | Emits after trying to prepare and Interstitial, when it is loaded and ready to be show |
1510
- | **`FailedToLoad`** | <code>'interstitialAdFailedToLoad'</code> | Emits after trying to prepare and Interstitial, when it could not be loaded |
1511
- | **`Showed`** | <code>'interstitialAdShowed'</code> | Emits when the Interstitial ad is visible to the user |
1512
- | **`FailedToShow`** | <code>'interstitialAdFailedToShow'</code> | Emits when the Interstitial ad is failed to show |
1513
- | **`Dismissed`** | <code>'interstitialAdDismissed'</code> | Emits when the Interstitial ad is not visible to the user anymore. |
1788
+ | Members | Value | Description |
1789
+ | ------------------ | ----------------------------------------- | --------------------------------------------------------------------- |
1790
+ | **`Loaded`** | <code>'interstitialAdLoaded'</code> | Emits when an interstitial ad has loaded and is ready to show. |
1791
+ | **`FailedToLoad`** | <code>'interstitialAdFailedToLoad'</code> | Emits when an interstitial ad fails to load. |
1792
+ | **`Showed`** | <code>'interstitialAdShowed'</code> | Emits when an interstitial ad is shown. |
1793
+ | **`FailedToShow`** | <code>'interstitialAdFailedToShow'</code> | Emits when a loaded interstitial ad fails to show. |
1794
+ | **`Dismissed`** | <code>'interstitialAdDismissed'</code> | Emits when an interstitial ad is dismissed. |
1795
+ | **`AdImpression`** | <code>'interstitialAdImpression'</code> | Emits impression-level ad revenue data when a paid event is recorded. |
1514
1796
 
1515
1797
 
1516
1798
  #### RewardAdPluginEvents
1517
1799
 
1518
- | Members | Value | Description |
1519
- | ------------------ | -------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
1520
- | **`Loaded`** | <code>'onRewardedVideoAdLoaded'</code> | Emits after trying to prepare a RewardAd and the Video is loaded and ready to be show |
1521
- | **`FailedToLoad`** | <code>'onRewardedVideoAdFailedToLoad'</code> | Emits after trying to prepare a RewardAd when it could not be loaded |
1522
- | **`Showed`** | <code>'onRewardedVideoAdShowed'</code> | Emits when the AdReward video is visible to the user |
1523
- | **`FailedToShow`** | <code>'onRewardedVideoAdFailedToShow'</code> | Emits when the AdReward video is failed to show |
1524
- | **`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. |
1525
- | **`Rewarded`** | <code>'onRewardedVideoAdReward'</code> | Emits when user get rewarded from AdReward |
1800
+ | Members | Value | Description |
1801
+ | ------------------ | -------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
1802
+ | **`Loaded`** | <code>'onRewardedVideoAdLoaded'</code> | Emits when a rewarded ad has loaded and is ready to show. |
1803
+ | **`FailedToLoad`** | <code>'onRewardedVideoAdFailedToLoad'</code> | Emits when a rewarded ad fails to load. |
1804
+ | **`Showed`** | <code>'onRewardedVideoAdShowed'</code> | Emits when a rewarded ad is shown. |
1805
+ | **`FailedToShow`** | <code>'onRewardedVideoAdFailedToShow'</code> | Emits when a loaded rewarded ad fails to show. |
1806
+ | **`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. |
1807
+ | **`Rewarded`** | <code>'onRewardedVideoAdReward'</code> | Emits when the user earns the advertised reward. |
1808
+ | **`AdImpression`** | <code>'onRewardedVideoAdImpression'</code> | Emits impression-level ad revenue data when a paid event is recorded. |
1526
1809
 
1527
1810
 
1528
1811
  #### RewardInterstitialAdPluginEvents
1529
1812
 
1530
- | Members | Value | Description |
1531
- | ------------------ | --------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
1532
- | **`Loaded`** | <code>'onRewardedInterstitialAdLoaded'</code> | Emits after trying to prepare a RewardAd and the Video is loaded and ready to be show |
1533
- | **`FailedToLoad`** | <code>'onRewardedInterstitialAdFailedToLoad'</code> | Emits after trying to prepare a RewardAd when it could not be loaded |
1534
- | **`Showed`** | <code>'onRewardedInterstitialAdShowed'</code> | Emits when the AdReward video is visible to the user |
1535
- | **`FailedToShow`** | <code>'onRewardedInterstitialAdFailedToShow'</code> | Emits when the AdReward video is failed to show |
1536
- | **`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. |
1537
- | **`Rewarded`** | <code>'onRewardedInterstitialAdReward'</code> | Emits when user get rewarded from AdReward |
1813
+ | Members | Value | Description |
1814
+ | ------------------ | --------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
1815
+ | **`Loaded`** | <code>'onRewardedInterstitialAdLoaded'</code> | Emits when a rewarded interstitial ad has loaded and is ready to show. |
1816
+ | **`FailedToLoad`** | <code>'onRewardedInterstitialAdFailedToLoad'</code> | Emits when a rewarded interstitial ad fails to load. |
1817
+ | **`Showed`** | <code>'onRewardedInterstitialAdShowed'</code> | Emits when a rewarded interstitial ad is shown. |
1818
+ | **`FailedToShow`** | <code>'onRewardedInterstitialAdFailedToShow'</code> | Emits when a loaded rewarded interstitial ad fails to show. |
1819
+ | **`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. |
1820
+ | **`Rewarded`** | <code>'onRewardedInterstitialAdReward'</code> | Emits when the user earns the advertised reward. |
1821
+ | **`AdImpression`** | <code>'onRewardedInterstitialAdImpression'</code> | Emits impression-level ad revenue data when a paid event is recorded. |
1538
1822
 
1539
1823
  </docgen-api>
1540
1824