@capacitor-community/admob 6.2.0 → 7.0.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 (6) hide show
  1. package/CapacitorCommunityAdmob.podspec +1 -1
  2. package/Package.swift +2 -2
  3. package/README.md +26 -840
  4. package/android/build.gradle +11 -11
  5. package/dist/docs.json +94 -2563
  6. package/package.json +11 -11
package/dist/docs.json CHANGED
@@ -7,7 +7,7 @@
7
7
  "methods": [
8
8
  {
9
9
  "name": "initialize",
10
- "signature": "(options?: AdMobInitializationOptions) => Promise<void>",
10
+ "signature": "(options?: AdMobInitializationOptions | undefined) => Promise<void>",
11
11
  "parameters": [
12
12
  {
13
13
  "name": "options",
@@ -19,38 +19,15 @@
19
19
  "tags": [
20
20
  {
21
21
  "name": "group",
22
- "text": [
23
- {
24
- "text": "Initialize",
25
- "kind": "text"
26
- }
27
- ]
22
+ "text": "Initialize"
28
23
  },
29
24
  {
30
25
  "name": "param",
31
- "text": [
32
- {
33
- "text": "options",
34
- "kind": "parameterName"
35
- },
36
- {
37
- "text": " ",
38
- "kind": "space"
39
- },
40
- {
41
- "text": "AdMobInitializationOptions",
42
- "kind": "text"
43
- }
44
- ]
26
+ "text": "options AdMobInitializationOptions"
45
27
  },
46
28
  {
47
29
  "name": "since",
48
- "text": [
49
- {
50
- "text": "1.1.2",
51
- "kind": "text"
52
- }
53
- ]
30
+ "text": "1.1.2"
54
31
  }
55
32
  ],
56
33
  "docs": "Initialize AdMob with AdMobInitializationOptions",
@@ -67,25 +44,11 @@
67
44
  "tags": [
68
45
  {
69
46
  "name": "see",
70
- "text": [
71
- {
72
- "text": "https",
73
- "kind": "text"
74
- },
75
- {
76
- "text": "://developer.apple.com/documentation/apptrackingtransparency/attrackingmanager/3547038-trackingauthorizationstatus",
77
- "kind": "text"
78
- }
79
- ]
47
+ "text": "https ://developer.apple.com/documentation/apptrackingtransparency/attrackingmanager/3547038-trackingauthorizationstatus"
80
48
  },
81
49
  {
82
50
  "name": "since",
83
- "text": [
84
- {
85
- "text": "3.1.0",
86
- "kind": "text"
87
- }
88
- ]
51
+ "text": "3.1.0"
89
52
  }
90
53
  ],
91
54
  "docs": "Confirm requestTrackingAuthorization status (iOS >14)",
@@ -102,25 +65,11 @@
102
65
  "tags": [
103
66
  {
104
67
  "name": "see",
105
- "text": [
106
- {
107
- "text": "https",
108
- "kind": "text"
109
- },
110
- {
111
- "text": "://developer.apple.com/documentation/apptrackingtransparency/attrackingmanager/3547038-trackingauthorizationstatus",
112
- "kind": "text"
113
- }
114
- ]
68
+ "text": "https ://developer.apple.com/documentation/apptrackingtransparency/attrackingmanager/3547038-trackingauthorizationstatus"
115
69
  },
116
70
  {
117
71
  "name": "since",
118
- "text": [
119
- {
120
- "text": "5.2.0",
121
- "kind": "text"
122
- }
123
- ]
72
+ "text": "5.2.0"
124
73
  }
125
74
  ],
126
75
  "docs": "request requestTrackingAuthorization (iOS >14).\nThis is deprecated method. We recommend UMP Consent.",
@@ -141,25 +90,11 @@
141
90
  "tags": [
142
91
  {
143
92
  "name": "see",
144
- "text": [
145
- {
146
- "text": "https",
147
- "kind": "text"
148
- },
149
- {
150
- "text": "://developer.apple.com/documentation/apptrackingtransparency/attrackingmanager/3547038-trackingauthorizationstatus",
151
- "kind": "text"
152
- }
153
- ]
93
+ "text": "https ://developer.apple.com/documentation/apptrackingtransparency/attrackingmanager/3547038-trackingauthorizationstatus"
154
94
  },
155
95
  {
156
96
  "name": "since",
157
- "text": [
158
- {
159
- "text": "4.1.1",
160
- "kind": "text"
161
- }
162
- ]
97
+ "text": "4.1.1"
163
98
  }
164
99
  ],
165
100
  "docs": "Report application mute state to AdMob SDK",
@@ -182,25 +117,11 @@
182
117
  "tags": [
183
118
  {
184
119
  "name": "see",
185
- "text": [
186
- {
187
- "text": "https",
188
- "kind": "text"
189
- },
190
- {
191
- "text": "://developer.apple.com/documentation/apptrackingtransparency/attrackingmanager/3547038-trackingauthorizationstatus",
192
- "kind": "text"
193
- }
194
- ]
120
+ "text": "https ://developer.apple.com/documentation/apptrackingtransparency/attrackingmanager/3547038-trackingauthorizationstatus"
195
121
  },
196
122
  {
197
123
  "name": "since",
198
- "text": [
199
- {
200
- "text": "4.1.1",
201
- "kind": "text"
202
- }
203
- ]
124
+ "text": "4.1.1"
204
125
  }
205
126
  ],
206
127
  "docs": "Report application volume to AdMob SDK",
@@ -208,2237 +129,176 @@
208
129
  "ApplicationVolumeOptions"
209
130
  ],
210
131
  "slug": "setapplicationvolume"
211
- },
212
- {
213
- "name": "showBanner",
214
- "signature": "(options: BannerAdOptions) => Promise<void>",
215
- "parameters": [
216
- {
217
- "name": "options",
218
- "docs": "AdOptions",
219
- "type": "BannerAdOptions"
220
- }
221
- ],
222
- "returns": "Promise<void>",
223
- "tags": [
224
- {
225
- "name": "group",
226
- "text": [
227
- {
228
- "text": "Banner",
229
- "kind": "text"
230
- }
231
- ]
232
- },
233
- {
234
- "name": "param",
235
- "text": [
236
- {
237
- "text": "options",
238
- "kind": "parameterName"
239
- },
240
- {
241
- "text": " ",
242
- "kind": "space"
243
- },
244
- {
245
- "text": "AdOptions",
246
- "kind": "text"
247
- }
248
- ]
249
- },
250
- {
251
- "name": "since",
252
- "text": [
253
- {
254
- "text": "1.1.2",
255
- "kind": "text"
256
- }
257
- ]
258
- }
259
- ],
260
- "docs": "Show a banner Ad",
261
- "complexTypes": [
262
- "BannerAdOptions"
263
- ],
264
- "slug": "showbanner"
265
- },
266
- {
267
- "name": "hideBanner",
268
- "signature": "() => Promise<void>",
269
- "parameters": [],
270
- "returns": "Promise<void>",
271
- "tags": [
272
- {
273
- "name": "group",
274
- "text": [
275
- {
276
- "text": "Banner",
277
- "kind": "text"
278
- }
279
- ]
280
- },
281
- {
282
- "name": "since",
283
- "text": [
284
- {
285
- "text": "1.1.2",
286
- "kind": "text"
287
- }
288
- ]
289
- }
290
- ],
291
- "docs": "Hide the banner, remove it from screen, but can show it later",
292
- "complexTypes": [],
293
- "slug": "hidebanner"
294
- },
295
- {
296
- "name": "resumeBanner",
297
- "signature": "() => Promise<void>",
298
- "parameters": [],
299
- "returns": "Promise<void>",
300
- "tags": [
301
- {
302
- "name": "group",
303
- "text": [
304
- {
305
- "text": "Banner",
306
- "kind": "text"
307
- }
308
- ]
309
- },
310
- {
311
- "name": "since",
312
- "text": [
313
- {
314
- "text": "1.1.2",
315
- "kind": "text"
316
- }
317
- ]
318
- }
319
- ],
320
- "docs": "Resume the banner, show it after hide",
321
- "complexTypes": [],
322
- "slug": "resumebanner"
323
- },
324
- {
325
- "name": "removeBanner",
326
- "signature": "() => Promise<void>",
327
- "parameters": [],
328
- "returns": "Promise<void>",
329
- "tags": [
330
- {
331
- "name": "group",
332
- "text": [
333
- {
334
- "text": "Banner",
335
- "kind": "text"
336
- }
337
- ]
338
- },
339
- {
340
- "name": "since",
341
- "text": [
342
- {
343
- "text": "1.1.2",
344
- "kind": "text"
345
- }
346
- ]
347
- }
348
- ],
349
- "docs": "Destroy the banner, remove it from screen.",
350
- "complexTypes": [],
351
- "slug": "removebanner"
352
- },
353
- {
354
- "name": "addListener",
355
- "signature": "(eventName: BannerAdPluginEvents.SizeChanged, listenerFunc: (info: AdMobBannerSize) => void) => Promise<PluginListenerHandle>",
356
- "parameters": [
357
- {
358
- "name": "eventName",
359
- "docs": "bannerAdSizeChanged",
360
- "type": "BannerAdPluginEvents.SizeChanged"
361
- },
362
- {
363
- "name": "listenerFunc",
364
- "docs": "",
365
- "type": "(info: AdMobBannerSize) => void"
366
- }
367
- ],
368
- "returns": "Promise<PluginListenerHandle>",
369
- "tags": [
370
- {
371
- "name": "group",
372
- "text": [
373
- {
374
- "text": "Banner",
375
- "kind": "text"
376
- }
377
- ]
378
- },
379
- {
380
- "name": "param",
381
- "text": [
382
- {
383
- "text": "eventName",
384
- "kind": "parameterName"
385
- },
386
- {
387
- "text": " ",
388
- "kind": "space"
389
- },
390
- {
391
- "text": "bannerAdSizeChanged",
392
- "kind": "text"
393
- }
394
- ]
395
- },
396
- {
397
- "name": "param",
398
- "text": [
399
- {
400
- "text": "listenerFunc",
401
- "kind": "text"
402
- }
403
- ]
404
- },
405
- {
406
- "name": "since",
407
- "text": [
408
- {
409
- "text": "3.0.0",
410
- "kind": "text"
411
- }
412
- ]
413
- }
414
- ],
415
- "docs": "",
416
- "complexTypes": [
417
- "PluginListenerHandle",
418
- "BannerAdPluginEvents",
419
- "AdMobBannerSize"
420
- ],
421
- "slug": "addlistenerbanneradplugineventssizechanged-"
422
- },
423
- {
424
- "name": "addListener",
425
- "signature": "(eventName: BannerAdPluginEvents.Loaded, listenerFunc: () => void) => Promise<PluginListenerHandle>",
426
- "parameters": [
427
- {
428
- "name": "eventName",
429
- "docs": "bannerAdLoaded",
430
- "type": "BannerAdPluginEvents.Loaded"
431
- },
432
- {
433
- "name": "listenerFunc",
434
- "docs": "",
435
- "type": "() => void"
436
- }
437
- ],
438
- "returns": "Promise<PluginListenerHandle>",
439
- "tags": [
440
- {
441
- "name": "group",
442
- "text": [
443
- {
444
- "text": "Banner",
445
- "kind": "text"
446
- }
447
- ]
448
- },
449
- {
450
- "name": "param",
451
- "text": [
452
- {
453
- "text": "eventName",
454
- "kind": "parameterName"
455
- },
456
- {
457
- "text": " ",
458
- "kind": "space"
459
- },
460
- {
461
- "text": "bannerAdLoaded",
462
- "kind": "text"
463
- }
464
- ]
465
- },
466
- {
467
- "name": "param",
468
- "text": [
469
- {
470
- "text": "listenerFunc",
471
- "kind": "text"
472
- }
473
- ]
474
- },
475
- {
476
- "name": "since",
477
- "text": [
478
- {
479
- "text": "3.0.0",
480
- "kind": "text"
481
- }
482
- ]
483
- }
484
- ],
485
- "docs": "Notice: request loaded Banner ad",
486
- "complexTypes": [
487
- "PluginListenerHandle",
488
- "BannerAdPluginEvents"
489
- ],
490
- "slug": "addlistenerbanneradplugineventsloaded-"
491
- },
492
- {
493
- "name": "addListener",
494
- "signature": "(eventName: BannerAdPluginEvents.FailedToLoad, listenerFunc: (info: AdMobError) => void) => Promise<PluginListenerHandle>",
495
- "parameters": [
496
- {
497
- "name": "eventName",
498
- "docs": "bannerAdFailedToLoad",
499
- "type": "BannerAdPluginEvents.FailedToLoad"
500
- },
501
- {
502
- "name": "listenerFunc",
503
- "docs": "",
504
- "type": "(info: AdMobError) => void"
505
- }
506
- ],
507
- "returns": "Promise<PluginListenerHandle>",
508
- "tags": [
509
- {
510
- "name": "group",
511
- "text": [
512
- {
513
- "text": "Banner",
514
- "kind": "text"
515
- }
516
- ]
517
- },
518
- {
519
- "name": "param",
520
- "text": [
521
- {
522
- "text": "eventName",
523
- "kind": "parameterName"
524
- },
525
- {
526
- "text": " ",
527
- "kind": "space"
528
- },
529
- {
530
- "text": "bannerAdFailedToLoad",
531
- "kind": "text"
532
- }
533
- ]
534
- },
535
- {
536
- "name": "param",
537
- "text": [
538
- {
539
- "text": "listenerFunc",
540
- "kind": "text"
541
- }
542
- ]
543
- },
544
- {
545
- "name": "since",
546
- "text": [
547
- {
548
- "text": "3.0.0",
549
- "kind": "text"
550
- }
551
- ]
552
- }
553
- ],
554
- "docs": "Notice: request failed Banner ad",
555
- "complexTypes": [
556
- "PluginListenerHandle",
557
- "BannerAdPluginEvents",
558
- "AdMobError"
559
- ],
560
- "slug": "addlistenerbanneradplugineventsfailedtoload-"
561
- },
562
- {
563
- "name": "addListener",
564
- "signature": "(eventName: BannerAdPluginEvents.Opened, listenerFunc: () => void) => Promise<PluginListenerHandle>",
565
- "parameters": [
566
- {
567
- "name": "eventName",
568
- "docs": "bannerAdOpened",
569
- "type": "BannerAdPluginEvents.Opened"
570
- },
571
- {
572
- "name": "listenerFunc",
573
- "docs": "",
574
- "type": "() => void"
575
- }
576
- ],
577
- "returns": "Promise<PluginListenerHandle>",
578
- "tags": [
579
- {
580
- "name": "group",
581
- "text": [
582
- {
583
- "text": "Banner",
584
- "kind": "text"
585
- }
586
- ]
587
- },
588
- {
589
- "name": "param",
590
- "text": [
591
- {
592
- "text": "eventName",
593
- "kind": "parameterName"
594
- },
595
- {
596
- "text": " ",
597
- "kind": "space"
598
- },
599
- {
600
- "text": "bannerAdOpened",
601
- "kind": "text"
602
- }
603
- ]
604
- },
605
- {
606
- "name": "param",
607
- "text": [
608
- {
609
- "text": "listenerFunc",
610
- "kind": "text"
611
- }
612
- ]
613
- },
614
- {
615
- "name": "since",
616
- "text": [
617
- {
618
- "text": "3.0.0",
619
- "kind": "text"
620
- }
621
- ]
622
- }
623
- ],
624
- "docs": "Notice: full-screen banner view will be presented in response to the user clicking on an ad.",
625
- "complexTypes": [
626
- "PluginListenerHandle",
627
- "BannerAdPluginEvents"
628
- ],
629
- "slug": "addlistenerbanneradplugineventsopened-"
630
- },
631
- {
632
- "name": "addListener",
633
- "signature": "(eventName: BannerAdPluginEvents.Closed, listenerFunc: () => void) => Promise<PluginListenerHandle>",
634
- "parameters": [
635
- {
636
- "name": "eventName",
637
- "docs": "bannerAdClosed",
638
- "type": "BannerAdPluginEvents.Closed"
639
- },
640
- {
641
- "name": "listenerFunc",
642
- "docs": "",
643
- "type": "() => void"
644
- }
645
- ],
646
- "returns": "Promise<PluginListenerHandle>",
647
- "tags": [
648
- {
649
- "name": "group",
650
- "text": [
651
- {
652
- "text": "Banner",
653
- "kind": "text"
654
- }
655
- ]
656
- },
657
- {
658
- "name": "param",
659
- "text": [
660
- {
661
- "text": "eventName",
662
- "kind": "parameterName"
663
- },
664
- {
665
- "text": " ",
666
- "kind": "space"
667
- },
668
- {
669
- "text": "bannerAdClosed",
670
- "kind": "text"
671
- }
672
- ]
673
- },
674
- {
675
- "name": "param",
676
- "text": [
677
- {
678
- "text": "listenerFunc",
679
- "kind": "text"
680
- }
681
- ]
682
- },
683
- {
684
- "name": "since",
685
- "text": [
686
- {
687
- "text": "3.0.0",
688
- "kind": "text"
689
- }
690
- ]
691
- }
692
- ],
693
- "docs": "Notice: The full-screen banner view will been dismissed.",
694
- "complexTypes": [
695
- "PluginListenerHandle",
696
- "BannerAdPluginEvents"
697
- ],
698
- "slug": "addlistenerbanneradplugineventsclosed-"
699
- },
700
- {
701
- "name": "addListener",
702
- "signature": "(eventName: BannerAdPluginEvents.AdImpression, listenerFunc: () => void) => Promise<PluginListenerHandle>",
703
- "parameters": [
704
- {
705
- "name": "eventName",
706
- "docs": "AdImpression",
707
- "type": "BannerAdPluginEvents.AdImpression"
708
- },
709
- {
710
- "name": "listenerFunc",
711
- "docs": "",
712
- "type": "() => void"
713
- }
714
- ],
715
- "returns": "Promise<PluginListenerHandle>",
716
- "tags": [
717
- {
718
- "name": "group",
719
- "text": [
720
- {
721
- "text": "Banner",
722
- "kind": "text"
723
- }
724
- ]
725
- },
726
- {
727
- "name": "param",
728
- "text": [
729
- {
730
- "text": "eventName",
731
- "kind": "parameterName"
732
- },
733
- {
734
- "text": " ",
735
- "kind": "space"
736
- },
737
- {
738
- "text": "AdImpression",
739
- "kind": "text"
740
- }
741
- ]
742
- },
743
- {
744
- "name": "param",
745
- "text": [
746
- {
747
- "text": "listenerFunc",
748
- "kind": "text"
749
- }
750
- ]
751
- },
752
- {
753
- "name": "since",
754
- "text": [
755
- {
756
- "text": "3.0.0",
757
- "kind": "text"
758
- }
759
- ]
760
- }
761
- ],
762
- "docs": "Unimplemented",
763
- "complexTypes": [
764
- "PluginListenerHandle",
765
- "BannerAdPluginEvents"
766
- ],
767
- "slug": "addlistenerbanneradplugineventsadimpression-"
768
- },
769
- {
770
- "name": "requestConsentInfo",
771
- "signature": "(options?: AdmobConsentRequestOptions) => Promise<AdmobConsentInfo>",
772
- "parameters": [
773
- {
774
- "name": "options",
775
- "docs": "ConsentRequestOptions",
776
- "type": "AdmobConsentRequestOptions | undefined"
777
- }
778
- ],
779
- "returns": "Promise<AdmobConsentInfo>",
780
- "tags": [
781
- {
782
- "name": "group",
783
- "text": [
784
- {
785
- "text": "Consent",
786
- "kind": "text"
787
- }
788
- ]
789
- },
790
- {
791
- "name": "param",
792
- "text": [
793
- {
794
- "text": "options",
795
- "kind": "parameterName"
796
- },
797
- {
798
- "text": " ",
799
- "kind": "space"
800
- },
801
- {
802
- "text": "ConsentRequestOptions",
803
- "kind": "text"
804
- }
805
- ]
806
- },
807
- {
808
- "name": "since",
809
- "text": [
810
- {
811
- "text": "5.0.0",
812
- "kind": "text"
813
- }
814
- ]
815
- }
816
- ],
817
- "docs": "Request user consent information",
818
- "complexTypes": [
819
- "AdmobConsentInfo",
820
- "AdmobConsentRequestOptions"
821
- ],
822
- "slug": "requestconsentinfo"
823
- },
824
- {
825
- "name": "showConsentForm",
826
- "signature": "() => Promise<AdmobConsentInfo>",
827
- "parameters": [],
828
- "returns": "Promise<AdmobConsentInfo>",
829
- "tags": [
830
- {
831
- "name": "group",
832
- "text": [
833
- {
834
- "text": "Consent",
835
- "kind": "text"
836
- }
837
- ]
838
- },
839
- {
840
- "name": "since",
841
- "text": [
842
- {
843
- "text": "5.0.0",
844
- "kind": "text"
845
- }
846
- ]
847
- }
848
- ],
849
- "docs": "Shows a google user consent form (rendered from your GDPR message config).",
850
- "complexTypes": [
851
- "AdmobConsentInfo"
852
- ],
853
- "slug": "showconsentform"
854
- },
855
- {
856
- "name": "resetConsentInfo",
857
- "signature": "() => Promise<void>",
858
- "parameters": [],
859
- "returns": "Promise<void>",
860
- "tags": [
861
- {
862
- "name": "group",
863
- "text": [
864
- {
865
- "text": "Consent",
866
- "kind": "text"
867
- }
868
- ]
869
- },
870
- {
871
- "name": "since",
872
- "text": [
873
- {
874
- "text": "5.0.0",
875
- "kind": "text"
876
- }
877
- ]
878
- }
879
- ],
880
- "docs": "Resets the UMP SDK state. Call requestConsentInfo function again to allow user modify their consent",
881
- "complexTypes": [],
882
- "slug": "resetconsentinfo"
883
- },
884
- {
885
- "name": "prepareInterstitial",
886
- "signature": "(options: AdOptions) => Promise<AdLoadInfo>",
887
- "parameters": [
888
- {
889
- "name": "options",
890
- "docs": "AdOptions",
891
- "type": "AdOptions"
892
- }
893
- ],
894
- "returns": "Promise<AdLoadInfo>",
895
- "tags": [
896
- {
897
- "name": "group",
898
- "text": [
899
- {
900
- "text": "Interstitial",
901
- "kind": "text"
902
- }
903
- ]
904
- },
905
- {
906
- "name": "param",
907
- "text": [
908
- {
909
- "text": "options",
910
- "kind": "parameterName"
911
- },
912
- {
913
- "text": " ",
914
- "kind": "space"
915
- },
916
- {
917
- "text": "AdOptions",
918
- "kind": "text"
919
- }
920
- ]
921
- },
922
- {
923
- "name": "since",
924
- "text": [
925
- {
926
- "text": "1.1.2",
927
- "kind": "text"
928
- }
929
- ]
930
- }
931
- ],
932
- "docs": "Prepare interstitial banner",
933
- "complexTypes": [
934
- "AdLoadInfo",
935
- "AdOptions"
936
- ],
937
- "slug": "prepareinterstitial"
938
- },
939
- {
940
- "name": "showInterstitial",
941
- "signature": "() => Promise<void>",
942
- "parameters": [],
943
- "returns": "Promise<void>",
944
- "tags": [
945
- {
946
- "name": "group",
947
- "text": [
948
- {
949
- "text": "Interstitial",
950
- "kind": "text"
951
- }
952
- ]
953
- },
954
- {
955
- "name": "since",
956
- "text": [
957
- {
958
- "text": "1.1.2",
959
- "kind": "text"
960
- }
961
- ]
962
- }
963
- ],
964
- "docs": "Show interstitial ad when it’s ready",
965
- "complexTypes": [],
966
- "slug": "showinterstitial"
967
- },
968
- {
969
- "name": "addListener",
970
- "signature": "(eventName: InterstitialAdPluginEvents.FailedToLoad, listenerFunc: (error: AdMobError) => void) => Promise<PluginListenerHandle>",
971
- "parameters": [
972
- {
973
- "name": "eventName",
974
- "docs": "",
975
- "type": "InterstitialAdPluginEvents.FailedToLoad"
976
- },
977
- {
978
- "name": "listenerFunc",
979
- "docs": "",
980
- "type": "(error: AdMobError) => void"
981
- }
982
- ],
983
- "returns": "Promise<PluginListenerHandle>",
984
- "tags": [],
985
- "docs": "",
986
- "complexTypes": [
987
- "PluginListenerHandle",
988
- "InterstitialAdPluginEvents",
989
- "AdMobError"
990
- ],
991
- "slug": "addlistenerinterstitialadplugineventsfailedtoload-"
992
- },
993
- {
994
- "name": "addListener",
995
- "signature": "(eventName: InterstitialAdPluginEvents.Loaded, listenerFunc: (info: AdLoadInfo) => void) => Promise<PluginListenerHandle>",
996
- "parameters": [
997
- {
998
- "name": "eventName",
999
- "docs": "",
1000
- "type": "InterstitialAdPluginEvents.Loaded"
1001
- },
1002
- {
1003
- "name": "listenerFunc",
1004
- "docs": "",
1005
- "type": "(info: AdLoadInfo) => void"
1006
- }
1007
- ],
1008
- "returns": "Promise<PluginListenerHandle>",
1009
- "tags": [],
1010
- "docs": "",
1011
- "complexTypes": [
1012
- "PluginListenerHandle",
1013
- "InterstitialAdPluginEvents",
1014
- "AdLoadInfo"
1015
- ],
1016
- "slug": "addlistenerinterstitialadplugineventsloaded-"
1017
- },
1018
- {
1019
- "name": "addListener",
1020
- "signature": "(eventName: InterstitialAdPluginEvents.Dismissed, listenerFunc: () => void) => Promise<PluginListenerHandle>",
1021
- "parameters": [
1022
- {
1023
- "name": "eventName",
1024
- "docs": "",
1025
- "type": "InterstitialAdPluginEvents.Dismissed"
1026
- },
1027
- {
1028
- "name": "listenerFunc",
1029
- "docs": "",
1030
- "type": "() => void"
1031
- }
1032
- ],
1033
- "returns": "Promise<PluginListenerHandle>",
1034
- "tags": [],
1035
- "docs": "",
1036
- "complexTypes": [
1037
- "PluginListenerHandle",
1038
- "InterstitialAdPluginEvents"
1039
- ],
1040
- "slug": "addlistenerinterstitialadplugineventsdismissed-"
1041
- },
1042
- {
1043
- "name": "addListener",
1044
- "signature": "(eventName: InterstitialAdPluginEvents.FailedToShow, listenerFunc: (error: AdMobError) => void) => Promise<PluginListenerHandle>",
1045
- "parameters": [
1046
- {
1047
- "name": "eventName",
1048
- "docs": "",
1049
- "type": "InterstitialAdPluginEvents.FailedToShow"
1050
- },
1051
- {
1052
- "name": "listenerFunc",
1053
- "docs": "",
1054
- "type": "(error: AdMobError) => void"
1055
- }
1056
- ],
1057
- "returns": "Promise<PluginListenerHandle>",
1058
- "tags": [],
1059
- "docs": "",
1060
- "complexTypes": [
1061
- "PluginListenerHandle",
1062
- "InterstitialAdPluginEvents",
1063
- "AdMobError"
1064
- ],
1065
- "slug": "addlistenerinterstitialadplugineventsfailedtoshow-"
1066
- },
1067
- {
1068
- "name": "addListener",
1069
- "signature": "(eventName: InterstitialAdPluginEvents.Showed, listenerFunc: () => void) => Promise<PluginListenerHandle>",
1070
- "parameters": [
1071
- {
1072
- "name": "eventName",
1073
- "docs": "",
1074
- "type": "InterstitialAdPluginEvents.Showed"
1075
- },
1076
- {
1077
- "name": "listenerFunc",
1078
- "docs": "",
1079
- "type": "() => void"
1080
- }
1081
- ],
1082
- "returns": "Promise<PluginListenerHandle>",
1083
- "tags": [],
1084
- "docs": "",
1085
- "complexTypes": [
1086
- "PluginListenerHandle",
1087
- "InterstitialAdPluginEvents"
1088
- ],
1089
- "slug": "addlistenerinterstitialadplugineventsshowed-"
1090
- },
1091
- {
1092
- "name": "prepareRewardVideoAd",
1093
- "signature": "(options: RewardAdOptions) => Promise<AdLoadInfo>",
1094
- "parameters": [
1095
- {
1096
- "name": "options",
1097
- "docs": "RewardAdOptions",
1098
- "type": "RewardAdOptions"
1099
- }
1100
- ],
1101
- "returns": "Promise<AdLoadInfo>",
1102
- "tags": [
1103
- {
1104
- "name": "group",
1105
- "text": [
1106
- {
1107
- "text": "RewardVideo",
1108
- "kind": "text"
1109
- }
1110
- ]
1111
- },
1112
- {
1113
- "name": "param",
1114
- "text": [
1115
- {
1116
- "text": "options",
1117
- "kind": "parameterName"
1118
- },
1119
- {
1120
- "text": " ",
1121
- "kind": "space"
1122
- },
1123
- {
1124
- "text": "RewardAdOptions",
1125
- "kind": "text"
1126
- }
1127
- ]
1128
- },
1129
- {
1130
- "name": "since",
1131
- "text": [
1132
- {
1133
- "text": "1.1.2",
1134
- "kind": "text"
1135
- }
1136
- ]
1137
- }
1138
- ],
1139
- "docs": "Prepare a reward video ad",
1140
- "complexTypes": [
1141
- "AdLoadInfo",
1142
- "RewardAdOptions"
1143
- ],
1144
- "slug": "preparerewardvideoad"
1145
- },
1146
- {
1147
- "name": "showRewardVideoAd",
1148
- "signature": "() => Promise<AdMobRewardItem>",
1149
- "parameters": [],
1150
- "returns": "Promise<AdMobRewardItem>",
1151
- "tags": [
1152
- {
1153
- "name": "group",
1154
- "text": [
1155
- {
1156
- "text": "RewardVideo",
1157
- "kind": "text"
1158
- }
1159
- ]
1160
- },
1161
- {
1162
- "name": "since",
1163
- "text": [
1164
- {
1165
- "text": "1.1.2",
1166
- "kind": "text"
1167
- }
1168
- ]
1169
- }
1170
- ],
1171
- "docs": "Show a reward video ad",
1172
- "complexTypes": [
1173
- "AdMobRewardItem"
1174
- ],
1175
- "slug": "showrewardvideoad"
1176
- },
1177
- {
1178
- "name": "addListener",
1179
- "signature": "(eventName: RewardAdPluginEvents.FailedToLoad, listenerFunc: (error: AdMobError) => void) => Promise<PluginListenerHandle>",
1180
- "parameters": [
1181
- {
1182
- "name": "eventName",
1183
- "docs": "",
1184
- "type": "RewardAdPluginEvents.FailedToLoad"
1185
- },
1186
- {
1187
- "name": "listenerFunc",
1188
- "docs": "",
1189
- "type": "(error: AdMobError) => void"
1190
- }
1191
- ],
1192
- "returns": "Promise<PluginListenerHandle>",
1193
- "tags": [],
1194
- "docs": "",
1195
- "complexTypes": [
1196
- "PluginListenerHandle",
1197
- "RewardAdPluginEvents",
1198
- "AdMobError"
1199
- ],
1200
- "slug": "addlistenerrewardadplugineventsfailedtoload-"
1201
- },
1202
- {
1203
- "name": "addListener",
1204
- "signature": "(eventName: RewardAdPluginEvents.Loaded, listenerFunc: (info: AdLoadInfo) => void) => Promise<PluginListenerHandle>",
1205
- "parameters": [
1206
- {
1207
- "name": "eventName",
1208
- "docs": "",
1209
- "type": "RewardAdPluginEvents.Loaded"
1210
- },
1211
- {
1212
- "name": "listenerFunc",
1213
- "docs": "",
1214
- "type": "(info: AdLoadInfo) => void"
1215
- }
1216
- ],
1217
- "returns": "Promise<PluginListenerHandle>",
1218
- "tags": [],
1219
- "docs": "",
1220
- "complexTypes": [
1221
- "PluginListenerHandle",
1222
- "RewardAdPluginEvents",
1223
- "AdLoadInfo"
1224
- ],
1225
- "slug": "addlistenerrewardadplugineventsloaded-"
1226
- },
1227
- {
1228
- "name": "addListener",
1229
- "signature": "(eventName: RewardAdPluginEvents.Rewarded, listenerFunc: (reward: AdMobRewardItem) => void) => Promise<PluginListenerHandle>",
1230
- "parameters": [
1231
- {
1232
- "name": "eventName",
1233
- "docs": "",
1234
- "type": "RewardAdPluginEvents.Rewarded"
1235
- },
1236
- {
1237
- "name": "listenerFunc",
1238
- "docs": "",
1239
- "type": "(reward: AdMobRewardItem) => void"
1240
- }
1241
- ],
1242
- "returns": "Promise<PluginListenerHandle>",
1243
- "tags": [],
1244
- "docs": "",
1245
- "complexTypes": [
1246
- "PluginListenerHandle",
1247
- "RewardAdPluginEvents",
1248
- "AdMobRewardItem"
1249
- ],
1250
- "slug": "addlistenerrewardadplugineventsrewarded-"
1251
- },
1252
- {
1253
- "name": "addListener",
1254
- "signature": "(eventName: RewardAdPluginEvents.Dismissed, listenerFunc: () => void) => Promise<PluginListenerHandle>",
1255
- "parameters": [
1256
- {
1257
- "name": "eventName",
1258
- "docs": "",
1259
- "type": "RewardAdPluginEvents.Dismissed"
1260
- },
1261
- {
1262
- "name": "listenerFunc",
1263
- "docs": "",
1264
- "type": "() => void"
1265
- }
1266
- ],
1267
- "returns": "Promise<PluginListenerHandle>",
1268
- "tags": [],
1269
- "docs": "",
1270
- "complexTypes": [
1271
- "PluginListenerHandle",
1272
- "RewardAdPluginEvents"
1273
- ],
1274
- "slug": "addlistenerrewardadplugineventsdismissed-"
1275
- },
1276
- {
1277
- "name": "addListener",
1278
- "signature": "(eventName: RewardAdPluginEvents.FailedToShow, listenerFunc: (error: AdMobError) => void) => Promise<PluginListenerHandle>",
1279
- "parameters": [
1280
- {
1281
- "name": "eventName",
1282
- "docs": "",
1283
- "type": "RewardAdPluginEvents.FailedToShow"
1284
- },
1285
- {
1286
- "name": "listenerFunc",
1287
- "docs": "",
1288
- "type": "(error: AdMobError) => void"
1289
- }
1290
- ],
1291
- "returns": "Promise<PluginListenerHandle>",
1292
- "tags": [],
1293
- "docs": "",
1294
- "complexTypes": [
1295
- "PluginListenerHandle",
1296
- "RewardAdPluginEvents",
1297
- "AdMobError"
1298
- ],
1299
- "slug": "addlistenerrewardadplugineventsfailedtoshow-"
1300
- },
1301
- {
1302
- "name": "addListener",
1303
- "signature": "(eventName: RewardAdPluginEvents.Showed, listenerFunc: () => void) => Promise<PluginListenerHandle>",
1304
- "parameters": [
1305
- {
1306
- "name": "eventName",
1307
- "docs": "",
1308
- "type": "RewardAdPluginEvents.Showed"
1309
- },
1310
- {
1311
- "name": "listenerFunc",
1312
- "docs": "",
1313
- "type": "() => void"
1314
- }
1315
- ],
1316
- "returns": "Promise<PluginListenerHandle>",
1317
- "tags": [],
1318
- "docs": "",
1319
- "complexTypes": [
1320
- "PluginListenerHandle",
1321
- "RewardAdPluginEvents"
1322
- ],
1323
- "slug": "addlistenerrewardadplugineventsshowed-"
1324
- },
1325
- {
1326
- "name": "prepareRewardInterstitialAd",
1327
- "signature": "(options: RewardInterstitialAdOptions) => Promise<AdLoadInfo>",
1328
- "parameters": [
1329
- {
1330
- "name": "options",
1331
- "docs": "RewardAdOptions",
1332
- "type": "RewardInterstitialAdOptions"
1333
- }
1334
- ],
1335
- "returns": "Promise<AdLoadInfo>",
1336
- "tags": [
1337
- {
1338
- "name": "group",
1339
- "text": [
1340
- {
1341
- "text": "RewardVideo",
1342
- "kind": "text"
1343
- }
1344
- ]
1345
- },
1346
- {
1347
- "name": "param",
1348
- "text": [
1349
- {
1350
- "text": "options",
1351
- "kind": "parameterName"
1352
- },
1353
- {
1354
- "text": " ",
1355
- "kind": "space"
1356
- },
1357
- {
1358
- "text": "RewardAdOptions",
1359
- "kind": "text"
1360
- }
1361
- ]
1362
- },
1363
- {
1364
- "name": "since",
1365
- "text": [
1366
- {
1367
- "text": "1.1.2",
1368
- "kind": "text"
1369
- }
1370
- ]
1371
- }
1372
- ],
1373
- "docs": "Prepare a reward video ad",
1374
- "complexTypes": [
1375
- "AdLoadInfo",
1376
- "RewardInterstitialAdOptions"
1377
- ],
1378
- "slug": "preparerewardinterstitialad"
1379
- },
1380
- {
1381
- "name": "showRewardInterstitialAd",
1382
- "signature": "() => Promise<AdMobRewardInterstitialItem>",
1383
- "parameters": [],
1384
- "returns": "Promise<AdMobRewardInterstitialItem>",
1385
- "tags": [
1386
- {
1387
- "name": "group",
1388
- "text": [
1389
- {
1390
- "text": "RewardVideo",
1391
- "kind": "text"
1392
- }
1393
- ]
1394
- },
1395
- {
1396
- "name": "since",
1397
- "text": [
1398
- {
1399
- "text": "1.1.2",
1400
- "kind": "text"
1401
- }
1402
- ]
1403
- }
1404
- ],
1405
- "docs": "Show a reward video ad",
1406
- "complexTypes": [
1407
- "AdMobRewardInterstitialItem"
1408
- ],
1409
- "slug": "showrewardinterstitialad"
1410
- },
1411
- {
1412
- "name": "addListener",
1413
- "signature": "(eventName: RewardInterstitialAdPluginEvents.FailedToLoad, listenerFunc: (error: AdMobError) => void) => Promise<PluginListenerHandle>",
1414
- "parameters": [
1415
- {
1416
- "name": "eventName",
1417
- "docs": "",
1418
- "type": "RewardInterstitialAdPluginEvents.FailedToLoad"
1419
- },
1420
- {
1421
- "name": "listenerFunc",
1422
- "docs": "",
1423
- "type": "(error: AdMobError) => void"
1424
- }
1425
- ],
1426
- "returns": "Promise<PluginListenerHandle>",
1427
- "tags": [],
1428
- "docs": "",
1429
- "complexTypes": [
1430
- "PluginListenerHandle",
1431
- "RewardInterstitialAdPluginEvents",
1432
- "AdMobError"
1433
- ],
1434
- "slug": "addlistenerrewardinterstitialadplugineventsfailedtoload-"
1435
- },
1436
- {
1437
- "name": "addListener",
1438
- "signature": "(eventName: RewardInterstitialAdPluginEvents.Loaded, listenerFunc: (info: AdLoadInfo) => void) => Promise<PluginListenerHandle>",
1439
- "parameters": [
1440
- {
1441
- "name": "eventName",
1442
- "docs": "",
1443
- "type": "RewardInterstitialAdPluginEvents.Loaded"
1444
- },
1445
- {
1446
- "name": "listenerFunc",
1447
- "docs": "",
1448
- "type": "(info: AdLoadInfo) => void"
1449
- }
1450
- ],
1451
- "returns": "Promise<PluginListenerHandle>",
1452
- "tags": [],
1453
- "docs": "",
1454
- "complexTypes": [
1455
- "PluginListenerHandle",
1456
- "RewardInterstitialAdPluginEvents",
1457
- "AdLoadInfo"
1458
- ],
1459
- "slug": "addlistenerrewardinterstitialadplugineventsloaded-"
1460
- },
1461
- {
1462
- "name": "addListener",
1463
- "signature": "(eventName: RewardInterstitialAdPluginEvents.Rewarded, listenerFunc: (reward: AdMobRewardInterstitialItem) => void) => Promise<PluginListenerHandle>",
1464
- "parameters": [
1465
- {
1466
- "name": "eventName",
1467
- "docs": "",
1468
- "type": "RewardInterstitialAdPluginEvents.Rewarded"
1469
- },
1470
- {
1471
- "name": "listenerFunc",
1472
- "docs": "",
1473
- "type": "(reward: AdMobRewardInterstitialItem) => void"
1474
- }
1475
- ],
1476
- "returns": "Promise<PluginListenerHandle>",
1477
- "tags": [],
1478
- "docs": "",
1479
- "complexTypes": [
1480
- "PluginListenerHandle",
1481
- "RewardInterstitialAdPluginEvents",
1482
- "AdMobRewardInterstitialItem"
1483
- ],
1484
- "slug": "addlistenerrewardinterstitialadplugineventsrewarded-"
1485
- },
1486
- {
1487
- "name": "addListener",
1488
- "signature": "(eventName: RewardInterstitialAdPluginEvents.Dismissed, listenerFunc: () => void) => Promise<PluginListenerHandle>",
1489
- "parameters": [
1490
- {
1491
- "name": "eventName",
1492
- "docs": "",
1493
- "type": "RewardInterstitialAdPluginEvents.Dismissed"
1494
- },
1495
- {
1496
- "name": "listenerFunc",
1497
- "docs": "",
1498
- "type": "() => void"
1499
- }
1500
- ],
1501
- "returns": "Promise<PluginListenerHandle>",
1502
- "tags": [],
1503
- "docs": "",
1504
- "complexTypes": [
1505
- "PluginListenerHandle",
1506
- "RewardInterstitialAdPluginEvents"
1507
- ],
1508
- "slug": "addlistenerrewardinterstitialadplugineventsdismissed-"
1509
- },
1510
- {
1511
- "name": "addListener",
1512
- "signature": "(eventName: RewardInterstitialAdPluginEvents.FailedToShow, listenerFunc: (error: AdMobError) => void) => Promise<PluginListenerHandle>",
1513
- "parameters": [
1514
- {
1515
- "name": "eventName",
1516
- "docs": "",
1517
- "type": "RewardInterstitialAdPluginEvents.FailedToShow"
1518
- },
1519
- {
1520
- "name": "listenerFunc",
1521
- "docs": "",
1522
- "type": "(error: AdMobError) => void"
1523
- }
1524
- ],
1525
- "returns": "Promise<PluginListenerHandle>",
1526
- "tags": [],
1527
- "docs": "",
1528
- "complexTypes": [
1529
- "PluginListenerHandle",
1530
- "RewardInterstitialAdPluginEvents",
1531
- "AdMobError"
1532
- ],
1533
- "slug": "addlistenerrewardinterstitialadplugineventsfailedtoshow-"
1534
- },
1535
- {
1536
- "name": "addListener",
1537
- "signature": "(eventName: RewardInterstitialAdPluginEvents.Showed, listenerFunc: () => void) => Promise<PluginListenerHandle>",
1538
- "parameters": [
1539
- {
1540
- "name": "eventName",
1541
- "docs": "",
1542
- "type": "RewardInterstitialAdPluginEvents.Showed"
1543
- },
1544
- {
1545
- "name": "listenerFunc",
1546
- "docs": "",
1547
- "type": "() => void"
1548
- }
1549
- ],
1550
- "returns": "Promise<PluginListenerHandle>",
1551
- "tags": [],
1552
- "docs": "",
1553
- "complexTypes": [
1554
- "PluginListenerHandle",
1555
- "RewardInterstitialAdPluginEvents"
1556
- ],
1557
- "slug": "addlistenerrewardinterstitialadplugineventsshowed-"
1558
- }
1559
- ],
1560
- "properties": [],
1561
- "importObject": [
1562
- "BannerDefinitions",
1563
- "AdmobConsentDefinitions",
1564
- "InterstitialDefinitions",
1565
- "RewardDefinitions",
1566
- "RewardInterstitialDefinitions",
1567
- "TrackingAuthorizationStatusInterface",
1568
- "AdMobDefinitions",
1569
- "AdMobInitializationOptions",
1570
- "MaxAdContentRating",
1571
- "ApplicationMutedOptions",
1572
- "ApplicationVolumeOptions"
1573
- ]
1574
- },
1575
- "interfaces": [
1576
- {
1577
- "name": "AdMobInitializationOptions",
1578
- "slug": "admobinitializationoptions",
1579
- "docs": "",
1580
- "tags": [],
1581
- "methods": [],
1582
- "properties": [
1583
- {
1584
- "name": "testingDevices",
1585
- "tags": [
1586
- {
1587
- "text": [
1588
- {
1589
- "text": "https",
1590
- "kind": "text"
1591
- },
1592
- {
1593
- "text": "://developers.google.com/admob/android/test-ads#enable_test_devices",
1594
- "kind": "text"
1595
- }
1596
- ],
1597
- "name": "see"
1598
- },
1599
- {
1600
- "text": [
1601
- {
1602
- "text": "1.2.0",
1603
- "kind": "text"
1604
- }
1605
- ],
1606
- "name": "since"
1607
- }
1608
- ],
1609
- "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').",
1610
- "complexTypes": [],
1611
- "type": "string[] | undefined"
1612
- },
1613
- {
1614
- "name": "initializeForTesting",
1615
- "tags": [
1616
- {
1617
- "text": [
1618
- {
1619
- "text": "AdMobInitializationOptions.testingDevices",
1620
- "kind": "text"
1621
- },
1622
- {
1623
- "text": " ",
1624
- "kind": "space"
1625
- },
1626
- {
1627
- "text": "*",
1628
- "kind": "text"
1629
- }
1630
- ],
1631
- "name": "see"
1632
- },
1633
- {
1634
- "text": [
1635
- {
1636
- "text": "false",
1637
- "kind": "text"
1638
- }
1639
- ],
1640
- "name": "default"
1641
- },
1642
- {
1643
- "text": [
1644
- {
1645
- "text": "1.2.0",
1646
- "kind": "text"
1647
- }
1648
- ],
1649
- "name": "since"
1650
- }
1651
- ],
1652
- "docs": "If set to true, the devices on {@link AdMobInitializationOptions.testingDevices} will\nbe registered to receive test production ads.",
1653
- "complexTypes": [],
1654
- "type": "boolean | undefined"
1655
- },
1656
- {
1657
- "name": "tagForChildDirectedTreatment",
1658
- "tags": [
1659
- {
1660
- "text": [
1661
- {
1662
- "text": "https",
1663
- "kind": "text"
1664
- },
1665
- {
1666
- "text": "://developers.google.com/admob/android/targeting#child-directed_setting",
1667
- "kind": "text"
1668
- }
1669
- ],
1670
- "name": "see"
1671
- },
1672
- {
1673
- "text": [
1674
- {
1675
- "text": "3.1.0",
1676
- "kind": "text"
1677
- }
1678
- ],
1679
- "name": "since"
1680
- }
1681
- ],
1682
- "docs": "For purposes of the Children's Online Privacy Protection Act (COPPA),\nthere is a setting called tagForChildDirectedTreatment.",
1683
- "complexTypes": [],
1684
- "type": "boolean | undefined"
1685
- },
1686
- {
1687
- "name": "tagForUnderAgeOfConsent",
1688
- "tags": [
1689
- {
1690
- "text": [
1691
- {
1692
- "text": "https",
1693
- "kind": "text"
1694
- },
1695
- {
1696
- "text": "://developers.google.com/admob/android/targeting#users_under_the_age_of_consent",
1697
- "kind": "text"
1698
- }
1699
- ],
1700
- "name": "see"
1701
- },
1702
- {
1703
- "text": [
1704
- {
1705
- "text": "3.1.0",
1706
- "kind": "text"
1707
- }
1708
- ],
1709
- "name": "since"
1710
- }
1711
- ],
1712
- "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.",
1713
- "complexTypes": [],
1714
- "type": "boolean | undefined"
1715
- },
1716
- {
1717
- "name": "maxAdContentRating",
1718
- "tags": [
1719
- {
1720
- "text": [
1721
- {
1722
- "text": "https",
1723
- "kind": "text"
1724
- },
1725
- {
1726
- "text": "://developers.google.com/admob/android/targeting#child-directed_setting",
1727
- "kind": "text"
1728
- }
1729
- ],
1730
- "name": "see"
1731
- },
1732
- {
1733
- "text": [
1734
- {
1735
- "text": "3.1.0",
1736
- "kind": "text"
1737
- }
1738
- ],
1739
- "name": "since"
1740
- }
1741
- ],
1742
- "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.",
1743
- "complexTypes": [
1744
- "MaxAdContentRating"
1745
- ],
1746
- "type": "MaxAdContentRating"
1747
- }
1748
- ],
1749
- "importObject": [
1750
- "BannerDefinitions",
1751
- "AdmobConsentDefinitions",
1752
- "InterstitialDefinitions",
1753
- "RewardDefinitions",
1754
- "RewardInterstitialDefinitions",
1755
- "TrackingAuthorizationStatusInterface",
1756
- "AdMobDefinitions",
1757
- "AdMobPlugin",
1758
- "MaxAdContentRating",
1759
- "ApplicationMutedOptions",
1760
- "ApplicationVolumeOptions"
1761
- ]
1762
- },
1763
- {
1764
- "name": "TrackingAuthorizationStatusInterface",
1765
- "slug": "trackingauthorizationstatusinterface",
1766
- "docs": "",
1767
- "tags": [
1768
- {
1769
- "text": [
1770
- {
1771
- "text": "https://developer.apple.com/documentation/apptrackingtransparency/attrackingmanager/authorizationstatus",
1772
- "kind": "text"
1773
- }
1774
- ],
1775
- "name": "url"
1776
- }
1777
- ],
1778
- "methods": [],
1779
- "properties": [
1780
- {
1781
- "name": "status",
1782
- "tags": [],
1783
- "docs": "",
1784
- "complexTypes": [],
1785
- "type": "'authorized' | 'denied' | 'notDetermined' | 'restricted'"
1786
- }
1787
- ],
1788
- "importObject": []
1789
- },
1790
- {
1791
- "name": "ApplicationMutedOptions",
1792
- "slug": "applicationmutedoptions",
1793
- "docs": "",
1794
- "tags": [],
1795
- "methods": [],
1796
- "properties": [
1797
- {
1798
- "name": "muted",
1799
- "tags": [
1800
- {
1801
- "text": [
1802
- {
1803
- "text": "https",
1804
- "kind": "text"
1805
- },
1806
- {
1807
- "text": "://developers.google.com/admob/android/global-settings",
1808
- "kind": "text"
1809
- }
1810
- ],
1811
- "name": "see"
1812
- },
1813
- {
1814
- "text": [
1815
- {
1816
- "text": "4.1.1",
1817
- "kind": "text"
1818
- }
1819
- ],
1820
- "name": "since"
1821
- }
1822
- ],
1823
- "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.",
1824
- "complexTypes": [],
1825
- "type": "boolean | undefined"
1826
- }
1827
- ],
1828
- "importObject": [
1829
- "BannerDefinitions",
1830
- "AdmobConsentDefinitions",
1831
- "InterstitialDefinitions",
1832
- "RewardDefinitions",
1833
- "RewardInterstitialDefinitions",
1834
- "TrackingAuthorizationStatusInterface",
1835
- "AdMobDefinitions",
1836
- "AdMobPlugin",
1837
- "AdMobInitializationOptions",
1838
- "MaxAdContentRating",
1839
- "ApplicationVolumeOptions"
1840
- ]
1841
- },
1842
- {
1843
- "name": "ApplicationVolumeOptions",
1844
- "slug": "applicationvolumeoptions",
1845
- "docs": "",
1846
- "tags": [],
1847
- "methods": [],
1848
- "properties": [
1849
- {
1850
- "name": "volume",
1851
- "tags": [
1852
- {
1853
- "text": [
1854
- {
1855
- "text": "https",
1856
- "kind": "text"
1857
- },
1858
- {
1859
- "text": "://developers.google.com/admob/android/global-settings",
1860
- "kind": "text"
1861
- }
1862
- ],
1863
- "name": "see"
1864
- },
1865
- {
1866
- "text": [
1867
- {
1868
- "text": "4.1.1",
1869
- "kind": "text"
1870
- }
1871
- ],
1872
- "name": "since"
1873
- }
1874
- ],
1875
- "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.",
1876
- "complexTypes": [],
1877
- "type": "0 | 1 | 0.1 | 0.2 | 0.3 | 0.4 | 0.5 | 0.6 | 0.7 | 0.8 | 0.9 | undefined"
1878
- }
1879
- ],
1880
- "importObject": [
1881
- "BannerDefinitions",
1882
- "AdmobConsentDefinitions",
1883
- "InterstitialDefinitions",
1884
- "RewardDefinitions",
1885
- "RewardInterstitialDefinitions",
1886
- "TrackingAuthorizationStatusInterface",
1887
- "AdMobDefinitions",
1888
- "AdMobPlugin",
1889
- "AdMobInitializationOptions",
1890
- "MaxAdContentRating",
1891
- "ApplicationMutedOptions"
1892
- ]
1893
- },
1894
- {
1895
- "name": "BannerAdOptions",
1896
- "slug": "banneradoptions",
1897
- "docs": "This interface extends AdOptions",
1898
- "tags": [],
1899
- "methods": [],
1900
- "properties": [
1901
- {
1902
- "name": "adSize",
1903
- "tags": [
1904
- {
1905
- "text": [
1906
- {
1907
- "text": "ADAPTIVE_BANNER",
1908
- "kind": "text"
1909
- }
1910
- ],
1911
- "name": "default"
1912
- },
1913
- {
1914
- "text": [
1915
- {
1916
- "text": "3.0.0",
1917
- "kind": "text"
1918
- }
1919
- ],
1920
- "name": "since"
1921
- }
1922
- ],
1923
- "docs": "Banner Ad Size, defaults to ADAPTIVE_BANNER.\r\nIT can be: ADAPTIVE_BANNER, SMART_BANNER, BANNER,\r\nMEDIUM_RECTANGLE, FULL_BANNER, LEADERBOARD",
1924
- "complexTypes": [
1925
- "BannerAdSize"
1926
- ],
1927
- "type": "BannerAdSize"
1928
- },
1929
- {
1930
- "name": "position",
1931
- "tags": [
1932
- {
1933
- "text": [
1934
- {
1935
- "text": "TOP_CENTER",
1936
- "kind": "text"
1937
- }
1938
- ],
1939
- "name": "default"
1940
- },
1941
- {
1942
- "text": [
1943
- {
1944
- "text": "1.1.2",
1945
- "kind": "text"
1946
- }
1947
- ],
1948
- "name": "since"
1949
- }
1950
- ],
1951
- "docs": "Set Banner Ad position.\r\nTOP_CENTER or CENTER or BOTTOM_CENTER",
1952
- "complexTypes": [
1953
- "BannerAdPosition"
1954
- ],
1955
- "type": "BannerAdPosition"
1956
- }
1957
- ],
1958
- "importObject": [
1959
- "AdOptions",
1960
- "BannerAdPosition",
1961
- "BannerAdSize"
1962
- ]
1963
- },
1964
- {
1965
- "name": "PluginListenerHandle",
1966
- "slug": "pluginlistenerhandle",
1967
- "docs": "",
1968
- "tags": [],
1969
- "methods": [],
1970
- "properties": [
1971
- {
1972
- "name": "remove",
1973
- "tags": [],
1974
- "docs": "",
1975
- "complexTypes": [],
1976
- "type": "() => Promise<void>"
1977
- }
1978
- ],
1979
- "importObject": [
1980
- "PluginRegistry",
1981
- "CapacitorException",
1982
- "CapacitorGlobal",
1983
- "RegisterPlugin",
1984
- "PluginImplementations",
1985
- "Plugin",
1986
- "PermissionState",
1987
- "PluginResultData",
1988
- "PluginResultError",
1989
- "PluginCallback"
1990
- ]
1991
- },
1992
- {
1993
- "name": "AdMobBannerSize",
1994
- "slug": "admobbannersize",
1995
- "docs": "When notice listener of OnAdLoaded, you can get banner size.",
1996
- "tags": [],
1997
- "methods": [],
1998
- "properties": [
1999
- {
2000
- "name": "width",
2001
- "tags": [],
2002
- "docs": "",
2003
- "complexTypes": [],
2004
- "type": "number"
2005
- },
2006
- {
2007
- "name": "height",
2008
- "tags": [],
2009
- "docs": "",
2010
- "complexTypes": [],
2011
- "type": "number"
2012
- }
2013
- ],
2014
- "importObject": []
2015
- },
2016
- {
2017
- "name": "AdMobError",
2018
- "slug": "admoberror",
2019
- "docs": "For more information\r\nhttps://developers.google.com/android/reference/com/google/android/gms/ads/AdError",
2020
- "tags": [],
2021
- "methods": [],
2022
- "properties": [
2023
- {
2024
- "name": "code",
2025
- "tags": [],
2026
- "docs": "Gets the error's code.",
2027
- "complexTypes": [],
2028
- "type": "number"
2029
- },
2030
- {
2031
- "name": "message",
2032
- "tags": [],
2033
- "docs": "Gets the message describing the error.",
2034
- "complexTypes": [],
2035
- "type": "string"
2036
- }
2037
- ],
2038
- "importObject": []
2039
- },
2040
- {
2041
- "name": "AdmobConsentInfo",
2042
- "slug": "admobconsentinfo",
2043
- "docs": "",
2044
- "tags": [],
2045
- "methods": [],
2046
- "properties": [
2047
- {
2048
- "name": "status",
2049
- "tags": [
2050
- {
2051
- "text": [
2052
- {
2053
- "text": "5.0.0",
2054
- "kind": "text"
2055
- }
2056
- ],
2057
- "name": "since"
2058
- }
2059
- ],
2060
- "docs": "The consent status of the user.",
2061
- "complexTypes": [
2062
- "AdmobConsentStatus"
2063
- ],
2064
- "type": "AdmobConsentStatus"
2065
- },
2066
- {
2067
- "name": "isConsentFormAvailable",
2068
- "tags": [
2069
- {
2070
- "text": [
2071
- {
2072
- "text": "5.0.0",
2073
- "kind": "text"
2074
- }
2075
- ],
2076
- "name": "since"
2077
- }
2078
- ],
2079
- "docs": "If `true` a consent form is available and vice versa.",
2080
- "complexTypes": [],
2081
- "type": "boolean | undefined"
2082
- }
2083
- ],
2084
- "importObject": [
2085
- "AdmobConsentStatus"
2086
- ]
2087
- },
2088
- {
2089
- "name": "AdmobConsentRequestOptions",
2090
- "slug": "admobconsentrequestoptions",
2091
- "docs": "",
2092
- "tags": [],
2093
- "methods": [],
2094
- "properties": [
2095
- {
2096
- "name": "debugGeography",
2097
- "tags": [
2098
- {
2099
- "text": [
2100
- {
2101
- "text": "5.0.0",
2102
- "kind": "text"
2103
- }
2104
- ],
2105
- "name": "since"
2106
- }
2107
- ],
2108
- "docs": "Sets the debug geography to test the consent locally.",
2109
- "complexTypes": [
2110
- "AdmobConsentDebugGeography"
2111
- ],
2112
- "type": "AdmobConsentDebugGeography"
2113
- },
2114
- {
2115
- "name": "testDeviceIdentifiers",
2116
- "tags": [
2117
- {
2118
- "text": [
2119
- {
2120
- "text": "5.0.0",
2121
- "kind": "text"
2122
- }
2123
- ],
2124
- "name": "since"
2125
- }
2126
- ],
2127
- "docs": "An array of test device IDs to allow.\nNote: On iOS, the ID may renew if you uninstall and reinstall the app.",
2128
- "complexTypes": [],
2129
- "type": "string[] | undefined"
2130
- },
2131
- {
2132
- "name": "tagForUnderAgeOfConsent",
2133
- "tags": [
2134
- {
2135
- "text": [
2136
- {
2137
- "text": "false",
2138
- "kind": "text"
2139
- }
2140
- ],
2141
- "name": "default"
2142
- },
2143
- {
2144
- "text": [
2145
- {
2146
- "text": "5.0.0",
2147
- "kind": "text"
2148
- }
2149
- ],
2150
- "name": "since"
2151
- }
2152
- ],
2153
- "docs": "Set to `true` to provide the option for the user to accept being shown personalized ads.",
2154
- "complexTypes": [],
2155
- "type": "boolean | undefined"
2156
- }
2157
- ],
2158
- "importObject": [
2159
- "AdmobConsentDebugGeography"
2160
- ]
2161
- },
2162
- {
2163
- "name": "AdLoadInfo",
2164
- "slug": "adloadinfo",
2165
- "docs": "",
2166
- "tags": [],
2167
- "methods": [],
2168
- "properties": [
2169
- {
2170
- "name": "adUnitId",
2171
- "tags": [],
2172
- "docs": "",
2173
- "complexTypes": [],
2174
- "type": "string"
2175
- }
2176
- ],
2177
- "importObject": []
2178
- },
132
+ }
133
+ ],
134
+ "properties": []
135
+ },
136
+ "interfaces": [
2179
137
  {
2180
- "name": "AdOptions",
2181
- "slug": "adoptions",
138
+ "name": "AdMobInitializationOptions",
139
+ "slug": "admobinitializationoptions",
2182
140
  "docs": "",
2183
141
  "tags": [],
2184
142
  "methods": [],
2185
143
  "properties": [
2186
144
  {
2187
- "name": "adId",
145
+ "name": "testingDevices",
2188
146
  "tags": [
2189
147
  {
2190
- "text": [
2191
- {
2192
- "text": "https",
2193
- "kind": "text"
2194
- },
2195
- {
2196
- "text": "://support.google.com/admob/answer/7356431?hl=en",
2197
- "kind": "text"
2198
- }
2199
- ],
148
+ "text": "https ://developers.google.com/admob/android/test-ads#enable_test_devices",
2200
149
  "name": "see"
2201
150
  },
2202
151
  {
2203
- "text": [
2204
- {
2205
- "text": "1.1.2",
2206
- "kind": "text"
2207
- }
2208
- ],
152
+ "text": "1.2.0",
2209
153
  "name": "since"
2210
154
  }
2211
155
  ],
2212
- "docs": "The ad unit ID that you want to request",
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').",
2213
157
  "complexTypes": [],
2214
- "type": "string"
158
+ "type": "string[] | undefined"
2215
159
  },
2216
160
  {
2217
- "name": "isTesting",
161
+ "name": "initializeForTesting",
2218
162
  "tags": [
2219
163
  {
2220
- "text": [
2221
- {
2222
- "text": "false",
2223
- "kind": "text"
2224
- }
2225
- ],
164
+ "text": "AdMobInitializationOptions.testingDevices *",
165
+ "name": "see"
166
+ },
167
+ {
168
+ "text": "false",
2226
169
  "name": "default"
2227
170
  },
2228
171
  {
2229
- "text": [
2230
- {
2231
- "text": "1.1.2",
2232
- "kind": "text"
2233
- }
2234
- ],
172
+ "text": "1.2.0",
2235
173
  "name": "since"
2236
174
  }
2237
175
  ],
2238
- "docs": "You can use test mode of ad.",
176
+ "docs": "If set to true, the devices on {@link AdMobInitializationOptions.testingDevices} will\nbe registered to receive test production ads.",
2239
177
  "complexTypes": [],
2240
178
  "type": "boolean | undefined"
2241
179
  },
2242
180
  {
2243
- "name": "margin",
181
+ "name": "tagForChildDirectedTreatment",
2244
182
  "tags": [
2245
183
  {
2246
- "text": [
2247
- {
2248
- "text": "0",
2249
- "kind": "text"
2250
- }
2251
- ],
2252
- "name": "default"
184
+ "text": "https ://developers.google.com/admob/android/targeting#child-directed_setting",
185
+ "name": "see"
2253
186
  },
2254
187
  {
2255
- "text": [
2256
- {
2257
- "text": "1.1.2",
2258
- "kind": "text"
2259
- }
2260
- ],
188
+ "text": "3.1.0",
2261
189
  "name": "since"
2262
190
  }
2263
191
  ],
2264
- "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.",
192
+ "docs": "For purposes of the Children's Online Privacy Protection Act (COPPA),\nthere is a setting called tagForChildDirectedTreatment.",
2265
193
  "complexTypes": [],
2266
- "type": "number | undefined"
194
+ "type": "boolean | undefined"
2267
195
  },
2268
196
  {
2269
- "name": "npa",
197
+ "name": "tagForUnderAgeOfConsent",
2270
198
  "tags": [
2271
199
  {
2272
- "text": [
2273
- {
2274
- "text": "https",
2275
- "kind": "text"
2276
- },
2277
- {
2278
- "text": "://developers.google.com/admob/ios/eu-consent",
2279
- "kind": "text"
2280
- }
2281
- ],
200
+ "text": "https ://developers.google.com/admob/android/targeting#users_under_the_age_of_consent",
2282
201
  "name": "see"
2283
202
  },
2284
203
  {
2285
- "text": [
2286
- {
2287
- "text": "https",
2288
- "kind": "text"
2289
- },
2290
- {
2291
- "text": "://developers.google.com/admob/android/eu-consent",
2292
- "kind": "text"
2293
- }
2294
- ],
2295
- "name": "see"
2296
- },
2297
- {
2298
- "text": [
2299
- {
2300
- "text": "false",
2301
- "kind": "text"
2302
- }
2303
- ],
2304
- "name": "default"
2305
- },
2306
- {
2307
- "text": [
2308
- {
2309
- "text": "1.2.0",
2310
- "kind": "text"
2311
- }
2312
- ],
204
+ "text": "3.1.0",
2313
205
  "name": "since"
2314
206
  }
2315
207
  ],
2316
- "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",
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.",
2317
209
  "complexTypes": [],
2318
210
  "type": "boolean | undefined"
2319
- }
2320
- ],
2321
- "importObject": []
2322
- },
2323
- {
2324
- "name": "RewardAdOptions",
2325
- "slug": "rewardadoptions",
2326
- "docs": "",
2327
- "tags": [],
2328
- "methods": [],
2329
- "properties": [
211
+ },
2330
212
  {
2331
- "name": "ssv",
213
+ "name": "maxAdContentRating",
2332
214
  "tags": [
2333
215
  {
2334
- "text": [
2335
- {
2336
- "text": "https",
2337
- "kind": "text"
2338
- },
2339
- {
2340
- "text": "://support.google.com/admob/answer/9603226?hl=en-GB",
2341
- "kind": "text"
2342
- }
2343
- ],
216
+ "text": "https ://developers.google.com/admob/android/targeting#child-directed_setting",
2344
217
  "name": "see"
218
+ },
219
+ {
220
+ "text": "3.1.0",
221
+ "name": "since"
2345
222
  }
2346
223
  ],
2347
- "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.",
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.",
2348
225
  "complexTypes": [
2349
- "AtLeastOne"
226
+ "MaxAdContentRating"
2350
227
  ],
2351
- "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 }>"
228
+ "type": "MaxAdContentRating"
2352
229
  }
2353
- ],
2354
- "importObject": [
2355
- "AdOptions",
2356
- "AtLeastOne"
2357
230
  ]
2358
231
  },
