@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.
- package/README.md +841 -0
- package/dist/docs.json +1852 -73
- package/package.json +3 -3
package/README.md
CHANGED
|
@@ -325,7 +325,44 @@ AdMob.addListener(RewardAdPluginEvents.Rewarded, async () => {
|
|
|
325
325
|
* [`requestTrackingAuthorization()`](#requesttrackingauthorization)
|
|
326
326
|
* [`setApplicationMuted(...)`](#setapplicationmuted)
|
|
327
327
|
* [`setApplicationVolume(...)`](#setapplicationvolume)
|
|
328
|
+
* [`showBanner(...)`](#showbanner)
|
|
329
|
+
* [`hideBanner()`](#hidebanner)
|
|
330
|
+
* [`resumeBanner()`](#resumebanner)
|
|
331
|
+
* [`removeBanner()`](#removebanner)
|
|
332
|
+
* [`addListener(BannerAdPluginEvents.SizeChanged, ...)`](#addlistenerbanneradplugineventssizechanged-)
|
|
333
|
+
* [`addListener(BannerAdPluginEvents.Loaded, ...)`](#addlistenerbanneradplugineventsloaded-)
|
|
334
|
+
* [`addListener(BannerAdPluginEvents.FailedToLoad, ...)`](#addlistenerbanneradplugineventsfailedtoload-)
|
|
335
|
+
* [`addListener(BannerAdPluginEvents.Opened, ...)`](#addlistenerbanneradplugineventsopened-)
|
|
336
|
+
* [`addListener(BannerAdPluginEvents.Closed, ...)`](#addlistenerbanneradplugineventsclosed-)
|
|
337
|
+
* [`addListener(BannerAdPluginEvents.AdImpression, ...)`](#addlistenerbanneradplugineventsadimpression-)
|
|
338
|
+
* [`requestConsentInfo(...)`](#requestconsentinfo)
|
|
339
|
+
* [`showConsentForm()`](#showconsentform)
|
|
340
|
+
* [`resetConsentInfo()`](#resetconsentinfo)
|
|
341
|
+
* [`prepareInterstitial(...)`](#prepareinterstitial)
|
|
342
|
+
* [`showInterstitial()`](#showinterstitial)
|
|
343
|
+
* [`addListener(InterstitialAdPluginEvents.FailedToLoad, ...)`](#addlistenerinterstitialadplugineventsfailedtoload-)
|
|
344
|
+
* [`addListener(InterstitialAdPluginEvents.Loaded, ...)`](#addlistenerinterstitialadplugineventsloaded-)
|
|
345
|
+
* [`addListener(InterstitialAdPluginEvents.Dismissed, ...)`](#addlistenerinterstitialadplugineventsdismissed-)
|
|
346
|
+
* [`addListener(InterstitialAdPluginEvents.FailedToShow, ...)`](#addlistenerinterstitialadplugineventsfailedtoshow-)
|
|
347
|
+
* [`addListener(InterstitialAdPluginEvents.Showed, ...)`](#addlistenerinterstitialadplugineventsshowed-)
|
|
348
|
+
* [`prepareRewardVideoAd(...)`](#preparerewardvideoad)
|
|
349
|
+
* [`showRewardVideoAd()`](#showrewardvideoad)
|
|
350
|
+
* [`addListener(RewardAdPluginEvents.FailedToLoad, ...)`](#addlistenerrewardadplugineventsfailedtoload-)
|
|
351
|
+
* [`addListener(RewardAdPluginEvents.Loaded, ...)`](#addlistenerrewardadplugineventsloaded-)
|
|
352
|
+
* [`addListener(RewardAdPluginEvents.Rewarded, ...)`](#addlistenerrewardadplugineventsrewarded-)
|
|
353
|
+
* [`addListener(RewardAdPluginEvents.Dismissed, ...)`](#addlistenerrewardadplugineventsdismissed-)
|
|
354
|
+
* [`addListener(RewardAdPluginEvents.FailedToShow, ...)`](#addlistenerrewardadplugineventsfailedtoshow-)
|
|
355
|
+
* [`addListener(RewardAdPluginEvents.Showed, ...)`](#addlistenerrewardadplugineventsshowed-)
|
|
356
|
+
* [`prepareRewardInterstitialAd(...)`](#preparerewardinterstitialad)
|
|
357
|
+
* [`showRewardInterstitialAd()`](#showrewardinterstitialad)
|
|
358
|
+
* [`addListener(RewardInterstitialAdPluginEvents.FailedToLoad, ...)`](#addlistenerrewardinterstitialadplugineventsfailedtoload-)
|
|
359
|
+
* [`addListener(RewardInterstitialAdPluginEvents.Loaded, ...)`](#addlistenerrewardinterstitialadplugineventsloaded-)
|
|
360
|
+
* [`addListener(RewardInterstitialAdPluginEvents.Rewarded, ...)`](#addlistenerrewardinterstitialadplugineventsrewarded-)
|
|
361
|
+
* [`addListener(RewardInterstitialAdPluginEvents.Dismissed, ...)`](#addlistenerrewardinterstitialadplugineventsdismissed-)
|
|
362
|
+
* [`addListener(RewardInterstitialAdPluginEvents.FailedToShow, ...)`](#addlistenerrewardinterstitialadplugineventsfailedtoshow-)
|
|
363
|
+
* [`addListener(RewardInterstitialAdPluginEvents.Showed, ...)`](#addlistenerrewardinterstitialadplugineventsshowed-)
|
|
328
364
|
* [Interfaces](#interfaces)
|
|
365
|
+
* [Type Aliases](#type-aliases)
|
|
329
366
|
* [Enums](#enums)
|
|
330
367
|
|
|
331
368
|
</docgen-index>
|
|
@@ -415,6 +452,599 @@ Report application volume to AdMob SDK
|
|
|
415
452
|
--------------------
|
|
416
453
|
|
|
417
454
|
|
|
455
|
+
### showBanner(...)
|
|
456
|
+
|
|
457
|
+
```typescript
|
|
458
|
+
showBanner(options: BannerAdOptions) => Promise<void>
|
|
459
|
+
```
|
|
460
|
+
|
|
461
|
+
Show a banner Ad
|
|
462
|
+
|
|
463
|
+
| Param | Type | Description |
|
|
464
|
+
| ------------- | ----------------------------------------------------------- | ---------------------------------- |
|
|
465
|
+
| **`options`** | <code><a href="#banneradoptions">BannerAdOptions</a></code> | <a href="#adoptions">AdOptions</a> |
|
|
466
|
+
|
|
467
|
+
**Since:** 1.1.2
|
|
468
|
+
|
|
469
|
+
--------------------
|
|
470
|
+
|
|
471
|
+
|
|
472
|
+
### hideBanner()
|
|
473
|
+
|
|
474
|
+
```typescript
|
|
475
|
+
hideBanner() => Promise<void>
|
|
476
|
+
```
|
|
477
|
+
|
|
478
|
+
Hide the banner, remove it from screen, but can show it later
|
|
479
|
+
|
|
480
|
+
**Since:** 1.1.2
|
|
481
|
+
|
|
482
|
+
--------------------
|
|
483
|
+
|
|
484
|
+
|
|
485
|
+
### resumeBanner()
|
|
486
|
+
|
|
487
|
+
```typescript
|
|
488
|
+
resumeBanner() => Promise<void>
|
|
489
|
+
```
|
|
490
|
+
|
|
491
|
+
Resume the banner, show it after hide
|
|
492
|
+
|
|
493
|
+
**Since:** 1.1.2
|
|
494
|
+
|
|
495
|
+
--------------------
|
|
496
|
+
|
|
497
|
+
|
|
498
|
+
### removeBanner()
|
|
499
|
+
|
|
500
|
+
```typescript
|
|
501
|
+
removeBanner() => Promise<void>
|
|
502
|
+
```
|
|
503
|
+
|
|
504
|
+
Destroy the banner, remove it from screen.
|
|
505
|
+
|
|
506
|
+
**Since:** 1.1.2
|
|
507
|
+
|
|
508
|
+
--------------------
|
|
509
|
+
|
|
510
|
+
|
|
511
|
+
### addListener(BannerAdPluginEvents.SizeChanged, ...)
|
|
512
|
+
|
|
513
|
+
```typescript
|
|
514
|
+
addListener(eventName: BannerAdPluginEvents.SizeChanged, listenerFunc: (info: AdMobBannerSize) => void) => Promise<PluginListenerHandle>
|
|
515
|
+
```
|
|
516
|
+
|
|
517
|
+
| Param | Type | Description |
|
|
518
|
+
| ------------------ | --------------------------------------------------------------------------------- | ------------------- |
|
|
519
|
+
| **`eventName`** | <code><a href="#banneradpluginevents">BannerAdPluginEvents.SizeChanged</a></code> | bannerAdSizeChanged |
|
|
520
|
+
| **`listenerFunc`** | <code>(info: <a href="#admobbannersize">AdMobBannerSize</a>) => void</code> | |
|
|
521
|
+
|
|
522
|
+
**Returns:** <code>Promise<<a href="#pluginlistenerhandle">PluginListenerHandle</a>></code>
|
|
523
|
+
|
|
524
|
+
**Since:** 3.0.0
|
|
525
|
+
|
|
526
|
+
--------------------
|
|
527
|
+
|
|
528
|
+
|
|
529
|
+
### addListener(BannerAdPluginEvents.Loaded, ...)
|
|
530
|
+
|
|
531
|
+
```typescript
|
|
532
|
+
addListener(eventName: BannerAdPluginEvents.Loaded, listenerFunc: () => void) => Promise<PluginListenerHandle>
|
|
533
|
+
```
|
|
534
|
+
|
|
535
|
+
Notice: request loaded Banner ad
|
|
536
|
+
|
|
537
|
+
| Param | Type | Description |
|
|
538
|
+
| ------------------ | ---------------------------------------------------------------------------- | -------------- |
|
|
539
|
+
| **`eventName`** | <code><a href="#banneradpluginevents">BannerAdPluginEvents.Loaded</a></code> | bannerAdLoaded |
|
|
540
|
+
| **`listenerFunc`** | <code>() => void</code> | |
|
|
541
|
+
|
|
542
|
+
**Returns:** <code>Promise<<a href="#pluginlistenerhandle">PluginListenerHandle</a>></code>
|
|
543
|
+
|
|
544
|
+
**Since:** 3.0.0
|
|
545
|
+
|
|
546
|
+
--------------------
|
|
547
|
+
|
|
548
|
+
|
|
549
|
+
### addListener(BannerAdPluginEvents.FailedToLoad, ...)
|
|
550
|
+
|
|
551
|
+
```typescript
|
|
552
|
+
addListener(eventName: BannerAdPluginEvents.FailedToLoad, listenerFunc: (info: AdMobError) => void) => Promise<PluginListenerHandle>
|
|
553
|
+
```
|
|
554
|
+
|
|
555
|
+
Notice: request failed Banner ad
|
|
556
|
+
|
|
557
|
+
| Param | Type | Description |
|
|
558
|
+
| ------------------ | ---------------------------------------------------------------------------------- | -------------------- |
|
|
559
|
+
| **`eventName`** | <code><a href="#banneradpluginevents">BannerAdPluginEvents.FailedToLoad</a></code> | bannerAdFailedToLoad |
|
|
560
|
+
| **`listenerFunc`** | <code>(info: <a href="#admoberror">AdMobError</a>) => void</code> | |
|
|
561
|
+
|
|
562
|
+
**Returns:** <code>Promise<<a href="#pluginlistenerhandle">PluginListenerHandle</a>></code>
|
|
563
|
+
|
|
564
|
+
**Since:** 3.0.0
|
|
565
|
+
|
|
566
|
+
--------------------
|
|
567
|
+
|
|
568
|
+
|
|
569
|
+
### addListener(BannerAdPluginEvents.Opened, ...)
|
|
570
|
+
|
|
571
|
+
```typescript
|
|
572
|
+
addListener(eventName: BannerAdPluginEvents.Opened, listenerFunc: () => void) => Promise<PluginListenerHandle>
|
|
573
|
+
```
|
|
574
|
+
|
|
575
|
+
Notice: full-screen banner view will be presented in response to the user clicking on an ad.
|
|
576
|
+
|
|
577
|
+
| Param | Type | Description |
|
|
578
|
+
| ------------------ | ---------------------------------------------------------------------------- | -------------- |
|
|
579
|
+
| **`eventName`** | <code><a href="#banneradpluginevents">BannerAdPluginEvents.Opened</a></code> | bannerAdOpened |
|
|
580
|
+
| **`listenerFunc`** | <code>() => void</code> | |
|
|
581
|
+
|
|
582
|
+
**Returns:** <code>Promise<<a href="#pluginlistenerhandle">PluginListenerHandle</a>></code>
|
|
583
|
+
|
|
584
|
+
**Since:** 3.0.0
|
|
585
|
+
|
|
586
|
+
--------------------
|
|
587
|
+
|
|
588
|
+
|
|
589
|
+
### addListener(BannerAdPluginEvents.Closed, ...)
|
|
590
|
+
|
|
591
|
+
```typescript
|
|
592
|
+
addListener(eventName: BannerAdPluginEvents.Closed, listenerFunc: () => void) => Promise<PluginListenerHandle>
|
|
593
|
+
```
|
|
594
|
+
|
|
595
|
+
Notice: The full-screen banner view will been dismissed.
|
|
596
|
+
|
|
597
|
+
| Param | Type | Description |
|
|
598
|
+
| ------------------ | ---------------------------------------------------------------------------- | -------------- |
|
|
599
|
+
| **`eventName`** | <code><a href="#banneradpluginevents">BannerAdPluginEvents.Closed</a></code> | bannerAdClosed |
|
|
600
|
+
| **`listenerFunc`** | <code>() => void</code> | |
|
|
601
|
+
|
|
602
|
+
**Returns:** <code>Promise<<a href="#pluginlistenerhandle">PluginListenerHandle</a>></code>
|
|
603
|
+
|
|
604
|
+
**Since:** 3.0.0
|
|
605
|
+
|
|
606
|
+
--------------------
|
|
607
|
+
|
|
608
|
+
|
|
609
|
+
### addListener(BannerAdPluginEvents.AdImpression, ...)
|
|
610
|
+
|
|
611
|
+
```typescript
|
|
612
|
+
addListener(eventName: BannerAdPluginEvents.AdImpression, listenerFunc: () => void) => Promise<PluginListenerHandle>
|
|
613
|
+
```
|
|
614
|
+
|
|
615
|
+
Unimplemented
|
|
616
|
+
|
|
617
|
+
| Param | Type | Description |
|
|
618
|
+
| ------------------ | ---------------------------------------------------------------------------------- | ------------ |
|
|
619
|
+
| **`eventName`** | <code><a href="#banneradpluginevents">BannerAdPluginEvents.AdImpression</a></code> | AdImpression |
|
|
620
|
+
| **`listenerFunc`** | <code>() => void</code> | |
|
|
621
|
+
|
|
622
|
+
**Returns:** <code>Promise<<a href="#pluginlistenerhandle">PluginListenerHandle</a>></code>
|
|
623
|
+
|
|
624
|
+
**Since:** 3.0.0
|
|
625
|
+
|
|
626
|
+
--------------------
|
|
627
|
+
|
|
628
|
+
|
|
629
|
+
### requestConsentInfo(...)
|
|
630
|
+
|
|
631
|
+
```typescript
|
|
632
|
+
requestConsentInfo(options?: AdmobConsentRequestOptions | undefined) => Promise<AdmobConsentInfo>
|
|
633
|
+
```
|
|
634
|
+
|
|
635
|
+
Request user consent information
|
|
636
|
+
|
|
637
|
+
| Param | Type | Description |
|
|
638
|
+
| ------------- | --------------------------------------------------------------------------------- | --------------------- |
|
|
639
|
+
| **`options`** | <code><a href="#admobconsentrequestoptions">AdmobConsentRequestOptions</a></code> | ConsentRequestOptions |
|
|
640
|
+
|
|
641
|
+
**Returns:** <code>Promise<<a href="#admobconsentinfo">AdmobConsentInfo</a>></code>
|
|
642
|
+
|
|
643
|
+
**Since:** 5.0.0
|
|
644
|
+
|
|
645
|
+
--------------------
|
|
646
|
+
|
|
647
|
+
|
|
648
|
+
### showConsentForm()
|
|
649
|
+
|
|
650
|
+
```typescript
|
|
651
|
+
showConsentForm() => Promise<AdmobConsentInfo>
|
|
652
|
+
```
|
|
653
|
+
|
|
654
|
+
Shows a google user consent form (rendered from your GDPR message config).
|
|
655
|
+
|
|
656
|
+
**Returns:** <code>Promise<<a href="#admobconsentinfo">AdmobConsentInfo</a>></code>
|
|
657
|
+
|
|
658
|
+
**Since:** 5.0.0
|
|
659
|
+
|
|
660
|
+
--------------------
|
|
661
|
+
|
|
662
|
+
|
|
663
|
+
### resetConsentInfo()
|
|
664
|
+
|
|
665
|
+
```typescript
|
|
666
|
+
resetConsentInfo() => Promise<void>
|
|
667
|
+
```
|
|
668
|
+
|
|
669
|
+
Resets the UMP SDK state. Call requestConsentInfo function again to allow user modify their consent
|
|
670
|
+
|
|
671
|
+
**Since:** 5.0.0
|
|
672
|
+
|
|
673
|
+
--------------------
|
|
674
|
+
|
|
675
|
+
|
|
676
|
+
### prepareInterstitial(...)
|
|
677
|
+
|
|
678
|
+
```typescript
|
|
679
|
+
prepareInterstitial(options: AdOptions) => Promise<AdLoadInfo>
|
|
680
|
+
```
|
|
681
|
+
|
|
682
|
+
Prepare interstitial banner
|
|
683
|
+
|
|
684
|
+
| Param | Type | Description |
|
|
685
|
+
| ------------- | ----------------------------------------------- | ---------------------------------- |
|
|
686
|
+
| **`options`** | <code><a href="#adoptions">AdOptions</a></code> | <a href="#adoptions">AdOptions</a> |
|
|
687
|
+
|
|
688
|
+
**Returns:** <code>Promise<<a href="#adloadinfo">AdLoadInfo</a>></code>
|
|
689
|
+
|
|
690
|
+
**Since:** 1.1.2
|
|
691
|
+
|
|
692
|
+
--------------------
|
|
693
|
+
|
|
694
|
+
|
|
695
|
+
### showInterstitial()
|
|
696
|
+
|
|
697
|
+
```typescript
|
|
698
|
+
showInterstitial() => Promise<void>
|
|
699
|
+
```
|
|
700
|
+
|
|
701
|
+
Show interstitial ad when it’s ready
|
|
702
|
+
|
|
703
|
+
**Since:** 1.1.2
|
|
704
|
+
|
|
705
|
+
--------------------
|
|
706
|
+
|
|
707
|
+
|
|
708
|
+
### addListener(InterstitialAdPluginEvents.FailedToLoad, ...)
|
|
709
|
+
|
|
710
|
+
```typescript
|
|
711
|
+
addListener(eventName: InterstitialAdPluginEvents.FailedToLoad, listenerFunc: (error: AdMobError) => void) => Promise<PluginListenerHandle>
|
|
712
|
+
```
|
|
713
|
+
|
|
714
|
+
| Param | Type |
|
|
715
|
+
| ------------------ | ---------------------------------------------------------------------------------------------- |
|
|
716
|
+
| **`eventName`** | <code><a href="#interstitialadpluginevents">InterstitialAdPluginEvents.FailedToLoad</a></code> |
|
|
717
|
+
| **`listenerFunc`** | <code>(error: <a href="#admoberror">AdMobError</a>) => void</code> |
|
|
718
|
+
|
|
719
|
+
**Returns:** <code>Promise<<a href="#pluginlistenerhandle">PluginListenerHandle</a>></code>
|
|
720
|
+
|
|
721
|
+
--------------------
|
|
722
|
+
|
|
723
|
+
|
|
724
|
+
### addListener(InterstitialAdPluginEvents.Loaded, ...)
|
|
725
|
+
|
|
726
|
+
```typescript
|
|
727
|
+
addListener(eventName: InterstitialAdPluginEvents.Loaded, listenerFunc: (info: AdLoadInfo) => void) => Promise<PluginListenerHandle>
|
|
728
|
+
```
|
|
729
|
+
|
|
730
|
+
| Param | Type |
|
|
731
|
+
| ------------------ | ---------------------------------------------------------------------------------------- |
|
|
732
|
+
| **`eventName`** | <code><a href="#interstitialadpluginevents">InterstitialAdPluginEvents.Loaded</a></code> |
|
|
733
|
+
| **`listenerFunc`** | <code>(info: <a href="#adloadinfo">AdLoadInfo</a>) => void</code> |
|
|
734
|
+
|
|
735
|
+
**Returns:** <code>Promise<<a href="#pluginlistenerhandle">PluginListenerHandle</a>></code>
|
|
736
|
+
|
|
737
|
+
--------------------
|
|
738
|
+
|
|
739
|
+
|
|
740
|
+
### addListener(InterstitialAdPluginEvents.Dismissed, ...)
|
|
741
|
+
|
|
742
|
+
```typescript
|
|
743
|
+
addListener(eventName: InterstitialAdPluginEvents.Dismissed, listenerFunc: () => void) => Promise<PluginListenerHandle>
|
|
744
|
+
```
|
|
745
|
+
|
|
746
|
+
| Param | Type |
|
|
747
|
+
| ------------------ | ------------------------------------------------------------------------------------------- |
|
|
748
|
+
| **`eventName`** | <code><a href="#interstitialadpluginevents">InterstitialAdPluginEvents.Dismissed</a></code> |
|
|
749
|
+
| **`listenerFunc`** | <code>() => void</code> |
|
|
750
|
+
|
|
751
|
+
**Returns:** <code>Promise<<a href="#pluginlistenerhandle">PluginListenerHandle</a>></code>
|
|
752
|
+
|
|
753
|
+
--------------------
|
|
754
|
+
|
|
755
|
+
|
|
756
|
+
### addListener(InterstitialAdPluginEvents.FailedToShow, ...)
|
|
757
|
+
|
|
758
|
+
```typescript
|
|
759
|
+
addListener(eventName: InterstitialAdPluginEvents.FailedToShow, listenerFunc: (error: AdMobError) => void) => Promise<PluginListenerHandle>
|
|
760
|
+
```
|
|
761
|
+
|
|
762
|
+
| Param | Type |
|
|
763
|
+
| ------------------ | ---------------------------------------------------------------------------------------------- |
|
|
764
|
+
| **`eventName`** | <code><a href="#interstitialadpluginevents">InterstitialAdPluginEvents.FailedToShow</a></code> |
|
|
765
|
+
| **`listenerFunc`** | <code>(error: <a href="#admoberror">AdMobError</a>) => void</code> |
|
|
766
|
+
|
|
767
|
+
**Returns:** <code>Promise<<a href="#pluginlistenerhandle">PluginListenerHandle</a>></code>
|
|
768
|
+
|
|
769
|
+
--------------------
|
|
770
|
+
|
|
771
|
+
|
|
772
|
+
### addListener(InterstitialAdPluginEvents.Showed, ...)
|
|
773
|
+
|
|
774
|
+
```typescript
|
|
775
|
+
addListener(eventName: InterstitialAdPluginEvents.Showed, listenerFunc: () => void) => Promise<PluginListenerHandle>
|
|
776
|
+
```
|
|
777
|
+
|
|
778
|
+
| Param | Type |
|
|
779
|
+
| ------------------ | ---------------------------------------------------------------------------------------- |
|
|
780
|
+
| **`eventName`** | <code><a href="#interstitialadpluginevents">InterstitialAdPluginEvents.Showed</a></code> |
|
|
781
|
+
| **`listenerFunc`** | <code>() => void</code> |
|
|
782
|
+
|
|
783
|
+
**Returns:** <code>Promise<<a href="#pluginlistenerhandle">PluginListenerHandle</a>></code>
|
|
784
|
+
|
|
785
|
+
--------------------
|
|
786
|
+
|
|
787
|
+
|
|
788
|
+
### prepareRewardVideoAd(...)
|
|
789
|
+
|
|
790
|
+
```typescript
|
|
791
|
+
prepareRewardVideoAd(options: RewardAdOptions) => Promise<AdLoadInfo>
|
|
792
|
+
```
|
|
793
|
+
|
|
794
|
+
Prepare a reward video ad
|
|
795
|
+
|
|
796
|
+
| Param | Type | Description |
|
|
797
|
+
| ------------- | ----------------------------------------------------------- | ---------------------------------------------- |
|
|
798
|
+
| **`options`** | <code><a href="#rewardadoptions">RewardAdOptions</a></code> | <a href="#rewardadoptions">RewardAdOptions</a> |
|
|
799
|
+
|
|
800
|
+
**Returns:** <code>Promise<<a href="#adloadinfo">AdLoadInfo</a>></code>
|
|
801
|
+
|
|
802
|
+
**Since:** 1.1.2
|
|
803
|
+
|
|
804
|
+
--------------------
|
|
805
|
+
|
|
806
|
+
|
|
807
|
+
### showRewardVideoAd()
|
|
808
|
+
|
|
809
|
+
```typescript
|
|
810
|
+
showRewardVideoAd() => Promise<AdMobRewardItem>
|
|
811
|
+
```
|
|
812
|
+
|
|
813
|
+
Show a reward video ad
|
|
814
|
+
|
|
815
|
+
**Returns:** <code>Promise<<a href="#admobrewarditem">AdMobRewardItem</a>></code>
|
|
816
|
+
|
|
817
|
+
**Since:** 1.1.2
|
|
818
|
+
|
|
819
|
+
--------------------
|
|
820
|
+
|
|
821
|
+
|
|
822
|
+
### addListener(RewardAdPluginEvents.FailedToLoad, ...)
|
|
823
|
+
|
|
824
|
+
```typescript
|
|
825
|
+
addListener(eventName: RewardAdPluginEvents.FailedToLoad, listenerFunc: (error: AdMobError) => void) => Promise<PluginListenerHandle>
|
|
826
|
+
```
|
|
827
|
+
|
|
828
|
+
| Param | Type |
|
|
829
|
+
| ------------------ | ---------------------------------------------------------------------------------- |
|
|
830
|
+
| **`eventName`** | <code><a href="#rewardadpluginevents">RewardAdPluginEvents.FailedToLoad</a></code> |
|
|
831
|
+
| **`listenerFunc`** | <code>(error: <a href="#admoberror">AdMobError</a>) => void</code> |
|
|
832
|
+
|
|
833
|
+
**Returns:** <code>Promise<<a href="#pluginlistenerhandle">PluginListenerHandle</a>></code>
|
|
834
|
+
|
|
835
|
+
--------------------
|
|
836
|
+
|
|
837
|
+
|
|
838
|
+
### addListener(RewardAdPluginEvents.Loaded, ...)
|
|
839
|
+
|
|
840
|
+
```typescript
|
|
841
|
+
addListener(eventName: RewardAdPluginEvents.Loaded, listenerFunc: (info: AdLoadInfo) => void) => Promise<PluginListenerHandle>
|
|
842
|
+
```
|
|
843
|
+
|
|
844
|
+
| Param | Type |
|
|
845
|
+
| ------------------ | ---------------------------------------------------------------------------- |
|
|
846
|
+
| **`eventName`** | <code><a href="#rewardadpluginevents">RewardAdPluginEvents.Loaded</a></code> |
|
|
847
|
+
| **`listenerFunc`** | <code>(info: <a href="#adloadinfo">AdLoadInfo</a>) => void</code> |
|
|
848
|
+
|
|
849
|
+
**Returns:** <code>Promise<<a href="#pluginlistenerhandle">PluginListenerHandle</a>></code>
|
|
850
|
+
|
|
851
|
+
--------------------
|
|
852
|
+
|
|
853
|
+
|
|
854
|
+
### addListener(RewardAdPluginEvents.Rewarded, ...)
|
|
855
|
+
|
|
856
|
+
```typescript
|
|
857
|
+
addListener(eventName: RewardAdPluginEvents.Rewarded, listenerFunc: (reward: AdMobRewardItem) => void) => Promise<PluginListenerHandle>
|
|
858
|
+
```
|
|
859
|
+
|
|
860
|
+
| Param | Type |
|
|
861
|
+
| ------------------ | -------------------------------------------------------------------------------- |
|
|
862
|
+
| **`eventName`** | <code><a href="#rewardadpluginevents">RewardAdPluginEvents.Rewarded</a></code> |
|
|
863
|
+
| **`listenerFunc`** | <code>(reward: <a href="#admobrewarditem">AdMobRewardItem</a>) => void</code> |
|
|
864
|
+
|
|
865
|
+
**Returns:** <code>Promise<<a href="#pluginlistenerhandle">PluginListenerHandle</a>></code>
|
|
866
|
+
|
|
867
|
+
--------------------
|
|
868
|
+
|
|
869
|
+
|
|
870
|
+
### addListener(RewardAdPluginEvents.Dismissed, ...)
|
|
871
|
+
|
|
872
|
+
```typescript
|
|
873
|
+
addListener(eventName: RewardAdPluginEvents.Dismissed, listenerFunc: () => void) => Promise<PluginListenerHandle>
|
|
874
|
+
```
|
|
875
|
+
|
|
876
|
+
| Param | Type |
|
|
877
|
+
| ------------------ | ------------------------------------------------------------------------------- |
|
|
878
|
+
| **`eventName`** | <code><a href="#rewardadpluginevents">RewardAdPluginEvents.Dismissed</a></code> |
|
|
879
|
+
| **`listenerFunc`** | <code>() => void</code> |
|
|
880
|
+
|
|
881
|
+
**Returns:** <code>Promise<<a href="#pluginlistenerhandle">PluginListenerHandle</a>></code>
|
|
882
|
+
|
|
883
|
+
--------------------
|
|
884
|
+
|
|
885
|
+
|
|
886
|
+
### addListener(RewardAdPluginEvents.FailedToShow, ...)
|
|
887
|
+
|
|
888
|
+
```typescript
|
|
889
|
+
addListener(eventName: RewardAdPluginEvents.FailedToShow, listenerFunc: (error: AdMobError) => void) => Promise<PluginListenerHandle>
|
|
890
|
+
```
|
|
891
|
+
|
|
892
|
+
| Param | Type |
|
|
893
|
+
| ------------------ | ---------------------------------------------------------------------------------- |
|
|
894
|
+
| **`eventName`** | <code><a href="#rewardadpluginevents">RewardAdPluginEvents.FailedToShow</a></code> |
|
|
895
|
+
| **`listenerFunc`** | <code>(error: <a href="#admoberror">AdMobError</a>) => void</code> |
|
|
896
|
+
|
|
897
|
+
**Returns:** <code>Promise<<a href="#pluginlistenerhandle">PluginListenerHandle</a>></code>
|
|
898
|
+
|
|
899
|
+
--------------------
|
|
900
|
+
|
|
901
|
+
|
|
902
|
+
### addListener(RewardAdPluginEvents.Showed, ...)
|
|
903
|
+
|
|
904
|
+
```typescript
|
|
905
|
+
addListener(eventName: RewardAdPluginEvents.Showed, listenerFunc: () => void) => Promise<PluginListenerHandle>
|
|
906
|
+
```
|
|
907
|
+
|
|
908
|
+
| Param | Type |
|
|
909
|
+
| ------------------ | ---------------------------------------------------------------------------- |
|
|
910
|
+
| **`eventName`** | <code><a href="#rewardadpluginevents">RewardAdPluginEvents.Showed</a></code> |
|
|
911
|
+
| **`listenerFunc`** | <code>() => void</code> |
|
|
912
|
+
|
|
913
|
+
**Returns:** <code>Promise<<a href="#pluginlistenerhandle">PluginListenerHandle</a>></code>
|
|
914
|
+
|
|
915
|
+
--------------------
|
|
916
|
+
|
|
917
|
+
|
|
918
|
+
### prepareRewardInterstitialAd(...)
|
|
919
|
+
|
|
920
|
+
```typescript
|
|
921
|
+
prepareRewardInterstitialAd(options: RewardInterstitialAdOptions) => Promise<AdLoadInfo>
|
|
922
|
+
```
|
|
923
|
+
|
|
924
|
+
Prepare a reward video ad
|
|
925
|
+
|
|
926
|
+
| Param | Type | Description |
|
|
927
|
+
| ------------- | ----------------------------------------------------------------------------------- | ---------------------------------------------- |
|
|
928
|
+
| **`options`** | <code><a href="#rewardinterstitialadoptions">RewardInterstitialAdOptions</a></code> | <a href="#rewardadoptions">RewardAdOptions</a> |
|
|
929
|
+
|
|
930
|
+
**Returns:** <code>Promise<<a href="#adloadinfo">AdLoadInfo</a>></code>
|
|
931
|
+
|
|
932
|
+
**Since:** 1.1.2
|
|
933
|
+
|
|
934
|
+
--------------------
|
|
935
|
+
|
|
936
|
+
|
|
937
|
+
### showRewardInterstitialAd()
|
|
938
|
+
|
|
939
|
+
```typescript
|
|
940
|
+
showRewardInterstitialAd() => Promise<AdMobRewardInterstitialItem>
|
|
941
|
+
```
|
|
942
|
+
|
|
943
|
+
Show a reward video ad
|
|
944
|
+
|
|
945
|
+
**Returns:** <code>Promise<<a href="#admobrewardinterstitialitem">AdMobRewardInterstitialItem</a>></code>
|
|
946
|
+
|
|
947
|
+
**Since:** 1.1.2
|
|
948
|
+
|
|
949
|
+
--------------------
|
|
950
|
+
|
|
951
|
+
|
|
952
|
+
### addListener(RewardInterstitialAdPluginEvents.FailedToLoad, ...)
|
|
953
|
+
|
|
954
|
+
```typescript
|
|
955
|
+
addListener(eventName: RewardInterstitialAdPluginEvents.FailedToLoad, listenerFunc: (error: AdMobError) => void) => Promise<PluginListenerHandle>
|
|
956
|
+
```
|
|
957
|
+
|
|
958
|
+
| Param | Type |
|
|
959
|
+
| ------------------ | ---------------------------------------------------------------------------------------------------------- |
|
|
960
|
+
| **`eventName`** | <code><a href="#rewardinterstitialadpluginevents">RewardInterstitialAdPluginEvents.FailedToLoad</a></code> |
|
|
961
|
+
| **`listenerFunc`** | <code>(error: <a href="#admoberror">AdMobError</a>) => void</code> |
|
|
962
|
+
|
|
963
|
+
**Returns:** <code>Promise<<a href="#pluginlistenerhandle">PluginListenerHandle</a>></code>
|
|
964
|
+
|
|
965
|
+
--------------------
|
|
966
|
+
|
|
967
|
+
|
|
968
|
+
### addListener(RewardInterstitialAdPluginEvents.Loaded, ...)
|
|
969
|
+
|
|
970
|
+
```typescript
|
|
971
|
+
addListener(eventName: RewardInterstitialAdPluginEvents.Loaded, listenerFunc: (info: AdLoadInfo) => void) => Promise<PluginListenerHandle>
|
|
972
|
+
```
|
|
973
|
+
|
|
974
|
+
| Param | Type |
|
|
975
|
+
| ------------------ | ---------------------------------------------------------------------------------------------------- |
|
|
976
|
+
| **`eventName`** | <code><a href="#rewardinterstitialadpluginevents">RewardInterstitialAdPluginEvents.Loaded</a></code> |
|
|
977
|
+
| **`listenerFunc`** | <code>(info: <a href="#adloadinfo">AdLoadInfo</a>) => void</code> |
|
|
978
|
+
|
|
979
|
+
**Returns:** <code>Promise<<a href="#pluginlistenerhandle">PluginListenerHandle</a>></code>
|
|
980
|
+
|
|
981
|
+
--------------------
|
|
982
|
+
|
|
983
|
+
|
|
984
|
+
### addListener(RewardInterstitialAdPluginEvents.Rewarded, ...)
|
|
985
|
+
|
|
986
|
+
```typescript
|
|
987
|
+
addListener(eventName: RewardInterstitialAdPluginEvents.Rewarded, listenerFunc: (reward: AdMobRewardInterstitialItem) => void) => Promise<PluginListenerHandle>
|
|
988
|
+
```
|
|
989
|
+
|
|
990
|
+
| Param | Type |
|
|
991
|
+
| ------------------ | -------------------------------------------------------------------------------------------------------- |
|
|
992
|
+
| **`eventName`** | <code><a href="#rewardinterstitialadpluginevents">RewardInterstitialAdPluginEvents.Rewarded</a></code> |
|
|
993
|
+
| **`listenerFunc`** | <code>(reward: <a href="#admobrewardinterstitialitem">AdMobRewardInterstitialItem</a>) => void</code> |
|
|
994
|
+
|
|
995
|
+
**Returns:** <code>Promise<<a href="#pluginlistenerhandle">PluginListenerHandle</a>></code>
|
|
996
|
+
|
|
997
|
+
--------------------
|
|
998
|
+
|
|
999
|
+
|
|
1000
|
+
### addListener(RewardInterstitialAdPluginEvents.Dismissed, ...)
|
|
1001
|
+
|
|
1002
|
+
```typescript
|
|
1003
|
+
addListener(eventName: RewardInterstitialAdPluginEvents.Dismissed, listenerFunc: () => void) => Promise<PluginListenerHandle>
|
|
1004
|
+
```
|
|
1005
|
+
|
|
1006
|
+
| Param | Type |
|
|
1007
|
+
| ------------------ | ------------------------------------------------------------------------------------------------------- |
|
|
1008
|
+
| **`eventName`** | <code><a href="#rewardinterstitialadpluginevents">RewardInterstitialAdPluginEvents.Dismissed</a></code> |
|
|
1009
|
+
| **`listenerFunc`** | <code>() => void</code> |
|
|
1010
|
+
|
|
1011
|
+
**Returns:** <code>Promise<<a href="#pluginlistenerhandle">PluginListenerHandle</a>></code>
|
|
1012
|
+
|
|
1013
|
+
--------------------
|
|
1014
|
+
|
|
1015
|
+
|
|
1016
|
+
### addListener(RewardInterstitialAdPluginEvents.FailedToShow, ...)
|
|
1017
|
+
|
|
1018
|
+
```typescript
|
|
1019
|
+
addListener(eventName: RewardInterstitialAdPluginEvents.FailedToShow, listenerFunc: (error: AdMobError) => void) => Promise<PluginListenerHandle>
|
|
1020
|
+
```
|
|
1021
|
+
|
|
1022
|
+
| Param | Type |
|
|
1023
|
+
| ------------------ | ---------------------------------------------------------------------------------------------------------- |
|
|
1024
|
+
| **`eventName`** | <code><a href="#rewardinterstitialadpluginevents">RewardInterstitialAdPluginEvents.FailedToShow</a></code> |
|
|
1025
|
+
| **`listenerFunc`** | <code>(error: <a href="#admoberror">AdMobError</a>) => void</code> |
|
|
1026
|
+
|
|
1027
|
+
**Returns:** <code>Promise<<a href="#pluginlistenerhandle">PluginListenerHandle</a>></code>
|
|
1028
|
+
|
|
1029
|
+
--------------------
|
|
1030
|
+
|
|
1031
|
+
|
|
1032
|
+
### addListener(RewardInterstitialAdPluginEvents.Showed, ...)
|
|
1033
|
+
|
|
1034
|
+
```typescript
|
|
1035
|
+
addListener(eventName: RewardInterstitialAdPluginEvents.Showed, listenerFunc: () => void) => Promise<PluginListenerHandle>
|
|
1036
|
+
```
|
|
1037
|
+
|
|
1038
|
+
| Param | Type |
|
|
1039
|
+
| ------------------ | ---------------------------------------------------------------------------------------------------- |
|
|
1040
|
+
| **`eventName`** | <code><a href="#rewardinterstitialadpluginevents">RewardInterstitialAdPluginEvents.Showed</a></code> |
|
|
1041
|
+
| **`listenerFunc`** | <code>() => void</code> |
|
|
1042
|
+
|
|
1043
|
+
**Returns:** <code>Promise<<a href="#pluginlistenerhandle">PluginListenerHandle</a>></code>
|
|
1044
|
+
|
|
1045
|
+
--------------------
|
|
1046
|
+
|
|
1047
|
+
|
|
418
1048
|
### Interfaces
|
|
419
1049
|
|
|
420
1050
|
|
|
@@ -450,6 +1080,129 @@ Report application volume to AdMob SDK
|
|
|
450
1080
|
| **`volume`** | <code>0 \| 1 \| 0.1 \| 0.2 \| 0.3 \| 0.4 \| 0.5 \| 0.6 \| 0.7 \| 0.8 \| 0.9</code> | If your app has its own volume controls (such as custom music or sound effect volumes), disclosing app volume to the Google Mobile Ads SDK allows video ads to respect app volume settings. enable set 0.0 - 1.0, any float allowed. | 4.1.1 |
|
|
451
1081
|
|
|
452
1082
|
|
|
1083
|
+
#### BannerAdOptions
|
|
1084
|
+
|
|
1085
|
+
This interface extends <a href="#adoptions">AdOptions</a>
|
|
1086
|
+
|
|
1087
|
+
| Prop | Type | Description | Default | Since |
|
|
1088
|
+
| -------------- | ------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------- | ----- |
|
|
1089
|
+
| **`adSize`** | <code><a href="#banneradsize">BannerAdSize</a></code> | Banner Ad Size, defaults to ADAPTIVE_BANNER. IT can be: ADAPTIVE_BANNER, SMART_BANNER, BANNER, MEDIUM_RECTANGLE, FULL_BANNER, LEADERBOARD | <code>ADAPTIVE_BANNER</code> | 3.0.0 |
|
|
1090
|
+
| **`position`** | <code><a href="#banneradposition">BannerAdPosition</a></code> | Set Banner Ad position. TOP_CENTER or CENTER or BOTTOM_CENTER | <code>TOP_CENTER</code> | 1.1.2 |
|
|
1091
|
+
|
|
1092
|
+
|
|
1093
|
+
#### PluginListenerHandle
|
|
1094
|
+
|
|
1095
|
+
| Prop | Type |
|
|
1096
|
+
| ------------ | ----------------------------------------- |
|
|
1097
|
+
| **`remove`** | <code>() => Promise<void></code> |
|
|
1098
|
+
|
|
1099
|
+
|
|
1100
|
+
#### AdMobBannerSize
|
|
1101
|
+
|
|
1102
|
+
When notice listener of OnAdLoaded, you can get banner size.
|
|
1103
|
+
|
|
1104
|
+
| Prop | Type |
|
|
1105
|
+
| ------------ | ------------------- |
|
|
1106
|
+
| **`width`** | <code>number</code> |
|
|
1107
|
+
| **`height`** | <code>number</code> |
|
|
1108
|
+
|
|
1109
|
+
|
|
1110
|
+
#### AdMobError
|
|
1111
|
+
|
|
1112
|
+
For more information
|
|
1113
|
+
https://developers.google.com/android/reference/com/google/android/gms/ads/AdError
|
|
1114
|
+
|
|
1115
|
+
| Prop | Type | Description |
|
|
1116
|
+
| ------------- | ------------------- | -------------------------------------- |
|
|
1117
|
+
| **`code`** | <code>number</code> | Gets the error's code. |
|
|
1118
|
+
| **`message`** | <code>string</code> | Gets the message describing the error. |
|
|
1119
|
+
|
|
1120
|
+
|
|
1121
|
+
#### AdmobConsentInfo
|
|
1122
|
+
|
|
1123
|
+
| Prop | Type | Description | Since |
|
|
1124
|
+
| ---------------------------- | ----------------------------------------------------------------- | ----------------------------------------------------- | ----- |
|
|
1125
|
+
| **`status`** | <code><a href="#admobconsentstatus">AdmobConsentStatus</a></code> | The consent status of the user. | 5.0.0 |
|
|
1126
|
+
| **`isConsentFormAvailable`** | <code>boolean</code> | If `true` a consent form is available and vice versa. | 5.0.0 |
|
|
1127
|
+
|
|
1128
|
+
|
|
1129
|
+
#### AdmobConsentRequestOptions
|
|
1130
|
+
|
|
1131
|
+
| Prop | Type | Description | Default | Since |
|
|
1132
|
+
| ----------------------------- | --------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------ | ------------------ | ----- |
|
|
1133
|
+
| **`debugGeography`** | <code><a href="#admobconsentdebuggeography">AdmobConsentDebugGeography</a></code> | Sets the debug geography to test the consent locally. | | 5.0.0 |
|
|
1134
|
+
| **`testDeviceIdentifiers`** | <code>string[]</code> | An array of test device IDs to allow. Note: On iOS, the ID may renew if you uninstall and reinstall the app. | | 5.0.0 |
|
|
1135
|
+
| **`tagForUnderAgeOfConsent`** | <code>boolean</code> | Set to `true` to provide the option for the user to accept being shown personalized ads. | <code>false</code> | 5.0.0 |
|
|
1136
|
+
|
|
1137
|
+
|
|
1138
|
+
#### AdLoadInfo
|
|
1139
|
+
|
|
1140
|
+
| Prop | Type |
|
|
1141
|
+
| -------------- | ------------------- |
|
|
1142
|
+
| **`adUnitId`** | <code>string</code> |
|
|
1143
|
+
|
|
1144
|
+
|
|
1145
|
+
#### AdOptions
|
|
1146
|
+
|
|
1147
|
+
| Prop | Type | Description | Default | Since |
|
|
1148
|
+
| --------------- | -------------------- | -------------------------------------------------------------------------------------------------------------------------------------------- | ------------------ | ----- |
|
|
1149
|
+
| **`adId`** | <code>string</code> | The ad unit ID that you want to request | | 1.1.2 |
|
|
1150
|
+
| **`isTesting`** | <code>boolean</code> | You can use test mode of ad. | <code>false</code> | 1.1.2 |
|
|
1151
|
+
| **`margin`** | <code>number</code> | Margin Banner. Default is 0px; If position is BOTTOM_CENTER, margin is be margin-bottom. If position is TOP_CENTER, margin is be margin-top. | <code>0</code> | 1.1.2 |
|
|
1152
|
+
| **`npa`** | <code>boolean</code> | The default behavior of the Google Mobile Ads SDK is to serve personalized ads. Set this to true to request Non-Personalized Ads | <code>false</code> | 1.2.0 |
|
|
1153
|
+
|
|
1154
|
+
|
|
1155
|
+
#### RewardAdOptions
|
|
1156
|
+
|
|
1157
|
+
| Prop | Type | Description |
|
|
1158
|
+
| --------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
|
1159
|
+
| **`ssv`** | <code><a href="#atleastone">AtLeastOne</a><{ /** * An optional UserId to pass to your SSV callback function. */ userId: string; /** * An optional custom set of data to pass to your SSV callback function. */ customData: string; }></code> | If you have enabled SSV in your AdMob Application. You can provide customData or a userId be passed to your callback to do further processing on. *Important* You *HAVE* to define one of them. |
|
|
1160
|
+
|
|
1161
|
+
|
|
1162
|
+
#### AdMobRewardItem
|
|
1163
|
+
|
|
1164
|
+
For more information
|
|
1165
|
+
https://developers.google.com/admob/android/rewarded-video-adapters?hl=en
|
|
1166
|
+
|
|
1167
|
+
| Prop | Type | Description |
|
|
1168
|
+
| ------------ | ------------------- | ------------------------ |
|
|
1169
|
+
| **`type`** | <code>string</code> | Rewarded type user got |
|
|
1170
|
+
| **`amount`** | <code>number</code> | Rewarded amount user got |
|
|
1171
|
+
|
|
1172
|
+
|
|
1173
|
+
#### RewardInterstitialAdOptions
|
|
1174
|
+
|
|
1175
|
+
| Prop | Type | Description |
|
|
1176
|
+
| --------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
|
1177
|
+
| **`ssv`** | <code><a href="#atleastone">AtLeastOne</a><{ /** * An optional UserId to pass to your SSV callback function. */ userId: string; /** * An optional custom set of data to pass to your SSV callback function. */ customData: string; }></code> | If you have enabled SSV in your AdMob Application. You can provide customData or a userId be passed to your callback to do further processing on. *Important* You *HAVE* to define one of them. |
|
|
1178
|
+
|
|
1179
|
+
|
|
1180
|
+
#### AdMobRewardInterstitialItem
|
|
1181
|
+
|
|
1182
|
+
For more information
|
|
1183
|
+
https://developers.google.com/admob/android/rewarded-video-adapters?hl=en
|
|
1184
|
+
|
|
1185
|
+
| Prop | Type | Description |
|
|
1186
|
+
| ------------ | ------------------- | ------------------------ |
|
|
1187
|
+
| **`type`** | <code>string</code> | Rewarded type user got |
|
|
1188
|
+
| **`amount`** | <code>number</code> | Rewarded amount user got |
|
|
1189
|
+
|
|
1190
|
+
|
|
1191
|
+
### Type Aliases
|
|
1192
|
+
|
|
1193
|
+
|
|
1194
|
+
#### AtLeastOne
|
|
1195
|
+
|
|
1196
|
+
<code>{[K in keyof T]: <a href="#pick">Pick</a><T, K>}[keyof T]</code>
|
|
1197
|
+
|
|
1198
|
+
|
|
1199
|
+
#### Pick
|
|
1200
|
+
|
|
1201
|
+
From T, pick a set of properties whose keys are in the union K
|
|
1202
|
+
|
|
1203
|
+
<code>{
|
|
453
1204
|
[P in K]: T[P];
|
|
454
1205
|
}</code>
|
|
1206
|
+
|
|
1207
|
+
|
|
455
1208
|
### Enums
|
|
456
1209
|
|
|
457
1210
|
|
|
@@ -462,6 +1215,94 @@ Report application volume to AdMob SDK
|
|
|
462
1215
|
| **`Teen`** | <code>'Teen'</code> | Content suitable for teen and older audiences. |
|
|
463
1216
|
| **`MatureAudience`** | <code>'MatureAudience'</code> | Content suitable only for mature audiences. |
|
|
464
1217
|
|
|
1218
|
+
|
|
1219
|
+
#### BannerAdSize
|
|
1220
|
+
|
|
1221
|
+
| Members | Value | Description |
|
|
1222
|
+
| ---------------------- | ------------------------------- | --------------------------------------------------------------------------------------------------- |
|
|
1223
|
+
| **`BANNER`** | <code>'BANNER'</code> | Mobile Marketing Association (MMA) banner ad size (320x50 density-independent pixels). |
|
|
1224
|
+
| **`FULL_BANNER`** | <code>'FULL_BANNER'</code> | Interactive Advertising Bureau (IAB) full banner ad size (468x60 density-independent pixels). |
|
|
1225
|
+
| **`LARGE_BANNER`** | <code>'LARGE_BANNER'</code> | Large banner ad size (320x100 density-independent pixels). |
|
|
1226
|
+
| **`MEDIUM_RECTANGLE`** | <code>'MEDIUM_RECTANGLE'</code> | Interactive Advertising Bureau (IAB) medium rectangle ad size (300x250 density-independent pixels). |
|
|
1227
|
+
| **`LEADERBOARD`** | <code>'LEADERBOARD'</code> | Interactive Advertising Bureau (IAB) leaderboard ad size (728x90 density-independent pixels). |
|
|
1228
|
+
| **`ADAPTIVE_BANNER`** | <code>'ADAPTIVE_BANNER'</code> | A dynamically sized banner that is full-width and auto-height. |
|
|
1229
|
+
| **`SMART_BANNER`** | <code>'SMART_BANNER'</code> | |
|
|
1230
|
+
|
|
1231
|
+
|
|
1232
|
+
#### BannerAdPosition
|
|
1233
|
+
|
|
1234
|
+
| Members | Value | Description |
|
|
1235
|
+
| ------------------- | ---------------------------- | ----------------------------------------- |
|
|
1236
|
+
| **`TOP_CENTER`** | <code>'TOP_CENTER'</code> | Banner position be top-center |
|
|
1237
|
+
| **`CENTER`** | <code>'CENTER'</code> | Banner position be center |
|
|
1238
|
+
| **`BOTTOM_CENTER`** | <code>'BOTTOM_CENTER'</code> | Banner position be bottom-center(default) |
|
|
1239
|
+
|
|
1240
|
+
|
|
1241
|
+
#### BannerAdPluginEvents
|
|
1242
|
+
|
|
1243
|
+
| Members | Value | Description |
|
|
1244
|
+
| ------------------ | ----------------------------------- | ------------------------------------------------------------------------------------------------------ |
|
|
1245
|
+
| **`SizeChanged`** | <code>"bannerAdSizeChanged"</code> | |
|
|
1246
|
+
| **`Loaded`** | <code>"bannerAdLoaded"</code> | |
|
|
1247
|
+
| **`FailedToLoad`** | <code>"bannerAdFailedToLoad"</code> | |
|
|
1248
|
+
| **`Opened`** | <code>"bannerAdOpened"</code> | Open "Adsense" Event after user click banner |
|
|
1249
|
+
| **`Closed`** | <code>"bannerAdClosed"</code> | Close "Adsense" Event after user click banner |
|
|
1250
|
+
| **`AdImpression`** | <code>"bannerAdImpression"</code> | Similarly, this method should be called when an impression is recorded for the ad by the mediated SDK. |
|
|
1251
|
+
|
|
1252
|
+
|
|
1253
|
+
#### AdmobConsentStatus
|
|
1254
|
+
|
|
1255
|
+
| Members | Value | Description |
|
|
1256
|
+
| ------------------ | --------------------------- | ------------------------------------------------------------------------------------- |
|
|
1257
|
+
| **`NOT_REQUIRED`** | <code>'NOT_REQUIRED'</code> | User consent not required. |
|
|
1258
|
+
| **`OBTAINED`** | <code>'OBTAINED'</code> | User consent already obtained. |
|
|
1259
|
+
| **`REQUIRED`** | <code>'REQUIRED'</code> | User consent required but not yet obtained. |
|
|
1260
|
+
| **`UNKNOWN`** | <code>'UNKNOWN'</code> | Unknown consent status, AdsConsent.requestInfoUpdate needs to be called to update it. |
|
|
1261
|
+
|
|
1262
|
+
|
|
1263
|
+
#### AdmobConsentDebugGeography
|
|
1264
|
+
|
|
1265
|
+
| Members | Value | Description |
|
|
1266
|
+
| -------------- | -------------- | -------------------------------------------------- |
|
|
1267
|
+
| **`DISABLED`** | <code>0</code> | Debug geography disabled. |
|
|
1268
|
+
| **`EEA`** | <code>1</code> | Geography appears as in EEA for debug devices. |
|
|
1269
|
+
| **`NOT_EEA`** | <code>2</code> | Geography appears as not in EEA for debug devices. |
|
|
1270
|
+
|
|
1271
|
+
|
|
1272
|
+
#### InterstitialAdPluginEvents
|
|
1273
|
+
|
|
1274
|
+
| Members | Value | Description |
|
|
1275
|
+
| ------------------ | ----------------------------------------- | -------------------------------------------------------------------------------------- |
|
|
1276
|
+
| **`Loaded`** | <code>'interstitialAdLoaded'</code> | Emits after trying to prepare and Interstitial, when it is loaded and ready to be show |
|
|
1277
|
+
| **`FailedToLoad`** | <code>'interstitialAdFailedToLoad'</code> | Emits after trying to prepare and Interstitial, when it could not be loaded |
|
|
1278
|
+
| **`Showed`** | <code>'interstitialAdShowed'</code> | Emits when the Interstitial ad is visible to the user |
|
|
1279
|
+
| **`FailedToShow`** | <code>'interstitialAdFailedToShow'</code> | Emits when the Interstitial ad is failed to show |
|
|
1280
|
+
| **`Dismissed`** | <code>'interstitialAdDismissed'</code> | Emits when the Interstitial ad is not visible to the user anymore. |
|
|
1281
|
+
|
|
1282
|
+
|
|
1283
|
+
#### RewardAdPluginEvents
|
|
1284
|
+
|
|
1285
|
+
| Members | Value | Description |
|
|
1286
|
+
| ------------------ | -------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
1287
|
+
| **`Loaded`** | <code>'onRewardedVideoAdLoaded'</code> | Emits after trying to prepare a RewardAd and the Video is loaded and ready to be show |
|
|
1288
|
+
| **`FailedToLoad`** | <code>'onRewardedVideoAdFailedToLoad'</code> | Emits after trying to prepare a RewardAd when it could not be loaded |
|
|
1289
|
+
| **`Showed`** | <code>'onRewardedVideoAdShowed'</code> | Emits when the AdReward video is visible to the user |
|
|
1290
|
+
| **`FailedToShow`** | <code>'onRewardedVideoAdFailedToShow'</code> | Emits when the AdReward video is failed to show |
|
|
1291
|
+
| **`Dismissed`** | <code>'onRewardedVideoAdDismissed'</code> | Emits when the AdReward video is not visible to the user anymore. **Important**: This has nothing to do with the reward it self. This event will emits in this two cases: 1. The user starts the video ad but close it before the reward emit. 2. The user start the video and see it until end, then gets the reward and after that the ad is closed. |
|
|
1292
|
+
| **`Rewarded`** | <code>'onRewardedVideoAdReward'</code> | Emits when user get rewarded from AdReward |
|
|
1293
|
+
|
|
1294
|
+
|
|
1295
|
+
#### RewardInterstitialAdPluginEvents
|
|
1296
|
+
|
|
1297
|
+
| Members | Value | Description |
|
|
1298
|
+
| ------------------ | --------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
1299
|
+
| **`Loaded`** | <code>'onRewardedInterstitialAdLoaded'</code> | Emits after trying to prepare a RewardAd and the Video is loaded and ready to be show |
|
|
1300
|
+
| **`FailedToLoad`** | <code>'onRewardedInterstitialAdFailedToLoad'</code> | Emits after trying to prepare a RewardAd when it could not be loaded |
|
|
1301
|
+
| **`Showed`** | <code>'onRewardedInterstitialAdShowed'</code> | Emits when the AdReward video is visible to the user |
|
|
1302
|
+
| **`FailedToShow`** | <code>'onRewardedInterstitialAdFailedToShow'</code> | Emits when the AdReward video is failed to show |
|
|
1303
|
+
| **`Dismissed`** | <code>'onRewardedInterstitialAdDismissed'</code> | Emits when the AdReward video is not visible to the user anymore. **Important**: This has nothing to do with the reward it self. This event will emits in this two cases: 1. The user starts the video ad but close it before the reward emit. 2. The user start the video and see it until end, then gets the reward and after that the ad is closed. |
|
|
1304
|
+
| **`Rewarded`** | <code>'onRewardedInterstitialAdReward'</code> | Emits when user get rewarded from AdReward |
|
|
1305
|
+
|
|
465
1306
|
</docgen-api>
|
|
466
1307
|
|
|
467
1308
|
## TROUBLE SHOOTING
|