@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/dist/docs.json CHANGED
@@ -19,7 +19,7 @@
19
19
  "parameters": [
20
20
  {
21
21
  "name": "options",
22
- "docs": "AdMobInitializationOptions",
22
+ "docs": "Optional SDK initialization settings.",
23
23
  "type": "AdMobInitializationOptions | undefined"
24
24
  }
25
25
  ],
@@ -31,14 +31,14 @@
31
31
  },
32
32
  {
33
33
  "name": "param",
34
- "text": "options AdMobInitializationOptions"
34
+ "text": "options Optional SDK initialization settings."
35
35
  },
36
36
  {
37
37
  "name": "since",
38
38
  "text": "1.1.2"
39
39
  }
40
40
  ],
41
- "docs": "Initialize AdMob with AdMobInitializationOptions",
41
+ "docs": "Initializes the Google Mobile Ads SDK.",
42
42
  "complexTypes": [
43
43
  "AdMobInitializationOptions"
44
44
  ],
@@ -59,7 +59,7 @@
59
59
  "text": "3.1.0"
60
60
  }
61
61
  ],
62
- "docs": "Confirm requestTrackingAuthorization status (iOS >14)",
62
+ "docs": "Returns the current App Tracking Transparency authorization status on iOS 14 and later.\nReturns `authorized` on earlier iOS versions, Android, and web.",
63
63
  "complexTypes": [
64
64
  "TrackingAuthorizationStatusInterface"
65
65
  ],
@@ -73,14 +73,14 @@
73
73
  "tags": [
74
74
  {
75
75
  "name": "see",
76
- "text": "https ://developer.apple.com/documentation/apptrackingtransparency/attrackingmanager/3547038-trackingauthorizationstatus"
76
+ "text": "https ://developer.apple.com/documentation/apptrackingtransparency/attrackingmanager/3547038-requesttrackingauthorization"
77
77
  },
78
78
  {
79
79
  "name": "since",
80
80
  "text": "5.2.0"
81
81
  }
82
82
  ],
83
- "docs": "request requestTrackingAuthorization (iOS >14).",
83
+ "docs": "Requests App Tracking Transparency authorization on iOS 14 and later.\nResolves without taking action on earlier iOS versions, Android, and web.",
84
84
  "complexTypes": [],
85
85
  "slug": "requesttrackingauthorization"
86
86
  },
@@ -98,14 +98,14 @@
98
98
  "tags": [
99
99
  {
100
100
  "name": "see",
101
- "text": "https ://developer.apple.com/documentation/apptrackingtransparency/attrackingmanager/3547038-trackingauthorizationstatus"
101
+ "text": "https ://developers.google.com/admob/android/global-settings"
102
102
  },
103
103
  {
104
104
  "name": "since",
105
105
  "text": "4.1.1"
106
106
  }
107
107
  ],
108
- "docs": "Report application mute state to AdMob SDK",
108
+ "docs": "Reports whether the application audio is muted to the Google Mobile Ads SDK.",
109
109
  "complexTypes": [
110
110
  "ApplicationMutedOptions"
111
111
  ],
@@ -125,14 +125,14 @@
125
125
  "tags": [
126
126
  {
127
127
  "name": "see",
128
- "text": "https ://developer.apple.com/documentation/apptrackingtransparency/attrackingmanager/3547038-trackingauthorizationstatus"
128
+ "text": "https ://developers.google.com/admob/android/global-settings"
129
129
  },
130
130
  {
131
131
  "name": "since",
132
132
  "text": "4.1.1"
133
133
  }
134
134
  ],
135
- "docs": "Report application volume to AdMob SDK",
135
+ "docs": "Reports the application audio volume to the Google Mobile Ads SDK.",
136
136
  "complexTypes": [
137
137
  "ApplicationVolumeOptions"
138
138
  ],
@@ -140,7 +140,7 @@
140
140
  },
141
141
  {
142
142
  "name": "loadAppOpen",
143
- "signature": "(options: AppOpenAdOptions) => Promise<void>",
143
+ "signature": "(options: AppOpenAdOptions) => Promise<AdLoadInfo>",
144
144
  "parameters": [
145
145
  {
146
146
  "name": "options",
@@ -148,37 +148,64 @@
148
148
  "type": "AppOpenAdOptions"
149
149
  }
150
150
  ],
151
- "returns": "Promise<void>",
151
+ "returns": "Promise<AdLoadInfo>",
152
152
  "tags": [],
153
- "docs": "Load an App Open ad",
153
+ "docs": "Loads an App Open ad and returns the loaded ad unit ID.",
154
154
  "complexTypes": [
155
+ "AdLoadInfo",
155
156
  "AppOpenAdOptions"
156
157
  ],
157
158
  "slug": "loadappopen"
158
159
  },
159
160
  {
160
161
  "name": "showAppOpen",
161
- "signature": "() => Promise<void>",
162
- "parameters": [],
162
+ "signature": "(options?: AdShowOptions | undefined) => Promise<void>",
163
+ "parameters": [
164
+ {
165
+ "name": "options",
166
+ "docs": "Optional. Pass { adId } to show a specific prepared ad instead of the most recent one.",
167
+ "type": "AdShowOptions | undefined"
168
+ }
169
+ ],
163
170
  "returns": "Promise<void>",
164
- "tags": [],
165
- "docs": "Shows the App Open ad if loaded",
166
- "complexTypes": [],
171
+ "tags": [
172
+ {
173
+ "name": "param",
174
+ "text": "options Optional. Pass { adId } to show a specific prepared ad instead of the most recent one."
175
+ }
176
+ ],
177
+ "docs": "Shows a loaded App Open ad.",
178
+ "complexTypes": [
179
+ "AdShowOptions"
180
+ ],
167
181
  "slug": "showappopen"
168
182
  },
169
183
  {
170
184
  "name": "isAppOpenLoaded",
171
- "signature": "() => Promise<{ value: boolean; }>",
172
- "parameters": [],
185
+ "signature": "(options?: AdShowOptions | undefined) => Promise<{ value: boolean; }>",
186
+ "parameters": [
187
+ {
188
+ "name": "options",
189
+ "docs": "Optional. Pass an adId to check a specific prepared ad instead of the most recent one.",
190
+ "type": "AdShowOptions | undefined"
191
+ }
192
+ ],
173
193
  "returns": "Promise<{ value: boolean; }>",
174
- "tags": [],
175
- "docs": "Check if the App Open ad is loaded",
176
- "complexTypes": [],
194
+ "tags": [
195
+ {
196
+ "name": "param",
197
+ "text": "options Optional. Pass an adId to check a specific prepared ad instead of the most recent one."
198
+ }
199
+ ],
200
+ "docs": "Checks whether an App Open ad is loaded.",
201
+ "complexTypes": [
202
+ "AdShowOptions"
203
+ ],
177
204
  "slug": "isappopenloaded"
178
205
  },
179
206
  {
180
207
  "name": "addListener",
181
- "signature": "(eventName: AppOpenAdPluginEvents.Loaded, listenerFunc: () => void) => Promise<PluginListenerHandle>",
208
+ "signature": "(eventName: AppOpenAdPluginEvents.Loaded, listenerFunc: (info: AdLoadInfo) => void) => Promise<PluginListenerHandle>",
182
209
  "parameters": [
183
210
  {
184
211
  "name": "eventName",
@@ -188,15 +215,16 @@
188
215
  {
189
216
  "name": "listenerFunc",
190
217
  "docs": "",
191
- "type": "() => void"
218
+ "type": "(info: AdLoadInfo) => void"
192
219
  }
193
220
  ],
194
221
  "returns": "Promise<PluginListenerHandle>",
195
222
  "tags": [],
196
- "docs": "",
223
+ "docs": "Listens for App Open ad load events.",
197
224
  "complexTypes": [
198
225
  "PluginListenerHandle",
199
- "AppOpenAdPluginEvents"
226
+ "AppOpenAdPluginEvents",
227
+ "AdLoadInfo"
200
228
  ],
201
229
  "slug": "addlistenerappopenadplugineventsloaded-"
202
230
  },
@@ -217,7 +245,7 @@
217
245
  ],
218
246
  "returns": "Promise<PluginListenerHandle>",
219
247
  "tags": [],
220
- "docs": "",
248
+ "docs": "Listens for App Open ad load failures.",
221
249
  "complexTypes": [
222
250
  "PluginListenerHandle",
223
251
  "AppOpenAdPluginEvents",
@@ -242,7 +270,7 @@
242
270
  ],
243
271
  "returns": "Promise<PluginListenerHandle>",
244
272
  "tags": [],
245
- "docs": "",
273
+ "docs": "Listens for App Open ad opened events.",
246
274
  "complexTypes": [
247
275
  "PluginListenerHandle",
248
276
  "AppOpenAdPluginEvents"
@@ -266,7 +294,7 @@
266
294
  ],
267
295
  "returns": "Promise<PluginListenerHandle>",
268
296
  "tags": [],
269
- "docs": "",
297
+ "docs": "Listens for App Open ad closed events.",
270
298
  "complexTypes": [
271
299
  "PluginListenerHandle",
272
300
  "AppOpenAdPluginEvents"
@@ -290,7 +318,7 @@
290
318
  ],
291
319
  "returns": "Promise<PluginListenerHandle>",