2359
232
  {
2360
- "name": "AdMobRewardItem",
2361
- "slug": "admobrewarditem",
2362
- "docs": "For more information\r\nhttps://developers.google.com/admob/android/rewarded-video-adapters?hl=en",
2363
- "tags": [],
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
+ ],
2364
242
  "methods": [],
2365
243
  "properties": [
2366
244
  {
2367
- "name": "type",
2368
- "tags": [],
2369
- "docs": "Rewarded type user got",
2370
- "complexTypes": [],
2371
- "type": "string"
2372
- },
2373
- {
2374
- "name": "amount",
245
+ "name": "status",
2375
246
  "tags": [],
2376
- "docs": "Rewarded amount user got",
247
+ "docs": "",
2377
248
  "complexTypes": [],
2378
- "type": "number"
249
+ "type": "'authorized' | 'denied' | 'notDetermined' | 'restricted'"
2379
250
  }
2380
- ],
2381
- "importObject": []
251
+ ]
2382
252
  },
2383
253
  {
2384
- "name": "RewardInterstitialAdOptions",
2385
- "slug": "rewardinterstitialadoptions",
254
+ "name": "ApplicationMutedOptions",
255
+ "slug": "applicationmutedoptions",
2386
256
  "docs": "",
2387
257
  "tags": [],
2388
258
  "methods": [],
2389
259
  "properties": [
2390
260
  {
2391
- "name": "ssv",
261
+ "name": "muted",
2392
262
  "tags": [
2393
263
  {
2394
- "text": [
2395
- {
2396
- "text": "https",
2397
- "kind": "text"
2398
- },
2399
- {
2400
- "text": "://support.google.com/admob/answer/9603226?hl=en-GB",
2401
- "kind": "text"
2402
- }
2403
- ],
264
+ "text": "https ://developers.google.com/admob/android/global-settings",
2404
265
  "name": "see"
266
+ },
267
+ {
268
+ "text": "4.1.1",
269
+ "name": "since"
2405
270
  }
2406
271
  ],
2407
- "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.",
2408
- "complexTypes": [
2409
- "AtLeastOne"
2410
- ],
2411
- "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 }>"
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"
2412
275
  }
2413
- ],
2414
- "importObject": [
2415
- "AdOptions",
2416
- "AtLeastOne"
2417
276
  ]
2418
277
  },
