@capacitor-community/admob 7.0.0-0 → 7.0.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 (3) hide show
  1. package/README.md +841 -0
  2. package/dist/docs.json +1852 -73
  3. package/package.json +3 -3
package/dist/docs.json CHANGED
@@ -129,176 +129,1631 @@
129
129
  "ApplicationVolumeOptions"
130
130
  ],
131
131
  "slug": "setapplicationvolume"
132
+ },
133
+ {
134
+ "name": "showBanner",
135
+ "signature": "(options: BannerAdOptions) => Promise<void>",
136
+ "parameters": [
137
+ {
138
+ "name": "options",
139
+ "docs": "AdOptions",
140
+ "type": "BannerAdOptions"
141
+ }
142
+ ],
143
+ "returns": "Promise<void>",
144
+ "tags": [
145
+ {
146
+ "name": "group",
147
+ "text": "Banner"
148
+ },
149
+ {
150
+ "name": "param",
151
+ "text": "options AdOptions"
152
+ },
153
+ {
154
+ "name": "since",
155
+ "text": "1.1.2"
156
+ }
157
+ ],
158
+ "docs": "Show a banner Ad",
159
+ "complexTypes": [
160
+ "BannerAdOptions"
161
+ ],
162
+ "slug": "showbanner"
163
+ },
164
+ {
165
+ "name": "hideBanner",
166
+ "signature": "() => Promise<void>",
167
+ "parameters": [],
168
+ "returns": "Promise<void>",
169
+ "tags": [
170
+ {
171
+ "name": "group",
172
+ "text": "Banner"
173
+ },
174
+ {
175
+ "name": "since",
176
+ "text": "1.1.2"
177
+ }
178
+ ],
179
+ "docs": "Hide the banner, remove it from screen, but can show it later",
180
+ "complexTypes": [],
181
+ "slug": "hidebanner"
182
+ },
183
+ {
184
+ "name": "resumeBanner",
185
+ "signature": "() => Promise<void>",
186
+ "parameters": [],
187
+ "returns": "Promise<void>",
188
+ "tags": [
189
+ {
190
+ "name": "group",
191
+ "text": "Banner"
192
+ },
193
+ {
194
+ "name": "since",
195
+ "text": "1.1.2"
196
+ }
197
+ ],
198
+ "docs": "Resume the banner, show it after hide",
199
+ "complexTypes": [],
200
+ "slug": "resumebanner"
201
+ },
202
+ {
203
+ "name": "removeBanner",
204
+ "signature": "() => Promise<void>",
205
+ "parameters": [],
206
+ "returns": "Promise<void>",
207
+ "tags": [
208
+ {
209
+ "name": "group",
210
+ "text": "Banner"
211
+ },
212
+ {
213
+ "name": "since",
214
+ "text": "1.1.2"
215
+ }
216
+ ],
217
+ "docs": "Destroy the banner, remove it from screen.",
218
+ "complexTypes": [],
219
+ "slug": "removebanner"
220
+ },
221
+ {
222
+ "name": "addListener",
223
+ "signature": "(eventName: BannerAdPluginEvents.SizeChanged, listenerFunc: (info: AdMobBannerSize) => void) => Promise<PluginListenerHandle>",
224
+ "parameters": [
225
+ {
226
+ "name": "eventName",
227
+ "docs": "bannerAdSizeChanged",
228
+ "type": "BannerAdPluginEvents.SizeChanged"
229
+ },
230
+ {
231
+ "name": "listenerFunc",
232
+ "docs": "",
233
+ "type": "(info: AdMobBannerSize) => void"
234
+ }
235
+ ],
236
+ "returns": "Promise<PluginListenerHandle>",
237
+ "tags": [
238
+ {
239
+ "name": "group",
240
+ "text": "Banner"
241
+ },
242
+ {
243
+ "name": "param",
244
+ "text": "eventName bannerAdSizeChanged"
245
+ },
246
+ {
247
+ "name": "param",
248
+ "text": "listenerFunc"
249
+ },
250
+ {
251
+ "name": "since",
252
+ "text": "3.0.0"
253
+ }
254
+ ],
255
+ "docs": "",
256
+ "complexTypes": [
257
+ "PluginListenerHandle",
258
+ "BannerAdPluginEvents",
259
+ "AdMobBannerSize"
260
+ ],
261
+ "slug": "addlistenerbanneradplugineventssizechanged-"
262
+ },
263
+ {
264
+ "name": "addListener",
265
+ "signature": "(eventName: BannerAdPluginEvents.Loaded, listenerFunc: () => void) => Promise<PluginListenerHandle>",
266
+ "parameters": [
267
+ {
268
+ "name": "eventName",
269
+ "docs": "bannerAdLoaded",
270
+ "type": "BannerAdPluginEvents.Loaded"
271
+ },
272
+ {
273
+ "name": "listenerFunc",
274
+ "docs": "",
275
+ "type": "() => void"
276
+ }
277
+ ],
278
+ "returns": "Promise<PluginListenerHandle>",
279
+ "tags": [
280
+ {
281
+ "name": "group",
282
+ "text": "Banner"
283
+ },
284
+ {
285
+ "name": "param",
286
+ "text": "eventName bannerAdLoaded"
287
+ },
288
+ {
289
+ "name": "param",
290
+ "text": "listenerFunc"
291
+ },
292
+ {
293
+ "name": "since",
294
+ "text": "3.0.0"
295
+ }
296
+ ],
297
+ "docs": "Notice: request loaded Banner ad",
298
+ "complexTypes": [
299
+ "PluginListenerHandle",
300
+ "BannerAdPluginEvents"
301
+ ],
302
+ "slug": "addlistenerbanneradplugineventsloaded-"
303
+ },
304
+ {
305
+ "name": "addListener",
306
+ "signature": "(eventName: BannerAdPluginEvents.FailedToLoad, listenerFunc: (info: AdMobError) => void) => Promise<PluginListenerHandle>",
307
+ "parameters": [
308
+ {
309
+ "name": "eventName",
310
+ "docs": "bannerAdFailedToLoad",
311
+ "type": "BannerAdPluginEvents.FailedToLoad"
312
+ },
313
+ {
314
+ "name": "listenerFunc",
315
+ "docs": "",
316
+ "type": "(info: AdMobError) => void"
317
+ }
318
+ ],
319
+ "returns": "Promise<PluginListenerHandle>",
320
+ "tags": [
321
+ {
322
+ "name": "group",
323
+ "text": "Banner"
324
+ },
325
+ {
326
+ "name": "param",
327
+ "text": "eventName bannerAdFailedToLoad"
328
+ },
329
+ {
330
+ "name": "param",
331
+ "text": "listenerFunc"
332
+ },
333
+ {
334
+ "name": "since",
335
+ "text": "3.0.0"
336
+ }
337
+ ],
338
+ "docs": "Notice: request failed Banner ad",
339
+ "complexTypes": [
340
+ "PluginListenerHandle",
341
+ "BannerAdPluginEvents",
342
+ "AdMobError"
343
+ ],
344
+ "slug": "addlistenerbanneradplugineventsfailedtoload-"
345
+ },
346
+ {
347
+ "name": "addListener",
348
+ "signature": "(eventName: BannerAdPluginEvents.Opened, listenerFunc: () => void) => Promise<PluginListenerHandle>",
349
+ "parameters": [
350
+ {
351
+ "name": "eventName",
352
+ "docs": "bannerAdOpened",
353
+ "type": "BannerAdPluginEvents.Opened"
354
+ },
355
+ {
356
+ "name": "listenerFunc",
357
+ "docs": "",
358
+ "type": "() => void"
359
+ }
360
+ ],
361
+ "returns": "Promise<PluginListenerHandle>",
362
+ "tags": [
363
+ {
364
+ "name": "group",
365
+ "text": "Banner"
366
+ },
367
+ {
368
+ "name": "param",
369
+ "text": "eventName bannerAdOpened"
370
+ },
371
+ {
372
+ "name": "param",
373
+ "text": "listenerFunc"
374
+ },
375
+ {
376
+ "name": "since",
377
+ "text": "3.0.0"
378
+ }
379
+ ],
380
+ "docs": "Notice: full-screen banner view will be presented in response to the user clicking on an ad.",
381
+ "complexTypes": [
382
+ "PluginListenerHandle",
383
+ "BannerAdPluginEvents"
384
+ ],
385
+ "slug": "addlistenerbanneradplugineventsopened-"
386
+ },
387
+ {
388
+ "name": "addListener",
389
+ "signature": "(eventName: BannerAdPluginEvents.Closed, listenerFunc: () => void) => Promise<PluginListenerHandle>",
390
+ "parameters": [
391
+ {
392
+ "name": "eventName",
393
+ "docs": "bannerAdClosed",
394
+ "type": "BannerAdPluginEvents.Closed"
395
+ },
396
+ {
397
+ "name": "listenerFunc",
398
+ "docs": "",
399
+ "type": "() => void"
400
+ }
401
+ ],
402
+ "returns": "Promise<PluginListenerHandle>",
403
+ "tags": [
404
+ {
405
+ "name": "group",
406
+ "text": "Banner"
407
+ },
408
+ {
409
+ "name": "param",
410
+ "text": "eventName bannerAdClosed"
411
+ },
412
+ {
413
+ "name": "param",
414
+ "text": "listenerFunc"
415
+ },
416
+ {
417
+ "name": "since",
418
+ "text": "3.0.0"
419
+ }
420
+ ],
421
+ "docs": "Notice: The full-screen banner view will been dismissed.",
422
+ "complexTypes": [
423
+ "PluginListenerHandle",
424
+ "BannerAdPluginEvents"
425
+ ],
426
+ "slug": "addlistenerbanneradplugineventsclosed-"
427
+ },
428
+ {
429
+ "name": "addListener",
430
+ "signature": "(eventName: BannerAdPluginEvents.AdImpression, listenerFunc: () => void) => Promise<PluginListenerHandle>",
431
+ "parameters": [
432
+ {
433
+ "name": "eventName",
434
+ "docs": "AdImpression",
435
+ "type": "BannerAdPluginEvents.AdImpression"
436
+ },
437
+ {
438
+ "name": "listenerFunc",
439
+ "docs": "",
440
+ "type": "() => void"
441
+ }
442
+ ],
443
+ "returns": "Promise<PluginListenerHandle>",
444
+ "tags": [
445
+ {
446
+ "name": "group",
447
+ "text": "Banner"
448
+ },
449
+ {
450
+ "name": "param",
451
+ "text": "eventName AdImpression"
452
+ },
453
+ {
454
+ "name": "param",
455
+ "text": "listenerFunc"
456
+ },
457
+ {
458
+ "name": "since",
459
+ "text": "3.0.0"
460
+ }
461
+ ],
462
+ "docs": "Unimplemented",
463
+ "complexTypes": [
464
+ "PluginListenerHandle",
465
+ "BannerAdPluginEvents"
466
+ ],
467
+ "slug": "addlistenerbanneradplugineventsadimpression-"
468
+ },
469
+ {
470
+ "name": "requestConsentInfo",
471
+ "signature": "(options?: AdmobConsentRequestOptions | undefined) => Promise<AdmobConsentInfo>",
472
+ "parameters": [
473
+ {
474
+ "name": "options",
475
+ "docs": "ConsentRequestOptions",
476
+ "type": "AdmobConsentRequestOptions | undefined"
477
+ }
478
+ ],
479
+ "returns": "Promise<AdmobConsentInfo>",
480
+ "tags": [
481
+ {
482
+ "name": "group",
483
+ "text": "Consent"
484
+ },
485
+ {
486
+ "name": "param",
487
+ "text": "options ConsentRequestOptions"
488
+ },
489
+ {
490
+ "name": "since",
491
+ "text": "5.0.0"
492
+ }
493
+ ],
494
+ "docs": "Request user consent information",
495
+ "complexTypes": [
496
+ "AdmobConsentInfo",
497
+ "AdmobConsentRequestOptions"
498
+ ],
499
+ "slug": "requestconsentinfo"
500
+ },
501
+ {
502
+ "name": "showConsentForm",
503
+ "signature": "() => Promise<AdmobConsentInfo>",
504
+ "parameters": [],
505
+ "returns": "Promise<AdmobConsentInfo>",
506
+ "tags": [
507
+ {
508
+ "name": "group",
509
+ "text": "Consent"
510
+ },
511
+ {
512
+ "name": "since",
513
+ "text": "5.0.0"
514
+ }
515
+ ],
516
+ "docs": "Shows a google user consent form (rendered from your GDPR message config).",
517
+ "complexTypes": [
518
+ "AdmobConsentInfo"
519
+ ],
520
+ "slug": "showconsentform"
521
+ },
522
+ {
523
+ "name": "resetConsentInfo",
524
+ "signature": "() => Promise<void>",
525
+ "parameters": [],
526
+ "returns": "Promise<void>",
527
+ "tags": [
528
+ {
529
+ "name": "group",
530
+ "text": "Consent"
531
+ },
532
+ {
533
+ "name": "since",
534
+ "text": "5.0.0"
535
+ }
536
+ ],
537
+ "docs": "Resets the UMP SDK state. Call requestConsentInfo function again to allow user modify their consent",
538
+ "complexTypes": [],
539
+ "slug": "resetconsentinfo"
540
+ },
541
+ {
542
+ "name": "prepareInterstitial",
543
+ "signature": "(options: AdOptions) => Promise<AdLoadInfo>",
544
+ "parameters": [
545
+ {
546
+ "name": "options",
547
+ "docs": "AdOptions",
548
+ "type": "AdOptions"
549
+ }
550
+ ],
551
+ "returns": "Promise<AdLoadInfo>",
552
+ "tags": [
553
+ {
554
+ "name": "group",
555
+ "text": "Interstitial"
556
+ },
557
+ {
558
+ "name": "param",
559
+ "text": "options AdOptions"
560
+ },
561
+ {
562
+ "name": "since",
563
+ "text": "1.1.2"
564
+ }
565
+ ],
566
+ "docs": "Prepare interstitial banner",
567
+ "complexTypes": [
568
+ "AdLoadInfo",
569
+ "AdOptions"
570
+ ],
571
+ "slug": "prepareinterstitial"
572
+ },
573
+ {
574
+ "name": "showInterstitial",
575
+ "signature": "() => Promise<void>",
576
+ "parameters": [],
577
+ "returns": "Promise<void>",
578
+ "tags": [
579
+ {
580
+ "name": "group",
581
+ "text": "Interstitial"
582
+ },
583
+ {
584
+ "name": "since",
585
+ "text": "1.1.2"
586
+ }
587
+ ],
588
+ "docs": "Show interstitial ad when it’s ready",
589
+ "complexTypes": [],
590
+ "slug": "showinterstitial"
591
+ },
592
+ {
593
+ "name": "addListener",
594
+ "signature": "(eventName: InterstitialAdPluginEvents.FailedToLoad, listenerFunc: (error: AdMobError) => void) => Promise<PluginListenerHandle>",
595
+ "parameters": [
596
+ {
597
+ "name": "eventName",
598
+ "docs": "",
599
+ "type": "InterstitialAdPluginEvents.FailedToLoad"
600
+ },
601
+ {
602
+ "name": "listenerFunc",
603
+ "docs": "",
604
+ "type": "(error: AdMobError) => void"
605
+ }
606
+ ],
607
+ "returns": "Promise<PluginListenerHandle>",
608
+ "tags": [],
609
+ "docs": "",
610
+ "complexTypes": [
611
+ "PluginListenerHandle",
612
+ "InterstitialAdPluginEvents",
613
+ "AdMobError"
614
+ ],
615
+ "slug": "addlistenerinterstitialadplugineventsfailedtoload-"
616
+ },
617
+ {
618
+ "name": "addListener",
619
+ "signature": "(eventName: InterstitialAdPluginEvents.Loaded, listenerFunc: (info: AdLoadInfo) => void) => Promise<PluginListenerHandle>",
620
+ "parameters": [
621
+ {
622
+ "name": "eventName",
623
+ "docs": "",
624
+ "type": "InterstitialAdPluginEvents.Loaded"
625
+ },
626
+ {
627
+ "name": "listenerFunc",
628
+ "docs": "",
629
+ "type": "(info: AdLoadInfo) => void"
630
+ }
631
+ ],
632
+ "returns": "Promise<PluginListenerHandle>",
633
+ "tags": [],
634
+ "docs": "",
635
+ "complexTypes": [
636
+ "PluginListenerHandle",
637
+ "InterstitialAdPluginEvents",
638
+ "AdLoadInfo"
639
+ ],
640
+ "slug": "addlistenerinterstitialadplugineventsloaded-"
641
+ },
642
+ {
643
+ "name": "addListener",
644
+ "signature": "(eventName: InterstitialAdPluginEvents.Dismissed, listenerFunc: () => void) => Promise<PluginListenerHandle>",
645
+ "parameters": [
646
+ {
647
+ "name": "eventName",
648
+ "docs": "",
649
+ "type": "InterstitialAdPluginEvents.Dismissed"
650
+ },
651
+ {
652
+ "name": "listenerFunc",
653
+ "docs": "",
654
+ "type": "() => void"
655
+ }
656
+ ],
657
+ "returns": "Promise<PluginListenerHandle>",
658
+ "tags": [],
659
+ "docs": "",
660
+ "complexTypes": [
661
+ "PluginListenerHandle",
662
+ "InterstitialAdPluginEvents"
663
+ ],
664
+ "slug": "addlistenerinterstitialadplugineventsdismissed-"
665
+ },
666
+ {
667
+ "name": "addListener",
668
+ "signature": "(eventName: InterstitialAdPluginEvents.FailedToShow, listenerFunc: (error: AdMobError) => void) => Promise<PluginListenerHandle>",
669
+ "parameters": [
670
+ {
671
+ "name": "eventName",
672
+ "docs": "",
673
+ "type": "InterstitialAdPluginEvents.FailedToShow"
674
+ },
675
+ {
676
+ "name": "listenerFunc",
677
+ "docs": "",
678
+ "type": "(error: AdMobError) => void"
679
+ }
680
+ ],
681
+ "returns": "Promise<PluginListenerHandle>",
682
+ "tags": [],
683
+ "docs": "",
684
+ "complexTypes": [
685
+ "PluginListenerHandle",
686
+ "InterstitialAdPluginEvents",
687
+ "AdMobError"
688
+ ],
689
+ "slug": "addlistenerinterstitialadplugineventsfailedtoshow-"
690
+ },
691
+ {
692
+ "name": "addListener",
693
+ "signature": "(eventName: InterstitialAdPluginEvents.Showed, listenerFunc: () => void) => Promise<PluginListenerHandle>",
694
+ "parameters": [
695
+ {
696
+ "name": "eventName",
697
+ "docs": "",
698
+ "type": "InterstitialAdPluginEvents.Showed"
699
+ },
700
+ {
701
+ "name": "listenerFunc",
702
+ "docs": "",
703
+ "type": "() => void"
704
+ }
705
+ ],
706
+ "returns": "Promise<PluginListenerHandle>",
707
+ "tags": [],
708
+ "docs": "",
709
+ "complexTypes": [
710
+ "PluginListenerHandle",
711
+ "InterstitialAdPluginEvents"
712
+ ],
713
+ "slug": "addlistenerinterstitialadplugineventsshowed-"
714
+ },
715
+ {
716
+ "name": "prepareRewardVideoAd",
717
+ "signature": "(options: RewardAdOptions) => Promise<AdLoadInfo>",
718
+ "parameters": [
719
+ {
720
+ "name": "options",
721
+ "docs": "RewardAdOptions",
722
+ "type": "RewardAdOptions"
723
+ }
724
+ ],
725
+ "returns": "Promise<AdLoadInfo>",
726
+ "tags": [
727
+ {
728
+ "name": "group",
729
+ "text": "RewardVideo"
730
+ },
731
+ {
732
+ "name": "param",
733
+ "text": "options RewardAdOptions"
734
+ },
735
+ {
736
+ "name": "since",
737
+ "text": "1.1.2"
738
+ }
739
+ ],
740
+ "docs": "Prepare a reward video ad",
741
+ "complexTypes": [
742
+ "AdLoadInfo",
743
+ "RewardAdOptions"
744
+ ],
745
+ "slug": "preparerewardvideoad"
746
+ },
747
+ {
748
+ "name": "showRewardVideoAd",
749
+ "signature": "() => Promise<AdMobRewardItem>",
750
+ "parameters": [],
751
+ "returns": "Promise<AdMobRewardItem>",
752
+ "tags": [
753
+ {
754
+ "name": "group",
755
+ "text": "RewardVideo"
756
+ },
757
+ {
758
+ "name": "since",
759
+ "text": "1.1.2"
760
+ }
761
+ ],
762
+ "docs": "Show a reward video ad",
763
+ "complexTypes": [
764
+ "AdMobRewardItem"
765
+ ],
766
+ "slug": "showrewardvideoad"
767
+ },
768
+ {
769
+ "name": "addListener",
770
+ "signature": "(eventName: RewardAdPluginEvents.FailedToLoad, listenerFunc: (error: AdMobError) => void) => Promise<PluginListenerHandle>",
771
+ "parameters": [
772
+ {
773
+ "name": "eventName",
774
+ "docs": "",
775
+ "type": "RewardAdPluginEvents.FailedToLoad"
776
+ },
777
+ {
778
+ "name": "listenerFunc",
779
+ "docs": "",
780
+ "type": "(error: AdMobError) => void"
781
+ }
782
+ ],
783
+ "returns": "Promise<PluginListenerHandle>",
784
+ "tags": [],
785
+ "docs": "",
786
+ "complexTypes": [
787
+ "PluginListenerHandle",
788
+ "RewardAdPluginEvents",
789
+ "AdMobError"
790
+ ],
791
+ "slug": "addlistenerrewardadplugineventsfailedtoload-"
792
+ },
793
+ {
794
+ "name": "addListener",
795
+ "signature": "(eventName: RewardAdPluginEvents.Loaded, listenerFunc: (info: AdLoadInfo) => void) => Promise<PluginListenerHandle>",
796
+ "parameters": [
797
+ {
798
+ "name": "eventName",
799
+ "docs": "",
800
+ "type": "RewardAdPluginEvents.Loaded"
801
+ },
802
+ {
803
+ "name": "listenerFunc",
804
+ "docs": "",
805
+ "type": "(info: AdLoadInfo) => void"
806
+ }
807
+ ],
808
+ "returns": "Promise<PluginListenerHandle>",
809
+ "tags": [],
810
+ "docs": "",
811
+ "complexTypes": [
812
+ "PluginListenerHandle",
813
+ "RewardAdPluginEvents",
814
+ "AdLoadInfo"
815
+ ],
816
+ "slug": "addlistenerrewardadplugineventsloaded-"
817
+ },
818
+ {
819
+ "name": "addListener",
820
+ "signature": "(eventName: RewardAdPluginEvents.Rewarded, listenerFunc: (reward: AdMobRewardItem) => void) => Promise<PluginListenerHandle>",
821
+ "parameters": [
822
+ {
823
+ "name": "eventName",
824
+ "docs": "",
825
+ "type": "RewardAdPluginEvents.Rewarded"
826
+ },
827
+ {
828
+ "name": "listenerFunc",
829
+ "docs": "",
830
+ "type": "(reward: AdMobRewardItem) => void"
831
+ }
832
+ ],
833
+ "returns": "Promise<PluginListenerHandle>",
834
+ "tags": [],
835
+ "docs": "",
836
+ "complexTypes": [
837
+ "PluginListenerHandle",
838
+ "RewardAdPluginEvents",
839
+ "AdMobRewardItem"
840
+ ],
841
+ "slug": "addlistenerrewardadplugineventsrewarded-"
842
+ },
843
+ {
844
+ "name": "addListener",
845
+ "signature": "(eventName: RewardAdPluginEvents.Dismissed, listenerFunc: () => void) => Promise<PluginListenerHandle>",
846
+ "parameters": [
847
+ {
848
+ "name": "eventName",
849
+ "docs": "",
850
+ "type": "RewardAdPluginEvents.Dismissed"
851
+ },
852
+ {
853
+ "name": "listenerFunc",
854
+ "docs": "",
855
+ "type": "() => void"
856
+ }
857
+ ],
858
+ "returns": "Promise<PluginListenerHandle>",
859
+ "tags": [],
860
+ "docs": "",
861
+ "complexTypes": [
862
+ "PluginListenerHandle",
863
+ "RewardAdPluginEvents"
864
+ ],
865
+ "slug": "addlistenerrewardadplugineventsdismissed-"
866
+ },
867
+ {
868
+ "name": "addListener",
869
+ "signature": "(eventName: RewardAdPluginEvents.FailedToShow, listenerFunc: (error: AdMobError) => void) => Promise<PluginListenerHandle>",
870
+ "parameters": [
871
+ {
872
+ "name": "eventName",
873
+ "docs": "",
874
+ "type": "RewardAdPluginEvents.FailedToShow"
875
+ },
876
+ {
877
+ "name": "listenerFunc",
878
+ "docs": "",
879
+ "type": "(error: AdMobError) => void"
880
+ }
881
+ ],
882
+ "returns": "Promise<PluginListenerHandle>",
883
+ "tags": [],
884
+ "docs": "",
885
+ "complexTypes": [
886
+ "PluginListenerHandle",
887
+ "RewardAdPluginEvents",
888
+ "AdMobError"
889
+ ],
890
+ "slug": "addlistenerrewardadplugineventsfailedtoshow-"
891
+ },
892
+ {
893
+ "name": "addListener",
894
+ "signature": "(eventName: RewardAdPluginEvents.Showed, listenerFunc: () => void) => Promise<PluginListenerHandle>",
895
+ "parameters": [
896
+ {
897
+ "name": "eventName",
898
+ "docs": "",
899
+ "type": "RewardAdPluginEvents.Showed"
900
+ },
901
+ {
902
+ "name": "listenerFunc",
903
+ "docs": "",
904
+ "type": "() => void"
905
+ }
906
+ ],
907
+ "returns": "Promise<PluginListenerHandle>",
908
+ "tags": [],
909
+ "docs": "",
910
+ "complexTypes": [
911
+ "PluginListenerHandle",
912
+ "RewardAdPluginEvents"
913
+ ],
914
+ "slug": "addlistenerrewardadplugineventsshowed-"
915
+ },
916
+ {
917
+ "name": "prepareRewardInterstitialAd",
918
+ "signature": "(options: RewardInterstitialAdOptions) => Promise<AdLoadInfo>",
919
+ "parameters": [
920
+ {
921
+ "name": "options",
922
+ "docs": "RewardAdOptions",
923
+ "type": "RewardInterstitialAdOptions"
924
+ }
925
+ ],
926
+ "returns": "Promise<AdLoadInfo>",
927
+ "tags": [
928
+ {
929
+ "name": "group",
930
+ "text": "RewardVideo"
931
+ },
932
+ {
933
+ "name": "param",
934
+ "text": "options RewardAdOptions"
935
+ },
936
+ {
937
+ "name": "since",
938
+ "text": "1.1.2"
939
+ }
940
+ ],
941
+ "docs": "Prepare a reward video ad",
942
+ "complexTypes": [
943
+ "AdLoadInfo",
944
+ "RewardInterstitialAdOptions"
945
+ ],
946
+ "slug": "preparerewardinterstitialad"
947
+ },
948
+ {
949
+ "name": "showRewardInterstitialAd",
950
+ "signature": "() => Promise<AdMobRewardInterstitialItem>",
951
+ "parameters": [],
952
+ "returns": "Promise<AdMobRewardInterstitialItem>",
953
+ "tags": [
954
+ {
955
+ "name": "group",
956
+ "text": "RewardVideo"
957
+ },
958
+ {
959
+ "name": "since",
960
+ "text": "1.1.2"
961
+ }
962
+ ],
963
+ "docs": "Show a reward video ad",
964
+ "complexTypes": [
965
+ "AdMobRewardInterstitialItem"
966
+ ],
967
+ "slug": "showrewardinterstitialad"
968
+ },
969
+ {
970
+ "name": "addListener",
971
+ "signature": "(eventName: RewardInterstitialAdPluginEvents.FailedToLoad, listenerFunc: (error: AdMobError) => void) => Promise<PluginListenerHandle>",
972
+ "parameters": [
973
+ {
974
+ "name": "eventName",
975
+ "docs": "",
976
+ "type": "RewardInterstitialAdPluginEvents.FailedToLoad"
977
+ },
978
+ {
979
+ "name": "listenerFunc",
980
+ "docs": "",
981
+ "type": "(error: AdMobError) => void"
982
+ }
983
+ ],
984
+ "returns": "Promise<PluginListenerHandle>",
985
+ "tags": [],
986
+ "docs": "",
987
+ "complexTypes": [
988
+ "PluginListenerHandle",
989
+ "RewardInterstitialAdPluginEvents",
990
+ "AdMobError"
991
+ ],
992
+ "slug": "addlistenerrewardinterstitialadplugineventsfailedtoload-"
993
+ },
994
+ {
995
+ "name": "addListener",
996
+ "signature": "(eventName: RewardInterstitialAdPluginEvents.Loaded, listenerFunc: (info: AdLoadInfo) => void) => Promise<PluginListenerHandle>",
997
+ "parameters": [
998
+ {
999
+ "name": "eventName",
1000
+ "docs": "",
1001
+ "type": "RewardInterstitialAdPluginEvents.Loaded"
1002
+ },
1003
+ {
1004
+ "name": "listenerFunc",
1005
+ "docs": "",
1006
+ "type": "(info: AdLoadInfo) => void"
1007
+ }
1008
+ ],
1009
+ "returns": "Promise<PluginListenerHandle>",
1010
+ "tags": [],
1011
+ "docs": "",
1012
+ "complexTypes": [
1013
+ "PluginListenerHandle",
1014
+ "RewardInterstitialAdPluginEvents",
1015
+ "AdLoadInfo"
1016
+ ],
1017
+ "slug": "addlistenerrewardinterstitialadplugineventsloaded-"
1018
+ },
1019
+ {
1020
+ "name": "addListener",
1021
+ "signature": "(eventName: RewardInterstitialAdPluginEvents.Rewarded, listenerFunc: (reward: AdMobRewardInterstitialItem) => void) => Promise<PluginListenerHandle>",
1022
+ "parameters": [
1023
+ {
1024
+ "name": "eventName",
1025
+ "docs": "",
1026
+ "type": "RewardInterstitialAdPluginEvents.Rewarded"
1027
+ },
1028
+ {
1029
+ "name": "listenerFunc",
1030
+ "docs": "",
1031
+ "type": "(reward: AdMobRewardInterstitialItem) => void"
1032
+ }
1033
+ ],
1034
+ "returns": "Promise<PluginListenerHandle>",
1035
+ "tags": [],
1036
+ "docs": "",
1037
+ "complexTypes": [
1038
+ "PluginListenerHandle",
1039
+ "RewardInterstitialAdPluginEvents",
1040
+ "AdMobRewardInterstitialItem"
1041
+ ],
1042
+ "slug": "addlistenerrewardinterstitialadplugineventsrewarded-"
1043
+ },
1044
+ {
1045
+ "name": "addListener",
1046
+ "signature": "(eventName: RewardInterstitialAdPluginEvents.Dismissed, listenerFunc: () => void) => Promise<PluginListenerHandle>",
1047
+ "parameters": [
1048
+ {
1049
+ "name": "eventName",
1050
+ "docs": "",
1051
+ "type": "RewardInterstitialAdPluginEvents.Dismissed"
1052
+ },
1053
+ {
1054
+ "name": "listenerFunc",
1055
+ "docs": "",
1056
+ "type": "() => void"
1057
+ }
1058
+ ],
1059
+ "returns": "Promise<PluginListenerHandle>",
1060
+ "tags": [],
1061
+ "docs": "",
1062
+ "complexTypes": [
1063
+ "PluginListenerHandle",
1064
+ "RewardInterstitialAdPluginEvents"
1065
+ ],
1066
+ "slug": "addlistenerrewardinterstitialadplugineventsdismissed-"
1067
+ },
1068
+ {
1069
+ "name": "addListener",
1070
+ "signature": "(eventName: RewardInterstitialAdPluginEvents.FailedToShow, listenerFunc: (error: AdMobError) => void) => Promise<PluginListenerHandle>",
1071
+ "parameters": [
1072
+ {
1073
+ "name": "eventName",
1074
+ "docs": "",
1075
+ "type": "RewardInterstitialAdPluginEvents.FailedToShow"
1076
+ },
1077
+ {
1078
+ "name": "listenerFunc",
1079
+ "docs": "",
1080
+ "type": "(error: AdMobError) => void"
1081
+ }
1082
+ ],
1083
+ "returns": "Promise<PluginListenerHandle>",
1084
+ "tags": [],
1085
+ "docs": "",
1086
+ "complexTypes": [
1087
+ "PluginListenerHandle",
1088
+ "RewardInterstitialAdPluginEvents",
1089
+ "AdMobError"
1090
+ ],
1091
+ "slug": "addlistenerrewardinterstitialadplugineventsfailedtoshow-"
1092
+ },
1093
+ {
1094
+ "name": "addListener",
1095
+ "signature": "(eventName: RewardInterstitialAdPluginEvents.Showed, listenerFunc: () => void) => Promise<PluginListenerHandle>",
1096
+ "parameters": [
1097
+ {
1098
+ "name": "eventName",
1099
+ "docs": "",
1100
+ "type": "RewardInterstitialAdPluginEvents.Showed"
1101
+ },
1102
+ {
1103
+ "name": "listenerFunc",
1104
+ "docs": "",
1105
+ "type": "() => void"
1106
+ }
1107
+ ],
1108
+ "returns": "Promise<PluginListenerHandle>",
1109
+ "tags": [],
1110
+ "docs": "",
1111
+ "complexTypes": [
1112
+ "PluginListenerHandle",
1113
+ "RewardInterstitialAdPluginEvents"
1114
+ ],
1115
+ "slug": "addlistenerrewardinterstitialadplugineventsshowed-"
132
1116
  }