292
320
  "tags": [],
293
- "docs": "",
321
+ "docs": "Listens for App Open ad show failures.",
294
322
  "complexTypes": [
295
323
  "PluginListenerHandle",
296
324
  "AppOpenAdPluginEvents",
@@ -298,6 +326,31 @@
298
326
  ],
299
327
  "slug": "addlistenerappopenadplugineventsfailedtoshow-"
300
328
  },
329
+ {
330
+ "name": "addListener",
331
+ "signature": "(eventName: AppOpenAdPluginEvents.AdImpression, listenerFunc: (data: AdMobRevenueData) => void) => Promise<PluginListenerHandle>",
332
+ "parameters": [
333
+ {
334
+ "name": "eventName",
335
+ "docs": "",
336
+ "type": "AppOpenAdPluginEvents.AdImpression"
337
+ },
338
+ {
339
+ "name": "listenerFunc",
340
+ "docs": "",
341
+ "type": "(data: AdMobRevenueData) => void"
342
+ }
343
+ ],
344
+ "returns": "Promise<PluginListenerHandle>",
345
+ "tags": [],
346
+ "docs": "Listens for App Open impression-level ad revenue events.",
347
+ "complexTypes": [
348
+ "PluginListenerHandle",
349
+ "AppOpenAdPluginEvents",
350
+ "AdMobRevenueData"
351
+ ],
352
+ "slug": "addlistenerappopenadplugineventsadimpression-"
353
+ },
301
354
  {
302
355
  "name": "showBanner",
303
356
  "signature": "(options: BannerAdOptions) => Promise<void>",
@@ -323,7 +376,7 @@
323
376
  "text": "1.1.2"
324
377
  }
325
378
  ],
326
- "docs": "Show a banner Ad",
379
+ "docs": "Displays a banner ad.",
327
380
  "complexTypes": [
328
381
  "BannerAdOptions"
329
382
  ],
@@ -344,7 +397,7 @@
344
397
  "text": "1.1.2"
345
398
  }
346
399
  ],
347
- "docs": "Hide the banner, remove it from screen, but can show it later",
400
+ "docs": "Hides the current banner without destroying it.",
348
401
  "complexTypes": [],
349
402
  "slug": "hidebanner"
350
403
  },
@@ -363,7 +416,7 @@
363
416
  "text": "1.1.2"
364
417
  }
365
418
  ],
366
- "docs": "Resume the banner, show it after hide",
419
+ "docs": "Shows a previously hidden banner.",
367
420
  "complexTypes": [],
368
421
  "slug": "resumebanner"
369
422
  },
@@ -382,7 +435,7 @@
382
435
  "text": "1.1.2"
383
436
  }
384
437
  ],
385
- "docs": "Destroy the banner, remove it from screen.",
438
+ "docs": "Destroys the current banner and removes it from the screen.",
386
439
  "complexTypes": [],
387
440
  "slug": "removebanner"
388
441
  },
@@ -420,7 +473,7 @@
420
473
  "text": "3.0.0"
421
474
  }
422
475
  ],
423
- "docs": "",
476
+ "docs": "Listens for changes to the displayed banner dimensions.",
424
477
  "complexTypes": [
425
478
  "PluginListenerHandle",
426
479
  "BannerAdPluginEvents",
@@ -462,7 +515,7 @@
462
515
  "text": "3.0.0"
463
516
  }
464
517
  ],
465
- "docs": "Notice: request loaded Banner ad",
518
+ "docs": "Listens for banner ad load events.",
466
519
  "complexTypes": [
467
520
  "PluginListenerHandle",
468
521
  "BannerAdPluginEvents"
@@ -503,7 +556,7 @@
503
556
  "text": "3.0.0"
504
557
  }
505
558
  ],
506
- "docs": "Notice: request failed Banner ad",
559
+ "docs": "Listens for banner ad load failures.",
507
560
  "complexTypes": [
508
561
  "PluginListenerHandle",
509
562
  "BannerAdPluginEvents",
@@ -545,7 +598,7 @@
545
598
  "text": "3.0.0"
546
599
  }
547
600
  ],
548
- "docs": "Notice: full-screen banner view will be presented in response to the user clicking on an ad.",
601
+ "docs": "Listens for banner overlay opened events.",
549
602
  "complexTypes": [
550
603
  "PluginListenerHandle",
551
604
  "BannerAdPluginEvents"
@@ -586,7 +639,7 @@
586
639
  "text": "3.0.0"
587
640
  }
588
641
  ],
589
- "docs": "Notice: The full-screen banner view will been dismissed.",
642
+ "docs": "Listens for banner overlay closed events.",
590
643
  "complexTypes": [
591
644
  "PluginListenerHandle",
592
645
  "BannerAdPluginEvents"
@@ -627,13 +680,43 @@
627
680
  "text": "3.0.0"
628
681
  }
629
682
  ],
630
- "docs": "Unimplemented",
683
+ "docs": "Listens for banner impression events.",
631
684
  "complexTypes": [
632
685
  "PluginListenerHandle",
633
686
  "BannerAdPluginEvents"
634
687
  ],
635
688
  "slug": "addlistenerbanneradplugineventsadimpression-"
636
689
  },
690
+ {
691
+ "name": "addListener",
692
+ "signature": "(eventName: BannerAdPluginEvents.AdPaid, listenerFunc: (data: AdMobRevenueData) => void) => Promise<PluginListenerHandle>",
693
+ "parameters": [
694
+ {
695
+ "name": "eventName",
696
+ "docs": "",
697
+ "type": "BannerAdPluginEvents.AdPaid"
698
+ },
699
+ {
700
+ "name": "listenerFunc",
701
+ "docs": "",
702
+ "type": "(data: AdMobRevenueData) => void"
703
+ }
704
+ ],
705
+ "returns": "Promise<PluginListenerHandle>",
706
+ "tags": [
707
+ {
708
+ "name": "group",
709
+ "text": "Banner"
710
+ }
711
+ ],
712
+ "docs": "Listens for banner impression-level ad revenue events.",
713
+ "complexTypes": [
714
+ "PluginListenerHandle",
715
+ "BannerAdPluginEvents",
716
+ "AdMobRevenueData"
717
+ ],
718
+ "slug": "addlistenerbanneradplugineventsadpaid-"
719
+ },
637
720
  {
638
721
  "name": "requestConsentInfo",
639
722
  "signature": "(options?: AdmobConsentRequestOptions | undefined) => Promise<AdmobConsentInfo>",
@@ -750,7 +833,7 @@
750
833
  "text": "1.1.2"
751
834
  }
752
835
  ],
753
- "docs": "Prepare interstitial banner",
836
+ "docs": "Loads an interstitial ad and returns the loaded ad unit ID.",
754
837
  "complexTypes": [
755
838
  "AdLoadInfo",
756
839
  "AdOptions"
@@ -759,21 +842,33 @@
759
842
  },
760
843
  {
761
844
  "name": "showInterstitial",
762
- "signature": "() => Promise<void>",
763
- "parameters": [],
845
+ "signature": "(options?: AdShowOptions | undefined) => Promise<void>",
846
+ "parameters": [
847
+ {
848
+ "name": "options",
849
+ "docs": "Optional. Pass { adId } to show a specific prepared ad instead of the most recent one.",
850
+ "type": "AdShowOptions | undefined"
851
+ }
852
+ ],
764
853
  "returns": "Promise<void>",
765
854
  "tags": [
766
855
  {
767
856
  "name": "group",
768
857
  "text": "Interstitial"
769
858
  },
859
+ {
860
+ "name": "param",
861
+ "text": "options Optional. Pass { adId } to show a specific prepared ad instead of the most recent one."
862
+ },
770
863
  {
771
864
  "name": "since",
772
865
  "text": "1.1.2"
773
866
  }
774
867
  ],
775
- "docs": "Show interstitial ad when it’s ready",
776
- "complexTypes": [],
868
+ "docs": "Shows a loaded interstitial ad.",
869
+ "complexTypes": [
870
+ "AdShowOptions"
871
+ ],
777
872
  "slug": "showinterstitial"
778
873
  },
779
874
  {
@@ -793,7 +888,7 @@
793
888
  ],
794
889
  "returns": "Promise<PluginListenerHandle>",
795
890
  "tags": [],
796
- "docs": "",
891
+ "docs": "Listens for interstitial ad load failures.",
797
892
  "complexTypes": [
798
893
  "PluginListenerHandle",
799
894
  "InterstitialAdPluginEvents",
@@ -818,7 +913,7 @@
818
913
  ],
819
914
  "returns": "Promise<PluginListenerHandle>",
820
915
  "tags": [],
821
- "docs": "",
916
+ "docs": "Listens for interstitial ad load events.",
822
917
  "complexTypes": [
823
918
  "PluginListenerHandle",
824
919
  "InterstitialAdPluginEvents",
@@ -843,7 +938,7 @@
843
938
  ],
844
939
  "returns": "Promise<PluginListenerHandle>",
845
940
  "tags": [],
846
- "docs": "",
941
+ "docs": "Listens for interstitial ad dismissed events.",
847
942
  "complexTypes": [
848
943
  "PluginListenerHandle",
849
944
  "InterstitialAdPluginEvents"
@@ -867,7 +962,7 @@
867
962
  ],