2419
278
  {
2420
- "name": "AdMobRewardInterstitialItem",
2421
- "slug": "admobrewardinterstitialitem",
2422
- "docs": "For more information\nhttps://developers.google.com/admob/android/rewarded-video-adapters?hl=en",
279
+ "name": "ApplicationVolumeOptions",
280
+ "slug": "applicationvolumeoptions",
281
+ "docs": "",
2423
282
  "tags": [],
2424
283
  "methods": [],
2425
284
  "properties": [
2426
285
  {
2427
- "name": "type",
2428
- "tags": [],
2429
- "docs": "Rewarded type user got",
2430
- "complexTypes": [],
2431
- "type": "string"
2432
- },
2433
- {
2434
- "name": "amount",
2435
- "tags": [],
2436
- "docs": "Rewarded amount user got",
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.",
2437
298
  "complexTypes": [],
2438
- "type": "number"
299
+ "type": "0 | 1 | 0.1 | 0.2 | 0.3 | 0.4 | 0.5 | 0.6 | 0.7 | 0.8 | 0.9 | undefined"
2439
300
  }
2440
- ],
2441
- "importObject": []
301
+ ]
2442
302
  }
2443
303
  ],
2444
304
  "enums": [
@@ -2471,337 +331,8 @@
2471
331
  "docs": "Content suitable only for mature audiences."
2472
332
  }