133
1117
  ],
134
- "properties": []
1118
+ "properties": [],
1119
+ "importObject": [
1120
+ "BannerDefinitions",
1121
+ "AdmobConsentDefinitions",
1122
+ "InterstitialDefinitions",
1123
+ "RewardDefinitions",
1124
+ "RewardInterstitialDefinitions",
1125
+ "TrackingAuthorizationStatusInterface",
1126
+ "AdMobDefinitions",
1127
+ "AdMobInitializationOptions",
1128
+ "MaxAdContentRating",
1129
+ "ApplicationMutedOptions",
1130
+ "ApplicationVolumeOptions"
1131
+ ]
135
1132
  },
136
1133
  "interfaces": [
137
1134
  {
138
- "name": "AdMobInitializationOptions",
139
- "slug": "admobinitializationoptions",
1135
+ "name": "AdMobInitializationOptions",
1136
+ "slug": "admobinitializationoptions",
1137
+ "docs": "",
1138
+ "tags": [],
1139
+ "methods": [],
1140
+ "properties": [
1141
+ {
1142
+ "name": "testingDevices",
1143
+ "tags": [
1144
+ {
1145
+ "text": "https ://developers.google.com/admob/android/test-ads#enable_test_devices",
1146
+ "name": "see"
1147
+ },
1148
+ {
1149
+ "text": "1.2.0",
1150
+ "name": "since"
1151
+ }
1152
+ ],
1153
+ "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').",
1154
+ "complexTypes": [],
1155
+ "type": "string[] | undefined"
1156
+ },
1157
+ {
1158
+ "name": "initializeForTesting",
1159
+ "tags": [
1160
+ {
1161
+ "text": "AdMobInitializationOptions.testingDevices *",
1162
+ "name": "see"
1163
+ },
1164
+ {
1165
+ "text": "false",
1166
+ "name": "default"
1167
+ },
1168
+ {
1169
+ "text": "1.2.0",
1170
+ "name": "since"
1171
+ }
1172
+ ],
1173
+ "docs": "If set to true, the devices on {@link AdMobInitializationOptions.testingDevices} will\nbe registered to receive test production ads.",
1174
+ "complexTypes": [],
1175
+ "type": "boolean | undefined"
1176
+ },
1177
+ {
1178
+ "name": "tagForChildDirectedTreatment",
1179
+ "tags": [
1180
+ {
1181
+ "text": "https ://developers.google.com/admob/android/targeting#child-directed_setting",
1182
+ "name": "see"
1183
+ },
1184
+ {
1185
+ "text": "3.1.0",
1186
+ "name": "since"
1187
+ }
1188
+ ],
1189
+ "docs": "For purposes of the Children's Online Privacy Protection Act (COPPA),\nthere is a setting called tagForChildDirectedTreatment.",
1190
+ "complexTypes": [],
1191
+ "type": "boolean | undefined"
1192
+ },
1193
+ {
1194
+ "name": "tagForUnderAgeOfConsent",
1195
+ "tags": [
1196
+ {
1197
+ "text": "https ://developers.google.com/admob/android/targeting#users_under_the_age_of_consent",
1198
+ "name": "see"
1199
+ },
1200
+ {
1201
+ "text": "3.1.0",
1202
+ "name": "since"
1203
+ }
1204
+ ],
1205
+ "docs": "When using this feature,\na Tag For Users under the Age of Consent in Europe (TFUA) parameter will be included in all future ad requests.",
1206
+ "complexTypes": [],
1207
+ "type": "boolean | undefined"
1208
+ },
1209
+ {
1210
+ "name": "maxAdContentRating",
1211
+ "tags": [
1212
+ {
1213
+ "text": "https ://developers.google.com/admob/android/targeting#child-directed_setting",
1214
+ "name": "see"
1215
+ },
1216
+ {
1217
+ "text": "3.1.0",
1218
+ "name": "since"
1219
+ }
1220
+ ],
1221
+ "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.",
1222
+ "complexTypes": [
1223
+ "MaxAdContentRating"
1224
+ ],
1225
+ "type": "MaxAdContentRating"
1226
+ }
1227
+ ],
1228
+ "importObject": [
1229
+ "BannerDefinitions",
1230
+ "AdmobConsentDefinitions",
1231
+ "InterstitialDefinitions",
1232
+ "RewardDefinitions",
1233
+ "RewardInterstitialDefinitions",
1234
+ "TrackingAuthorizationStatusInterface",
1235
+ "AdMobDefinitions",
1236
+ "AdMobPlugin",
1237
+ "MaxAdContentRating",
1238
+ "ApplicationMutedOptions",
1239
+ "ApplicationVolumeOptions"
1240
+ ]
1241
+ },
1242
+ {
1243
+ "name": "TrackingAuthorizationStatusInterface",
1244
+ "slug": "trackingauthorizationstatusinterface",
1245
+ "docs": "",
1246
+ "tags": [
1247
+ {
1248
+ "text": "https://developer.apple.com/documentation/apptrackingtransparency/attrackingmanager/authorizationstatus",
1249
+ "name": "url"
1250
+ }
1251
+ ],
1252
+ "methods": [],
1253
+ "properties": [
1254
+ {
1255
+ "name": "status",
1256
+ "tags": [],
1257
+ "docs": "",
1258
+ "complexTypes": [],
1259
+ "type": "'authorized' | 'denied' | 'notDetermined' | 'restricted'"
1260
+ }
1261
+ ],
1262
+ "importObject": []
1263
+ },
1264
+ {
1265
+ "name": "ApplicationMutedOptions",
1266
+ "slug": "applicationmutedoptions",
140
1267
  "docs": "",
141
1268
  "tags": [],
142
1269
  "methods": [],
143
1270
  "properties": [
144
1271
  {
145
- "name": "testingDevices",
1272
+ "name": "muted",
146
1273
  "tags": [
147
1274
  {
148
- "text": "https ://developers.google.com/admob/android/test-ads#enable_test_devices",
1275
+ "text": "https ://developers.google.com/admob/android/global-settings",
149
1276
  "name": "see"
150
1277
  },
151
1278
  {
152
- "text": "1.2.0",
1279
+ "text": "4.1.1",
153
1280
  "name": "since"
154
1281
  }
155
1282
  ],
156
- "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').",
1283
+ "docs": "To inform the SDK that the app volume has been muted.\nNote: Video ads that are ineligible to be shown with muted audio are not returned for ad requests made,\nwhen the app volume is reported as muted or set to a value of 0. This may restrict a subset of the broader video ads pool from serving.",
1284
+ "complexTypes": [],
1285
+ "type": "boolean | undefined"
1286
+ }
1287
+ ],
1288
+ "importObject": [
1289
+ "BannerDefinitions",
1290
+ "AdmobConsentDefinitions",
1291
+ "InterstitialDefinitions",
1292
+ "RewardDefinitions",
1293
+ "RewardInterstitialDefinitions",
1294
+ "TrackingAuthorizationStatusInterface",
1295
+ "AdMobDefinitions",
1296
+ "AdMobPlugin",
1297
+ "AdMobInitializationOptions",
1298
+ "MaxAdContentRating",
1299
+ "ApplicationVolumeOptions"
1300
+ ]
1301
+ },
1302
+ {
1303
+ "name": "ApplicationVolumeOptions",
1304
+ "slug": "applicationvolumeoptions",
1305
+ "docs": "",
1306
+ "tags": [],
1307
+ "methods": [],
1308
+ "properties": [
1309
+ {
1310
+ "name": "volume",
1311
+ "tags": [
1312
+ {
1313
+ "text": "https ://developers.google.com/admob/android/global-settings",
1314
+ "name": "see"
1315
+ },
1316
+ {
1317
+ "text": "4.1.1",
1318
+ "name": "since"
1319
+ }
1320
+ ],
1321
+ "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.",
1322
+ "complexTypes": [],
1323
+ "type": "0 | 1 | 0.1 | 0.2 | 0.3 | 0.4 | 0.5 | 0.6 | 0.7 | 0.8 | 0.9 | undefined"
1324
+ }
1325
+ ],
1326
+ "importObject": [
1327
+ "BannerDefinitions",
1328
+ "AdmobConsentDefinitions",
1329
+ "InterstitialDefinitions",
1330
+ "RewardDefinitions",
1331
+ "RewardInterstitialDefinitions",
1332
+ "TrackingAuthorizationStatusInterface",
1333
+ "AdMobDefinitions",
1334
+ "AdMobPlugin",
1335
+ "AdMobInitializationOptions",
1336
+ "MaxAdContentRating",
1337
+ "ApplicationMutedOptions"
1338
+ ]
1339
+ },
1340
+ {
1341
+ "name": "BannerAdOptions",
1342
+ "slug": "banneradoptions",
1343
+ "docs": "This interface extends AdOptions",
1344
+ "tags": [],
1345
+ "methods": [],
1346
+ "properties": [
1347
+ {
1348
+ "name": "adSize",
1349
+ "tags": [
1350
+ {
1351
+ "text": "ADAPTIVE_BANNER",
1352
+ "name": "default"
1353
+ },
1354
+ {
1355
+ "text": "3.0.0",
1356
+ "name": "since"
1357
+ }
1358
+ ],
1359
+ "docs": "Banner Ad Size, defaults to ADAPTIVE_BANNER.\r\nIT can be: ADAPTIVE_BANNER, SMART_BANNER, BANNER,\r\nMEDIUM_RECTANGLE, FULL_BANNER, LEADERBOARD",
1360
+ "complexTypes": [
1361
+ "BannerAdSize"
1362
+ ],
1363
+ "type": "BannerAdSize"
1364
+ },
1365
+ {
1366
+ "name": "position",
1367
+ "tags": [
1368
+ {
1369
+ "text": "TOP_CENTER",
1370
+ "name": "default"
1371
+ },
1372
+ {
1373
+ "text": "1.1.2",
1374
+ "name": "since"
1375
+ }
1376
+ ],
1377
+ "docs": "Set Banner Ad position.\r\nTOP_CENTER or CENTER or BOTTOM_CENTER",
1378
+ "complexTypes": [
1379
+ "BannerAdPosition"
1380
+ ],
1381
+ "type": "BannerAdPosition"
1382
+ }
1383
+ ],
1384
+ "importObject": [
1385
+ "AdOptions",
1386
+ "BannerAdPosition",
1387
+ "BannerAdSize"
1388
+ ]
1389
+ },
1390
+ {
1391
+ "name": "PluginListenerHandle",
1392
+ "slug": "pluginlistenerhandle",
1393
+ "docs": "",
1394
+ "tags": [],
1395
+ "methods": [],
1396
+ "properties": [
1397
+ {
1398
+ "name": "remove",
1399
+ "tags": [],
1400
+ "docs": "",
1401
+ "complexTypes": [],
1402
+ "type": "() => Promise<void>"
1403
+ }
1404
+ ],
1405
+ "importObject": [
1406
+ "CapacitorException",
1407
+ "CapacitorGlobal",
1408
+ "RegisterPlugin",
1409
+ "PluginImplementations",
1410
+ "Plugin",
1411
+ "PermissionState",
1412
+ "PluginResultData",
1413
+ "PluginResultError",
1414
+ "PluginCallback"
1415
+ ]
1416
+ },
1417
+ {
1418
+ "name": "AdMobBannerSize",
1419
+ "slug": "admobbannersize",
1420
+ "docs": "When notice listener of OnAdLoaded, you can get banner size.",
1421
+ "tags": [],
1422
+ "methods": [],
1423
+ "properties": [
1424
+ {
1425
+ "name": "width",
1426
+ "tags": [],
1427
+ "docs": "",
1428
+ "complexTypes": [],
1429
+ "type": "number"
1430
+ },
1431
+ {
1432
+ "name": "height",
1433
+ "tags": [],
1434
+ "docs": "",
1435
+ "complexTypes": [],
1436
+ "type": "number"
1437
+ }
1438
+ ],
1439
+ "importObject": []
1440
+ },
1441
+ {
1442
+ "name": "AdMobError",
1443
+ "slug": "admoberror",
1444
+ "docs": "For more information\r\nhttps://developers.google.com/android/reference/com/google/android/gms/ads/AdError",
1445
+ "tags": [],
1446
+ "methods": [],
1447
+ "properties": [
1448
+ {
1449
+ "name": "code",
1450
+ "tags": [],
1451
+ "docs": "Gets the error's code.",
1452
+ "complexTypes": [],
1453
+ "type": "number"
1454
+ },
1455
+ {
1456
+ "name": "message",
1457
+ "tags": [],
1458
+ "docs": "Gets the message describing the error.",
1459
+ "complexTypes": [],
1460
+ "type": "string"
1461
+ }
1462
+ ],
1463
+ "importObject": []
1464
+ },
1465
+ {
1466
+ "name": "AdmobConsentInfo",
1467
+ "slug": "admobconsentinfo",
1468
+ "docs": "",
1469
+ "tags": [],
1470
+ "methods": [],
1471
+ "properties": [
1472
+ {
1473
+ "name": "status",
1474
+ "tags": [
1475
+ {
1476
+ "text": "5.0.0",
1477
+ "name": "since"
1478
+ }
1479
+ ],
1480
+ "docs": "The consent status of the user.",
1481
+ "complexTypes": [
1482
+ "AdmobConsentStatus"
1483
+ ],
1484
+ "type": "AdmobConsentStatus"
1485
+ },
1486
+ {
1487
+ "name": "isConsentFormAvailable",
1488
+ "tags": [
1489
+ {
1490
+ "text": "5.0.0",
1491
+ "name": "since"
1492
+ }
1493
+ ],
1494
+ "docs": "If `true` a consent form is available and vice versa.",
1495
+ "complexTypes": [],
1496
+ "type": "boolean | undefined"
1497
+ }
1498
+ ],
1499
+ "importObject": [
1500
+ "AdmobConsentStatus"
1501
+ ]
1502
+ },
1503
+ {
1504
+ "name": "AdmobConsentRequestOptions",
1505
+ "slug": "admobconsentrequestoptions",
1506
+ "docs": "",
1507
+ "tags": [],
1508
+ "methods": [],
1509
+ "properties": [
1510
+ {
1511
+ "name": "debugGeography",
1512
+ "tags": [
1513
+ {
1514
+ "text": "5.0.0",
1515
+ "name": "since"
1516
+ }
1517
+ ],
1518
+ "docs": "Sets the debug geography to test the consent locally.",
1519
+ "complexTypes": [
1520
+ "AdmobConsentDebugGeography"
1521
+ ],
1522
+ "type": "AdmobConsentDebugGeography"
1523
+ },
1524
+ {
1525
+ "name": "testDeviceIdentifiers",
1526
+ "tags": [
1527
+ {
1528
+ "text": "5.0.0",
1529
+ "name": "since"
1530
+ }
1531
+ ],
1532
+ "docs": "An array of test device IDs to allow.\nNote: On iOS, the ID may renew if you uninstall and reinstall the app.",
157
1533
  "complexTypes": [],
158
1534
  "type": "string[] | undefined"
159
1535
  },
160
1536
  {
161
- "name": "initializeForTesting",
1537
+ "name": "tagForUnderAgeOfConsent",
162
1538
  "tags": [
163
1539
  {
164
- "text": "AdMobInitializationOptions.testingDevices *",
1540
+ "text": "false",
1541
+ "name": "default"
1542
+ },
1543
+ {
1544
+ "text": "5.0.0",
1545
+ "name": "since"
1546
+ }
1547
+ ],
1548
+ "docs": "Set to `true` to provide the option for the user to accept being shown personalized ads.",
1549
+ "complexTypes": [],
1550
+ "type": "boolean | undefined"
1551
+ }
1552
+ ],
1553
+ "importObject": [
1554
+ "AdmobConsentDebugGeography"
1555
+ ]
1556
+ },
1557
+ {
1558
+ "name": "AdLoadInfo",
1559
+ "slug": "adloadinfo",
1560
+ "docs": "",
1561
+ "tags": [],
1562
+ "methods": [],
1563
+ "properties": [
1564
+ {
1565
+ "name": "adUnitId",
1566
+ "tags": [],
1567
+ "docs": "",
1568
+ "complexTypes": [],
1569
+ "type": "string"
1570
+ }
1571
+ ],
1572
+ "importObject": []
1573
+ },
1574
+ {
1575
+ "name": "AdOptions",
1576
+ "slug": "adoptions",
1577
+ "docs": "",
1578
+ "tags": [],
1579
+ "methods": [],
1580
+ "properties": [
1581
+ {
1582
+ "name": "adId",
1583
+ "tags": [
1584
+ {
1585
+ "text": "https ://support.google.com/admob/answer/7356431?hl=en",
165
1586
  "name": "see"
166
1587
  },
1588
+ {
1589
+ "text": "1.1.2",
1590
+ "name": "since"
1591
+ }
1592
+ ],
1593
+ "docs": "The ad unit ID that you want to request",
1594
+ "complexTypes": [],
1595
+ "type": "string"
1596
+ },
1597
+ {
1598
+ "name": "isTesting",
1599
+ "tags": [
167
1600
  {
168
1601
  "text": "false",
169
1602
  "name": "default"
170
1603
  },
171
1604
  {
172
- "text": "1.2.0",
1605
+ "text": "1.1.2",
173
1606
  "name": "since"
174
1607
  }
175
1608
  ],
176
- "docs": "If set to true, the devices on {@link AdMobInitializationOptions.testingDevices} will\nbe registered to receive test production ads.",
1609
+ "docs": "You can use test mode of ad.",
177
1610
  "complexTypes": [],
178
1611
  "type": "boolean | undefined"
179
1612
  },
180
1613
  {
181
- "name": "tagForChildDirectedTreatment",
1614
+ "name": "margin",
182
1615
  "tags": [
183
1616
  {
184
- "text": "https ://developers.google.com/admob/android/targeting#child-directed_setting",
185
- "name": "see"
1617
+ "text": "0",
1618
+ "name": "default"
186
1619
  },
187
1620
  {
188
- "text": "3.1.0",
1621
+ "text": "1.1.2",
189
1622
  "name": "since"
190
1623
  }
191
1624
  ],
192
- "docs": "For purposes of the Children's Online Privacy Protection Act (COPPA),\nthere is a setting called tagForChildDirectedTreatment.",
1625
+ "docs": "Margin Banner. Default is 0px;\r\nIf position is BOTTOM_CENTER, margin is be margin-bottom.\r\nIf position is TOP_CENTER, margin is be margin-top.",
193
1626
  "complexTypes": [],
194
- "type": "boolean | undefined"
1627
+ "type": "number | undefined"
195
1628
  },
196
1629
  {
197
- "name": "tagForUnderAgeOfConsent",
1630
+ "name": "npa",
198
1631
  "tags": [
199
1632
  {
200
- "text": "https ://developers.google.com/admob/android/targeting#users_under_the_age_of_consent",
1633
+ "text": "https ://developers.google.com/admob/ios/eu-consent",
201
1634
  "name": "see"
202
1635
  },
203
1636
  {
204
- "text": "3.1.0",
1637
+ "text": "https ://developers.google.com/admob/android/eu-consent",
1638
+ "name": "see"
1639
+ },
1640
+ {
1641
+ "text": "false",
1642
+ "name": "default"
1643
+ },
1644
+ {
1645
+ "text": "1.2.0",
205
1646
  "name": "since"
206
1647
  }
207
1648
  ],
208
- "docs": "When using this feature,\na Tag For Users under the Age of Consent in Europe (TFUA) parameter will be included in all future ad requests.",
1649
+ "docs": "The default behavior of the Google Mobile Ads SDK is to serve personalized ads.\r\nSet this to true to request Non-Personalized Ads",
209
1650
  "complexTypes": [],
210
1651
  "type": "boolean | undefined"
211
- },
1652
+ }
1653
+ ],
1654
+ "importObject": []
1655
+ },
1656
+ {
1657
+ "name": "RewardAdOptions",
1658
+ "slug": "rewardadoptions",
1659
+ "docs": "",
1660
+ "tags": [],
1661
+ "methods": [],
1662
+ "properties": [
212
1663
  {
213
- "name": "maxAdContentRating",
1664
+ "name": "ssv",
214
1665
  "tags": [
215
1666
  {
216
- "text": "https ://developers.google.com/admob/android/targeting#child-directed_setting",
1667
+ "text": "https ://support.google.com/admob/answer/9603226?hl=en-GB",
217
1668
  "name": "see"
218
- },
219
- {
220
- "text": "3.1.0",
221
- "name": "since"
222
1669
  }
223
1670
  ],
224
- "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.",
1671
+ "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.",
225
1672
  "complexTypes": [
226
- "MaxAdContentRating"
1673
+ "AtLeastOne"
227
1674
  ],
228
- "type": "MaxAdContentRating"
1675
+ "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 }>"
229
1676
  }
1677
+ ],
1678
+ "importObject": [
1679
+ "AdOptions",
1680
+ "AtLeastOne"
230
1681
  ]
231
1682
  },