868
963
  "returns": "Promise<PluginListenerHandle>",
869
964
  "tags": [],
870
- "docs": "",
965
+ "docs": "Listens for interstitial ad show failures.",
871
966
  "complexTypes": [
872
967
  "PluginListenerHandle",
873
968
  "InterstitialAdPluginEvents",
@@ -892,13 +987,38 @@
892
987
  ],
893
988
  "returns": "Promise<PluginListenerHandle>",
894
989
  "tags": [],
895
- "docs": "",
990
+ "docs": "Listens for interstitial ad shown events.",
896
991
  "complexTypes": [
897
992
  "PluginListenerHandle",
898
993
  "InterstitialAdPluginEvents"
899
994
  ],
900
995
  "slug": "addlistenerinterstitialadplugineventsshowed-"
901
996
  },
997
+ {
998
+ "name": "addListener",
999
+ "signature": "(eventName: InterstitialAdPluginEvents.AdImpression, listenerFunc: (data: AdMobRevenueData) => void) => Promise<PluginListenerHandle>",
1000
+ "parameters": [
1001
+ {
1002
+ "name": "eventName",
1003
+ "docs": "",
1004
+ "type": "InterstitialAdPluginEvents.AdImpression"
1005
+ },
1006
+ {
1007
+ "name": "listenerFunc",
1008
+ "docs": "",
1009
+ "type": "(data: AdMobRevenueData) => void"
1010
+ }
1011
+ ],
1012
+ "returns": "Promise<PluginListenerHandle>",
1013
+ "tags": [],
1014
+ "docs": "Listens for interstitial impression-level ad revenue events.",
1015
+ "complexTypes": [
1016
+ "PluginListenerHandle",
1017
+ "InterstitialAdPluginEvents",
1018
+ "AdMobRevenueData"
1019
+ ],
1020
+ "slug": "addlistenerinterstitialadplugineventsadimpression-"
1021
+ },
902
1022
  {
903
1023
  "name": "prepareRewardVideoAd",
904
1024
  "signature": "(options: RewardAdOptions) => Promise<AdLoadInfo>",
@@ -924,7 +1044,7 @@
924
1044
  "text": "1.1.2"
925
1045
  }
926
1046
  ],
927
- "docs": "Prepare a reward video ad",
1047
+ "docs": "Loads a rewarded ad and returns the loaded ad unit ID.",
928
1048
  "complexTypes": [
929
1049
  "AdLoadInfo",
930
1050
  "RewardAdOptions"
@@ -933,22 +1053,33 @@
933
1053
  },
934
1054
  {
935
1055
  "name": "showRewardVideoAd",
936
- "signature": "() => Promise<AdMobRewardItem>",
937
- "parameters": [],
1056
+ "signature": "(options?: AdShowOptions | undefined) => Promise<AdMobRewardItem>",
1057
+ "parameters": [
1058
+ {
1059
+ "name": "options",
1060
+ "docs": "Optional. Pass { adId } to show a specific prepared ad instead of the most recent one.",
1061
+ "type": "AdShowOptions | undefined"
1062
+ }
1063
+ ],
938
1064
  "returns": "Promise<AdMobRewardItem>",
939
1065
  "tags": [
940
1066
  {
941
1067
  "name": "group",
942
1068
  "text": "RewardVideo"
943
1069
  },
1070
+ {
1071
+ "name": "param",
1072
+ "text": "options Optional. Pass { adId } to show a specific prepared ad instead of the most recent one."
1073
+ },
944
1074
  {
945
1075
  "name": "since",
946
1076
  "text": "1.1.2"
947
1077
  }
948
1078
  ],
949
- "docs": "Show a reward video ad",
1079
+ "docs": "Shows a loaded rewarded ad and resolves when the user earns the reward.",
950
1080
  "complexTypes": [
951
- "AdMobRewardItem"
1081
+ "AdMobRewardItem",
1082
+ "AdShowOptions"
952
1083
  ],
953
1084
  "slug": "showrewardvideoad"
954
1085
  },
@@ -969,7 +1100,7 @@
969
1100
  ],
970
1101
  "returns": "Promise<PluginListenerHandle>",
971
1102
  "tags": [],
972
- "docs": "",
1103
+ "docs": "Listens for rewarded ad load failures.",
973
1104
  "complexTypes": [
974
1105
  "PluginListenerHandle",
975
1106
  "RewardAdPluginEvents",
@@ -994,7 +1125,7 @@
994
1125
  ],
995
1126
  "returns": "Promise<PluginListenerHandle>",
996
1127
  "tags": [],
997
- "docs": "",
1128
+ "docs": "Listens for rewarded ad load events.",
998
1129
  "complexTypes": [
999
1130
  "PluginListenerHandle",
1000
1131
  "RewardAdPluginEvents",
@@ -1019,7 +1150,7 @@
1019
1150
  ],
1020
1151
  "returns": "Promise<PluginListenerHandle>",
1021
1152
  "tags": [],
1022
- "docs": "",
1153
+ "docs": "Listens for earned reward events.",
1023
1154
  "complexTypes": [
1024
1155
  "PluginListenerHandle",
1025
1156
  "RewardAdPluginEvents",
@@ -1044,7 +1175,7 @@
1044
1175
  ],
1045
1176
  "returns": "Promise<PluginListenerHandle>",
1046
1177
  "tags": [],
1047
- "docs": "",
1178
+ "docs": "Listens for rewarded ad dismissed events.",
1048
1179
  "complexTypes": [
1049
1180
  "PluginListenerHandle",
1050
1181
  "RewardAdPluginEvents"
@@ -1068,7 +1199,7 @@
1068
1199
  ],
1069
1200
  "returns": "Promise<PluginListenerHandle>",
1070
1201
  "tags": [],
1071
- "docs": "",
1202
+ "docs": "Listens for rewarded ad show failures.",
1072
1203
  "complexTypes": [
1073
1204
  "PluginListenerHandle",
1074
1205
  "RewardAdPluginEvents",
@@ -1093,20 +1224,45 @@
1093
1224
  ],
1094
1225
  "returns": "Promise<PluginListenerHandle>",
1095
1226
  "tags": [],
1096
- "docs": "",
1227
+ "docs": "Listens for rewarded ad shown events.",
1097
1228
  "complexTypes": [
1098
1229
  "PluginListenerHandle",
1099
1230
  "RewardAdPluginEvents"
1100
1231
  ],
1101
1232
  "slug": "addlistenerrewardadplugineventsshowed-"
1102
1233
  },
1234
+ {
1235
+ "name": "addListener",
1236
+ "signature": "(eventName: RewardAdPluginEvents.AdImpression, listenerFunc: (data: AdMobRevenueData) => void) => Promise<PluginListenerHandle>",
1237
+ "parameters": [
1238
+ {
1239
+ "name": "eventName",
1240
+ "docs": "",
1241
+ "type": "RewardAdPluginEvents.AdImpression"
1242
+ },
1243
+ {
1244
+ "name": "listenerFunc",
1245
+ "docs": "",
1246
+ "type": "(data: AdMobRevenueData) => void"
1247
+ }
1248
+ ],
1249
+ "returns": "Promise<PluginListenerHandle>",
1250
+ "tags": [],
1251
+ "docs": "Listens for rewarded impression-level ad revenue events.",
1252
+ "complexTypes": [
1253
+ "PluginListenerHandle",
1254
+ "RewardAdPluginEvents",
1255
+ "AdMobRevenueData"
1256
+ ],
1257
+ "slug": "addlistenerrewardadplugineventsadimpression-"
1258
+ },
1103
1259
  {
1104
1260
  "name": "prepareRewardInterstitialAd",
1105
1261
  "signature": "(options: RewardInterstitialAdOptions) => Promise<AdLoadInfo>",
1106
1262
  "parameters": [
1107
1263
  {
1108
1264
  "name": "options",
1109
- "docs": "RewardAdOptions",
1265
+ "docs": "RewardInterstitialAdOptions",
1110
1266
  "type": "RewardInterstitialAdOptions"
1111
1267
  }
1112
1268
  ],
@@ -1114,18 +1270,18 @@
1114
1270
  "tags": [
1115
1271
  {
1116
1272
  "name": "group",
1117
- "text": "RewardVideo"
1273
+ "text": "RewardInterstitial"
1118
1274
  },
1119
1275
  {
1120
1276
  "name": "param",
1121
- "text": "options RewardAdOptions"
1277
+ "text": "options RewardInterstitialAdOptions"
1122
1278
  },
1123
1279
  {
1124
1280
  "name": "since",
1125
1281
  "text": "1.1.2"
1126
1282
  }
1127
1283
  ],
1128
- "docs": "Prepare a reward video ad",
1284
+ "docs": "Loads a rewarded interstitial ad and returns the loaded ad unit ID.",
1129
1285
  "complexTypes": [
1130
1286
  "AdLoadInfo",
1131
1287
  "RewardInterstitialAdOptions"
@@ -1134,22 +1290,33 @@
1134
1290
  },
1135
1291
  {
1136
1292
  "name": "showRewardInterstitialAd",
1137
- "signature": "() => Promise<AdMobRewardInterstitialItem>",
1138
- "parameters": [],
1293
+ "signature": "(options?: AdShowOptions | undefined) => Promise<AdMobRewardInterstitialItem>",
1294
+ "parameters": [
1295
+ {
1296
+ "name": "options",
1297
+ "docs": "Optional. Pass { adId } to show a specific prepared ad instead of the most recent one.",
1298
+ "type": "AdShowOptions | undefined"
1299
+ }
1300
+ ],
1139
1301
  "returns": "Promise<AdMobRewardInterstitialItem>",
1140
1302
  "tags": [
1141
1303
  {
1142
1304
  "name": "group",
1143
- "text": "RewardVideo"
1305
+ "text": "RewardInterstitial"
1306
+ },
1307
+ {
1308
+ "name": "param",
1309
+ "text": "options Optional. Pass { adId } to show a specific prepared ad instead of the most recent one."
1144
1310
  },
1145
1311
  {
1146
1312
  "name": "since",
1147
1313
  "text": "1.1.2"
1148
1314
  }
1149
1315
  ],
1150
- "docs": "Show a reward video ad",
1316
+ "docs": "Shows a loaded rewarded interstitial ad and resolves when the user earns the reward.",
1151
1317
  "complexTypes": [
1152
- "AdMobRewardInterstitialItem"
1318
+ "AdMobRewardInterstitialItem",
1319
+ "AdShowOptions"
1153
1320
  ],
1154
1321
  "slug": "showrewardinterstitialad"
1155
1322
  },
@@ -1170,7 +1337,7 @@
1170
1337
  ],