2473
333
  ]
2474
- },
2475
- {
2476
- "name": "BannerAdSize",
2477
- "slug": "banneradsize",
2478
- "members": [
2479
- {
2480
- "name": "BANNER",
2481
- "value": "'BANNER'",
2482
- "tags": [],
2483
- "docs": "Mobile Marketing Association (MMA)\r\nbanner ad size (320x50 density-independent pixels)."
2484
- },
2485
- {
2486
- "name": "FULL_BANNER",
2487
- "value": "'FULL_BANNER'",
2488
- "tags": [],
2489
- "docs": "Interactive Advertising Bureau (IAB)\r\nfull banner ad size (468x60 density-independent pixels)."
2490
- },
2491
- {
2492
- "name": "LARGE_BANNER",
2493
- "value": "'LARGE_BANNER'",
2494
- "tags": [],
2495
- "docs": "Large banner ad size (320x100 density-independent pixels)."
2496
- },
2497
- {
2498
- "name": "MEDIUM_RECTANGLE",
2499
- "value": "'MEDIUM_RECTANGLE'",
2500
- "tags": [],
2501
- "docs": "Interactive Advertising Bureau (IAB)\r\nmedium rectangle ad size (300x250 density-independent pixels)."
2502
- },
2503
- {
2504
- "name": "LEADERBOARD",
2505
- "value": "'LEADERBOARD'",
2506
- "tags": [],
2507
- "docs": "Interactive Advertising Bureau (IAB)\r\nleaderboard ad size (728x90 density-independent pixels)."
2508
- },
2509
- {
2510
- "name": "ADAPTIVE_BANNER",
2511
- "value": "'ADAPTIVE_BANNER'",
2512
- "tags": [],
2513
- "docs": "A dynamically sized banner that is full-width and auto-height."
2514
- },
2515
- {
2516
- "name": "SMART_BANNER",
2517
- "value": "'SMART_BANNER'",
2518
- "tags": [
2519
- {
2520
- "text": [
2521
- {
2522
- "text": "Will be removed in next AdMob versions use `ADAPTIVE_BANNER`\r\nScreen width x 32|50|90",
2523
- "kind": "text"
2524
- }
2525
- ],
2526
- "name": "deprecated"
2527
- }
2528
- ],
2529
- "docs": ""
2530
- }
2531
- ]
2532
- },
2533
- {
2534
- "name": "BannerAdPosition",
2535
- "slug": "banneradposition",
2536
- "members": [
2537
- {
2538
- "name": "TOP_CENTER",
2539
- "value": "'TOP_CENTER'",
2540
- "tags": [],
2541
- "docs": "Banner position be top-center"
2542
- },
2543
- {
2544
- "name": "CENTER",
2545
- "value": "'CENTER'",
2546
- "tags": [],
2547
- "docs": "Banner position be center"
2548
- },
2549
- {
2550
- "name": "BOTTOM_CENTER",
2551
- "value": "'BOTTOM_CENTER'",
2552
- "tags": [],
2553
- "docs": "Banner position be bottom-center(default)"
2554
- }
2555
- ]
2556
- },
2557
- {
2558
- "name": "BannerAdPluginEvents",
2559
- "slug": "banneradpluginevents",
2560
- "members": [
2561
- {
2562
- "name": "SizeChanged",
2563
- "value": "\"bannerAdSizeChanged\"",
2564
- "tags": [],
2565
- "docs": ""
2566
- },
2567
- {
2568
- "name": "Loaded",
2569
- "value": "\"bannerAdLoaded\"",
2570
- "tags": [],
2571
- "docs": ""
2572
- },
2573
- {
2574
- "name": "FailedToLoad",
2575
- "value": "\"bannerAdFailedToLoad\"",
2576
- "tags": [],
2577
- "docs": ""
2578
- },
2579
- {
2580
- "name": "Opened",
2581
- "value": "\"bannerAdOpened\"",
2582
- "tags": [],
2583
- "docs": "Open \"Adsense\" Event after user click banner"
2584
- },
2585
- {
2586
- "name": "Closed",
2587
- "value": "\"bannerAdClosed\"",
2588
- "tags": [],
2589
- "docs": "Close \"Adsense\" Event after user click banner"
2590
- },
2591
- {
2592
- "name": "AdImpression",
2593
- "value": "\"bannerAdImpression\"",
2594
- "tags": [],
2595
- "docs": "Similarly, this method should be called when an impression is recorded for the ad by the mediated SDK."
2596
- }
2597
- ]
2598
- },
2599
- {
2600
- "name": "AdmobConsentStatus",
2601
- "slug": "admobconsentstatus",
2602
- "members": [
2603
- {
2604
- "name": "NOT_REQUIRED",
2605
- "value": "'NOT_REQUIRED'",
2606
- "tags": [],
2607
- "docs": "User consent not required."
2608
- },
2609
- {
2610
- "name": "OBTAINED",
2611
- "value": "'OBTAINED'",
2612
- "tags": [],
2613
- "docs": "User consent already obtained."
2614
- },
2615
- {
2616
- "name": "REQUIRED",
2617
- "value": "'REQUIRED'",
2618
- "tags": [],
2619
- "docs": "User consent required but not yet obtained."
2620
- },
2621
- {
2622
- "name": "UNKNOWN",
2623
- "value": "'UNKNOWN'",
2624
- "tags": [],
2625
- "docs": "Unknown consent status, AdsConsent.requestInfoUpdate needs to be called to update it."
2626
- }
2627
- ]
2628
- },
2629
- {
2630
- "name": "AdmobConsentDebugGeography",
2631
- "slug": "admobconsentdebuggeography",
2632
- "members": [
2633
- {
2634
- "name": "DISABLED",
2635
- "value": "0",
2636
- "tags": [],
2637
- "docs": "Debug geography disabled."
2638
- },
2639
- {
2640
- "name": "EEA",
2641
- "value": "1",
2642
- "tags": [],
2643
- "docs": "Geography appears as in EEA for debug devices."
2644
- },
2645
- {
2646
- "name": "NOT_EEA",
2647
- "value": "2",
2648
- "tags": [],
2649
- "docs": "Geography appears as not in EEA for debug devices."
2650
- }
2651
- ]
2652
- },
2653
- {
2654
- "name": "InterstitialAdPluginEvents",
2655
- "slug": "interstitialadpluginevents",
2656
- "members": [
2657
- {
2658
- "name": "Loaded",
2659
- "value": "'interstitialAdLoaded'",
2660
- "tags": [],
2661
- "docs": "Emits after trying to prepare and Interstitial, when it is loaded and ready to be show"
2662
- },
2663
- {
2664
- "name": "FailedToLoad",
2665
- "value": "'interstitialAdFailedToLoad'",
2666
- "tags": [],
2667
- "docs": "Emits after trying to prepare and Interstitial, when it could not be loaded"
2668
- },
2669
- {
2670
- "name": "Showed",
2671
- "value": "'interstitialAdShowed'",
2672
- "tags": [],
2673
- "docs": "Emits when the Interstitial ad is visible to the user"
2674
- },
2675
- {
2676
- "name": "FailedToShow",
2677
- "value": "'interstitialAdFailedToShow'",
2678
- "tags": [],
2679
- "docs": "Emits when the Interstitial ad is failed to show"
2680
- },
2681
- {
2682
- "name": "Dismissed",
2683
- "value": "'interstitialAdDismissed'",
2684
- "tags": [],
2685
- "docs": "Emits when the Interstitial ad is not visible to the user anymore."
2686
- }
2687
- ]
2688
- },
2689
- {
2690
- "name": "RewardAdPluginEvents",
2691
- "slug": "rewardadpluginevents",
2692
- "members": [
2693
- {
2694
- "name": "Loaded",
2695
- "value": "'onRewardedVideoAdLoaded'",
2696
- "tags": [],
2697
- "docs": "Emits after trying to prepare a RewardAd and the Video is loaded and ready to be show"
2698
- },
2699
- {
2700
- "name": "FailedToLoad",
2701
- "value": "'onRewardedVideoAdFailedToLoad'",
2702
- "tags": [],
2703
- "docs": "Emits after trying to prepare a RewardAd when it could not be loaded"
2704
- },
2705
- {
2706
- "name": "Showed",
2707
- "value": "'onRewardedVideoAdShowed'",
2708
- "tags": [],
2709
- "docs": "Emits when the AdReward video is visible to the user"
2710
- },
2711
- {
2712
- "name": "FailedToShow",
2713
- "value": "'onRewardedVideoAdFailedToShow'",
2714
- "tags": [],
2715
- "docs": "Emits when the AdReward video is failed to show"
2716
- },
2717
- {
2718
- "name": "Dismissed",
2719
- "value": "'onRewardedVideoAdDismissed'",
2720
- "tags": [],
2721
- "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."
2722
- },
2723
- {
2724
- "name": "Rewarded",
2725
- "value": "'onRewardedVideoAdReward'",
2726
- "tags": [],
2727
- "docs": "Emits when user get rewarded from AdReward"
2728
- }
2729
- ]
2730
- },
2731
- {
2732
- "name": "RewardInterstitialAdPluginEvents",
2733
- "slug": "rewardinterstitialadpluginevents",
2734
- "members": [
2735
- {
2736
- "name": "Loaded",
2737
- "value": "'onRewardedInterstitialAdLoaded'",
2738
- "tags": [],
2739
- "docs": "Emits after trying to prepare a RewardAd and the Video is loaded and ready to be show"
2740
- },
2741
- {
2742
- "name": "FailedToLoad",
2743
- "value": "'onRewardedInterstitialAdFailedToLoad'",
2744
- "tags": [],
2745
- "docs": "Emits after trying to prepare a RewardAd when it could not be loaded"
2746
- },
2747
- {
2748
- "name": "Showed",
2749
- "value": "'onRewardedInterstitialAdShowed'",
2750
- "tags": [],
2751
- "docs": "Emits when the AdReward video is visible to the user"
2752
- },
2753
- {
2754
- "name": "FailedToShow",
2755
- "value": "'onRewardedInterstitialAdFailedToShow'",
2756
- "tags": [],
2757
- "docs": "Emits when the AdReward video is failed to show"
2758
- },
2759
- {
2760
- "name": "Dismissed",
2761
- "value": "'onRewardedInterstitialAdDismissed'",
2762
- "tags": [],
2763
- "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."
2764
- },
2765
- {
2766
- "name": "Rewarded",
2767
- "value": "'onRewardedInterstitialAdReward'",
2768
- "tags": [],
2769
- "docs": "Emits when user get rewarded from AdReward"
2770
- }
2771
- ]
2772
- }
2773
- ],
2774
- "typeAliases": [
2775
- {
2776
- "name": "AtLeastOne",
2777
- "slug": "atleastone",
2778
- "docs": "",
2779
- "types": [
2780
- {
2781
- "text": "{[K in keyof T]: Pick<T, K>}[keyof T]",
2782
- "complexTypes": [
2783
- "T",
2784
- "Pick",
2785
- "K"
2786
- ]
2787
- }
2788
- ]
2789
- },
2790
- {
2791
- "name": "Pick",
2792
- "slug": "pick",
2793
- "docs": "From T, pick a set of properties whose keys are in the union K",
2794
- "types": [
2795
- {
2796
- "text": "{\r\n [P in K]: T[P];\r\n}",
2797
- "complexTypes": [
2798
- "K",
2799
- "T",
2800
- "P"
2801
- ]
2802
- }
2803
- ]
2804
334
  }
2805
335
  ],
336
+ "typeAliases": [],
2806
337
  "pluginConfigs": []
2807
338
  }