232
1683
  {
233
- "name": "TrackingAuthorizationStatusInterface",
234
- "slug": "trackingauthorizationstatusinterface",
235
- "docs": "",
236
- "tags": [
237
- {
238
- "text": "https://developer.apple.com/documentation/apptrackingtransparency/attrackingmanager/authorizationstatus",
239
- "name": "url"
240
- }
241
- ],
1684
+ "name": "AdMobRewardItem",
1685
+ "slug": "admobrewarditem",
1686
+ "docs": "For more information\r\nhttps://developers.google.com/admob/android/rewarded-video-adapters?hl=en",
1687
+ "tags": [],
242
1688
  "methods": [],
243
1689
  "properties": [
244
1690
  {
245
- "name": "status",
1691
+ "name": "type",
246
1692
  "tags": [],
247
- "docs": "",
1693
+ "docs": "Rewarded type user got",
248
1694
  "complexTypes": [],
249
- "type": "'authorized' | 'denied' | 'notDetermined' | 'restricted'"
1695
+ "type": "string"
1696
+ },
1697
+ {
1698
+ "name": "amount",
1699
+ "tags": [],
1700
+ "docs": "Rewarded amount user got",
1701
+ "complexTypes": [],
1702
+ "type": "number"
250
1703
  }
251
- ]
1704
+ ],
1705
+ "importObject": []
252
1706
  },