1171
1338
  "returns": "Promise<PluginListenerHandle>",
1172
1339
  "tags": [],
1173
- "docs": "",
1340
+ "docs": "Listens for rewarded interstitial ad load failures.",
1174
1341
  "complexTypes": [
1175
1342
  "PluginListenerHandle",
1176
1343
  "RewardInterstitialAdPluginEvents",
@@ -1195,7 +1362,7 @@
1195
1362
  ],
1196
1363
  "returns": "Promise<PluginListenerHandle>",
1197
1364
  "tags": [],
1198
- "docs": "",
1365
+ "docs": "Listens for rewarded interstitial ad load events.",
1199
1366
  "complexTypes": [
1200
1367
  "PluginListenerHandle",
1201
1368
  "RewardInterstitialAdPluginEvents",
@@ -1220,7 +1387,7 @@
1220
1387
  ],
1221
1388
  "returns": "Promise<PluginListenerHandle>",
1222
1389
  "tags": [],
1223
- "docs": "",
1390
+ "docs": "Listens for earned reward events.",
1224
1391
  "complexTypes": [
1225
1392
  "PluginListenerHandle",
1226
1393
  "RewardInterstitialAdPluginEvents",
@@ -1245,7 +1412,7 @@
1245
1412
  ],
1246
1413
  "returns": "Promise<PluginListenerHandle>",
1247
1414
  "tags": [],
1248
- "docs": "",
1415
+ "docs": "Listens for rewarded interstitial ad dismissed events.",
1249
1416
  "complexTypes": [
1250
1417
  "PluginListenerHandle",
1251
1418
  "RewardInterstitialAdPluginEvents"
@@ -1269,7 +1436,7 @@
1269
1436
  ],
1270
1437
  "returns": "Promise<PluginListenerHandle>",
1271
1438
  "tags": [],
1272
- "docs": "",
1439
+ "docs": "Listens for rewarded interstitial ad show failures.",
1273
1440
  "complexTypes": [
1274
1441
  "PluginListenerHandle",
1275
1442
  "RewardInterstitialAdPluginEvents",
@@ -1294,12 +1461,37 @@
1294
1461
  ],
1295
1462
  "returns": "Promise<PluginListenerHandle>",
1296
1463
  "tags": [],
1297
- "docs": "",
1464
+ "docs": "Listens for rewarded interstitial ad shown events.",
1298
1465
  "complexTypes": [
1299
1466
  "PluginListenerHandle",
1300
1467
  "RewardInterstitialAdPluginEvents"
1301
1468
  ],
1302
1469
  "slug": "addlistenerrewardinterstitialadplugineventsshowed-"
1470
+ },
1471
+ {
1472
+ "name": "addListener",
1473
+ "signature": "(eventName: RewardInterstitialAdPluginEvents.AdImpression, listenerFunc: (data: AdMobRevenueData) => void) => Promise<PluginListenerHandle>",
1474
+ "parameters": [
1475
+ {
1476
+ "name": "eventName",
1477
+ "docs": "",
1478
+ "type": "RewardInterstitialAdPluginEvents.AdImpression"
1479
+ },
1480
+ {
1481
+ "name": "listenerFunc",
1482
+ "docs": "",
1483
+ "type": "(data: AdMobRevenueData) => void"
1484
+ }
1485
+ ],
1486
+ "returns": "Promise<PluginListenerHandle>",
1487
+ "tags": [],
1488
+ "docs": "Listens for rewarded interstitial impression-level ad revenue events.",
1489
+ "complexTypes": [
1490
+ "PluginListenerHandle",
1491
+ "RewardInterstitialAdPluginEvents",
1492
+ "AdMobRevenueData"
1493
+ ],
1494
+ "slug": "addlistenerrewardinterstitialadplugineventsadimpression-"
1303
1495
  }
1304
1496
  ],
1305
1497
  "properties": []
@@ -1325,7 +1517,7 @@
1325
1517
  "name": "since"
1326
1518
  }
1327
1519
  ],
1328
- "docs": "An Array of devices IDs that will be marked as tested devices if {@link AdMobInitializationOptions.initializeForTesting} is true\n(Real Ads will be served to Testing devices, but they will not count as 'real').",
1520
+ "docs": "Device IDs to register as test devices when {@link AdMobInitializationOptions.initializeForTesting} is `true`.\nRequests from registered devices receive test ads and do not generate invalid traffic.",
1329
1521
  "complexTypes": [],
1330
1522
  "type": "string[] | undefined"
1331
1523
  },
@@ -1345,7 +1537,7 @@
1345
1537
  "name": "since"
1346
1538
  }
1347
1539
  ],
1348
- "docs": "If set to true, the devices on {@link AdMobInitializationOptions.testingDevices} will\nbe registered to receive test production ads.",
1540
+ "docs": "Whether to register {@link AdMobInitializationOptions.testingDevices} as test devices.",
1349
1541
  "complexTypes": [],
1350
1542
  "type": "boolean | undefined"
1351
1543
  },
@@ -1393,7 +1585,7 @@
1393
1585
  "name": "since"
1394
1586
  }
1395
1587
  ],
1396
- "docs": "As an app developer,\nyou can indicate whether you want Google to treat your content as child-directed when you make an ad request.",
1588
+ "docs": "The maximum ad content rating applied to all ad requests.\nAds with a higher rating are excluded.",
1397
1589
  "complexTypes": [
1398
1590
  "MaxAdContentRating"
1399
1591
  ],
@@ -1404,11 +1596,11 @@
1404
1596
  {
1405
1597
  "name": "TrackingAuthorizationStatusInterface",
1406
1598
  "slug": "trackingauthorizationstatusinterface",
1407
- "docs": "",
1599
+ "docs": "The current iOS App Tracking Transparency authorization status.",
1408
1600
  "tags": [
1409
1601
  {
1410
- "text": "https://developer.apple.com/documentation/apptrackingtransparency/attrackingmanager/authorizationstatus",
1411
- "name": "url"
1602
+ "text": "https ://developer.apple.com/documentation/apptrackingtransparency/attrackingmanager/authorizationstatus",
1603
+ "name": "see"
1412
1604
  }
1413
1605
  ],
1414
1606
  "extends": [],
@@ -1417,7 +1609,7 @@
1417
1609
  {
1418
1610
  "name": "status",
1419
1611
  "tags": [],
1420
- "docs": "",
1612
+ "docs": "The authorization status reported by App Tracking Transparency.",
1421
1613
  "complexTypes": [],
1422
1614
  "type": "'authorized' | 'denied' | 'notDetermined' | 'restricted'"
1423
1615
  }
@@ -1469,16 +1661,33 @@
1469
1661
  "name": "since"
1470
1662
  }
1471
1663
  ],
1472
- "docs": "If your app has its own volume controls (such as custom music or sound effect volumes),\ndisclosing app volume to the Google Mobile Ads SDK allows video ads to respect app volume settings.\nenable set 0.0 - 1.0, any float allowed.",
1664
+ "docs": "If your app has its own volume controls (such as custom music or sound effect volumes),\ndisclosing app volume to the Google Mobile Ads SDK allows video ads to respect app volume settings.\nUse a supported value from 0.0 (silent) to 1.0 (full volume).",
1473
1665
  "complexTypes": [],
1474
1666
  "type": "0 | 1 | 0.1 | 0.2 | 0.3 | 0.4 | 0.5 | 0.6 | 0.7 | 0.8 | 0.9 | undefined"
1475
1667
  }
1476
1668
  ]
1477
1669
  },
