@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.
- package/CapacitorCommunityAdmob.podspec +1 -1
- package/Package.swift +2 -2
- package/README.md +26 -840
- package/android/build.gradle +11 -11
- package/dist/docs.json +94 -2563
- package/package.json +11 -11
package/README.md
CHANGED
|
@@ -6,8 +6,7 @@
|
|
|
6
6
|
</p>
|
|
7
7
|
|
|
8
8
|
<p align="center">
|
|
9
|
-
<img src="https://img.shields.io/maintenance/yes/
|
|
10
|
-
<!-- <a href="https://github.com/capacitor-community/example/actions?query=workflow%3A%22CI%22"><img src="https://img.shields.io/github/workflow/status/capacitor-community/example/CI?style=flat-square" /></a> -->
|
|
9
|
+
<img src="https://img.shields.io/maintenance/yes/2025?style=flat-square" />
|
|
11
10
|
<a href="https://www.npmjs.com/package/@capacitor-community/admob"><img src="https://img.shields.io/npm/l/@capacitor-community/admob?style=flat-square" /></a>
|
|
12
11
|
<br>
|
|
13
12
|
<a href="https://www.npmjs.com/package/@capacitor-community/admob"><img src="https://img.shields.io/npm/dw/@capacitor-community/admob?style=flat-square" /></a>
|
|
@@ -44,30 +43,10 @@ Made with [contributors-img](https://contrib.rocks).
|
|
|
44
43
|
|
|
45
44
|
## Installation
|
|
46
45
|
|
|
47
|
-
If you use capacitor 6
|
|
46
|
+
If you use capacitor 6:
|
|
48
47
|
|
|
49
|
-
```bash
|
|
50
|
-
% npm install --save @capacitor-community/admob@next
|
|
51
48
|
```
|
|
52
|
-
|
|
53
|
-
If you use capacitor 5:
|
|
54
|
-
|
|
55
|
-
```
|
|
56
|
-
% npm install --save @capacitor-community/admob@5.0.0
|
|
57
|
-
% npx cap update
|
|
58
|
-
```
|
|
59
|
-
|
|
60
|
-
If you use capacitor 4:
|
|
61
|
-
|
|
62
|
-
```
|
|
63
|
-
% npm install --save @capacitor-community/admob@4.0.0
|
|
64
|
-
% npx cap update
|
|
65
|
-
```
|
|
66
|
-
|
|
67
|
-
capacitor 3:
|
|
68
|
-
|
|
69
|
-
```
|
|
70
|
-
% npm install --save @capacitor-community/admob@3.3.0
|
|
49
|
+
% npm install --save @capacitor-community/admob@6
|
|
71
50
|
% npx cap update
|
|
72
51
|
```
|
|
73
52
|
|
|
@@ -346,44 +325,7 @@ AdMob.addListener(RewardAdPluginEvents.Rewarded, async () => {
|
|
|
346
325
|
* [`requestTrackingAuthorization()`](#requesttrackingauthorization)
|
|
347
326
|
* [`setApplicationMuted(...)`](#setapplicationmuted)
|
|
348
327
|
* [`setApplicationVolume(...)`](#setapplicationvolume)
|
|
349
|
-
* [`showBanner(...)`](#showbanner)
|
|
350
|
-
* [`hideBanner()`](#hidebanner)
|
|
351
|
-
* [`resumeBanner()`](#resumebanner)
|
|
352
|
-
* [`removeBanner()`](#removebanner)
|
|
353
|
-
* [`addListener(BannerAdPluginEvents.SizeChanged, ...)`](#addlistenerbanneradplugineventssizechanged-)
|
|
354
|
-
* [`addListener(BannerAdPluginEvents.Loaded, ...)`](#addlistenerbanneradplugineventsloaded-)
|
|
355
|
-
* [`addListener(BannerAdPluginEvents.FailedToLoad, ...)`](#addlistenerbanneradplugineventsfailedtoload-)
|
|
356
|
-
* [`addListener(BannerAdPluginEvents.Opened, ...)`](#addlistenerbanneradplugineventsopened-)
|
|
357
|
-
* [`addListener(BannerAdPluginEvents.Closed, ...)`](#addlistenerbanneradplugineventsclosed-)
|
|
358
|
-
* [`addListener(BannerAdPluginEvents.AdImpression, ...)`](#addlistenerbanneradplugineventsadimpression-)
|
|
359
|
-
* [`requestConsentInfo(...)`](#requestconsentinfo)
|
|
360
|
-
* [`showConsentForm()`](#showconsentform)
|
|
361
|
-
* [`resetConsentInfo()`](#resetconsentinfo)
|
|
362
|
-
* [`prepareInterstitial(...)`](#prepareinterstitial)
|
|
363
|
-
* [`showInterstitial()`](#showinterstitial)
|
|
364
|
-
* [`addListener(InterstitialAdPluginEvents.FailedToLoad, ...)`](#addlistenerinterstitialadplugineventsfailedtoload-)
|
|
365
|
-
* [`addListener(InterstitialAdPluginEvents.Loaded, ...)`](#addlistenerinterstitialadplugineventsloaded-)
|
|
366
|
-
* [`addListener(InterstitialAdPluginEvents.Dismissed, ...)`](#addlistenerinterstitialadplugineventsdismissed-)
|
|
367
|
-
* [`addListener(InterstitialAdPluginEvents.FailedToShow, ...)`](#addlistenerinterstitialadplugineventsfailedtoshow-)
|
|
368
|
-
* [`addListener(InterstitialAdPluginEvents.Showed, ...)`](#addlistenerinterstitialadplugineventsshowed-)
|
|
369
|
-
* [`prepareRewardVideoAd(...)`](#preparerewardvideoad)
|
|
370
|
-
* [`showRewardVideoAd()`](#showrewardvideoad)
|
|
371
|
-
* [`addListener(RewardAdPluginEvents.FailedToLoad, ...)`](#addlistenerrewardadplugineventsfailedtoload-)
|
|
372
|
-
* [`addListener(RewardAdPluginEvents.Loaded, ...)`](#addlistenerrewardadplugineventsloaded-)
|
|
373
|
-
* [`addListener(RewardAdPluginEvents.Rewarded, ...)`](#addlistenerrewardadplugineventsrewarded-)
|
|
374
|
-
* [`addListener(RewardAdPluginEvents.Dismissed, ...)`](#addlistenerrewardadplugineventsdismissed-)
|
|
375
|
-
* [`addListener(RewardAdPluginEvents.FailedToShow, ...)`](#addlistenerrewardadplugineventsfailedtoshow-)
|
|
376
|
-
* [`addListener(RewardAdPluginEvents.Showed, ...)`](#addlistenerrewardadplugineventsshowed-)
|
|
377
|
-
* [`prepareRewardInterstitialAd(...)`](#preparerewardinterstitialad)
|
|
378
|
-
* [`showRewardInterstitialAd()`](#showrewardinterstitialad)
|
|
379
|
-
* [`addListener(RewardInterstitialAdPluginEvents.FailedToLoad, ...)`](#addlistenerrewardinterstitialadplugineventsfailedtoload-)
|
|
380
|
-
* [`addListener(RewardInterstitialAdPluginEvents.Loaded, ...)`](#addlistenerrewardinterstitialadplugineventsloaded-)
|
|
381
|
-
* [`addListener(RewardInterstitialAdPluginEvents.Rewarded, ...)`](#addlistenerrewardinterstitialadplugineventsrewarded-)
|
|
382
|
-
* [`addListener(RewardInterstitialAdPluginEvents.Dismissed, ...)`](#addlistenerrewardinterstitialadplugineventsdismissed-)
|
|
383
|
-
* [`addListener(RewardInterstitialAdPluginEvents.FailedToShow, ...)`](#addlistenerrewardinterstitialadplugineventsfailedtoshow-)
|
|
384
|
-
* [`addListener(RewardInterstitialAdPluginEvents.Showed, ...)`](#addlistenerrewardinterstitialadplugineventsshowed-)
|
|
385
328
|
* [Interfaces](#interfaces)
|
|
386
|
-
* [Type Aliases](#type-aliases)
|
|
387
329
|
* [Enums](#enums)
|
|
388
330
|
|
|
389
331
|
</docgen-index>
|
|
@@ -396,7 +338,7 @@ AdMob.addListener(RewardAdPluginEvents.Rewarded, async () => {
|
|
|
396
338
|
### initialize(...)
|
|
397
339
|
|
|
398
340
|
```typescript
|
|
399
|
-
initialize(options?: AdMobInitializationOptions) => Promise<void>
|
|
341
|
+
initialize(options?: AdMobInitializationOptions | undefined) => Promise<void>
|
|
400
342
|
```
|
|
401
343
|
|
|
402
344
|
Initialize AdMob with <a href="#admobinitializationoptions">AdMobInitializationOptions</a>
|
|
@@ -405,6 +347,8 @@ Initialize AdMob with <a href="#admobinitializationoptions">AdMobInitializationO
|
|
|
405
347
|
| ------------- | --------------------------------------------------------------------------------- | -------------------------------------------------------------------- |
|
|
406
348
|
| **`options`** | <code><a href="#admobinitializationoptions">AdMobInitializationOptions</a></code> | <a href="#admobinitializationoptions">AdMobInitializationOptions</a> |
|
|
407
349
|
|
|
350
|
+
**Since:** 1.1.2
|
|
351
|
+
|
|
408
352
|
--------------------
|
|
409
353
|
|
|
410
354
|
|
|
@@ -418,6 +362,8 @@ Confirm requestTrackingAuthorization status (iOS >14)
|
|
|
418
362
|
|
|
419
363
|
**Returns:** <code>Promise<<a href="#trackingauthorizationstatusinterface">TrackingAuthorizationStatusInterface</a>></code>
|
|
420
364
|
|
|
365
|
+
**Since:** 3.1.0
|
|
366
|
+
|
|
421
367
|
--------------------
|
|
422
368
|
|
|
423
369
|
|
|
@@ -430,6 +376,8 @@ requestTrackingAuthorization() => Promise<void>
|
|
|
430
376
|
request requestTrackingAuthorization (iOS >14).
|
|
431
377
|
This is deprecated method. We recommend UMP Consent.
|
|
432
378
|
|
|
379
|
+
**Since:** 5.2.0
|
|
380
|
+
|
|
433
381
|
--------------------
|
|
434
382
|
|
|
435
383
|
|
|
@@ -445,6 +393,8 @@ Report application mute state to AdMob SDK
|
|
|
445
393
|
| ------------- | --------------------------------------------------------------------------- |
|
|
446
394
|
| **`options`** | <code><a href="#applicationmutedoptions">ApplicationMutedOptions</a></code> |
|
|
447
395
|
|
|
396
|
+
**Since:** 4.1.1
|
|
397
|
+
|
|
448
398
|
--------------------
|
|
449
399
|
|
|
450
400
|
|
|
@@ -460,560 +410,7 @@ Report application volume to AdMob SDK
|
|
|
460
410
|
| ------------- | ----------------------------------------------------------------------------- |
|
|
461
411
|
| **`options`** | <code><a href="#applicationvolumeoptions">ApplicationVolumeOptions</a></code> |
|
|
462
412
|
|
|
463
|
-
|
|
464
|
-
|
|
465
|
-
|
|
466
|
-
### showBanner(...)
|
|
467
|
-
|
|
468
|
-
```typescript
|
|
469
|
-
showBanner(options: BannerAdOptions) => Promise<void>
|
|
470
|
-
```
|
|
471
|
-
|
|
472
|
-
Show a banner Ad
|
|
473
|
-
|
|
474
|
-
| Param | Type | Description |
|
|
475
|
-
| ------------- | ----------------------------------------------------------- | ---------------------------------- |
|
|
476
|
-
| **`options`** | <code><a href="#banneradoptions">BannerAdOptions</a></code> | <a href="#adoptions">AdOptions</a> |
|
|
477
|
-
|
|
478
|
-
--------------------
|
|
479
|
-
|
|
480
|
-
|
|
481
|
-
### hideBanner()
|
|
482
|
-
|
|
483
|
-
```typescript
|
|
484
|
-
hideBanner() => Promise<void>
|
|
485
|
-
```
|
|
486
|
-
|
|
487
|
-
Hide the banner, remove it from screen, but can show it later
|
|
488
|
-
|
|
489
|
-
--------------------
|
|
490
|
-
|
|
491
|
-
|
|
492
|
-
### resumeBanner()
|
|
493
|
-
|
|
494
|
-
```typescript
|
|
495
|
-
resumeBanner() => Promise<void>
|
|
496
|
-
```
|
|
497
|
-
|
|
498
|
-
Resume the banner, show it after hide
|
|
499
|
-
|
|
500
|
-
--------------------
|
|
501
|
-
|
|
502
|
-
|
|
503
|
-
### removeBanner()
|
|
504
|
-
|
|
505
|
-
```typescript
|
|
506
|
-
removeBanner() => Promise<void>
|
|
507
|
-
```
|
|
508
|
-
|
|
509
|
-
Destroy the banner, remove it from screen.
|
|
510
|
-
|
|
511
|
-
--------------------
|
|
512
|
-
|
|
513
|
-
|
|
514
|
-
### addListener(BannerAdPluginEvents.SizeChanged, ...)
|
|
515
|
-
|
|
516
|
-
```typescript
|
|
517
|
-
addListener(eventName: BannerAdPluginEvents.SizeChanged, listenerFunc: (info: AdMobBannerSize) => void) => Promise<PluginListenerHandle>
|
|
518
|
-
```
|
|
519
|
-
|
|
520
|
-
| Param | Type | Description |
|
|
521
|
-
| ------------------ | --------------------------------------------------------------------------------- | ------------------- |
|
|
522
|
-
| **`eventName`** | <code><a href="#banneradpluginevents">BannerAdPluginEvents.SizeChanged</a></code> | bannerAdSizeChanged |
|
|
523
|
-
| **`listenerFunc`** | <code>(info: <a href="#admobbannersize">AdMobBannerSize</a>) => void</code> | |
|
|
524
|
-
|
|
525
|
-
**Returns:** <code>Promise<<a href="#pluginlistenerhandle">PluginListenerHandle</a>></code>
|
|
526
|
-
|
|
527
|
-
--------------------
|
|
528
|
-
|
|
529
|
-
|
|
530
|
-
### addListener(BannerAdPluginEvents.Loaded, ...)
|
|
531
|
-
|
|
532
|
-
```typescript
|
|
533
|
-
addListener(eventName: BannerAdPluginEvents.Loaded, listenerFunc: () => void) => Promise<PluginListenerHandle>
|
|
534
|
-
```
|
|
535
|
-
|
|
536
|
-
Notice: request loaded Banner ad
|
|
537
|
-
|
|
538
|
-
| Param | Type | Description |
|
|
539
|
-
| ------------------ | ---------------------------------------------------------------------------- | -------------- |
|
|
540
|
-
| **`eventName`** | <code><a href="#banneradpluginevents">BannerAdPluginEvents.Loaded</a></code> | bannerAdLoaded |
|
|
541
|
-
| **`listenerFunc`** | <code>() => void</code> | |
|
|
542
|
-
|
|
543
|
-
**Returns:** <code>Promise<<a href="#pluginlistenerhandle">PluginListenerHandle</a>></code>
|
|
544
|
-
|
|
545
|
-
--------------------
|
|
546
|
-
|
|
547
|
-
|
|
548
|
-
### addListener(BannerAdPluginEvents.FailedToLoad, ...)
|
|
549
|
-
|
|
550
|
-
```typescript
|
|
551
|
-
addListener(eventName: BannerAdPluginEvents.FailedToLoad, listenerFunc: (info: AdMobError) => void) => Promise<PluginListenerHandle>
|
|
552
|
-
```
|
|
553
|
-
|
|
554
|
-
Notice: request failed Banner ad
|
|
555
|
-
|
|
556
|
-
| Param | Type | Description |
|
|
557
|
-
| ------------------ | ---------------------------------------------------------------------------------- | -------------------- |
|
|
558
|
-
| **`eventName`** | <code><a href="#banneradpluginevents">BannerAdPluginEvents.FailedToLoad</a></code> | bannerAdFailedToLoad |
|
|
559
|
-
| **`listenerFunc`** | <code>(info: <a href="#admoberror">AdMobError</a>) => void</code> | |
|
|
560
|
-
|
|
561
|
-
**Returns:** <code>Promise<<a href="#pluginlistenerhandle">PluginListenerHandle</a>></code>
|
|
562
|
-
|
|
563
|
-
--------------------
|
|
564
|
-
|
|
565
|
-
|
|
566
|
-
### addListener(BannerAdPluginEvents.Opened, ...)
|
|
567
|
-
|
|
568
|
-
```typescript
|
|
569
|
-
addListener(eventName: BannerAdPluginEvents.Opened, listenerFunc: () => void) => Promise<PluginListenerHandle>
|
|
570
|
-
```
|
|
571
|
-
|
|
572
|
-
Notice: full-screen banner view will be presented in response to the user clicking on an ad.
|
|
573
|
-
|
|
574
|
-
| Param | Type | Description |
|
|
575
|
-
| ------------------ | ---------------------------------------------------------------------------- | -------------- |
|
|
576
|
-
| **`eventName`** | <code><a href="#banneradpluginevents">BannerAdPluginEvents.Opened</a></code> | bannerAdOpened |
|
|
577
|
-
| **`listenerFunc`** | <code>() => void</code> | |
|
|
578
|
-
|
|
579
|
-
**Returns:** <code>Promise<<a href="#pluginlistenerhandle">PluginListenerHandle</a>></code>
|
|
580
|
-
|
|
581
|
-
--------------------
|
|
582
|
-
|
|
583
|
-
|
|
584
|
-
### addListener(BannerAdPluginEvents.Closed, ...)
|
|
585
|
-
|
|
586
|
-
```typescript
|
|
587
|
-
addListener(eventName: BannerAdPluginEvents.Closed, listenerFunc: () => void) => Promise<PluginListenerHandle>
|
|
588
|
-
```
|
|
589
|
-
|
|
590
|
-
Notice: The full-screen banner view will been dismissed.
|
|
591
|
-
|
|
592
|
-
| Param | Type | Description |
|
|
593
|
-
| ------------------ | ---------------------------------------------------------------------------- | -------------- |
|
|
594
|
-
| **`eventName`** | <code><a href="#banneradpluginevents">BannerAdPluginEvents.Closed</a></code> | bannerAdClosed |
|
|
595
|
-
| **`listenerFunc`** | <code>() => void</code> | |
|
|
596
|
-
|
|
597
|
-
**Returns:** <code>Promise<<a href="#pluginlistenerhandle">PluginListenerHandle</a>></code>
|
|
598
|
-
|
|
599
|
-
--------------------
|
|
600
|
-
|
|
601
|
-
|
|
602
|
-
### addListener(BannerAdPluginEvents.AdImpression, ...)
|
|
603
|
-
|
|
604
|
-
```typescript
|
|
605
|
-
addListener(eventName: BannerAdPluginEvents.AdImpression, listenerFunc: () => void) => Promise<PluginListenerHandle>
|
|
606
|
-
```
|
|
607
|
-
|
|
608
|
-
Unimplemented
|
|
609
|
-
|
|
610
|
-
| Param | Type | Description |
|
|
611
|
-
| ------------------ | ---------------------------------------------------------------------------------- | ------------ |
|
|
612
|
-
| **`eventName`** | <code><a href="#banneradpluginevents">BannerAdPluginEvents.AdImpression</a></code> | AdImpression |
|
|
613
|
-
| **`listenerFunc`** | <code>() => void</code> | |
|
|
614
|
-
|
|
615
|
-
**Returns:** <code>Promise<<a href="#pluginlistenerhandle">PluginListenerHandle</a>></code>
|
|
616
|
-
|
|
617
|
-
--------------------
|
|
618
|
-
|
|
619
|
-
|
|
620
|
-
### requestConsentInfo(...)
|
|
621
|
-
|
|
622
|
-
```typescript
|
|
623
|
-
requestConsentInfo(options?: AdmobConsentRequestOptions) => Promise<AdmobConsentInfo>
|
|
624
|
-
```
|
|
625
|
-
|
|
626
|
-
Request user consent information
|
|
627
|
-
|
|
628
|
-
| Param | Type | Description |
|
|
629
|
-
| ------------- | --------------------------------------------------------------------------------- | --------------------- |
|
|
630
|
-
| **`options`** | <code><a href="#admobconsentrequestoptions">AdmobConsentRequestOptions</a></code> | ConsentRequestOptions |
|
|
631
|
-
|
|
632
|
-
**Returns:** <code>Promise<<a href="#admobconsentinfo">AdmobConsentInfo</a>></code>
|
|
633
|
-
|
|
634
|
-
--------------------
|
|
635
|
-
|
|
636
|
-
|
|
637
|
-
### showConsentForm()
|
|
638
|
-
|
|
639
|
-
```typescript
|
|
640
|
-
showConsentForm() => Promise<AdmobConsentInfo>
|
|
641
|
-
```
|
|
642
|
-
|
|
643
|
-
Shows a google user consent form (rendered from your GDPR message config).
|
|
644
|
-
|
|
645
|
-
**Returns:** <code>Promise<<a href="#admobconsentinfo">AdmobConsentInfo</a>></code>
|
|
646
|
-
|
|
647
|
-
--------------------
|
|
648
|
-
|
|
649
|
-
|
|
650
|
-
### resetConsentInfo()
|
|
651
|
-
|
|
652
|
-
```typescript
|
|
653
|
-
resetConsentInfo() => Promise<void>
|
|
654
|
-
```
|
|
655
|
-
|
|
656
|
-
Resets the UMP SDK state. Call requestConsentInfo function again to allow user modify their consent
|
|
657
|
-
|
|
658
|
-
--------------------
|
|
659
|
-
|
|
660
|
-
|
|
661
|
-
### prepareInterstitial(...)
|
|
662
|
-
|
|
663
|
-
```typescript
|
|
664
|
-
prepareInterstitial(options: AdOptions) => Promise<AdLoadInfo>
|
|
665
|
-
```
|
|
666
|
-
|
|
667
|
-
Prepare interstitial banner
|
|
668
|
-
|
|
669
|
-
| Param | Type | Description |
|
|
670
|
-
| ------------- | ----------------------------------------------- | ---------------------------------- |
|
|
671
|
-
| **`options`** | <code><a href="#adoptions">AdOptions</a></code> | <a href="#adoptions">AdOptions</a> |
|
|
672
|
-
|
|
673
|
-
**Returns:** <code>Promise<<a href="#adloadinfo">AdLoadInfo</a>></code>
|
|
674
|
-
|
|
675
|
-
--------------------
|
|
676
|
-
|
|
677
|
-
|
|
678
|
-
### showInterstitial()
|
|
679
|
-
|
|
680
|
-
```typescript
|
|
681
|
-
showInterstitial() => Promise<void>
|
|
682
|
-
```
|
|
683
|
-
|
|
684
|
-
Show interstitial ad when it’s ready
|
|
685
|
-
|
|
686
|
-
--------------------
|
|
687
|
-
|
|
688
|
-
|
|
689
|
-
### addListener(InterstitialAdPluginEvents.FailedToLoad, ...)
|
|
690
|
-
|
|
691
|
-
```typescript
|
|
692
|
-
addListener(eventName: InterstitialAdPluginEvents.FailedToLoad, listenerFunc: (error: AdMobError) => void) => Promise<PluginListenerHandle>
|
|
693
|
-
```
|
|
694
|
-
|
|
695
|
-
| Param | Type |
|
|
696
|
-
| ------------------ | ---------------------------------------------------------------------------------------------- |
|
|
697
|
-
| **`eventName`** | <code><a href="#interstitialadpluginevents">InterstitialAdPluginEvents.FailedToLoad</a></code> |
|
|
698
|
-
| **`listenerFunc`** | <code>(error: <a href="#admoberror">AdMobError</a>) => void</code> |
|
|
699
|
-
|
|
700
|
-
**Returns:** <code>Promise<<a href="#pluginlistenerhandle">PluginListenerHandle</a>></code>
|
|
701
|
-
|
|
702
|
-
--------------------
|
|
703
|
-
|
|
704
|
-
|
|
705
|
-
### addListener(InterstitialAdPluginEvents.Loaded, ...)
|
|
706
|
-
|
|
707
|
-
```typescript
|
|
708
|
-
addListener(eventName: InterstitialAdPluginEvents.Loaded, listenerFunc: (info: AdLoadInfo) => void) => Promise<PluginListenerHandle>
|
|
709
|
-
```
|
|
710
|
-
|
|
711
|
-
| Param | Type |
|
|
712
|
-
| ------------------ | ---------------------------------------------------------------------------------------- |
|
|
713
|
-
| **`eventName`** | <code><a href="#interstitialadpluginevents">InterstitialAdPluginEvents.Loaded</a></code> |
|
|
714
|
-
| **`listenerFunc`** | <code>(info: <a href="#adloadinfo">AdLoadInfo</a>) => void</code> |
|
|
715
|
-
|
|
716
|
-
**Returns:** <code>Promise<<a href="#pluginlistenerhandle">PluginListenerHandle</a>></code>
|
|
717
|
-
|
|
718
|
-
--------------------
|
|
719
|
-
|
|
720
|
-
|
|
721
|
-
### addListener(InterstitialAdPluginEvents.Dismissed, ...)
|
|
722
|
-
|
|
723
|
-
```typescript
|
|
724
|
-
addListener(eventName: InterstitialAdPluginEvents.Dismissed, listenerFunc: () => void) => Promise<PluginListenerHandle>
|
|
725
|
-
```
|
|
726
|
-
|
|
727
|
-
| Param | Type |
|
|
728
|
-
| ------------------ | ------------------------------------------------------------------------------------------- |
|
|
729
|
-
| **`eventName`** | <code><a href="#interstitialadpluginevents">InterstitialAdPluginEvents.Dismissed</a></code> |
|
|
730
|
-
| **`listenerFunc`** | <code>() => void</code> |
|
|
731
|
-
|
|
732
|
-
**Returns:** <code>Promise<<a href="#pluginlistenerhandle">PluginListenerHandle</a>></code>
|
|
733
|
-
|
|
734
|
-
--------------------
|
|
735
|
-
|
|
736
|
-
|
|
737
|
-
### addListener(InterstitialAdPluginEvents.FailedToShow, ...)
|
|
738
|
-
|
|
739
|
-
```typescript
|
|
740
|
-
addListener(eventName: InterstitialAdPluginEvents.FailedToShow, listenerFunc: (error: AdMobError) => void) => Promise<PluginListenerHandle>
|
|
741
|
-
```
|
|
742
|
-
|
|
743
|
-
| Param | Type |
|
|
744
|
-
| ------------------ | ---------------------------------------------------------------------------------------------- |
|
|
745
|
-
| **`eventName`** | <code><a href="#interstitialadpluginevents">InterstitialAdPluginEvents.FailedToShow</a></code> |
|
|
746
|
-
| **`listenerFunc`** | <code>(error: <a href="#admoberror">AdMobError</a>) => void</code> |
|
|
747
|
-
|
|
748
|
-
**Returns:** <code>Promise<<a href="#pluginlistenerhandle">PluginListenerHandle</a>></code>
|
|
749
|
-
|
|
750
|
-
--------------------
|
|
751
|
-
|
|
752
|
-
|
|
753
|
-
### addListener(InterstitialAdPluginEvents.Showed, ...)
|
|
754
|
-
|
|
755
|
-
```typescript
|
|
756
|
-
addListener(eventName: InterstitialAdPluginEvents.Showed, listenerFunc: () => void) => Promise<PluginListenerHandle>
|
|
757
|
-
```
|
|
758
|
-
|
|
759
|
-
| Param | Type |
|
|
760
|
-
| ------------------ | ---------------------------------------------------------------------------------------- |
|
|
761
|
-
| **`eventName`** | <code><a href="#interstitialadpluginevents">InterstitialAdPluginEvents.Showed</a></code> |
|
|
762
|
-
| **`listenerFunc`** | <code>() => void</code> |
|
|
763
|
-
|
|
764
|
-
**Returns:** <code>Promise<<a href="#pluginlistenerhandle">PluginListenerHandle</a>></code>
|
|
765
|
-
|
|
766
|
-
--------------------
|
|
767
|
-
|
|
768
|
-
|
|
769
|
-
### prepareRewardVideoAd(...)
|
|
770
|
-
|
|
771
|
-
```typescript
|
|
772
|
-
prepareRewardVideoAd(options: RewardAdOptions) => Promise<AdLoadInfo>
|
|
773
|
-
```
|
|
774
|
-
|
|
775
|
-
Prepare a reward video ad
|
|
776
|
-
|
|
777
|
-
| Param | Type | Description |
|
|
778
|
-
| ------------- | ----------------------------------------------------------- | ---------------------------------------------- |
|
|
779
|
-
| **`options`** | <code><a href="#rewardadoptions">RewardAdOptions</a></code> | <a href="#rewardadoptions">RewardAdOptions</a> |
|
|
780
|
-
|
|
781
|
-
**Returns:** <code>Promise<<a href="#adloadinfo">AdLoadInfo</a>></code>
|
|
782
|
-
|
|
783
|
-
--------------------
|
|
784
|
-
|
|
785
|
-
|
|
786
|
-
### showRewardVideoAd()
|
|
787
|
-
|
|
788
|
-
```typescript
|
|
789
|
-
showRewardVideoAd() => Promise<AdMobRewardItem>
|
|
790
|
-
```
|
|
791
|
-
|
|
792
|
-
Show a reward video ad
|
|
793
|
-
|
|
794
|
-
**Returns:** <code>Promise<<a href="#admobrewarditem">AdMobRewardItem</a>></code>
|
|
795
|
-
|
|
796
|
-
--------------------
|
|
797
|
-
|
|
798
|
-
|
|
799
|
-
### addListener(RewardAdPluginEvents.FailedToLoad, ...)
|
|
800
|
-
|
|
801
|
-
```typescript
|
|
802
|
-
addListener(eventName: RewardAdPluginEvents.FailedToLoad, listenerFunc: (error: AdMobError) => void) => Promise<PluginListenerHandle>
|
|
803
|
-
```
|
|
804
|
-
|
|
805
|
-
| Param | Type |
|
|
806
|
-
| ------------------ | ---------------------------------------------------------------------------------- |
|
|
807
|
-
| **`eventName`** | <code><a href="#rewardadpluginevents">RewardAdPluginEvents.FailedToLoad</a></code> |
|
|
808
|
-
| **`listenerFunc`** | <code>(error: <a href="#admoberror">AdMobError</a>) => void</code> |
|
|
809
|
-
|
|
810
|
-
**Returns:** <code>Promise<<a href="#pluginlistenerhandle">PluginListenerHandle</a>></code>
|
|
811
|
-
|
|
812
|
-
--------------------
|
|
813
|
-
|
|
814
|
-
|
|
815
|
-
### addListener(RewardAdPluginEvents.Loaded, ...)
|
|
816
|
-
|
|
817
|
-
```typescript
|
|
818
|
-
addListener(eventName: RewardAdPluginEvents.Loaded, listenerFunc: (info: AdLoadInfo) => void) => Promise<PluginListenerHandle>
|
|
819
|
-
```
|
|
820
|
-
|
|
821
|
-
| Param | Type |
|
|
822
|
-
| ------------------ | ---------------------------------------------------------------------------- |
|
|
823
|
-
| **`eventName`** | <code><a href="#rewardadpluginevents">RewardAdPluginEvents.Loaded</a></code> |
|
|
824
|
-
| **`listenerFunc`** | <code>(info: <a href="#adloadinfo">AdLoadInfo</a>) => void</code> |
|
|
825
|
-
|
|
826
|
-
**Returns:** <code>Promise<<a href="#pluginlistenerhandle">PluginListenerHandle</a>></code>
|
|
827
|
-
|
|
828
|
-
--------------------
|
|
829
|
-
|
|
830
|
-
|
|
831
|
-
### addListener(RewardAdPluginEvents.Rewarded, ...)
|
|
832
|
-
|
|
833
|
-
```typescript
|
|
834
|
-
addListener(eventName: RewardAdPluginEvents.Rewarded, listenerFunc: (reward: AdMobRewardItem) => void) => Promise<PluginListenerHandle>
|
|
835
|
-
```
|
|
836
|
-
|
|
837
|
-
| Param | Type |
|
|
838
|
-
| ------------------ | -------------------------------------------------------------------------------- |
|
|
839
|
-
| **`eventName`** | <code><a href="#rewardadpluginevents">RewardAdPluginEvents.Rewarded</a></code> |
|
|
840
|
-
| **`listenerFunc`** | <code>(reward: <a href="#admobrewarditem">AdMobRewardItem</a>) => void</code> |
|
|
841
|
-
|
|
842
|
-
**Returns:** <code>Promise<<a href="#pluginlistenerhandle">PluginListenerHandle</a>></code>
|
|
843
|
-
|
|
844
|
-
--------------------
|
|
845
|
-
|
|
846
|
-
|
|
847
|
-
### addListener(RewardAdPluginEvents.Dismissed, ...)
|
|
848
|
-
|
|
849
|
-
```typescript
|
|
850
|
-
addListener(eventName: RewardAdPluginEvents.Dismissed, listenerFunc: () => void) => Promise<PluginListenerHandle>
|
|
851
|
-
```
|
|
852
|
-
|
|
853
|
-
| Param | Type |
|
|
854
|
-
| ------------------ | ------------------------------------------------------------------------------- |
|
|
855
|
-
| **`eventName`** | <code><a href="#rewardadpluginevents">RewardAdPluginEvents.Dismissed</a></code> |
|
|
856
|
-
| **`listenerFunc`** | <code>() => void</code> |
|
|
857
|
-
|
|
858
|
-
**Returns:** <code>Promise<<a href="#pluginlistenerhandle">PluginListenerHandle</a>></code>
|
|
859
|
-
|
|
860
|
-
--------------------
|
|
861
|
-
|
|
862
|
-
|
|
863
|
-
### addListener(RewardAdPluginEvents.FailedToShow, ...)
|
|
864
|
-
|
|
865
|
-
```typescript
|
|
866
|
-
addListener(eventName: RewardAdPluginEvents.FailedToShow, listenerFunc: (error: AdMobError) => void) => Promise<PluginListenerHandle>
|
|
867
|
-
```
|
|
868
|
-
|
|
869
|
-
| Param | Type |
|
|
870
|
-
| ------------------ | ---------------------------------------------------------------------------------- |
|
|
871
|
-
| **`eventName`** | <code><a href="#rewardadpluginevents">RewardAdPluginEvents.FailedToShow</a></code> |
|
|
872
|
-
| **`listenerFunc`** | <code>(error: <a href="#admoberror">AdMobError</a>) => void</code> |
|
|
873
|
-
|
|
874
|
-
**Returns:** <code>Promise<<a href="#pluginlistenerhandle">PluginListenerHandle</a>></code>
|
|
875
|
-
|
|
876
|
-
--------------------
|
|
877
|
-
|
|
878
|
-
|
|
879
|
-
### addListener(RewardAdPluginEvents.Showed, ...)
|
|
880
|
-
|
|
881
|
-
```typescript
|
|
882
|
-
addListener(eventName: RewardAdPluginEvents.Showed, listenerFunc: () => void) => Promise<PluginListenerHandle>
|
|
883
|
-
```
|
|
884
|
-
|
|
885
|
-
| Param | Type |
|
|
886
|
-
| ------------------ | ---------------------------------------------------------------------------- |
|
|
887
|
-
| **`eventName`** | <code><a href="#rewardadpluginevents">RewardAdPluginEvents.Showed</a></code> |
|
|
888
|
-
| **`listenerFunc`** | <code>() => void</code> |
|
|
889
|
-
|
|
890
|
-
**Returns:** <code>Promise<<a href="#pluginlistenerhandle">PluginListenerHandle</a>></code>
|
|
891
|
-
|
|
892
|
-
--------------------
|
|
893
|
-
|
|
894
|
-
|
|
895
|
-
### prepareRewardInterstitialAd(...)
|
|
896
|
-
|
|
897
|
-
```typescript
|
|
898
|
-
prepareRewardInterstitialAd(options: RewardInterstitialAdOptions) => Promise<AdLoadInfo>
|
|
899
|
-
```
|
|
900
|
-
|
|
901
|
-
Prepare a reward video ad
|
|
902
|
-
|
|
903
|
-
| Param | Type | Description |
|
|
904
|
-
| ------------- | ----------------------------------------------------------------------------------- | ---------------------------------------------- |
|
|
905
|
-
| **`options`** | <code><a href="#rewardinterstitialadoptions">RewardInterstitialAdOptions</a></code> | <a href="#rewardadoptions">RewardAdOptions</a> |
|
|
906
|
-
|
|
907
|
-
**Returns:** <code>Promise<<a href="#adloadinfo">AdLoadInfo</a>></code>
|
|
908
|
-
|
|
909
|
-
--------------------
|
|
910
|
-
|
|
911
|
-
|
|
912
|
-
### showRewardInterstitialAd()
|
|
913
|
-
|
|
914
|
-
```typescript
|
|
915
|
-
showRewardInterstitialAd() => Promise<AdMobRewardInterstitialItem>
|
|
916
|
-
```
|
|
917
|
-
|
|
918
|
-
Show a reward video ad
|
|
919
|
-
|
|
920
|
-
**Returns:** <code>Promise<<a href="#admobrewardinterstitialitem">AdMobRewardInterstitialItem</a>></code>
|
|
921
|
-
|
|
922
|
-
--------------------
|
|
923
|
-
|
|
924
|
-
|
|
925
|
-
### addListener(RewardInterstitialAdPluginEvents.FailedToLoad, ...)
|
|
926
|
-
|
|
927
|
-
```typescript
|
|
928
|
-
addListener(eventName: RewardInterstitialAdPluginEvents.FailedToLoad, listenerFunc: (error: AdMobError) => void) => Promise<PluginListenerHandle>
|
|
929
|
-
```
|
|
930
|
-
|
|
931
|
-
| Param | Type |
|
|
932
|
-
| ------------------ | ---------------------------------------------------------------------------------------------------------- |
|
|
933
|
-
| **`eventName`** | <code><a href="#rewardinterstitialadpluginevents">RewardInterstitialAdPluginEvents.FailedToLoad</a></code> |
|
|
934
|
-
| **`listenerFunc`** | <code>(error: <a href="#admoberror">AdMobError</a>) => void</code> |
|
|
935
|
-
|
|
936
|
-
**Returns:** <code>Promise<<a href="#pluginlistenerhandle">PluginListenerHandle</a>></code>
|
|
937
|
-
|
|
938
|
-
--------------------
|
|
939
|
-
|
|
940
|
-
|
|
941
|
-
### addListener(RewardInterstitialAdPluginEvents.Loaded, ...)
|
|
942
|
-
|
|
943
|
-
```typescript
|
|
944
|
-
addListener(eventName: RewardInterstitialAdPluginEvents.Loaded, listenerFunc: (info: AdLoadInfo) => void) => Promise<PluginListenerHandle>
|
|
945
|
-
```
|
|
946
|
-
|
|
947
|
-
| Param | Type |
|
|
948
|
-
| ------------------ | ---------------------------------------------------------------------------------------------------- |
|
|
949
|
-
| **`eventName`** | <code><a href="#rewardinterstitialadpluginevents">RewardInterstitialAdPluginEvents.Loaded</a></code> |
|
|
950
|
-
| **`listenerFunc`** | <code>(info: <a href="#adloadinfo">AdLoadInfo</a>) => void</code> |
|
|
951
|
-
|
|
952
|
-
**Returns:** <code>Promise<<a href="#pluginlistenerhandle">PluginListenerHandle</a>></code>
|
|
953
|
-
|
|
954
|
-
--------------------
|
|
955
|
-
|
|
956
|
-
|
|
957
|
-
### addListener(RewardInterstitialAdPluginEvents.Rewarded, ...)
|
|
958
|
-
|
|
959
|
-
```typescript
|
|
960
|
-
addListener(eventName: RewardInterstitialAdPluginEvents.Rewarded, listenerFunc: (reward: AdMobRewardInterstitialItem) => void) => Promise<PluginListenerHandle>
|
|
961
|
-
```
|
|
962
|
-
|
|
963
|
-
| Param | Type |
|
|
964
|
-
| ------------------ | -------------------------------------------------------------------------------------------------------- |
|
|
965
|
-
| **`eventName`** | <code><a href="#rewardinterstitialadpluginevents">RewardInterstitialAdPluginEvents.Rewarded</a></code> |
|
|
966
|
-
| **`listenerFunc`** | <code>(reward: <a href="#admobrewardinterstitialitem">AdMobRewardInterstitialItem</a>) => void</code> |
|
|
967
|
-
|
|
968
|
-
**Returns:** <code>Promise<<a href="#pluginlistenerhandle">PluginListenerHandle</a>></code>
|
|
969
|
-
|
|
970
|
-
--------------------
|
|
971
|
-
|
|
972
|
-
|
|
973
|
-
### addListener(RewardInterstitialAdPluginEvents.Dismissed, ...)
|
|
974
|
-
|
|
975
|
-
```typescript
|
|
976
|
-
addListener(eventName: RewardInterstitialAdPluginEvents.Dismissed, listenerFunc: () => void) => Promise<PluginListenerHandle>
|
|
977
|
-
```
|
|
978
|
-
|
|
979
|
-
| Param | Type |
|
|
980
|
-
| ------------------ | ------------------------------------------------------------------------------------------------------- |
|
|
981
|
-
| **`eventName`** | <code><a href="#rewardinterstitialadpluginevents">RewardInterstitialAdPluginEvents.Dismissed</a></code> |
|
|
982
|
-
| **`listenerFunc`** | <code>() => void</code> |
|
|
983
|
-
|
|
984
|
-
**Returns:** <code>Promise<<a href="#pluginlistenerhandle">PluginListenerHandle</a>></code>
|
|
985
|
-
|
|
986
|
-
--------------------
|
|
987
|
-
|
|
988
|
-
|
|
989
|
-
### addListener(RewardInterstitialAdPluginEvents.FailedToShow, ...)
|
|
990
|
-
|
|
991
|
-
```typescript
|
|
992
|
-
addListener(eventName: RewardInterstitialAdPluginEvents.FailedToShow, listenerFunc: (error: AdMobError) => void) => Promise<PluginListenerHandle>
|
|
993
|
-
```
|
|
994
|
-
|
|
995
|
-
| Param | Type |
|
|
996
|
-
| ------------------ | ---------------------------------------------------------------------------------------------------------- |
|
|
997
|
-
| **`eventName`** | <code><a href="#rewardinterstitialadpluginevents">RewardInterstitialAdPluginEvents.FailedToShow</a></code> |
|
|
998
|
-
| **`listenerFunc`** | <code>(error: <a href="#admoberror">AdMobError</a>) => void</code> |
|
|
999
|
-
|
|
1000
|
-
**Returns:** <code>Promise<<a href="#pluginlistenerhandle">PluginListenerHandle</a>></code>
|
|
1001
|
-
|
|
1002
|
-
--------------------
|
|
1003
|
-
|
|
1004
|
-
|
|
1005
|
-
### addListener(RewardInterstitialAdPluginEvents.Showed, ...)
|
|
1006
|
-
|
|
1007
|
-
```typescript
|
|
1008
|
-
addListener(eventName: RewardInterstitialAdPluginEvents.Showed, listenerFunc: () => void) => Promise<PluginListenerHandle>
|
|
1009
|
-
```
|
|
1010
|
-
|
|
1011
|
-
| Param | Type |
|
|
1012
|
-
| ------------------ | ---------------------------------------------------------------------------------------------------- |
|
|
1013
|
-
| **`eventName`** | <code><a href="#rewardinterstitialadpluginevents">RewardInterstitialAdPluginEvents.Showed</a></code> |
|
|
1014
|
-
| **`listenerFunc`** | <code>() => void</code> |
|
|
1015
|
-
|
|
1016
|
-
**Returns:** <code>Promise<<a href="#pluginlistenerhandle">PluginListenerHandle</a>></code>
|
|
413
|
+
**Since:** 4.1.1
|
|
1017
414
|
|
|
1018
415
|
--------------------
|
|
1019
416
|
|
|
@@ -1023,13 +420,13 @@ addListener(eventName: RewardInterstitialAdPluginEvents.Showed, listenerFunc: ()
|
|
|
1023
420
|
|
|
1024
421
|
#### AdMobInitializationOptions
|
|
1025
422
|
|
|
1026
|
-
| Prop | Type | Description |
|
|
1027
|
-
| ---------------------------------- | ----------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
|
1028
|
-
| **`testingDevices`** | <code>string[]</code> | An Array of devices IDs that will be marked as tested devices if {@link <a href="#admobinitializationoptions">AdMobInitializationOptions.initializeForTesting</a>} is true (Real Ads will be served to Testing devices, but they will not count as 'real'). |
|
|
1029
|
-
| **`initializeForTesting`** | <code>boolean</code> | If set to true, the devices on {@link <a href="#admobinitializationoptions">AdMobInitializationOptions.testingDevices</a>} will be registered to receive test production ads. |
|
|
1030
|
-
| **`tagForChildDirectedTreatment`** | <code>boolean</code> | For purposes of the Children's Online Privacy Protection Act (COPPA), there is a setting called tagForChildDirectedTreatment. |
|
|
1031
|
-
| **`tagForUnderAgeOfConsent`** | <code>boolean</code> | When using this feature, a Tag For Users under the Age of Consent in Europe (TFUA) parameter will be included in all future ad requests. |
|
|
1032
|
-
| **`maxAdContentRating`** | <code><a href="#maxadcontentrating">MaxAdContentRating</a></code> | As an app developer, you can indicate whether you want Google to treat your content as child-directed when you make an ad request. |
|
|
423
|
+
| Prop | Type | Description | Default | Since |
|
|
424
|
+
| ---------------------------------- | ----------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------ | ----- |
|
|
425
|
+
| **`testingDevices`** | <code>string[]</code> | An Array of devices IDs that will be marked as tested devices if {@link <a href="#admobinitializationoptions">AdMobInitializationOptions.initializeForTesting</a>} is true (Real Ads will be served to Testing devices, but they will not count as 'real'). | | 1.2.0 |
|
|
426
|
+
| **`initializeForTesting`** | <code>boolean</code> | If set to true, the devices on {@link <a href="#admobinitializationoptions">AdMobInitializationOptions.testingDevices</a>} will be registered to receive test production ads. | <code>false</code> | 1.2.0 |
|
|
427
|
+
| **`tagForChildDirectedTreatment`** | <code>boolean</code> | For purposes of the Children's Online Privacy Protection Act (COPPA), there is a setting called tagForChildDirectedTreatment. | | 3.1.0 |
|
|
428
|
+
| **`tagForUnderAgeOfConsent`** | <code>boolean</code> | When using this feature, a Tag For Users under the Age of Consent in Europe (TFUA) parameter will be included in all future ad requests. | | 3.1.0 |
|
|
429
|
+
| **`maxAdContentRating`** | <code><a href="#maxadcontentrating">MaxAdContentRating</a></code> | As an app developer, you can indicate whether you want Google to treat your content as child-directed when you make an ad request. | | 3.1.0 |
|
|
1033
430
|
|
|
1034
431
|
|
|
1035
432
|
#### TrackingAuthorizationStatusInterface
|
|
@@ -1041,139 +438,16 @@ addListener(eventName: RewardInterstitialAdPluginEvents.Showed, listenerFunc: ()
|
|
|
1041
438
|
|
|
1042
439
|
#### ApplicationMutedOptions
|
|
1043
440
|
|
|
1044
|
-
| Prop | Type | Description |
|
|
1045
|
-
| ----------- | -------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
|
1046
|
-
| **`muted`** | <code>boolean</code> | To inform the SDK that the app volume has been muted. Note: Video ads that are ineligible to be shown with muted audio are not returned for ad requests made, when 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. |
|
|
441
|
+
| Prop | Type | Description | Since |
|
|
442
|
+
| ----------- | -------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----- |
|
|
443
|
+
| **`muted`** | <code>boolean</code> | To inform the SDK that the app volume has been muted. Note: Video ads that are ineligible to be shown with muted audio are not returned for ad requests made, when 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. | 4.1.1 |
|
|
1047
444
|
|
|
1048
445
|
|
|
1049
446
|
#### ApplicationVolumeOptions
|
|
1050
447
|
|
|
1051
|
-
| Prop | Type | Description |
|
|
1052
|
-
| ------------ | ---------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
1053
|
-
| **`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. |
|
|
1054
|
-
|
|
1055
|
-
|
|
1056
|
-
#### BannerAdOptions
|
|
1057
|
-
|
|
1058
|
-
This interface extends <a href="#adoptions">AdOptions</a>
|
|
1059
|
-
|
|
1060
|
-
| Prop | Type | Description |
|
|
1061
|
-
| -------------- | ------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------- |
|
|
1062
|
-
| **`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 |
|
|
1063
|
-
| **`position`** | <code><a href="#banneradposition">BannerAdPosition</a></code> | Set Banner Ad position. TOP_CENTER or CENTER or BOTTOM_CENTER |
|
|
1064
|
-
|
|
1065
|
-
|
|
1066
|
-
#### PluginListenerHandle
|
|
1067
|
-
|
|
1068
|
-
| Prop | Type |
|
|
1069
|
-
| ------------ | ----------------------------------------- |
|
|
1070
|
-
| **`remove`** | <code>() => Promise<void></code> |
|
|
1071
|
-
|
|
1072
|
-
|
|
1073
|
-
#### AdMobBannerSize
|
|
1074
|
-
|
|
1075
|
-
When notice listener of OnAdLoaded, you can get banner size.
|
|
1076
|
-
|
|
1077
|
-
| Prop | Type |
|
|
1078
|
-
| ------------ | ------------------- |
|
|
1079
|
-
| **`width`** | <code>number</code> |
|
|
1080
|
-
| **`height`** | <code>number</code> |
|
|
1081
|
-
|
|
1082
|
-
|
|
1083
|
-
#### AdMobError
|
|
1084
|
-
|
|
1085
|
-
For more information
|
|
1086
|
-
https://developers.google.com/android/reference/com/google/android/gms/ads/AdError
|
|
1087
|
-
|
|
1088
|
-
| Prop | Type | Description |
|
|
1089
|
-
| ------------- | ------------------- | -------------------------------------- |
|
|
1090
|
-
| **`code`** | <code>number</code> | Gets the error's code. |
|
|
1091
|
-
| **`message`** | <code>string</code> | Gets the message describing the error. |
|
|
1092
|
-
|
|
1093
|
-
|
|
1094
|
-
#### AdmobConsentInfo
|
|
1095
|
-
|
|
1096
|
-
| Prop | Type | Description |
|
|
1097
|
-
| ---------------------------- | ----------------------------------------------------------------- | ----------------------------------------------------- |
|
|
1098
|
-
| **`status`** | <code><a href="#admobconsentstatus">AdmobConsentStatus</a></code> | The consent status of the user. |
|
|
1099
|
-
| **`isConsentFormAvailable`** | <code>boolean</code> | If `true` a consent form is available and vice versa. |
|
|
1100
|
-
|
|
1101
|
-
|
|
1102
|
-
#### AdmobConsentRequestOptions
|
|
1103
|
-
|
|
1104
|
-
| Prop | Type | Description |
|
|
1105
|
-
| ----------------------------- | --------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------ |
|
|
1106
|
-
| **`debugGeography`** | <code><a href="#admobconsentdebuggeography">AdmobConsentDebugGeography</a></code> | Sets the debug geography to test the consent locally. |
|
|
1107
|
-
| **`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. |
|
|
1108
|
-
| **`tagForUnderAgeOfConsent`** | <code>boolean</code> | Set to `true` to provide the option for the user to accept being shown personalized ads. |
|
|
1109
|
-
|
|
1110
|
-
|
|
1111
|
-
#### AdLoadInfo
|
|
1112
|
-
|
|
1113
|
-
| Prop | Type |
|
|
1114
|
-
| -------------- | ------------------- |
|
|
1115
|
-
| **`adUnitId`** | <code>string</code> |
|
|
1116
|
-
|
|
1117
|
-
|
|
1118
|
-
#### AdOptions
|
|
1119
|
-
|
|
1120
|
-
| Prop | Type | Description |
|
|
1121
|
-
| --------------- | -------------------- | -------------------------------------------------------------------------------------------------------------------------------------------- |
|
|
1122
|
-
| **`adId`** | <code>string</code> | The ad unit ID that you want to request |
|
|
1123
|
-
| **`isTesting`** | <code>boolean</code> | You can use test mode of ad. |
|
|
1124
|
-
| **`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. |
|
|
1125
|
-
| **`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 |
|
|
1126
|
-
|
|
1127
|
-
|
|
1128
|
-
#### RewardAdOptions
|
|
1129
|
-
|
|
1130
|
-
| Prop | Type | Description |
|
|
1131
|
-
| --------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
|
1132
|
-
| **`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. |
|
|
1133
|
-
|
|
1134
|
-
|
|
1135
|
-
#### AdMobRewardItem
|
|
1136
|
-
|
|
1137
|
-
For more information
|
|
1138
|
-
https://developers.google.com/admob/android/rewarded-video-adapters?hl=en
|
|
1139
|
-
|
|
1140
|
-
| Prop | Type | Description |
|
|
1141
|
-
| ------------ | ------------------- | ------------------------ |
|
|
1142
|
-
| **`type`** | <code>string</code> | Rewarded type user got |
|
|
1143
|
-
| **`amount`** | <code>number</code> | Rewarded amount user got |
|
|
1144
|
-
|
|
1145
|
-
|
|
1146
|
-
#### RewardInterstitialAdOptions
|
|
1147
|
-
|
|
1148
|
-
| Prop | Type | Description |
|
|
1149
|
-
| --------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
|
1150
|
-
| **`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. |
|
|
1151
|
-
|
|
1152
|
-
|
|
1153
|
-
#### AdMobRewardInterstitialItem
|
|
1154
|
-
|
|
1155
|
-
For more information
|
|
1156
|
-
https://developers.google.com/admob/android/rewarded-video-adapters?hl=en
|
|
1157
|
-
|
|
1158
|
-
| Prop | Type | Description |
|
|
1159
|
-
| ------------ | ------------------- | ------------------------ |
|
|
1160
|
-
| **`type`** | <code>string</code> | Rewarded type user got |
|
|
1161
|
-
| **`amount`** | <code>number</code> | Rewarded amount user got |
|
|
1162
|
-
|
|
1163
|
-
|
|
1164
|
-
### Type Aliases
|
|
1165
|
-
|
|
1166
|
-
|
|
1167
|
-
#### AtLeastOne
|
|
1168
|
-
|
|
1169
|
-
<code>{[K in keyof T]: <a href="#pick">Pick</a><T, K>}[keyof T]</code>
|
|
1170
|
-
|
|
1171
|
-
|
|
1172
|
-
#### Pick
|
|
1173
|
-
|
|
1174
|
-
From T, pick a set of properties whose keys are in the union K
|
|
1175
|
-
|
|
1176
|
-
<code>{
|
|
1177
448
|
[P in K]: T[P];
|
|
1178
449
|
}</code>
|
|
450
|
+
| Prop | Type | Description | Since |
|
|
451
|
+
| ------------ | ---------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ----- |
|
|
452
|
+
| **`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 |
|
|
1179
453
|
|
|
1180
454
|
|
|
1181
455
|
### Enums
|
|
@@ -1188,94 +462,6 @@ From T, pick a set of properties whose keys are in the union K
|
|
|
1188
462
|
| **`Teen`** | <code>'Teen'</code> | Content suitable for teen and older audiences. |
|
|
1189
463
|
| **`MatureAudience`** | <code>'MatureAudience'</code> | Content suitable only for mature audiences. |
|
|
1190
464
|
|
|
1191
|
-
|
|
1192
|
-
#### BannerAdSize
|
|
1193
|
-
|
|
1194
|
-
| Members | Value | Description |
|
|
1195
|
-
| ---------------------- | ------------------------------- | --------------------------------------------------------------------------------------------------- |
|
|
1196
|
-
| **`BANNER`** | <code>'BANNER'</code> | Mobile Marketing Association (MMA) banner ad size (320x50 density-independent pixels). |
|
|
1197
|
-
| **`FULL_BANNER`** | <code>'FULL_BANNER'</code> | Interactive Advertising Bureau (IAB) full banner ad size (468x60 density-independent pixels). |
|
|
1198
|
-
| **`LARGE_BANNER`** | <code>'LARGE_BANNER'</code> | Large banner ad size (320x100 density-independent pixels). |
|
|
1199
|
-
| **`MEDIUM_RECTANGLE`** | <code>'MEDIUM_RECTANGLE'</code> | Interactive Advertising Bureau (IAB) medium rectangle ad size (300x250 density-independent pixels). |
|
|
1200
|
-
| **`LEADERBOARD`** | <code>'LEADERBOARD'</code> | Interactive Advertising Bureau (IAB) leaderboard ad size (728x90 density-independent pixels). |
|
|
1201
|
-
| **`ADAPTIVE_BANNER`** | <code>'ADAPTIVE_BANNER'</code> | A dynamically sized banner that is full-width and auto-height. |
|
|
1202
|
-
| **`SMART_BANNER`** | <code>'SMART_BANNER'</code> | |
|
|
1203
|
-
|
|
1204
|
-
|
|
1205
|
-
#### BannerAdPosition
|
|
1206
|
-
|
|
1207
|
-
| Members | Value | Description |
|
|
1208
|
-
| ------------------- | ---------------------------- | ----------------------------------------- |
|
|
1209
|
-
| **`TOP_CENTER`** | <code>'TOP_CENTER'</code> | Banner position be top-center |
|
|
1210
|
-
| **`CENTER`** | <code>'CENTER'</code> | Banner position be center |
|
|
1211
|
-
| **`BOTTOM_CENTER`** | <code>'BOTTOM_CENTER'</code> | Banner position be bottom-center(default) |
|
|
1212
|
-
|
|
1213
|
-
|
|
1214
|
-
#### BannerAdPluginEvents
|
|
1215
|
-
|
|
1216
|
-
| Members | Value | Description |
|
|
1217
|
-
| ------------------ | ----------------------------------- | ------------------------------------------------------------------------------------------------------ |
|
|
1218
|
-
| **`SizeChanged`** | <code>"bannerAdSizeChanged"</code> | |
|
|
1219
|
-
| **`Loaded`** | <code>"bannerAdLoaded"</code> | |
|
|
1220
|
-
| **`FailedToLoad`** | <code>"bannerAdFailedToLoad"</code> | |
|
|
1221
|
-
| **`Opened`** | <code>"bannerAdOpened"</code> | Open "Adsense" Event after user click banner |
|
|
1222
|
-
| **`Closed`** | <code>"bannerAdClosed"</code> | Close "Adsense" Event after user click banner |
|
|
1223
|
-
| **`AdImpression`** | <code>"bannerAdImpression"</code> | Similarly, this method should be called when an impression is recorded for the ad by the mediated SDK. |
|
|
1224
|
-
|
|
1225
|
-
|
|
1226
|
-
#### AdmobConsentStatus
|
|
1227
|
-
|
|
1228
|
-
| Members | Value | Description |
|
|
1229
|
-
| ------------------ | --------------------------- | ------------------------------------------------------------------------------------- |
|
|
1230
|
-
| **`NOT_REQUIRED`** | <code>'NOT_REQUIRED'</code> | User consent not required. |
|
|
1231
|
-
| **`OBTAINED`** | <code>'OBTAINED'</code> | User consent already obtained. |
|
|
1232
|
-
| **`REQUIRED`** | <code>'REQUIRED'</code> | User consent required but not yet obtained. |
|
|
1233
|
-
| **`UNKNOWN`** | <code>'UNKNOWN'</code> | Unknown consent status, AdsConsent.requestInfoUpdate needs to be called to update it. |
|
|
1234
|
-
|
|
1235
|
-
|
|
1236
|
-
#### AdmobConsentDebugGeography
|
|
1237
|
-
|
|
1238
|
-
| Members | Value | Description |
|
|
1239
|
-
| -------------- | -------------- | -------------------------------------------------- |
|
|
1240
|
-
| **`DISABLED`** | <code>0</code> | Debug geography disabled. |
|
|
1241
|
-
| **`EEA`** | <code>1</code> | Geography appears as in EEA for debug devices. |
|
|
1242
|
-
| **`NOT_EEA`** | <code>2</code> | Geography appears as not in EEA for debug devices. |
|
|
1243
|
-
|
|
1244
|
-
|
|
1245
|
-
#### InterstitialAdPluginEvents
|
|
1246
|
-
|
|
1247
|
-
| Members | Value | Description |
|
|
1248
|
-
| ------------------ | ----------------------------------------- | -------------------------------------------------------------------------------------- |
|
|
1249
|
-
| **`Loaded`** | <code>'interstitialAdLoaded'</code> | Emits after trying to prepare and Interstitial, when it is loaded and ready to be show |
|
|
1250
|
-
| **`FailedToLoad`** | <code>'interstitialAdFailedToLoad'</code> | Emits after trying to prepare and Interstitial, when it could not be loaded |
|
|
1251
|
-
| **`Showed`** | <code>'interstitialAdShowed'</code> | Emits when the Interstitial ad is visible to the user |
|
|
1252
|
-
| **`FailedToShow`** | <code>'interstitialAdFailedToShow'</code> | Emits when the Interstitial ad is failed to show |
|
|
1253
|
-
| **`Dismissed`** | <code>'interstitialAdDismissed'</code> | Emits when the Interstitial ad is not visible to the user anymore. |
|
|
1254
|
-
|
|
1255
|
-
|
|
1256
|
-
#### RewardAdPluginEvents
|
|
1257
|
-
|
|
1258
|
-
| Members | Value | Description |
|
|
1259
|
-
| ------------------ | -------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
1260
|
-
| **`Loaded`** | <code>'onRewardedVideoAdLoaded'</code> | Emits after trying to prepare a RewardAd and the Video is loaded and ready to be show |
|
|
1261
|
-
| **`FailedToLoad`** | <code>'onRewardedVideoAdFailedToLoad'</code> | Emits after trying to prepare a RewardAd when it could not be loaded |
|
|
1262
|
-
| **`Showed`** | <code>'onRewardedVideoAdShowed'</code> | Emits when the AdReward video is visible to the user |
|
|
1263
|
-
| **`FailedToShow`** | <code>'onRewardedVideoAdFailedToShow'</code> | Emits when the AdReward video is failed to show |
|
|
1264
|
-
| **`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. |
|
|
1265
|
-
| **`Rewarded`** | <code>'onRewardedVideoAdReward'</code> | Emits when user get rewarded from AdReward |
|
|
1266
|
-
|
|
1267
|
-
|
|
1268
|
-
#### RewardInterstitialAdPluginEvents
|
|
1269
|
-
|
|
1270
|
-
| Members | Value | Description |
|
|
1271
|
-
| ------------------ | --------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
1272
|
-
| **`Loaded`** | <code>'onRewardedInterstitialAdLoaded'</code> | Emits after trying to prepare a RewardAd and the Video is loaded and ready to be show |
|
|
1273
|
-
| **`FailedToLoad`** | <code>'onRewardedInterstitialAdFailedToLoad'</code> | Emits after trying to prepare a RewardAd when it could not be loaded |
|
|
1274
|
-
| **`Showed`** | <code>'onRewardedInterstitialAdShowed'</code> | Emits when the AdReward video is visible to the user |
|
|
1275
|
-
| **`FailedToShow`** | <code>'onRewardedInterstitialAdFailedToShow'</code> | Emits when the AdReward video is failed to show |
|
|
1276
|
-
| **`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. |
|
|
1277
|
-
| **`Rewarded`** | <code>'onRewardedInterstitialAdReward'</code> | Emits when user get rewarded from AdReward |
|
|
1278
|
-
|
|
1279
465
|
</docgen-api>
|
|
1280
466
|
|
|
1281
467
|
## TROUBLE SHOOTING
|