253
1707
  {
254
- "name": "ApplicationMutedOptions",
255
- "slug": "applicationmutedoptions",
1708
+ "name": "RewardInterstitialAdOptions",
1709
+ "slug": "rewardinterstitialadoptions",
256
1710
  "docs": "",
257
1711
  "tags": [],
258
1712
  "methods": [],
259
1713
  "properties": [
260
1714
  {
261
- "name": "muted",
1715
+ "name": "ssv",
262
1716
  "tags": [
263
1717
  {
264
- "text": "https ://developers.google.com/admob/android/global-settings",
1718
+ "text": "https ://support.google.com/admob/answer/9603226?hl=en-GB",
265
1719
  "name": "see"
266
- },
267
- {
268
- "text": "4.1.1",
269
- "name": "since"
270
1720
  }
271
1721
  ],
272
- "docs": "To inform the SDK that the app volume has been muted.\nNote: Video ads that are ineligible to be shown with muted audio are not returned for ad requests made,\nwhen the app volume is reported as muted or set to a value of 0. This may restrict a subset of the broader video ads pool from serving.",
273
- "complexTypes": [],
274
- "type": "boolean | undefined"
1722
+ "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.",
1723
+ "complexTypes": [
1724
+ "AtLeastOne"
1725
+ ],
1726
+ "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 }>"
275
1727
  }
1728
+ ],
1729
+ "importObject": [
1730
+ "AdOptions",
1731
+ "AtLeastOne"
276
1732
  ]
277
1733
  },