1670
+ {
1671
+ "name": "AdLoadInfo",
1672
+ "slug": "adloadinfo",
1673
+ "docs": "Information returned after an ad loads successfully.",
1674
+ "tags": [],
1675
+ "extends": [],
1676
+ "methods": [],
1677
+ "properties": [
1678
+ {
1679
+ "name": "adUnitId",
1680
+ "tags": [],
1681
+ "docs": "The ad unit ID of the loaded ad.",
1682
+ "complexTypes": [],
1683
+ "type": "string"
1684
+ }
1685
+ ]
1686
+ },
1478
1687
  {
1479
1688
  "name": "AppOpenAdOptions",
1480
1689
  "slug": "appopenadoptions",
1481
- "docs": "",
1690
+ "docs": "Options for loading an App Open ad.",
1482
1691
  "tags": [],
1483
1692
  "extends": [],
1484
1693
  "methods": [],
@@ -1486,12 +1695,34 @@
1486
1695
  {
1487
1696
  "name": "adId",
1488
1697
  "tags": [],
1489
- "docs": "",
1698
+ "docs": "The App Open ad unit ID to load.",
1490
1699
  "complexTypes": [],
1491
1700
  "type": "string"
1492
1701
  }
1493
1702
  ]
1494
1703
  },
1704
+ {
1705
+ "name": "AdShowOptions",
1706
+ "slug": "adshowoptions",
1707
+ "docs": "Options for selecting a previously loaded ad to show or inspect.",
1708
+ "tags": [],
1709
+ "extends": [],
1710
+ "methods": [],
1711
+ "properties": [
1712
+ {
1713
+ "name": "adId",
1714
+ "tags": [
1715
+ {
1716
+ "text": "8.0.1",
1717
+ "name": "since"
1718
+ }
1719
+ ],
1720
+ "docs": "The ad unit ID of a previously prepared ad to target.\nIf omitted, the operation targets the most recently prepared ad.",
1721
+ "complexTypes": [],
1722
+ "type": "string | undefined"
1723
+ }
1724
+ ]
1725
+ },
1495
1726
  {
1496
1727
  "name": "PluginListenerHandle",
1497
1728
  "slug": "pluginlistenerhandle",
@@ -1512,8 +1743,13 @@
1512
1743
  {
1513
1744
  "name": "AdMobError",
1514
1745
  "slug": "admoberror",
1515
- "docs": "For more information\r\nhttps://developers.google.com/android/reference/com/google/android/gms/ads/AdError",
1516
- "tags": [],
1746
+ "docs": "An error returned by the Google Mobile Ads SDK.",
1747
+ "tags": [
1748
+ {
1749
+ "text": "https ://developers.google.com/admob/android/reference/com/google/android/gms/ads/AdError",
1750
+ "name": "see"
1751
+ }
1752
+ ],
1517
1753
  "extends": [],
1518
1754
  "methods": [],
1519
1755
  "properties": [
@@ -1533,10 +1769,64 @@
1533
1769
  }
1534
1770
  ]
1535
1771
  },
1772
+ {
1773
+ "name": "AdMobRevenueData",
1774
+ "slug": "admobrevenuedata",
1775
+ "docs": "Impression-level ad revenue data emitted by a paid event.",
1776
+ "tags": [],
1777
+ "extends": [],
1778
+ "methods": [],
1779
+ "properties": [
1780
+ {
1781
+ "name": "adUnitId",
1782
+ "tags": [],
1783
+ "docs": "The ad unit ID associated with the paid event.",
1784
+ "complexTypes": [],
1785
+ "type": "string"
1786
+ },
1787
+ {
1788
+ "name": "valueMicros",
1789
+ "tags": [],
1790
+ "docs": "The ad value in micros, where 1,000,000 micros equals one currency unit.",
1791
+ "complexTypes": [],
1792
+ "type": "number"
1793
+ },
1794
+ {
1795
+ "name": "currencyCode",
1796
+ "tags": [],
1797
+ "docs": "The ISO 4217 currency code for `valueMicros`.",
1798
+ "complexTypes": [],
1799
+ "type": "string"
1800
+ },
1801
+ {
1802
+ "name": "precision",
1803
+ "tags": [],
1804
+ "docs": "The precision of the reported ad value.",
1805
+ "complexTypes": [
1806
+ "AdValuePrecision"
1807
+ ],
1808
+ "type": "AdValuePrecision"
1809
+ },
1810
+ {
1811
+ "name": "networkName",
1812
+ "tags": [],
1813
+ "docs": "The mediation adapter class name that served the impression, or an empty string when unavailable.",
1814
+ "complexTypes": [],
1815
+ "type": "string"
1816
+ },
1817
+ {
1818
+ "name": "impressionId",
1819
+ "tags": [],
1820
+ "docs": "The response identifier associated with the impression, or an empty string when unavailable.",
1821
+ "complexTypes": [],
1822
+ "type": "string"
1823
+ }
1824
+ ]
1825
+ },
1536
1826
  {
1537
1827
  "name": "BannerAdOptions",
1538
1828
  "slug": "banneradoptions",
1539
- "docs": "This interface extends AdOptions",
1829
+ "docs": "Options for displaying a banner ad.\n\nThis interface extends AdOptions.",
1540
1830
  "tags": [],
1541
1831
  "extends": [
1542
1832
  "AdOptions"
@@ -1555,7 +1845,7 @@
1555
1845
  "name": "since"
1556
1846
  }
1557
1847
  ],
1558
- "docs": "Banner Ad Size, defaults to ADAPTIVE_BANNER.\r\nIT can be: ADAPTIVE_BANNER, SMART_BANNER, BANNER,\r\nMEDIUM_RECTANGLE, FULL_BANNER, LEADERBOARD",
1848
+ "docs": "The banner size to display.",
1559
1849
  "complexTypes": [
1560
1850
  "BannerAdSize"
1561
1851
  ],
@@ -1573,7 +1863,7 @@
1573
1863
  "name": "since"
1574
1864
  }
1575
1865
  ],
1576
- "docs": "Set Banner Ad position.\r\nTOP_CENTER or CENTER or BOTTOM_CENTER",
1866
+ "docs": "The position where the banner is displayed.",
1577
1867
  "complexTypes": [
1578
1868
  "BannerAdPosition"
1579
1869
  ],
@@ -1591,7 +1881,7 @@
1591
1881
  "name": "since"
1592
1882
  }
1593
1883
  ],
1594
- "docs": "The ad unit ID that you want to request",
1884
+ "docs": "The ad unit ID to load.",
1595
1885
  "complexTypes": [],
1596
1886
  "type": "string"
1597
1887
  },
@@ -1607,7 +1897,7 @@
1607
1897
  "name": "since"
1608
1898
  }
1609
1899
  ],
1610
- "docs": "You can use test mode of ad.",
1900
+ "docs": "Whether to request a test ad.",
1611
1901
  "complexTypes": [],
1612
1902
  "type": "boolean | undefined"
1613
1903
  },
@@ -1623,7 +1913,7 @@
1623
1913
  "name": "since"
1624
1914
  }
1625
1915
  ],
1626
- "docs": "Margin Banner. Default is 0px;\nIf position is BOTTOM_CENTER, margin is be margin-bottom.\nIf position is TOP_CENTER, margin is be margin-top.",
1916
+ "docs": "The banner margin in logical display units (dp on Android and points on iOS).\nFor `BOTTOM_CENTER`, this is the bottom margin. For `TOP_CENTER`, this is the top margin.",
1627
1917
  "complexTypes": [],
1628
1918
  "type": "number | undefined"
1629
1919
  },
@@ -1647,7 +1937,7 @@
1647
1937
  "name": "since"
1648
1938
  }
1649
1939
  ],
1650
- "docs": "The default behavior of the Google Mobile Ads SDK is to serve personalized ads.\nSet this to true to request Non-Personalized Ads",
1940
+ "docs": "Whether to request non-personalized ads.",
1651
1941
  "complexTypes": [],
1652
1942
  "type": "boolean | undefined"
1653
1943
  },
@@ -1667,7 +1957,7 @@
1667
1957
  "name": "since"
1668
1958
  }
1669
1959
  ],
1670
- "docs": "Sets a flag that controls if this interstitial or reward object will be displayed in immersive mode.\nCall this method before show.\nDuring show, if this flag is on and immersive mode is supported,\nSYSTEM_UI_FLAG_IMMERSIVE_STICKY &SYSTEM_UI_FLAG_HIDE_NAVIGATION will be turned on for interstitial or reward ad.",
1960
+ "docs": "Whether to display a full-screen ad in immersive mode on Android.",
1671
1961
  "complexTypes": [],
1672
1962
  "type": "boolean | undefined"
1673
1963
  }
@@ -1676,7 +1966,7 @@
1676
1966
  {
1677
1967
  "name": "AdMobBannerSize",
1678
1968
  "slug": "admobbannersize",
1679
- "docs": "When notice listener of OnAdLoaded, you can get banner size.",
1969
+ "docs": "The displayed banner dimensions in logical display units (dp on Android and points on iOS).\nA hidden, removed, or failed banner can report both dimensions as `0`.",
1680
1970
  "tags": [],
1681
1971
  "extends": [],
1682
1972
  "methods": [],
@@ -1684,14 +1974,14 @@
1684
1974
  {
1685
1975
  "name": "width",
1686
1976
  "tags": [],
1687
- "docs": "",
1977
+ "docs": "The displayed banner width.",
1688
1978
  "complexTypes": [],
1689
1979
  "type": "number"
1690
1980
  },
1691
1981
  {
1692
1982
  "name": "height",
1693
1983
  "tags": [],
1694
- "docs": "",
1984
+ "docs": "The displayed banner height.",
1695
1985
  "complexTypes": [],
1696
1986
  "type": "number"
1697
1987
  }
@@ -1811,27 +2101,10 @@
1811
2101
  }
1812
2102
  ]
1813
2103
  },
1814
- {
1815
- "name": "AdLoadInfo",
1816
- "slug": "adloadinfo",
1817
- "docs": "",
1818
- "tags": [],
1819
- "extends": [],
1820
- "methods": [],
1821
- "properties": [
1822
- {
1823
- "name": "adUnitId",
1824
- "tags": [],
1825
- "docs": "",
1826
- "complexTypes": [],
1827
- "type": "string"
1828
- }
1829
- ]
1830
- },
1831
2104
  {
1832
2105
  "name": "AdOptions",
1833
2106
  "slug": "adoptions",
1834
- "docs": "",
2107
+ "docs": "Common options for requesting an ad.",
1835
2108
  "tags": [],
1836
2109
  "extends": [],
1837
2110
  "methods": [],
@@ -1848,7 +2121,7 @@
1848
2121
  "name": "since"
1849
2122
  }
1850
2123
  ],
1851
- "docs": "The ad unit ID that you want to request",
2124
+ "docs": "The ad unit ID to load.",
1852
2125
  "complexTypes": [],
1853
2126
  "type": "string"
1854
2127
  },
@@ -1864,7 +2137,7 @@
1864
2137
  "name": "since"
1865
2138
  }
1866
2139
  ],
1867
- "docs": "You can use test mode of ad.",
2140
+ "docs": "Whether to request a test ad.",
1868
2141
  "complexTypes": [],
1869
2142
  "type": "boolean | undefined"
1870
2143
  },
@@ -1880,7 +2153,7 @@
1880
2153
  "name": "since"
1881
2154
  }
1882
2155
  ],
1883
- "docs": "Margin Banner. Default is 0px;\nIf position is BOTTOM_CENTER, margin is be margin-bottom.\nIf position is TOP_CENTER, margin is be margin-top.",
2156
+ "docs": "The banner margin in logical display units (dp on Android and points on iOS).\nFor `BOTTOM_CENTER`, this is the bottom margin. For `TOP_CENTER`, this is the top margin.",
1884
2157
  "complexTypes": [],
1885
2158
  "type": "number | undefined"
1886
2159
  },
@@ -1904,7 +2177,7 @@
1904
2177
  "name": "since"
1905
2178
  }
1906
2179
  ],
1907
- "docs": "The default behavior of the Google Mobile Ads SDK is to serve personalized ads.\nSet this to true to request Non-Personalized Ads",
2180
+ "docs": "Whether to request non-personalized ads.",
1908
2181
  "complexTypes": [],
1909
2182
  "type": "boolean | undefined"
1910
2183
  },
@@ -1924,7 +2197,7 @@
1924
2197
  "name": "since"
1925
2198
  }
1926
2199
  ],
1927
- "docs": "Sets a flag that controls if this interstitial or reward object will be displayed in immersive mode.\nCall this method before show.\nDuring show, if this flag is on and immersive mode is supported,\nSYSTEM_UI_FLAG_IMMERSIVE_STICKY &SYSTEM_UI_FLAG_HIDE_NAVIGATION will be turned on for interstitial or reward ad.",
2200
+ "docs": "Whether to display a full-screen ad in immersive mode on Android.",
1928
2201
  "complexTypes": [],
1929
2202
  "type": "boolean | undefined"
1930
2203
  }
@@ -1933,7 +2206,7 @@
1933
2206
  {
1934
2207
  "name": "RewardAdOptions",
1935
2208
  "slug": "rewardadoptions",
1936
- "docs": "",
2209
+ "docs": "Options for loading a rewarded ad.",
1937
2210
  "tags": [],
1938
2211
  "extends": [
1939
2212
  "AdOptions"
@@ -1948,11 +2221,11 @@
1948
2221
  "name": "see"
1949
2222
  }
1950
2223
  ],
1951
- "docs": "If you have enabled SSV in your AdMob Application. You can provide customData or\na userId be passed to your callback to do further processing on.\n\n*Important* You *HAVE* to define one of them.",
2224
+ "docs": "Server-side verification options for the rewarded ad.\nProvide at least one of `userId` or `customData`.",
1952
2225
  "complexTypes": [
1953
2226
  "AtLeastOne"
1954
2227
  ],
1955
- "type": "AtLeastOne<{\n /**\n * An optional UserId to pass to your SSV callback function.\n */\n userId: string;\n /**\n * An optional custom set of data to pass to your SSV callback function.\n */\n customData: string;\n }>"
2228
+ "type": "AtLeastOne<{\n /**\n * A user identifier passed to the SSV callback.\n */\n userId: string;\n /**\n * Custom data passed to the SSV callback.\n */\n customData: string;\n }>"
1956
2229
  },
1957
2230
  {
1958
2231
  "name": "adId",
@@ -1966,7 +2239,7 @@
1966
2239
  "name": "since"
1967
2240
  }
1968
2241
  ],
1969
- "docs": "The ad unit ID that you want to request",
2242
+ "docs": "The ad unit ID to load.",
1970
2243
  "complexTypes": [],
1971
2244
  "type": "string"
1972
2245
  },
@@ -1982,7 +2255,7 @@
1982
2255
  "name": "since"
1983
2256
  }
1984
2257
  ],
1985
- "docs": "You can use test mode of ad.",
2258
+ "docs": "Whether to request a test ad.",
1986
2259
  "complexTypes": [],
1987
2260
  "type": "boolean | undefined"
1988
2261
  },
@@ -1998,7 +2271,7 @@
1998
2271
  "name": "since"
1999
2272
  }
2000
2273
  ],
2001
- "docs": "Margin Banner. Default is 0px;\nIf position is BOTTOM_CENTER, margin is be margin-bottom.\nIf position is TOP_CENTER, margin is be margin-top.",
2274
+ "docs": "The banner margin in logical display units (dp on Android and points on iOS).\nFor `BOTTOM_CENTER`, this is the bottom margin. For `TOP_CENTER`, this is the top margin.",
2002
2275
  "complexTypes": [],
2003
2276
  "type": "number | undefined"
2004
2277
  },
@@ -2022,7 +2295,7 @@
2022
2295
  "name": "since"
2023
2296
  }
2024
2297
  ],
2025
- "docs": "The default behavior of the Google Mobile Ads SDK is to serve personalized ads.\nSet this to true to request Non-Personalized Ads",
2298
+ "docs": "Whether to request non-personalized ads.",
2026
2299
  "complexTypes": [],
2027
2300
  "type": "boolean | undefined"
2028
2301
  },
@@ -2042,7 +2315,7 @@
2042
2315
  "name": "since"
2043
2316
  }
2044
2317
  ],
2045
- "docs": "Sets a flag that controls if this interstitial or reward object will be displayed in immersive mode.\nCall this method before show.\nDuring show, if this flag is on and immersive mode is supported,\nSYSTEM_UI_FLAG_IMMERSIVE_STICKY &SYSTEM_UI_FLAG_HIDE_NAVIGATION will be turned on for interstitial or reward ad.",
2318
+ "docs": "Whether to display a full-screen ad in immersive mode on Android.",
2046
2319
  "complexTypes": [],
2047
2320
  "type": "boolean | undefined"
2048
2321
  }
@@ -2051,7 +2324,7 @@
2051
2324
  {
2052
2325
  "name": "AdMobRewardItem",
2053
2326
  "slug": "admobrewarditem",
2054
- "docs": "For more information\r\nhttps://developers.google.com/admob/android/rewarded-video-adapters?hl=en",
2327
+ "docs": "The reward earned by the user after viewing a rewarded ad.",
2055
2328
  "tags": [],
2056
2329
  "extends": [],
2057
2330
  "methods": [],
@@ -2059,14 +2332,14 @@
2059
2332
  {
2060
2333
  "name": "type",
2061
2334
  "tags": [],
2062
- "docs": "Rewarded type user got",
2335
+ "docs": "The reward item type configured for the ad unit.",
2063
2336
  "complexTypes": [],
2064
2337
  "type": "string"
2065
2338
  },
2066
2339
  {
2067
2340
  "name": "amount",
2068
2341
  "tags": [],
2069
- "docs": "Rewarded amount user got",
2342
+ "docs": "The reward amount earned by the user.",
2070
2343
  "complexTypes": [],
2071
2344
  "type": "number"
2072
2345
  }
@@ -2075,7 +2348,7 @@
2075
2348
  {
2076
2349
  "name": "RewardInterstitialAdOptions",
2077
2350
  "slug": "rewardinterstitialadoptions",
2078
- "docs": "",
2351
+ "docs": "Options for loading a rewarded interstitial ad.",
2079
2352
  "tags": [],
2080
2353
  "extends": [
2081
2354
  "AdOptions"
@@ -2090,11 +2363,11 @@
2090
2363
  "name": "see"
2091
2364
  }
2092
2365
  ],
2093
- "docs": "If you have enabled SSV in your AdMob Application. You can provide customData or\na userId be passed to your callback to do further processing on.\n\n*Important* You *HAVE* to define one of them.",
2366
+ "docs": "Server-side verification options for the rewarded interstitial ad.\nProvide at least one of `userId` or `customData`.",
2094
2367
  "complexTypes": [
2095
2368
  "AtLeastOne"
2096
2369
  ],
2097
- "type": "AtLeastOne<{\n /**\n * An optional UserId to pass to your SSV callback function.\n */\n userId: string;\n /**\n * An optional custom set of data to pass to your SSV callback function.\n */\n customData: string;\n }>"
2370
+ "type": "AtLeastOne<{\n /**\n * A user identifier passed to the SSV callback.\n */\n userId: string;\n /**\n * Custom data passed to the SSV callback.\n */\n customData: string;\n }>"
2098
2371
  },