278
1734
  {
279
- "name": "ApplicationVolumeOptions",
280
- "slug": "applicationvolumeoptions",
281
- "docs": "",
1735
+ "name": "AdMobRewardInterstitialItem",
1736
+ "slug": "admobrewardinterstitialitem",
1737
+ "docs": "For more information\nhttps://developers.google.com/admob/android/rewarded-video-adapters?hl=en",
282
1738
  "tags": [],
283
1739
  "methods": [],
284
1740
  "properties": [
285
1741
  {
286
- "name": "volume",
287
- "tags": [
288
- {
289
- "text": "https ://developers.google.com/admob/android/global-settings",
290
- "name": "see"
291
- },
292
- {
293
- "text": "4.1.1",
294
- "name": "since"
295
- }
296
- ],
297
- "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.",
1742
+ "name": "type",
1743
+ "tags": [],
1744
+ "docs": "Rewarded type user got",
298
1745
  "complexTypes": [],
299
- "type": "0 | 1 | 0.1 | 0.2 | 0.3 | 0.4 | 0.5 | 0.6 | 0.7 | 0.8 | 0.9 | undefined"
1746
+ "type": "string"
1747
+ },
1748
+ {
1749
+ "name": "amount",
1750
+ "tags": [],
1751
+ "docs": "Rewarded amount user got",
1752
+ "complexTypes": [],
1753
+ "type": "number"
300
1754
  }
301
- ]
1755
+ ],
1756
+ "importObject": []
302
1757
  }