2099
2372
  {
2100
2373
  "name": "adId",
@@ -2108,7 +2381,7 @@
2108
2381
  "name": "since"
2109
2382
  }
2110
2383
  ],
2111
- "docs": "The ad unit ID that you want to request",
2384
+ "docs": "The ad unit ID to load.",
2112
2385
  "complexTypes": [],
2113
2386
  "type": "string"
2114
2387
  },
@@ -2124,7 +2397,7 @@
2124
2397
  "name": "since"
2125
2398
  }
2126
2399
  ],
2127
- "docs": "You can use test mode of ad.",
2400
+ "docs": "Whether to request a test ad.",
2128
2401
  "complexTypes": [],
2129
2402
  "type": "boolean | undefined"
2130
2403
  },
@@ -2140,7 +2413,7 @@
2140
2413
  "name": "since"
2141
2414
  }
2142
2415
  ],
2143
- "docs": "Margin Banner. Default is 0px;\nIf position is BOTTOM_CENTER, margin is be margin-bottom.\nIf position is TOP_CENTER, margin is be margin-top.",
2416
+ "docs": "The banner margin in logical display units (dp on Android and points on iOS).\nFor `BOTTOM_CENTER`, this is the bottom margin. For `TOP_CENTER`, this is the top margin.",
2144
2417
  "complexTypes": [],
2145
2418
  "type": "number | undefined"
2146
2419
  },
@@ -2164,7 +2437,7 @@
2164
2437
  "name": "since"
2165
2438
  }
2166
2439
  ],
2167
- "docs": "The default behavior of the Google Mobile Ads SDK is to serve personalized ads.\nSet this to true to request Non-Personalized Ads",
2440
+ "docs": "Whether to request non-personalized ads.",
2168
2441
  "complexTypes": [],
2169
2442
  "type": "boolean | undefined"
2170
2443
  },
@@ -2184,7 +2457,7 @@
2184
2457
  "name": "since"
2185
2458
  }
2186
2459
  ],
2187
- "docs": "Sets a flag that controls if this interstitial or reward object will be displayed in immersive mode.\nCall this method before show.\nDuring show, if this flag is on and immersive mode is supported,\nSYSTEM_UI_FLAG_IMMERSIVE_STICKY &SYSTEM_UI_FLAG_HIDE_NAVIGATION will be turned on for interstitial or reward ad.",
2460
+ "docs": "Whether to display a full-screen ad in immersive mode on Android.",
2188
2461
  "complexTypes": [],
2189
2462
  "type": "boolean | undefined"
2190
2463
  }
@@ -2193,7 +2466,7 @@
2193
2466
  {
2194
2467
  "name": "AdMobRewardInterstitialItem",
2195
2468
  "slug": "admobrewardinterstitialitem",
2196
- "docs": "For more information\nhttps://developers.google.com/admob/android/rewarded-video-adapters?hl=en",
2469
+ "docs": "The reward earned by the user after viewing a rewarded interstitial ad.",
2197
2470
  "tags": [],
2198
2471
  "extends": [],
2199
2472
  "methods": [],
@@ -2201,14 +2474,14 @@
2201
2474
  {
2202
2475
  "name": "type",
2203
2476
  "tags": [],
2204
- "docs": "Rewarded type user got",
2477
+ "docs": "The reward item type configured for the ad unit.",
2205
2478
  "complexTypes": [],
2206
2479
  "type": "string"
2207
2480
  },
2208
2481
  {
2209
2482
  "name": "amount",
2210
2483
  "tags": [],
2211
- "docs": "Rewarded amount user got",
2484
+ "docs": "The reward amount earned by the user.",
2212
2485
  "complexTypes": [],
2213
2486
  "type": "number"
2214
2487
  }
@@ -2254,31 +2527,67 @@
2254
2527
  "name": "Loaded",
2255
2528
  "value": "'appOpenAdLoaded'",
2256
2529
  "tags": [],
2257
- "docs": ""
2530
+ "docs": "Emits when an App Open ad has loaded."
2258
2531
  },
2259
2532
  {
2260
2533
  "name": "FailedToLoad",
2261
2534
  "value": "'appOpenAdFailedToLoad'",
2262
2535
  "tags": [],
2263
- "docs": ""
2536
+ "docs": "Emits when an App Open ad fails to load."
2264
2537
  },
2265
2538
  {
2266
2539
  "name": "Opened",
2267
2540
  "value": "'appOpenAdOpened'",
2268
2541
  "tags": [],
2269
- "docs": ""
2542
+ "docs": "Emits when an App Open ad is shown."
2270
2543
  },
2271
2544
  {
2272
2545
  "name": "Closed",
2273
2546
  "value": "'appOpenAdClosed'",
2274
2547
  "tags": [],
2275
- "docs": ""
2548
+ "docs": "Emits when an App Open ad is dismissed."
2276
2549
  },
2277
2550
  {
2278
2551
  "name": "FailedToShow",
2279
2552
  "value": "'appOpenAdFailedToShow'",
2280
2553
  "tags": [],
2281
- "docs": ""
2554
+ "docs": "Emits when a loaded App Open ad fails to show."
2555
+ },
2556
+ {
2557
+ "name": "AdImpression",
2558
+ "value": "'appOpenAdImpression'",
2559
+ "tags": [],
2560
+ "docs": "Emits impression-level ad revenue data when a paid event is recorded."
2561
+ }
2562
+ ]
2563
+ },
2564
+ {
2565
+ "name": "AdValuePrecision",
2566
+ "slug": "advalueprecision",
2567
+ "members": [
2568
+ {
2569
+ "name": "Unknown",
2570
+ "value": "0",
2571
+ "tags": [],
2572
+ "docs": "The ad value precision is unknown."
2573
+ },
2574
+ {
2575
+ "name": "Estimated",
2576
+ "value": "1",
2577
+ "tags": [],
2578
+ "docs": "The ad value is estimated from aggregated data."
2579
+ },
2580
+ {
2581
+ "name": "PublisherProvided",
2582
+ "value": "2",
2583
+ "tags": [],
2584
+ "docs": "The ad value was provided by the publisher."
2585
+ },
2586
+ {
2587
+ "name": "Precise",
2588
+ "value": "3",
2589
+ "tags": [],
2590
+ "docs": "The ad value is the precise value paid for this ad."
2282
2591
  }
2283
2592
  ]
2284
2593
  },
@@ -2327,11 +2636,11 @@
2327
2636
  "value": "'SMART_BANNER'",
2328
2637
  "tags": [
2329
2638
  {
2330
- "text": "Will be removed in next AdMob versions use `ADAPTIVE_BANNER`\r\nScreen width x 32|50|90",
2639
+ "text": "Use `ADAPTIVE_BANNER` instead.",
2331
2640
  "name": "deprecated"
2332
2641
  }
2333
2642
  ],
2334
- "docs": ""
2643
+ "docs": "A legacy smart banner sized to the screen width.\nRetained for compatibility; use `ADAPTIVE_BANNER` for new integrations."
2335
2644
  }
2336
2645
  ]
2337
2646
  },
@@ -2343,19 +2652,19 @@
2343
2652
  "name": "TOP_CENTER",
2344
2653
  "value": "'TOP_CENTER'",
2345
2654
  "tags": [],
2346
- "docs": "Banner position be top-center"
2655
+ "docs": "Positions the banner at the top center of the screen."
2347
2656
  },
2348
2657
  {
2349
2658
  "name": "CENTER",
2350
2659
  "value": "'CENTER'",
2351
2660
  "tags": [],
2352
- "docs": "Banner position be center"
2661
+ "docs": "Positions the banner at the center of the screen."
2353
2662
  },
2354
2663
  {
2355
2664
  "name": "BOTTOM_CENTER",
2356
2665
  "value": "'BOTTOM_CENTER'",
2357
2666
  "tags": [],
2358
- "docs": "Banner position be bottom-center(default)"
2667
+ "docs": "Positions the banner at the bottom center of the screen."
2359
2668
  }
2360
2669
  ]
2361
2670
  },
@@ -2367,37 +2676,43 @@
2367
2676
  "name": "SizeChanged",
2368
2677
  "value": "\"bannerAdSizeChanged\"",
2369
2678
  "tags": [],
2370
- "docs": ""
2679
+ "docs": "Emits when the displayed banner size changes."
2371
2680
  },
2372
2681
  {
2373
2682
  "name": "Loaded",
2374
2683
  "value": "\"bannerAdLoaded\"",
2375
2684
  "tags": [],
2376
- "docs": ""
2685
+ "docs": "Emits when a banner ad has loaded."
2377
2686
  },
2378
2687
  {
2379
2688
  "name": "FailedToLoad",
2380
2689
  "value": "\"bannerAdFailedToLoad\"",
2381
2690
  "tags": [],
2382
- "docs": ""
2691
+ "docs": "Emits when a banner ad fails to load."
2383
2692
  },
2384
2693
  {
2385
2694
  "name": "Opened",
2386
2695
  "value": "\"bannerAdOpened\"",
2387
2696
  "tags": [],
2388
- "docs": "Open \"Adsense\" Event after user click banner"
2697
+ "docs": "Emits when a banner opens an overlay after the user taps it."
2389
2698
  },
2390
2699
  {
2391
2700
  "name": "Closed",
2392
2701
  "value": "\"bannerAdClosed\"",
2393
2702
  "tags": [],
2394
- "docs": "Close \"Adsense\" Event after user click banner"
2703
+ "docs": "Emits when the banner overlay is closed."
2395
2704
  },
2396
2705
  {
2397
2706
  "name": "AdImpression",
2398
2707
  "value": "\"bannerAdImpression\"",
2399
2708
  "tags": [],
2400
- "docs": "Similarly, this method should be called when an impression is recorded for the ad by the mediated SDK."
2709
+ "docs": "Emits when an impression is recorded for the banner ad."
2710
+ },
2711
+ {
2712
+ "name": "AdPaid",
2713
+ "value": "\"bannerAdPaid\"",
2714
+ "tags": [],
2715
+ "docs": "Emits impression-level ad revenue data when a paid event is recorded."
2401
2716
  }
2402
2717
  ]
2403
2718
  },
@@ -2503,31 +2818,37 @@
2503
2818
  "name": "Loaded",
2504
2819
  "value": "'interstitialAdLoaded'",
2505
2820
  "tags": [],
2506
- "docs": "Emits after trying to prepare and Interstitial, when it is loaded and ready to be show"
2821
+ "docs": "Emits when an interstitial ad has loaded and is ready to show."
2507
2822
  },
2508
2823
  {
2509
2824
  "name": "FailedToLoad",
2510
2825
  "value": "'interstitialAdFailedToLoad'",
2511
2826
  "tags": [],
2512
- "docs": "Emits after trying to prepare and Interstitial, when it could not be loaded"
2827
+ "docs": "Emits when an interstitial ad fails to load."
2513
2828
  },
2514
2829
  {
2515
2830
  "name": "Showed",
2516
2831
  "value": "'interstitialAdShowed'",
2517
2832
  "tags": [],
2518
- "docs": "Emits when the Interstitial ad is visible to the user"
2833
+ "docs": "Emits when an interstitial ad is shown."
2519
2834
  },
2520
2835
  {
2521
2836
  "name": "FailedToShow",
2522
2837
  "value": "'interstitialAdFailedToShow'",
2523
2838
  "tags": [],
2524
- "docs": "Emits when the Interstitial ad is failed to show"
2839
+ "docs": "Emits when a loaded interstitial ad fails to show."
2525
2840
  },
2526
2841
  {
2527
2842
  "name": "Dismissed",
2528
2843
  "value": "'interstitialAdDismissed'",
2529
2844
  "tags": [],
2530
- "docs": "Emits when the Interstitial ad is not visible to the user anymore."
2845
+ "docs": "Emits when an interstitial ad is dismissed."
2846
+ },
2847
+ {
2848
+ "name": "AdImpression",
2849
+ "value": "'interstitialAdImpression'",
2850
+ "tags": [],
2851
+ "docs": "Emits impression-level ad revenue data when a paid event is recorded."
2531
2852
  }
2532
2853
  ]
2533
2854
  },
@@ -2539,37 +2860,43 @@
2539
2860
  "name": "Loaded",
2540
2861
  "value": "'onRewardedVideoAdLoaded'",
2541
2862
  "tags": [],
2542
- "docs": "Emits after trying to prepare a RewardAd and the Video is loaded and ready to be show"
2863
+ "docs": "Emits when a rewarded ad has loaded and is ready to show."
2543
2864
  },
2544
2865
  {
2545
2866
  "name": "FailedToLoad",
2546
2867
  "value": "'onRewardedVideoAdFailedToLoad'",
2547
2868
  "tags": [],
2548
- "docs": "Emits after trying to prepare a RewardAd when it could not be loaded"
2869
+ "docs": "Emits when a rewarded ad fails to load."
2549
2870
  },
2550
2871
  {
2551
2872
  "name": "Showed",
2552
2873
  "value": "'onRewardedVideoAdShowed'",
2553
2874
  "tags": [],
2554
- "docs": "Emits when the AdReward video is visible to the user"
2875
+ "docs": "Emits when a rewarded ad is shown."
2555
2876
  },
2556
2877
  {
2557
2878
  "name": "FailedToShow",
2558
2879
  "value": "'onRewardedVideoAdFailedToShow'",
2559
2880
  "tags": [],
2560
- "docs": "Emits when the AdReward video is failed to show"
2881
+ "docs": "Emits when a loaded rewarded ad fails to show."
2561
2882
  },
2562
2883
  {
2563
2884
  "name": "Dismissed",
2564
2885
  "value": "'onRewardedVideoAdDismissed'",
2565
2886
  "tags": [],
2566
- "docs": "Emits when the AdReward video is not visible to the user anymore.\r\n\r\n**Important**: This has nothing to do with the reward it self. This event\r\nwill emits in this two cases:\r\n1. The user starts the video ad but close it before the reward emit.\r\n2. The user start the video and see it until end, then gets the reward\r\nand after that the ad is closed."
2887
+ "docs": "Emits when a rewarded ad is dismissed.\n\r\nThis event does not indicate whether the user earned a reward. Listen for\n`Rewarded` separately before granting the reward."
2567
2888
  },
2568
2889
  {
2569
2890
  "name": "Rewarded",
2570
2891
  "value": "'onRewardedVideoAdReward'",
2571
2892
  "tags": [],
2572
- "docs": "Emits when user get rewarded from AdReward"
2893
+ "docs": "Emits when the user earns the advertised reward."
2894
+ },
2895
+ {
2896
+ "name": "AdImpression",
2897
+ "value": "'onRewardedVideoAdImpression'",
2898
+ "tags": [],
2899
+ "docs": "Emits impression-level ad revenue data when a paid event is recorded."
2573
2900
  }
2574
2901
  ]
2575
2902
  },
@@ -2581,37 +2908,43 @@
2581
2908
  "name": "Loaded",
2582
2909
  "value": "'onRewardedInterstitialAdLoaded'",
2583
2910
  "tags": [],
2584
- "docs": "Emits after trying to prepare a RewardAd and the Video is loaded and ready to be show"
2911
+ "docs": "Emits when a rewarded interstitial ad has loaded and is ready to show."
2585
2912
  },
2586
2913
  {
2587
2914
  "name": "FailedToLoad",
2588
2915
  "value": "'onRewardedInterstitialAdFailedToLoad'",
2589
2916
  "tags": [],
2590
- "docs": "Emits after trying to prepare a RewardAd when it could not be loaded"
2917
+ "docs": "Emits when a rewarded interstitial ad fails to load."
2591
2918
  },
2592
2919
  {
2593
2920
  "name": "Showed",
2594
2921
  "value": "'onRewardedInterstitialAdShowed'",
2595
2922
  "tags": [],
2596
- "docs": "Emits when the AdReward video is visible to the user"
2923
+ "docs": "Emits when a rewarded interstitial ad is shown."
2597
2924
  },
2598
2925
  {
2599
2926
  "name": "FailedToShow",
2600
2927
  "value": "'onRewardedInterstitialAdFailedToShow'",
2601
2928
  "tags": [],
2602
- "docs": "Emits when the AdReward video is failed to show"
2929
+ "docs": "Emits when a loaded rewarded interstitial ad fails to show."
2603
2930
  },
2604
2931
  {
2605
2932
  "name": "Dismissed",
2606
2933
  "value": "'onRewardedInterstitialAdDismissed'",
2607
2934
  "tags": [],
2608
- "docs": "Emits when the AdReward video is not visible to the user anymore.\n\n**Important**: This has nothing to do with the reward it self. This event\nwill emits in this two cases:\n1. The user starts the video ad but close it before the reward emit.\n2. The user start the video and see it until end, then gets the reward\nand after that the ad is closed."
2935
+ "docs": "Emits when a rewarded interstitial ad is dismissed.\n\nThis event does not indicate whether the user earned a reward. Listen for\n`Rewarded` separately before granting the reward."
2609
2936
  },
2610
2937
  {
2611
2938
  "name": "Rewarded",
2612
2939
  "value": "'onRewardedInterstitialAdReward'",
2613
2940
  "tags": [],
2614
- "docs": "Emits when user get rewarded from AdReward"
2941
+ "docs": "Emits when the user earns the advertised reward."
2942
+ },
2943
+ {
2944
+ "name": "AdImpression",
2945
+ "value": "'onRewardedInterstitialAdImpression'",
2946
+ "tags": [],
2947
+ "docs": "Emits impression-level ad revenue data when a paid event is recorded."
2615
2948
  }
2616
2949
  ]
2617
2950
  }