303
1758
  ],
304
1759
  "enums": [
@@ -331,8 +1786,332 @@
331
1786
  "docs": "Content suitable only for mature audiences."
332
1787
  }
333
1788
  ]
1789
+ },
1790
+ {
1791
+ "name": "BannerAdSize",
1792
+ "slug": "banneradsize",
1793
+ "members": [
1794
+ {
1795
+ "name": "BANNER",
1796
+ "value": "'BANNER'",
1797
+ "tags": [],
1798
+ "docs": "Mobile Marketing Association (MMA)\r\nbanner ad size (320x50 density-independent pixels)."
1799
+ },
1800
+ {
1801
+ "name": "FULL_BANNER",
1802
+ "value": "'FULL_BANNER'",
1803
+ "tags": [],
1804
+ "docs": "Interactive Advertising Bureau (IAB)\r\nfull banner ad size (468x60 density-independent pixels)."
1805
+ },
1806
+ {
1807
+ "name": "LARGE_BANNER",
1808
+ "value": "'LARGE_BANNER'",
1809
+ "tags": [],
1810
+ "docs": "Large banner ad size (320x100 density-independent pixels)."
1811
+ },
1812
+ {
1813
+ "name": "MEDIUM_RECTANGLE",
1814
+ "value": "'MEDIUM_RECTANGLE'",
1815
+ "tags": [],
1816
+ "docs": "Interactive Advertising Bureau (IAB)\r\nmedium rectangle ad size (300x250 density-independent pixels)."
1817
+ },
1818
+ {
1819
+ "name": "LEADERBOARD",
1820
+ "value": "'LEADERBOARD'",
1821
+ "tags": [],
1822
+ "docs": "Interactive Advertising Bureau (IAB)\r\nleaderboard ad size (728x90 density-independent pixels)."
1823
+ },
1824
+ {
1825
+ "name": "ADAPTIVE_BANNER",
1826
+ "value": "'ADAPTIVE_BANNER'",
1827
+ "tags": [],
1828
+ "docs": "A dynamically sized banner that is full-width and auto-height."
1829
+ },
1830
+ {
1831
+ "name": "SMART_BANNER",
1832
+ "value": "'SMART_BANNER'",
1833
+ "tags": [
1834
+ {
1835
+ "text": "Will be removed in next AdMob versions use `ADAPTIVE_BANNER`\r\nScreen width x 32|50|90",
1836
+ "name": "deprecated"
1837
+ }
1838
+ ],
1839
+ "docs": ""
1840
+ }
1841
+ ]
1842
+ },
1843
+ {
1844
+ "name": "BannerAdPosition",
1845
+ "slug": "banneradposition",
1846
+ "members": [
1847
+ {
1848
+ "name": "TOP_CENTER",
1849
+ "value": "'TOP_CENTER'",
1850
+ "tags": [],
1851
+ "docs": "Banner position be top-center"
1852
+ },
1853
+ {
1854
+ "name": "CENTER",
1855
+ "value": "'CENTER'",
1856
+ "tags": [],
1857
+ "docs": "Banner position be center"
1858
+ },
1859
+ {
1860
+ "name": "BOTTOM_CENTER",
1861
+ "value": "'BOTTOM_CENTER'",
1862
+ "tags": [],
1863
+ "docs": "Banner position be bottom-center(default)"
1864
+ }
1865
+ ]
1866
+ },
1867
+ {
1868
+ "name": "BannerAdPluginEvents",
1869
+ "slug": "banneradpluginevents",
1870
+ "members": [
1871
+ {
1872
+ "name": "SizeChanged",
1873
+ "value": "\"bannerAdSizeChanged\"",
1874
+ "tags": [],
1875
+ "docs": ""
1876
+ },
1877
+ {
1878
+ "name": "Loaded",
1879
+ "value": "\"bannerAdLoaded\"",
1880
+ "tags": [],
1881
+ "docs": ""
1882
+ },
1883
+ {
1884
+ "name": "FailedToLoad",
1885
+ "value": "\"bannerAdFailedToLoad\"",
1886
+ "tags": [],
1887
+ "docs": ""
1888
+ },
1889
+ {
1890
+ "name": "Opened",
1891
+ "value": "\"bannerAdOpened\"",
1892
+ "tags": [],
1893
+ "docs": "Open \"Adsense\" Event after user click banner"
1894
+ },
1895
+ {
1896
+ "name": "Closed",
1897
+ "value": "\"bannerAdClosed\"",
1898
+ "tags": [],
1899
+ "docs": "Close \"Adsense\" Event after user click banner"
1900
+ },
1901
+ {
1902
+ "name": "AdImpression",
1903
+ "value": "\"bannerAdImpression\"",
1904
+ "tags": [],
1905
+ "docs": "Similarly, this method should be called when an impression is recorded for the ad by the mediated SDK."
1906
+ }
1907
+ ]
1908
+ },
1909
+ {
1910
+ "name": "AdmobConsentStatus",
1911
+ "slug": "admobconsentstatus",
1912
+ "members": [
1913
+ {
1914
+ "name": "NOT_REQUIRED",
1915
+ "value": "'NOT_REQUIRED'",
1916
+ "tags": [],
1917
+ "docs": "User consent not required."
1918
+ },
1919
+ {
1920
+ "name": "OBTAINED",
1921
+ "value": "'OBTAINED'",
1922
+ "tags": [],
1923
+ "docs": "User consent already obtained."
1924
+ },
1925
+ {
1926
+ "name": "REQUIRED",
1927
+ "value": "'REQUIRED'",
1928
+ "tags": [],
1929
+ "docs": "User consent required but not yet obtained."
1930
+ },
1931
+ {
1932
+ "name": "UNKNOWN",
1933
+ "value": "'UNKNOWN'",
1934
+ "tags": [],
1935
+ "docs": "Unknown consent status, AdsConsent.requestInfoUpdate needs to be called to update it."
1936
+ }
1937
+ ]
1938
+ },
1939
+ {
1940
+ "name": "AdmobConsentDebugGeography",
1941
+ "slug": "admobconsentdebuggeography",
1942
+ "members": [
1943
+ {
1944
+ "name": "DISABLED",
1945
+ "value": "0",
1946
+ "tags": [],
1947
+ "docs": "Debug geography disabled."
1948
+ },
1949
+ {
1950
+ "name": "EEA",
1951
+ "value": "1",
1952
+ "tags": [],
1953
+ "docs": "Geography appears as in EEA for debug devices."
1954
+ },
1955
+ {
1956
+ "name": "NOT_EEA",
1957
+ "value": "2",
1958
+ "tags": [],
1959
+ "docs": "Geography appears as not in EEA for debug devices."
1960
+ }
1961
+ ]
1962
+ },
1963
+ {
1964
+ "name": "InterstitialAdPluginEvents",
1965
+ "slug": "interstitialadpluginevents",
1966
+ "members": [
1967
+ {
1968
+ "name": "Loaded",
1969
+ "value": "'interstitialAdLoaded'",
1970
+ "tags": [],
1971
+ "docs": "Emits after trying to prepare and Interstitial, when it is loaded and ready to be show"
1972
+ },
1973
+ {
1974
+ "name": "FailedToLoad",
1975
+ "value": "'interstitialAdFailedToLoad'",
1976
+ "tags": [],
1977
+ "docs": "Emits after trying to prepare and Interstitial, when it could not be loaded"
1978
+ },
1979
+ {
1980
+ "name": "Showed",
1981
+ "value": "'interstitialAdShowed'",
1982
+ "tags": [],
1983
+ "docs": "Emits when the Interstitial ad is visible to the user"
1984
+ },
1985
+ {
1986
+ "name": "FailedToShow",
1987
+ "value": "'interstitialAdFailedToShow'",
1988
+ "tags": [],
1989
+ "docs": "Emits when the Interstitial ad is failed to show"
1990
+ },
1991
+ {
1992
+ "name": "Dismissed",
1993
+ "value": "'interstitialAdDismissed'",
1994
+ "tags": [],
1995
+ "docs": "Emits when the Interstitial ad is not visible to the user anymore."
1996
+ }
1997
+ ]
1998
+ },
1999
+ {
2000
+ "name": "RewardAdPluginEvents",
2001
+ "slug": "rewardadpluginevents",
2002
+ "members": [
2003
+ {
2004
+ "name": "Loaded",
2005
+ "value": "'onRewardedVideoAdLoaded'",
2006
+ "tags": [],
2007
+ "docs": "Emits after trying to prepare a RewardAd and the Video is loaded and ready to be show"
2008
+ },
2009
+ {
2010
+ "name": "FailedToLoad",
2011
+ "value": "'onRewardedVideoAdFailedToLoad'",
2012
+ "tags": [],
2013
+ "docs": "Emits after trying to prepare a RewardAd when it could not be loaded"
2014
+ },
2015
+ {
2016
+ "name": "Showed",
2017
+ "value": "'onRewardedVideoAdShowed'",
2018
+ "tags": [],
2019
+ "docs": "Emits when the AdReward video is visible to the user"
2020
+ },
2021
+ {
2022
+ "name": "FailedToShow",
2023
+ "value": "'onRewardedVideoAdFailedToShow'",
2024
+ "tags": [],
2025
+ "docs": "Emits when the AdReward video is failed to show"
2026
+ },
2027
+ {
2028
+ "name": "Dismissed",
2029
+ "value": "'onRewardedVideoAdDismissed'",
2030
+ "tags": [],
2031
+ "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."
2032
+ },
2033
+ {
2034
+ "name": "Rewarded",
2035
+ "value": "'onRewardedVideoAdReward'",
2036
+ "tags": [],
2037
+ "docs": "Emits when user get rewarded from AdReward"
2038
+ }
2039
+ ]
2040
+ },
2041
+ {
2042
+ "name": "RewardInterstitialAdPluginEvents",
2043
+ "slug": "rewardinterstitialadpluginevents",
2044
+ "members": [
2045
+ {
2046
+ "name": "Loaded",
2047
+ "value": "'onRewardedInterstitialAdLoaded'",
2048
+ "tags": [],
2049
+ "docs": "Emits after trying to prepare a RewardAd and the Video is loaded and ready to be show"
2050
+ },
2051
+ {
2052
+ "name": "FailedToLoad",
2053
+ "value": "'onRewardedInterstitialAdFailedToLoad'",
2054
+ "tags": [],
2055
+ "docs": "Emits after trying to prepare a RewardAd when it could not be loaded"
2056
+ },
2057
+ {
2058
+ "name": "Showed",
2059
+ "value": "'onRewardedInterstitialAdShowed'",
2060
+ "tags": [],
2061
+ "docs": "Emits when the AdReward video is visible to the user"
2062
+ },
2063
+ {
2064
+ "name": "FailedToShow",
2065
+ "value": "'onRewardedInterstitialAdFailedToShow'",
2066
+ "tags": [],
2067
+ "docs": "Emits when the AdReward video is failed to show"
2068
+ },
2069
+ {
2070
+ "name": "Dismissed",
2071
+ "value": "'onRewardedInterstitialAdDismissed'",
2072
+ "tags": [],
2073
+ "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."
2074
+ },
2075
+ {
2076
+ "name": "Rewarded",
2077
+ "value": "'onRewardedInterstitialAdReward'",
2078
+ "tags": [],
2079
+ "docs": "Emits when user get rewarded from AdReward"
2080
+ }
2081
+ ]
2082
+ }
2083
+ ],
2084
+ "typeAliases": [
2085
+ {
2086
+ "name": "AtLeastOne",
2087
+ "slug": "atleastone",
2088
+ "docs": "",
2089
+ "types": [
2090
+ {
2091
+ "text": "{[K in keyof T]: Pick<T, K>}[keyof T]",
2092
+ "complexTypes": [
2093
+ "T",
2094
+ "Pick",
2095
+ "K"
2096
+ ]
2097
+ }
2098
+ ]
2099
+ },
2100
+ {
2101
+ "name": "Pick",
2102
+ "slug": "pick",
2103
+ "docs": "From T, pick a set of properties whose keys are in the union K",
2104
+ "types": [
2105
+ {
2106
+ "text": "{\r\n [P in K]: T[P];\r\n}",
2107
+ "complexTypes": [
2108
+ "K",
2109
+ "T",
2110
+ "P"
2111
+ ]
2112
+ }
2113
+ ]
334
2114
  }
335
2115
  ],
336
- "typeAliases": [],
337
2116
  "pluginConfigs": []
338
2117
  }