@capacitor-community/admob 8.0.0 → 8.1.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CapacitorCommunityAdmob.podspec +1 -1
- package/Package.swift +1 -1
- package/README.md +635 -169
- package/android/build.gradle +1 -1
- package/android/src/main/java/com/getcapacitor/community/admob/AdMob.java +73 -23
- package/android/src/main/java/com/getcapacitor/community/admob/appopen/AppOpenAdManager.kt +92 -0
- package/android/src/main/java/com/getcapacitor/community/admob/appopen/AppOpenAdPlugin.kt +122 -0
- package/android/src/main/java/com/getcapacitor/community/admob/appopen/AppOpenAdPluginEvents.kt +10 -0
- package/android/src/main/java/com/getcapacitor/community/admob/banner/BannerAdPluginEvents.kt +2 -1
- package/android/src/main/java/com/getcapacitor/community/admob/banner/BannerExecutor.java +79 -29
- package/android/src/main/java/com/getcapacitor/community/admob/helpers/FullscreenPluginCallback.kt +7 -2
- package/android/src/main/java/com/getcapacitor/community/admob/interstitial/AdInterstitialExecutor.java +21 -3
- package/android/src/main/java/com/getcapacitor/community/admob/interstitial/InterstitialAdCallbackAndListeners.kt +12 -2
- package/android/src/main/java/com/getcapacitor/community/admob/interstitial/InterstitialAdPluginPluginEvent.kt +1 -0
- package/android/src/main/java/com/getcapacitor/community/admob/models/AdMobRevenueData.kt +15 -0
- package/android/src/main/java/com/getcapacitor/community/admob/models/AdOptions.java +10 -0
- package/android/src/main/java/com/getcapacitor/community/admob/rewarded/AdRewardExecutor.java +20 -3
- package/android/src/main/java/com/getcapacitor/community/admob/rewarded/RewardAdPluginEvents.kt +1 -0
- package/android/src/main/java/com/getcapacitor/community/admob/rewarded/RewardedAdCallbackAndListeners.kt +14 -4
- package/android/src/main/java/com/getcapacitor/community/admob/rewardedinterstitial/AdRewardInterstitialExecutor.java +20 -3
- package/android/src/main/java/com/getcapacitor/community/admob/rewardedinterstitial/RewardInterstitialAdPluginEvents.kt +1 -0
- package/android/src/main/java/com/getcapacitor/community/admob/rewardedinterstitial/RewardedInterstitialAdCallbackAndListeners.kt +14 -3
- package/dist/docs.json +740 -193
- package/dist/esm/app-open/app-open-ad-options.interface.d.ts +9 -0
- package/dist/esm/app-open/app-open-ad-options.interface.js +2 -0
- package/dist/esm/app-open/app-open-ad-options.interface.js.map +1 -0
- package/dist/esm/app-open/app-open-ad-plugin-events.enum.d.ts +26 -0
- package/dist/esm/app-open/app-open-ad-plugin-events.enum.js +28 -0
- package/dist/esm/app-open/app-open-ad-plugin-events.enum.js.map +1 -0
- package/dist/esm/app-open/app-open-definitions.interface.d.ts +50 -0
- package/dist/esm/app-open/app-open-definitions.interface.js +2 -0
- package/dist/esm/app-open/app-open-definitions.interface.js.map +1 -0
- package/dist/esm/app-open/index.d.ts +3 -0
- package/dist/esm/app-open/index.js +4 -0
- package/dist/esm/app-open/index.js.map +1 -0
- package/dist/esm/banner/banner-ad-options.interface.d.ts +5 -6
- package/dist/esm/banner/banner-ad-plugin-events.enum.d.ts +17 -4
- package/dist/esm/banner/banner-ad-plugin-events.enum.js +16 -3
- package/dist/esm/banner/banner-ad-plugin-events.enum.js.map +1 -1
- package/dist/esm/banner/banner-ad-position.enum.d.ts +3 -3
- package/dist/esm/banner/banner-ad-position.enum.js +3 -3
- package/dist/esm/banner/banner-ad-size.enum.d.ts +4 -3
- package/dist/esm/banner/banner-ad-size.enum.js +4 -3
- package/dist/esm/banner/banner-ad-size.enum.js.map +1 -1
- package/dist/esm/banner/banner-definitions.interface.d.ts +17 -10
- package/dist/esm/banner/banner-size.interface.d.ts +8 -1
- package/dist/esm/definitions.d.ts +19 -17
- package/dist/esm/definitions.js.map +1 -1
- package/dist/esm/index.d.ts +1 -0
- package/dist/esm/index.js +1 -0
- package/dist/esm/index.js.map +1 -1
- package/dist/esm/interstitial/interstitial-ad-plugin-events.enum.d.ts +10 -6
- package/dist/esm/interstitial/interstitial-ad-plugin-events.enum.js +9 -5
- package/dist/esm/interstitial/interstitial-ad-plugin-events.enum.js.map +1 -1
- package/dist/esm/interstitial/interstitial-definitions.interface.d.ts +24 -4
- package/dist/esm/reward/reward-ad-options.interface.d.ts +7 -6
- package/dist/esm/reward/reward-ad-plugin-events.enum.d.ts +13 -12
- package/dist/esm/reward/reward-ad-plugin-events.enum.js +12 -11
- package/dist/esm/reward/reward-ad-plugin-events.enum.js.map +1 -1
- package/dist/esm/reward/reward-definitions.interface.d.ts +27 -4
- package/dist/esm/reward/reward-item.interface.d.ts +3 -4
- package/dist/esm/reward-interstitial/reward-interstitial-ad-options.interface.d.ts +7 -6
- package/dist/esm/reward-interstitial/reward-interstitial-ad-plugin-events.enum.d.ts +13 -12
- package/dist/esm/reward-interstitial/reward-interstitial-ad-plugin-events.enum.js +12 -11
- package/dist/esm/reward-interstitial/reward-interstitial-ad-plugin-events.enum.js.map +1 -1
- package/dist/esm/reward-interstitial/reward-interstitial-definitions.interface.d.ts +30 -7
- package/dist/esm/reward-interstitial/reward-interstitial-item.interface.d.ts +3 -4
- package/dist/esm/shared/ad-load-info.interface.d.ts +6 -0
- package/dist/esm/shared/ad-mob-revenue-data.interface.d.ts +50 -0
- package/dist/esm/shared/ad-mob-revenue-data.interface.js +23 -0
- package/dist/esm/shared/ad-mob-revenue-data.interface.js.map +1 -0
- package/dist/esm/shared/ad-options.interface.d.ts +9 -11
- package/dist/esm/shared/ad-show-options.interface.d.ts +12 -0
- package/dist/esm/shared/ad-show-options.interface.js +2 -0
- package/dist/esm/shared/ad-show-options.interface.js.map +1 -0
- package/dist/esm/shared/admob-error.interface.d.ts +3 -2
- package/dist/esm/shared/index.d.ts +2 -0
- package/dist/esm/shared/index.js +2 -0
- package/dist/esm/shared/index.js.map +1 -1
- package/dist/esm/shared/tracking-authorization-status.interface.d.ts +6 -1
- package/dist/esm/web.d.ts +13 -4
- package/dist/esm/web.js +25 -9
- package/dist/esm/web.js.map +1 -1
- package/dist/plugin.cjs.js +131 -45
- package/dist/plugin.cjs.js.map +1 -1
- package/dist/plugin.js +131 -45
- package/dist/plugin.js.map +1 -1
- package/ios/Sources/AdMobPlugin/AdMobPlugin.swift +30 -4
- package/ios/Sources/AdMobPlugin/AppOpen/AppOpenAdManager.swift +112 -0
- package/ios/Sources/AdMobPlugin/AppOpen/AppOpenAdPlugin.swift +101 -0
- package/ios/Sources/AdMobPlugin/AppOpen/AppOpenAdPluginEvents.swift +8 -0
- package/ios/Sources/AdMobPlugin/Banner/BannerAdPluginEvents.swift +1 -0
- package/ios/Sources/AdMobPlugin/Banner/BannerExecutor.swift +20 -6
- package/ios/Sources/AdMobPlugin/Interstitial/AdInterstitialExecutor.swift +41 -5
- package/ios/Sources/AdMobPlugin/Interstitial/InterstitialAdPluginEvents.swift +1 -0
- package/ios/Sources/AdMobPlugin/Rewarded/AdRewardExecutor.swift +44 -5
- package/ios/Sources/AdMobPlugin/Rewarded/RewardAdPluginEvents.swift +1 -0
- package/ios/Sources/AdMobPlugin/RewardedInterstitial/AdRewardInterstitialExecutor.swift +45 -6
- package/ios/Sources/AdMobPlugin/RewardedInterstitial/RewardInterstitialAdPluginEvents.swift +1 -0
- package/package.json +2 -1
package/README.md
CHANGED
|
@@ -6,7 +6,7 @@
|
|
|
6
6
|
</p>
|
|
7
7
|
|
|
8
8
|
<p align="center">
|
|
9
|
-
<img src="https://img.shields.io/maintenance/yes/
|
|
9
|
+
<img src="https://img.shields.io/maintenance/yes/2026?style=flat-square" />
|
|
10
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>
|
|
11
11
|
<br>
|
|
12
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>
|
|
@@ -32,24 +32,32 @@ Made with [contributors-img](https://contrib.rocks).
|
|
|
32
32
|
|
|
33
33
|
## Demo
|
|
34
34
|
|
|
35
|
-
[Demo code is here.](https://github.com/capacitor-community/admob/tree/
|
|
35
|
+
[Demo code is here.](https://github.com/capacitor-community/admob/tree/main/demo)
|
|
36
36
|
|
|
37
37
|
### Screenshots
|
|
38
38
|
|
|
39
|
-
| | Banner | Interstitial | Reward |
|
|
40
|
-
| :---------- | :----------------------------------: | :----------------------------------------: | :----------------------------------: |
|
|
41
|
-
| **iOS** |  |  |  |
|
|
42
|
-
| **Android** |  |  |  |
|
|
39
|
+
| | Banner | Interstitial | Reward | App Open |
|
|
40
|
+
| :---------- | :----------------------------------: | :----------------------------------------: | :----------------------------------: | :---------------------------------: |
|
|
41
|
+
| **iOS** |  |  |  |  |
|
|
42
|
+
| **Android** |  |  |  |  |
|
|
43
43
|
|
|
44
44
|
## Installation
|
|
45
45
|
|
|
46
|
-
If you use
|
|
46
|
+
If you use Capacitor 7:
|
|
47
47
|
|
|
48
48
|
```
|
|
49
|
-
% npm install --save @capacitor-community/admob@
|
|
49
|
+
% npm install --save @capacitor-community/admob@7
|
|
50
50
|
% npx cap update
|
|
51
51
|
```
|
|
52
52
|
|
|
53
|
+
### Google Mobile Ads SDK compatibility
|
|
54
|
+
|
|
55
|
+
To preserve behavior for users of the current major version, this plugin continues to use Google Mobile Ads SDK APIs that are deprecated but still supported. Replacing those APIs can change banner sizing and age-restricted treatment behavior, so that migration is deferred until the next major release.
|
|
56
|
+
|
|
57
|
+
Migration to the [GMA Next-Gen SDK for Android](https://developers.google.com/admob/android/next-gen) is also deferred until the next major release because it requires breaking changes to SDK initialization, ad requests, and mediation integration.
|
|
58
|
+
|
|
59
|
+
Android continues to use GMA SDK (Legacy) 25.4.x. On iOS, both Swift Package Manager and CocoaPods are fixed to GMA SDK 13.6.0 until CocoaPods support is removed in the next major release.
|
|
60
|
+
|
|
53
61
|
### Android configuration
|
|
54
62
|
|
|
55
63
|
In file `android/app/src/main/AndroidManifest.xml`, add the following XML elements under `<manifest><application>` :
|
|
@@ -72,8 +80,8 @@ Don't forget to replace `[APP_ID]` by your AdMob application Id.
|
|
|
72
80
|
|
|
73
81
|
This plugin will use the following project variables (defined in your app's `variables.gradle` file):
|
|
74
82
|
|
|
75
|
-
- `playServicesAdsVersion` version of `com.google.android.gms:play-services-ads` (default: `
|
|
76
|
-
- `androidxCoreKTXVersion`: version of `androidx.core:core-ktx` (default: `1.
|
|
83
|
+
- `playServicesAdsVersion` version of `com.google.android.gms:play-services-ads` (default: `25.4.+`)
|
|
84
|
+
- `androidxCoreKTXVersion`: version of `androidx.core:core-ktx` (default: `1.15.0`)
|
|
77
85
|
|
|
78
86
|
### iOS configuration
|
|
79
87
|
|
|
@@ -102,7 +110,7 @@ Don't forget to replace `[APP_ID]` by your AdMob application Id.
|
|
|
102
110
|
### Initialize AdMob
|
|
103
111
|
|
|
104
112
|
```ts
|
|
105
|
-
import { AdMob } from '@capacitor-community/admob';
|
|
113
|
+
import { AdMob, AdmobConsentStatus } from '@capacitor-community/admob';
|
|
106
114
|
|
|
107
115
|
export async function initialize(): Promise<void> {
|
|
108
116
|
await AdMob.initialize();
|
|
@@ -174,6 +182,8 @@ showPrivacyOptionsForm() {
|
|
|
174
182
|
If you testing on real device, you have to set `debugGeography` and add your device ID to `testDeviceIdentifiers`. You can find your device ID with logcat (Android) or XCode (iOS).
|
|
175
183
|
|
|
176
184
|
```ts
|
|
185
|
+
import { AdMob, AdmobConsentDebugGeography } from '@capacitor-community/admob';
|
|
186
|
+
|
|
177
187
|
const consentInfo = await AdMob.requestConsentInfo({
|
|
178
188
|
debugGeography: AdmobConsentDebugGeography.EEA,
|
|
179
189
|
testDeviceIdentifiers: ['YOUR_DEVICE_ID'],
|
|
@@ -188,7 +198,45 @@ const consentInfo = await AdMob.requestConsentInfo({
|
|
|
188
198
|
2. AdMob.requestConsentInfo
|
|
189
199
|
3. AdMob.showConsentForm (If consent form required )
|
|
190
200
|
3/ AdMob.showBanner
|
|
201
|
+
|
|
202
|
+
### Show App Open Ad
|
|
191
203
|
|
|
204
|
+
```ts
|
|
205
|
+
import {
|
|
206
|
+
AdMob,
|
|
207
|
+
AppOpenAdPluginEvents,
|
|
208
|
+
AppOpenAdOptions,
|
|
209
|
+
AdLoadInfo,
|
|
210
|
+
} from '@capacitor-community/admob';
|
|
211
|
+
|
|
212
|
+
export async function showAppOpenAd(): Promise<void> {
|
|
213
|
+
// listen to events
|
|
214
|
+
AdMob.addListener(AppOpenAdPluginEvents.Loaded, (info: AdLoadInfo) => {
|
|
215
|
+
console.log('App Open Ad loaded', info.adUnitId);
|
|
216
|
+
});
|
|
217
|
+
AdMob.addListener(AppOpenAdPluginEvents.FailedToLoad, (error) => {
|
|
218
|
+
console.log('Failed to load App Open Ad', error);
|
|
219
|
+
});
|
|
220
|
+
AdMob.addListener(AppOpenAdPluginEvents.Opened, () => {
|
|
221
|
+
console.log('App Open Ad open');
|
|
222
|
+
});
|
|
223
|
+
AdMob.addListener(AppOpenAdPluginEvents.Closed, () => {
|
|
224
|
+
console.log('App Open Ad close');
|
|
225
|
+
});
|
|
226
|
+
AdMob.addListener(AppOpenAdPluginEvents.FailedToShow, (error) => {
|
|
227
|
+
console.log('Failed to show App Open Ad', error);
|
|
228
|
+
});
|
|
229
|
+
|
|
230
|
+
const options: AppOpenAdOptions = {
|
|
231
|
+
adId: 'YOUR_AD_UNIT_ID',
|
|
232
|
+
};
|
|
233
|
+
const { adUnitId } = await AdMob.loadAppOpen(options);
|
|
234
|
+
const { value } = await AdMob.isAppOpenLoaded({ adId: adUnitId });
|
|
235
|
+
if (value) {
|
|
236
|
+
await AdMob.showAppOpen({ adId: adUnitId });
|
|
237
|
+
}
|
|
238
|
+
}
|
|
239
|
+
```
|
|
192
240
|
### Show Banner
|
|
193
241
|
|
|
194
242
|
```ts
|
|
@@ -225,6 +273,30 @@ export async function banner(): Promise<void> {
|
|
|
225
273
|
}
|
|
226
274
|
```
|
|
227
275
|
|
|
276
|
+
### Impression-level ad revenue
|
|
277
|
+
|
|
278
|
+
Full-screen ad formats emit revenue data through their `AdImpression` event. Banners use the separate `AdPaid` event.
|
|
279
|
+
|
|
280
|
+
```ts
|
|
281
|
+
import {
|
|
282
|
+
AdMob,
|
|
283
|
+
AdMobRevenueData,
|
|
284
|
+
BannerAdPluginEvents,
|
|
285
|
+
InterstitialAdPluginEvents,
|
|
286
|
+
} from '@capacitor-community/admob';
|
|
287
|
+
|
|
288
|
+
AdMob.addListener(
|
|
289
|
+
InterstitialAdPluginEvents.AdImpression,
|
|
290
|
+
(data: AdMobRevenueData) => {
|
|
291
|
+
console.log(data);
|
|
292
|
+
},
|
|
293
|
+
);
|
|
294
|
+
|
|
295
|
+
AdMob.addListener(BannerAdPluginEvents.AdPaid, (data: AdMobRevenueData) => {
|
|
296
|
+
console.log(data);
|
|
297
|
+
});
|
|
298
|
+
```
|
|
299
|
+
|
|
228
300
|
### Show Interstitial
|
|
229
301
|
|
|
230
302
|
```ts
|
|
@@ -248,6 +320,16 @@ export async function interstitial(): Promise<void> {
|
|
|
248
320
|
};
|
|
249
321
|
await AdMob.prepareInterstitial(options);
|
|
250
322
|
await AdMob.showInterstitial();
|
|
323
|
+
|
|
324
|
+
// You can also prepare multiple interstitials and show a specific one by passing its adId:
|
|
325
|
+
await AdMob.prepareInterstitial({ adId: 'ca-app-pub-xxx/interstitial-1' });
|
|
326
|
+
await AdMob.prepareInterstitial({ adId: 'ca-app-pub-xxx/interstitial-2' });
|
|
327
|
+
|
|
328
|
+
// Show a specific prepared ad
|
|
329
|
+
await AdMob.showInterstitial({ adId: 'ca-app-pub-xxx/interstitial-1' });
|
|
330
|
+
|
|
331
|
+
// Or omit adId to show the most recently prepared one (default behavior)
|
|
332
|
+
await AdMob.showInterstitial();
|
|
251
333
|
}
|
|
252
334
|
```
|
|
253
335
|
|
|
@@ -287,6 +369,30 @@ export async function rewardVideo(): Promise<void> {
|
|
|
287
369
|
};
|
|
288
370
|
await AdMob.prepareRewardVideoAd(options);
|
|
289
371
|
const rewardItem = await AdMob.showRewardVideoAd();
|
|
372
|
+
|
|
373
|
+
// You can also prepare multiple reward ads and show a specific one by passing its adId:
|
|
374
|
+
await AdMob.prepareRewardVideoAd({ adId: 'ca-app-pub-xxx/reward-1' });
|
|
375
|
+
await AdMob.prepareRewardVideoAd({ adId: 'ca-app-pub-xxx/reward-2' });
|
|
376
|
+
|
|
377
|
+
// Show a specific prepared ad
|
|
378
|
+
const reward = await AdMob.showRewardVideoAd({ adId: 'ca-app-pub-xxx/reward-1' });
|
|
379
|
+
|
|
380
|
+
// Or omit adId to show the most recently prepared one (default behavior)
|
|
381
|
+
const reward2 = await AdMob.showRewardVideoAd();
|
|
382
|
+
}
|
|
383
|
+
```
|
|
384
|
+
|
|
385
|
+
### Show Rewarded Interstitial
|
|
386
|
+
|
|
387
|
+
```ts
|
|
388
|
+
import { AdMob, RewardInterstitialAdOptions } from '@capacitor-community/admob';
|
|
389
|
+
|
|
390
|
+
export async function rewardInterstitial(): Promise<void> {
|
|
391
|
+
const options: RewardInterstitialAdOptions = {
|
|
392
|
+
adId: 'YOUR ADID',
|
|
393
|
+
};
|
|
394
|
+
const { adUnitId } = await AdMob.prepareRewardInterstitialAd(options);
|
|
395
|
+
await AdMob.showRewardInterstitialAd({ adId: adUnitId });
|
|
290
396
|
}
|
|
291
397
|
```
|
|
292
398
|
|
|
@@ -334,6 +440,15 @@ AdMob.addListener(RewardAdPluginEvents.Rewarded, async () => {
|
|
|
334
440
|
* [`requestTrackingAuthorization()`](#requesttrackingauthorization)
|
|
335
441
|
* [`setApplicationMuted(...)`](#setapplicationmuted)
|
|
336
442
|
* [`setApplicationVolume(...)`](#setapplicationvolume)
|
|
443
|
+
* [`loadAppOpen(...)`](#loadappopen)
|
|
444
|
+
* [`showAppOpen(...)`](#showappopen)
|
|
445
|
+
* [`isAppOpenLoaded(...)`](#isappopenloaded)
|
|
446
|
+
* [`addListener(AppOpenAdPluginEvents.Loaded, ...)`](#addlistenerappopenadplugineventsloaded-)
|
|
447
|
+
* [`addListener(AppOpenAdPluginEvents.FailedToLoad, ...)`](#addlistenerappopenadplugineventsfailedtoload-)
|
|
448
|
+
* [`addListener(AppOpenAdPluginEvents.Opened, ...)`](#addlistenerappopenadplugineventsopened-)
|
|
449
|
+
* [`addListener(AppOpenAdPluginEvents.Closed, ...)`](#addlistenerappopenadplugineventsclosed-)
|
|
450
|
+
* [`addListener(AppOpenAdPluginEvents.FailedToShow, ...)`](#addlistenerappopenadplugineventsfailedtoshow-)
|
|
451
|
+
* [`addListener(AppOpenAdPluginEvents.AdImpression, ...)`](#addlistenerappopenadplugineventsadimpression-)
|
|
337
452
|
* [`showBanner(...)`](#showbanner)
|
|
338
453
|
* [`hideBanner()`](#hidebanner)
|
|
339
454
|
* [`resumeBanner()`](#resumebanner)
|
|
@@ -344,33 +459,37 @@ AdMob.addListener(RewardAdPluginEvents.Rewarded, async () => {
|
|
|
344
459
|
* [`addListener(BannerAdPluginEvents.Opened, ...)`](#addlistenerbanneradplugineventsopened-)
|
|
345
460
|
* [`addListener(BannerAdPluginEvents.Closed, ...)`](#addlistenerbanneradplugineventsclosed-)
|
|
346
461
|
* [`addListener(BannerAdPluginEvents.AdImpression, ...)`](#addlistenerbanneradplugineventsadimpression-)
|
|
462
|
+
* [`addListener(BannerAdPluginEvents.AdPaid, ...)`](#addlistenerbanneradplugineventsadpaid-)
|
|
347
463
|
* [`requestConsentInfo(...)`](#requestconsentinfo)
|
|
348
464
|
* [`showPrivacyOptionsForm()`](#showprivacyoptionsform)
|
|
349
465
|
* [`showConsentForm()`](#showconsentform)
|
|
350
466
|
* [`resetConsentInfo()`](#resetconsentinfo)
|
|
351
467
|
* [`prepareInterstitial(...)`](#prepareinterstitial)
|
|
352
|
-
* [`showInterstitial()`](#showinterstitial)
|
|
468
|
+
* [`showInterstitial(...)`](#showinterstitial)
|
|
353
469
|
* [`addListener(InterstitialAdPluginEvents.FailedToLoad, ...)`](#addlistenerinterstitialadplugineventsfailedtoload-)
|
|
354
470
|
* [`addListener(InterstitialAdPluginEvents.Loaded, ...)`](#addlistenerinterstitialadplugineventsloaded-)
|
|
355
471
|
* [`addListener(InterstitialAdPluginEvents.Dismissed, ...)`](#addlistenerinterstitialadplugineventsdismissed-)
|
|
356
472
|
* [`addListener(InterstitialAdPluginEvents.FailedToShow, ...)`](#addlistenerinterstitialadplugineventsfailedtoshow-)
|
|
357
473
|
* [`addListener(InterstitialAdPluginEvents.Showed, ...)`](#addlistenerinterstitialadplugineventsshowed-)
|
|
474
|
+
* [`addListener(InterstitialAdPluginEvents.AdImpression, ...)`](#addlistenerinterstitialadplugineventsadimpression-)
|
|
358
475
|
* [`prepareRewardVideoAd(...)`](#preparerewardvideoad)
|
|
359
|
-
* [`showRewardVideoAd()`](#showrewardvideoad)
|
|
476
|
+
* [`showRewardVideoAd(...)`](#showrewardvideoad)
|
|
360
477
|
* [`addListener(RewardAdPluginEvents.FailedToLoad, ...)`](#addlistenerrewardadplugineventsfailedtoload-)
|
|
361
478
|
* [`addListener(RewardAdPluginEvents.Loaded, ...)`](#addlistenerrewardadplugineventsloaded-)
|
|
362
479
|
* [`addListener(RewardAdPluginEvents.Rewarded, ...)`](#addlistenerrewardadplugineventsrewarded-)
|
|
363
480
|
* [`addListener(RewardAdPluginEvents.Dismissed, ...)`](#addlistenerrewardadplugineventsdismissed-)
|
|
364
481
|
* [`addListener(RewardAdPluginEvents.FailedToShow, ...)`](#addlistenerrewardadplugineventsfailedtoshow-)
|
|
365
482
|
* [`addListener(RewardAdPluginEvents.Showed, ...)`](#addlistenerrewardadplugineventsshowed-)
|
|
483
|
+
* [`addListener(RewardAdPluginEvents.AdImpression, ...)`](#addlistenerrewardadplugineventsadimpression-)
|
|
366
484
|
* [`prepareRewardInterstitialAd(...)`](#preparerewardinterstitialad)
|
|
367
|
-
* [`showRewardInterstitialAd()`](#showrewardinterstitialad)
|
|
485
|
+
* [`showRewardInterstitialAd(...)`](#showrewardinterstitialad)
|
|
368
486
|
* [`addListener(RewardInterstitialAdPluginEvents.FailedToLoad, ...)`](#addlistenerrewardinterstitialadplugineventsfailedtoload-)
|
|
369
487
|
* [`addListener(RewardInterstitialAdPluginEvents.Loaded, ...)`](#addlistenerrewardinterstitialadplugineventsloaded-)
|
|
370
488
|
* [`addListener(RewardInterstitialAdPluginEvents.Rewarded, ...)`](#addlistenerrewardinterstitialadplugineventsrewarded-)
|
|
371
489
|
* [`addListener(RewardInterstitialAdPluginEvents.Dismissed, ...)`](#addlistenerrewardinterstitialadplugineventsdismissed-)
|
|
372
490
|
* [`addListener(RewardInterstitialAdPluginEvents.FailedToShow, ...)`](#addlistenerrewardinterstitialadplugineventsfailedtoshow-)
|
|
373
491
|
* [`addListener(RewardInterstitialAdPluginEvents.Showed, ...)`](#addlistenerrewardinterstitialadplugineventsshowed-)
|
|
492
|
+
* [`addListener(RewardInterstitialAdPluginEvents.AdImpression, ...)`](#addlistenerrewardinterstitialadplugineventsadimpression-)
|
|
374
493
|
* [Interfaces](#interfaces)
|
|
375
494
|
* [Type Aliases](#type-aliases)
|
|
376
495
|
* [Enums](#enums)
|
|
@@ -388,11 +507,11 @@ AdMob.addListener(RewardAdPluginEvents.Rewarded, async () => {
|
|
|
388
507
|
initialize(options?: AdMobInitializationOptions | undefined) => Promise<void>
|
|
389
508
|
```
|
|
390
509
|
|
|
391
|
-
|
|
510
|
+
Initializes the Google Mobile Ads SDK.
|
|
392
511
|
|
|
393
|
-
| Param | Type | Description
|
|
394
|
-
| ------------- | --------------------------------------------------------------------------------- |
|
|
395
|
-
| **`options`** | <code><a href="#admobinitializationoptions">AdMobInitializationOptions</a></code> |
|
|
512
|
+
| Param | Type | Description |
|
|
513
|
+
| ------------- | --------------------------------------------------------------------------------- | ------------------------------------- |
|
|
514
|
+
| **`options`** | <code><a href="#admobinitializationoptions">AdMobInitializationOptions</a></code> | Optional SDK initialization settings. |
|
|
396
515
|
|
|
397
516
|
**Since:** 1.1.2
|
|
398
517
|
|
|
@@ -405,7 +524,8 @@ Initialize AdMob with <a href="#admobinitializationoptions">AdMobInitializationO
|
|
|
405
524
|
trackingAuthorizationStatus() => Promise<TrackingAuthorizationStatusInterface>
|
|
406
525
|
```
|
|
407
526
|
|
|
408
|
-
|
|
527
|
+
Returns the current App Tracking Transparency authorization status on iOS 14 and later.
|
|
528
|
+
Returns `authorized` on earlier iOS versions, Android, and web.
|
|
409
529
|
|
|
410
530
|
**Returns:** <code>Promise<<a href="#trackingauthorizationstatusinterface">TrackingAuthorizationStatusInterface</a>></code>
|
|
411
531
|
|
|
@@ -420,7 +540,8 @@ Confirm requestTrackingAuthorization status (iOS >14)
|
|
|
420
540
|
requestTrackingAuthorization() => Promise<void>
|
|
421
541
|
```
|
|
422
542
|
|
|
423
|
-
|
|
543
|
+
Requests App Tracking Transparency authorization on iOS 14 and later.
|
|
544
|
+
Resolves without taking action on earlier iOS versions, Android, and web.
|
|
424
545
|
|
|
425
546
|
**Since:** 5.2.0
|
|
426
547
|
|
|
@@ -433,7 +554,7 @@ request requestTrackingAuthorization (iOS >14).
|
|
|
433
554
|
setApplicationMuted(options: ApplicationMutedOptions) => Promise<void>
|
|
434
555
|
```
|
|
435
556
|
|
|
436
|
-
|
|
557
|
+
Reports whether the application audio is muted to the Google Mobile Ads SDK.
|
|
437
558
|
|
|
438
559
|
| Param | Type |
|
|
439
560
|
| ------------- | --------------------------------------------------------------------------- |
|
|
@@ -450,7 +571,7 @@ Report application mute state to AdMob SDK
|
|
|
450
571
|
setApplicationVolume(options: ApplicationVolumeOptions) => Promise<void>
|
|
451
572
|
```
|
|
452
573
|
|
|
453
|
-
|
|
574
|
+
Reports the application audio volume to the Google Mobile Ads SDK.
|
|
454
575
|
|
|
455
576
|
| Param | Type |
|
|
456
577
|
| ------------- | ----------------------------------------------------------------------------- |
|
|
@@ -461,13 +582,170 @@ Report application volume to AdMob SDK
|
|
|
461
582
|
--------------------
|
|
462
583
|
|
|
463
584
|
|
|
585
|
+
### loadAppOpen(...)
|
|
586
|
+
|
|
587
|
+
```typescript
|
|
588
|
+
loadAppOpen(options: AppOpenAdOptions) => Promise<AdLoadInfo>
|
|
589
|
+
```
|
|
590
|
+
|
|
591
|
+
Loads an App Open ad and returns the loaded ad unit ID.
|
|
592
|
+
|
|
593
|
+
| Param | Type |
|
|
594
|
+
| ------------- | ------------------------------------------------------------- |
|
|
595
|
+
| **`options`** | <code><a href="#appopenadoptions">AppOpenAdOptions</a></code> |
|
|
596
|
+
|
|
597
|
+
**Returns:** <code>Promise<<a href="#adloadinfo">AdLoadInfo</a>></code>
|
|
598
|
+
|
|
599
|
+
--------------------
|
|
600
|
+
|
|
601
|
+
|
|
602
|
+
### showAppOpen(...)
|
|
603
|
+
|
|
604
|
+
```typescript
|
|
605
|
+
showAppOpen(options?: AdShowOptions | undefined) => Promise<void>
|
|
606
|
+
```
|
|
607
|
+
|
|
608
|
+
Shows a loaded App Open ad.
|
|
609
|
+
|
|
610
|
+
| Param | Type | Description |
|
|
611
|
+
| ------------- | ------------------------------------------------------- | -------------------------------------------------------------------------------------- |
|
|
612
|
+
| **`options`** | <code><a href="#adshowoptions">AdShowOptions</a></code> | Optional. Pass { adId } to show a specific prepared ad instead of the most recent one. |
|
|
613
|
+
|
|
614
|
+
--------------------
|
|
615
|
+
|
|
616
|
+
|
|
617
|
+
### isAppOpenLoaded(...)
|
|
618
|
+
|
|
619
|
+
```typescript
|
|
620
|
+
isAppOpenLoaded(options?: AdShowOptions | undefined) => Promise<{ value: boolean; }>
|
|
621
|
+
```
|
|
622
|
+
|
|
623
|
+
Checks whether an App Open ad is loaded.
|
|
624
|
+
|
|
625
|
+
| Param | Type | Description |
|
|
626
|
+
| ------------- | ------------------------------------------------------- | -------------------------------------------------------------------------------------- |
|
|
627
|
+
| **`options`** | <code><a href="#adshowoptions">AdShowOptions</a></code> | Optional. Pass an adId to check a specific prepared ad instead of the most recent one. |
|
|
628
|
+
|
|
629
|
+
**Returns:** <code>Promise<{ value: boolean; }></code>
|
|
630
|
+
|
|
631
|
+
--------------------
|
|
632
|
+
|
|
633
|
+
|
|
634
|
+
### addListener(AppOpenAdPluginEvents.Loaded, ...)
|
|
635
|
+
|
|
636
|
+
```typescript
|
|
637
|
+
addListener(eventName: AppOpenAdPluginEvents.Loaded, listenerFunc: (info: AdLoadInfo) => void) => Promise<PluginListenerHandle>
|
|
638
|
+
```
|
|
639
|
+
|
|
640
|
+
Listens for App Open ad load events.
|
|
641
|
+
|
|
642
|
+
| Param | Type |
|
|
643
|
+
| ------------------ | ------------------------------------------------------------------------------ |
|
|
644
|
+
| **`eventName`** | <code><a href="#appopenadpluginevents">AppOpenAdPluginEvents.Loaded</a></code> |
|
|
645
|
+
| **`listenerFunc`** | <code>(info: <a href="#adloadinfo">AdLoadInfo</a>) => void</code> |
|
|
646
|
+
|
|
647
|
+
**Returns:** <code>Promise<<a href="#pluginlistenerhandle">PluginListenerHandle</a>></code>
|
|
648
|
+
|
|
649
|
+
--------------------
|
|
650
|
+
|
|
651
|
+
|
|
652
|
+
### addListener(AppOpenAdPluginEvents.FailedToLoad, ...)
|
|
653
|
+
|
|
654
|
+
```typescript
|
|
655
|
+
addListener(eventName: AppOpenAdPluginEvents.FailedToLoad, listenerFunc: (error: AdMobError) => void) => Promise<PluginListenerHandle>
|
|
656
|
+
```
|
|
657
|
+
|
|
658
|
+
Listens for App Open ad load failures.
|
|
659
|
+
|
|
660
|
+
| Param | Type |
|
|
661
|
+
| ------------------ | ------------------------------------------------------------------------------------ |
|
|
662
|
+
| **`eventName`** | <code><a href="#appopenadpluginevents">AppOpenAdPluginEvents.FailedToLoad</a></code> |
|
|
663
|
+
| **`listenerFunc`** | <code>(error: <a href="#admoberror">AdMobError</a>) => void</code> |
|
|
664
|
+
|
|
665
|
+
**Returns:** <code>Promise<<a href="#pluginlistenerhandle">PluginListenerHandle</a>></code>
|
|
666
|
+
|
|
667
|
+
--------------------
|
|
668
|
+
|
|
669
|
+
|
|
670
|
+
### addListener(AppOpenAdPluginEvents.Opened, ...)
|
|
671
|
+
|
|
672
|
+
```typescript
|
|
673
|
+
addListener(eventName: AppOpenAdPluginEvents.Opened, listenerFunc: () => void) => Promise<PluginListenerHandle>
|
|
674
|
+
```
|
|
675
|
+
|
|
676
|
+
Listens for App Open ad opened events.
|
|
677
|
+
|
|
678
|
+
| Param | Type |
|
|
679
|
+
| ------------------ | ------------------------------------------------------------------------------ |
|
|
680
|
+
| **`eventName`** | <code><a href="#appopenadpluginevents">AppOpenAdPluginEvents.Opened</a></code> |
|
|
681
|
+
| **`listenerFunc`** | <code>() => void</code> |
|
|
682
|
+
|
|
683
|
+
**Returns:** <code>Promise<<a href="#pluginlistenerhandle">PluginListenerHandle</a>></code>
|
|
684
|
+
|
|
685
|
+
--------------------
|
|
686
|
+
|
|
687
|
+
|
|
688
|
+
### addListener(AppOpenAdPluginEvents.Closed, ...)
|
|
689
|
+
|
|
690
|
+
```typescript
|
|
691
|
+
addListener(eventName: AppOpenAdPluginEvents.Closed, listenerFunc: () => void) => Promise<PluginListenerHandle>
|
|
692
|
+
```
|
|
693
|
+
|
|
694
|
+
Listens for App Open ad closed events.
|
|
695
|
+
|
|
696
|
+
| Param | Type |
|
|
697
|
+
| ------------------ | ------------------------------------------------------------------------------ |
|
|
698
|
+
| **`eventName`** | <code><a href="#appopenadpluginevents">AppOpenAdPluginEvents.Closed</a></code> |
|
|
699
|
+
| **`listenerFunc`** | <code>() => void</code> |
|
|
700
|
+
|
|
701
|
+
**Returns:** <code>Promise<<a href="#pluginlistenerhandle">PluginListenerHandle</a>></code>
|
|
702
|
+
|
|
703
|
+
--------------------
|
|
704
|
+
|
|
705
|
+
|
|
706
|
+
### addListener(AppOpenAdPluginEvents.FailedToShow, ...)
|
|
707
|
+
|
|
708
|
+
```typescript
|
|
709
|
+
addListener(eventName: AppOpenAdPluginEvents.FailedToShow, listenerFunc: (error: AdMobError) => void) => Promise<PluginListenerHandle>
|
|
710
|
+
```
|
|
711
|
+
|
|
712
|
+
Listens for App Open ad show failures.
|
|
713
|
+
|
|
714
|
+
| Param | Type |
|
|
715
|
+
| ------------------ | ------------------------------------------------------------------------------------ |
|
|
716
|
+
| **`eventName`** | <code><a href="#appopenadpluginevents">AppOpenAdPluginEvents.FailedToShow</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(AppOpenAdPluginEvents.AdImpression, ...)
|
|
725
|
+
|
|
726
|
+
```typescript
|
|
727
|
+
addListener(eventName: AppOpenAdPluginEvents.AdImpression, listenerFunc: (data: AdMobRevenueData) => void) => Promise<PluginListenerHandle>
|
|
728
|
+
```
|
|
729
|
+
|
|
730
|
+
Listens for App Open impression-level ad revenue events.
|
|
731
|
+
|
|
732
|
+
| Param | Type |
|
|
733
|
+
| ------------------ | ------------------------------------------------------------------------------------ |
|
|
734
|
+
| **`eventName`** | <code><a href="#appopenadpluginevents">AppOpenAdPluginEvents.AdImpression</a></code> |
|
|
735
|
+
| **`listenerFunc`** | <code>(data: <a href="#admobrevenuedata">AdMobRevenueData</a>) => void</code> |
|
|
736
|
+
|
|
737
|
+
**Returns:** <code>Promise<<a href="#pluginlistenerhandle">PluginListenerHandle</a>></code>
|
|
738
|
+
|
|
739
|
+
--------------------
|
|
740
|
+
|
|
741
|
+
|
|
464
742
|
### showBanner(...)
|
|
465
743
|
|
|
466
744
|
```typescript
|
|
467
745
|
showBanner(options: BannerAdOptions) => Promise<void>
|
|
468
746
|
```
|
|
469
747
|
|
|
470
|
-
|
|
748
|
+
Displays a banner ad.
|
|
471
749
|
|
|
472
750
|
| Param | Type | Description |
|
|
473
751
|
| ------------- | ----------------------------------------------------------- | ---------------------------------- |
|
|
@@ -484,7 +762,7 @@ Show a banner Ad
|
|
|
484
762
|
hideBanner() => Promise<void>
|
|
485
763
|
```
|
|
486
764
|
|
|
487
|
-
|
|
765
|
+
Hides the current banner without destroying it.
|
|
488
766
|
|
|
489
767
|
**Since:** 1.1.2
|
|
490
768
|
|
|
@@ -497,7 +775,7 @@ Hide the banner, remove it from screen, but can show it later
|
|
|
497
775
|
resumeBanner() => Promise<void>
|
|
498
776
|
```
|
|
499
777
|
|
|
500
|
-
|
|
778
|
+
Shows a previously hidden banner.
|
|
501
779
|
|
|
502
780
|
**Since:** 1.1.2
|
|
503
781
|
|
|
@@ -510,7 +788,7 @@ Resume the banner, show it after hide
|
|
|
510
788
|
removeBanner() => Promise<void>
|
|
511
789
|
```
|
|
512
790
|
|
|
513
|
-
|
|
791
|
+
Destroys the current banner and removes it from the screen.
|
|
514
792
|
|
|
515
793
|
**Since:** 1.1.2
|
|
516
794
|
|
|
@@ -523,6 +801,8 @@ Destroy the banner, remove it from screen.
|
|
|
523
801
|
addListener(eventName: BannerAdPluginEvents.SizeChanged, listenerFunc: (info: AdMobBannerSize) => void) => Promise<PluginListenerHandle>
|
|
524
802
|
```
|
|
525
803
|
|
|
804
|
+
Listens for changes to the displayed banner dimensions.
|
|
805
|
+
|
|
526
806
|
| Param | Type | Description |
|
|
527
807
|
| ------------------ | --------------------------------------------------------------------------------- | ------------------- |
|
|
528
808
|
| **`eventName`** | <code><a href="#banneradpluginevents">BannerAdPluginEvents.SizeChanged</a></code> | bannerAdSizeChanged |
|
|
@@ -541,7 +821,7 @@ addListener(eventName: BannerAdPluginEvents.SizeChanged, listenerFunc: (info: Ad
|
|
|
541
821
|
addListener(eventName: BannerAdPluginEvents.Loaded, listenerFunc: () => void) => Promise<PluginListenerHandle>
|
|
542
822
|
```
|
|
543
823
|
|
|
544
|
-
|
|
824
|
+
Listens for banner ad load events.
|
|
545
825
|
|
|
546
826
|
| Param | Type | Description |
|
|
547
827
|
| ------------------ | ---------------------------------------------------------------------------- | -------------- |
|
|
@@ -561,7 +841,7 @@ Notice: request loaded Banner ad
|
|
|
561
841
|
addListener(eventName: BannerAdPluginEvents.FailedToLoad, listenerFunc: (info: AdMobError) => void) => Promise<PluginListenerHandle>
|
|
562
842
|
```
|
|
563
843
|
|
|
564
|
-
|
|
844
|
+
Listens for banner ad load failures.
|
|
565
845
|
|
|
566
846
|
| Param | Type | Description |
|
|
567
847
|
| ------------------ | ---------------------------------------------------------------------------------- | -------------------- |
|
|
@@ -581,7 +861,7 @@ Notice: request failed Banner ad
|
|
|
581
861
|
addListener(eventName: BannerAdPluginEvents.Opened, listenerFunc: () => void) => Promise<PluginListenerHandle>
|
|
582
862
|
```
|
|
583
863
|
|
|
584
|
-
|
|
864
|
+
Listens for banner overlay opened events.
|
|
585
865
|
|
|
586
866
|
| Param | Type | Description |
|
|
587
867
|
| ------------------ | ---------------------------------------------------------------------------- | -------------- |
|
|
@@ -601,7 +881,7 @@ Notice: full-screen banner view will be presented in response to the user clicki
|
|
|
601
881
|
addListener(eventName: BannerAdPluginEvents.Closed, listenerFunc: () => void) => Promise<PluginListenerHandle>
|
|
602
882
|
```
|
|
603
883
|
|
|
604
|
-
|
|
884
|
+
Listens for banner overlay closed events.
|
|
605
885
|
|
|
606
886
|
| Param | Type | Description |
|
|
607
887
|
| ------------------ | ---------------------------------------------------------------------------- | -------------- |
|
|
@@ -621,7 +901,7 @@ Notice: The full-screen banner view will been dismissed.
|
|
|
621
901
|
addListener(eventName: BannerAdPluginEvents.AdImpression, listenerFunc: () => void) => Promise<PluginListenerHandle>
|
|
622
902
|
```
|
|
623
903
|
|
|
624
|
-
|
|
904
|
+
Listens for banner impression events.
|
|
625
905
|
|
|
626
906
|
| Param | Type | Description |
|
|
627
907
|
| ------------------ | ---------------------------------------------------------------------------------- | ------------ |
|
|
@@ -635,6 +915,24 @@ Unimplemented
|
|
|
635
915
|
--------------------
|
|
636
916
|
|
|
637
917
|
|
|
918
|
+
### addListener(BannerAdPluginEvents.AdPaid, ...)
|
|
919
|
+
|
|
920
|
+
```typescript
|
|
921
|
+
addListener(eventName: BannerAdPluginEvents.AdPaid, listenerFunc: (data: AdMobRevenueData) => void) => Promise<PluginListenerHandle>
|
|
922
|
+
```
|
|
923
|
+
|
|
924
|
+
Listens for banner impression-level ad revenue events.
|
|
925
|
+
|
|
926
|
+
| Param | Type |
|
|
927
|
+
| ------------------ | -------------------------------------------------------------------------------- |
|
|
928
|
+
| **`eventName`** | <code><a href="#banneradpluginevents">BannerAdPluginEvents.AdPaid</a></code> |
|
|
929
|
+
| **`listenerFunc`** | <code>(data: <a href="#admobrevenuedata">AdMobRevenueData</a>) => void</code> |
|
|
930
|
+
|
|
931
|
+
**Returns:** <code>Promise<<a href="#pluginlistenerhandle">PluginListenerHandle</a>></code>
|
|
932
|
+
|
|
933
|
+
--------------------
|
|
934
|
+
|
|
935
|
+
|
|
638
936
|
### requestConsentInfo(...)
|
|
639
937
|
|
|
640
938
|
```typescript
|
|
@@ -701,7 +999,7 @@ Resets the UMP SDK state. Call requestConsentInfo function again to allow user m
|
|
|
701
999
|
prepareInterstitial(options: AdOptions) => Promise<AdLoadInfo>
|
|
702
1000
|
```
|
|
703
1001
|
|
|
704
|
-
|
|
1002
|
+
Loads an interstitial ad and returns the loaded ad unit ID.
|
|
705
1003
|
|
|
706
1004
|
| Param | Type | Description |
|
|
707
1005
|
| ------------- | ----------------------------------------------- | ---------------------------------- |
|
|
@@ -714,13 +1012,17 @@ Prepare interstitial banner
|
|
|
714
1012
|
--------------------
|
|
715
1013
|
|
|
716
1014
|
|
|
717
|
-
### showInterstitial()
|
|
1015
|
+
### showInterstitial(...)
|
|
718
1016
|
|
|
719
1017
|
```typescript
|
|
720
|
-
showInterstitial() => Promise<void>
|
|
1018
|
+
showInterstitial(options?: AdShowOptions | undefined) => Promise<void>
|
|
721
1019
|
```
|
|
722
1020
|
|
|
723
|
-
|
|
1021
|
+
Shows a loaded interstitial ad.
|
|
1022
|
+
|
|
1023
|
+
| Param | Type | Description |
|
|
1024
|
+
| ------------- | ------------------------------------------------------- | -------------------------------------------------------------------------------------- |
|
|
1025
|
+
| **`options`** | <code><a href="#adshowoptions">AdShowOptions</a></code> | Optional. Pass { adId } to show a specific prepared ad instead of the most recent one. |
|
|
724
1026
|
|
|
725
1027
|
**Since:** 1.1.2
|
|
726
1028
|
|
|
@@ -733,6 +1035,8 @@ Show interstitial ad when it’s ready
|
|
|
733
1035
|
addListener(eventName: InterstitialAdPluginEvents.FailedToLoad, listenerFunc: (error: AdMobError) => void) => Promise<PluginListenerHandle>
|
|
734
1036
|
```
|
|
735
1037
|
|
|
1038
|
+
Listens for interstitial ad load failures.
|
|
1039
|
+
|
|
736
1040
|
| Param | Type |
|
|
737
1041
|
| ------------------ | ---------------------------------------------------------------------------------------------- |
|
|
738
1042
|
| **`eventName`** | <code><a href="#interstitialadpluginevents">InterstitialAdPluginEvents.FailedToLoad</a></code> |
|
|
@@ -749,6 +1053,8 @@ addListener(eventName: InterstitialAdPluginEvents.FailedToLoad, listenerFunc: (e
|
|
|
749
1053
|
addListener(eventName: InterstitialAdPluginEvents.Loaded, listenerFunc: (info: AdLoadInfo) => void) => Promise<PluginListenerHandle>
|
|
750
1054
|
```
|
|
751
1055
|
|
|
1056
|
+
Listens for interstitial ad load events.
|
|
1057
|
+
|
|
752
1058
|
| Param | Type |
|
|
753
1059
|
| ------------------ | ---------------------------------------------------------------------------------------- |
|
|
754
1060
|
| **`eventName`** | <code><a href="#interstitialadpluginevents">InterstitialAdPluginEvents.Loaded</a></code> |
|
|
@@ -765,6 +1071,8 @@ addListener(eventName: InterstitialAdPluginEvents.Loaded, listenerFunc: (info: A
|
|
|
765
1071
|
addListener(eventName: InterstitialAdPluginEvents.Dismissed, listenerFunc: () => void) => Promise<PluginListenerHandle>
|
|
766
1072
|
```
|
|
767
1073
|
|
|
1074
|
+
Listens for interstitial ad dismissed events.
|
|
1075
|
+
|
|
768
1076
|
| Param | Type |
|
|
769
1077
|
| ------------------ | ------------------------------------------------------------------------------------------- |
|
|
770
1078
|
| **`eventName`** | <code><a href="#interstitialadpluginevents">InterstitialAdPluginEvents.Dismissed</a></code> |
|
|
@@ -781,6 +1089,8 @@ addListener(eventName: InterstitialAdPluginEvents.Dismissed, listenerFunc: () =>
|
|
|
781
1089
|
addListener(eventName: InterstitialAdPluginEvents.FailedToShow, listenerFunc: (error: AdMobError) => void) => Promise<PluginListenerHandle>
|
|
782
1090
|
```
|
|
783
1091
|
|
|
1092
|
+
Listens for interstitial ad show failures.
|
|
1093
|
+
|
|
784
1094
|
| Param | Type |
|
|
785
1095
|
| ------------------ | ---------------------------------------------------------------------------------------------- |
|
|
786
1096
|
| **`eventName`** | <code><a href="#interstitialadpluginevents">InterstitialAdPluginEvents.FailedToShow</a></code> |
|
|
@@ -797,6 +1107,8 @@ addListener(eventName: InterstitialAdPluginEvents.FailedToShow, listenerFunc: (e
|
|
|
797
1107
|
addListener(eventName: InterstitialAdPluginEvents.Showed, listenerFunc: () => void) => Promise<PluginListenerHandle>
|
|
798
1108
|
```
|
|
799
1109
|
|
|
1110
|
+
Listens for interstitial ad shown events.
|
|
1111
|
+
|
|
800
1112
|
| Param | Type |
|
|
801
1113
|
| ------------------ | ---------------------------------------------------------------------------------------- |
|
|
802
1114
|
| **`eventName`** | <code><a href="#interstitialadpluginevents">InterstitialAdPluginEvents.Showed</a></code> |
|
|
@@ -807,13 +1119,31 @@ addListener(eventName: InterstitialAdPluginEvents.Showed, listenerFunc: () => vo
|
|
|
807
1119
|
--------------------
|
|
808
1120
|
|
|
809
1121
|
|
|
1122
|
+
### addListener(InterstitialAdPluginEvents.AdImpression, ...)
|
|
1123
|
+
|
|
1124
|
+
```typescript
|
|
1125
|
+
addListener(eventName: InterstitialAdPluginEvents.AdImpression, listenerFunc: (data: AdMobRevenueData) => void) => Promise<PluginListenerHandle>
|
|
1126
|
+
```
|
|
1127
|
+
|
|
1128
|
+
Listens for interstitial impression-level ad revenue events.
|
|
1129
|
+
|
|
1130
|
+
| Param | Type |
|
|
1131
|
+
| ------------------ | ---------------------------------------------------------------------------------------------- |
|
|
1132
|
+
| **`eventName`** | <code><a href="#interstitialadpluginevents">InterstitialAdPluginEvents.AdImpression</a></code> |
|
|
1133
|
+
| **`listenerFunc`** | <code>(data: <a href="#admobrevenuedata">AdMobRevenueData</a>) => void</code> |
|
|
1134
|
+
|
|
1135
|
+
**Returns:** <code>Promise<<a href="#pluginlistenerhandle">PluginListenerHandle</a>></code>
|
|
1136
|
+
|
|
1137
|
+
--------------------
|
|
1138
|
+
|
|
1139
|
+
|
|
810
1140
|
### prepareRewardVideoAd(...)
|
|
811
1141
|
|
|
812
1142
|
```typescript
|
|
813
1143
|
prepareRewardVideoAd(options: RewardAdOptions) => Promise<AdLoadInfo>
|
|
814
1144
|
```
|
|
815
1145
|
|
|
816
|
-
|
|
1146
|
+
Loads a rewarded ad and returns the loaded ad unit ID.
|
|
817
1147
|
|
|
818
1148
|
| Param | Type | Description |
|
|
819
1149
|
| ------------- | ----------------------------------------------------------- | ---------------------------------------------- |
|
|
@@ -826,13 +1156,17 @@ Prepare a reward video ad
|
|
|
826
1156
|
--------------------
|
|
827
1157
|
|
|
828
1158
|
|
|
829
|
-
### showRewardVideoAd()
|
|
1159
|
+
### showRewardVideoAd(...)
|
|
830
1160
|
|
|
831
1161
|
```typescript
|
|
832
|
-
showRewardVideoAd() => Promise<AdMobRewardItem>
|
|
1162
|
+
showRewardVideoAd(options?: AdShowOptions | undefined) => Promise<AdMobRewardItem>
|
|
833
1163
|
```
|
|
834
1164
|
|
|
835
|
-
|
|
1165
|
+
Shows a loaded rewarded ad and resolves when the user earns the reward.
|
|
1166
|
+
|
|
1167
|
+
| Param | Type | Description |
|
|
1168
|
+
| ------------- | ------------------------------------------------------- | -------------------------------------------------------------------------------------- |
|
|
1169
|
+
| **`options`** | <code><a href="#adshowoptions">AdShowOptions</a></code> | Optional. Pass { adId } to show a specific prepared ad instead of the most recent one. |
|
|
836
1170
|
|
|
837
1171
|
**Returns:** <code>Promise<<a href="#admobrewarditem">AdMobRewardItem</a>></code>
|
|
838
1172
|
|
|
@@ -847,6 +1181,8 @@ Show a reward video ad
|
|
|
847
1181
|
addListener(eventName: RewardAdPluginEvents.FailedToLoad, listenerFunc: (error: AdMobError) => void) => Promise<PluginListenerHandle>
|
|
848
1182
|
```
|
|
849
1183
|
|
|
1184
|
+
Listens for rewarded ad load failures.
|
|
1185
|
+
|
|
850
1186
|
| Param | Type |
|
|
851
1187
|
| ------------------ | ---------------------------------------------------------------------------------- |
|
|
852
1188
|
| **`eventName`** | <code><a href="#rewardadpluginevents">RewardAdPluginEvents.FailedToLoad</a></code> |
|
|
@@ -863,6 +1199,8 @@ addListener(eventName: RewardAdPluginEvents.FailedToLoad, listenerFunc: (error:
|
|
|
863
1199
|
addListener(eventName: RewardAdPluginEvents.Loaded, listenerFunc: (info: AdLoadInfo) => void) => Promise<PluginListenerHandle>
|
|
864
1200
|
```
|
|
865
1201
|
|
|
1202
|
+
Listens for rewarded ad load events.
|
|
1203
|
+
|
|
866
1204
|
| Param | Type |
|
|
867
1205
|
| ------------------ | ---------------------------------------------------------------------------- |
|
|
868
1206
|
| **`eventName`** | <code><a href="#rewardadpluginevents">RewardAdPluginEvents.Loaded</a></code> |
|
|
@@ -879,6 +1217,8 @@ addListener(eventName: RewardAdPluginEvents.Loaded, listenerFunc: (info: AdLoadI
|
|
|
879
1217
|
addListener(eventName: RewardAdPluginEvents.Rewarded, listenerFunc: (reward: AdMobRewardItem) => void) => Promise<PluginListenerHandle>
|
|
880
1218
|
```
|
|
881
1219
|
|
|
1220
|
+
Listens for earned reward events.
|
|
1221
|
+
|
|
882
1222
|
| Param | Type |
|
|
883
1223
|
| ------------------ | -------------------------------------------------------------------------------- |
|
|
884
1224
|
| **`eventName`** | <code><a href="#rewardadpluginevents">RewardAdPluginEvents.Rewarded</a></code> |
|
|
@@ -895,6 +1235,8 @@ addListener(eventName: RewardAdPluginEvents.Rewarded, listenerFunc: (reward: AdM
|
|
|
895
1235
|
addListener(eventName: RewardAdPluginEvents.Dismissed, listenerFunc: () => void) => Promise<PluginListenerHandle>
|
|
896
1236
|
```
|
|
897
1237
|
|
|
1238
|
+
Listens for rewarded ad dismissed events.
|
|
1239
|
+
|
|
898
1240
|
| Param | Type |
|
|
899
1241
|
| ------------------ | ------------------------------------------------------------------------------- |
|
|
900
1242
|
| **`eventName`** | <code><a href="#rewardadpluginevents">RewardAdPluginEvents.Dismissed</a></code> |
|
|
@@ -911,6 +1253,8 @@ addListener(eventName: RewardAdPluginEvents.Dismissed, listenerFunc: () => void)
|
|
|
911
1253
|
addListener(eventName: RewardAdPluginEvents.FailedToShow, listenerFunc: (error: AdMobError) => void) => Promise<PluginListenerHandle>
|
|
912
1254
|
```
|
|
913
1255
|
|
|
1256
|
+
Listens for rewarded ad show failures.
|
|
1257
|
+
|
|
914
1258
|
| Param | Type |
|
|
915
1259
|
| ------------------ | ---------------------------------------------------------------------------------- |
|
|
916
1260
|
| **`eventName`** | <code><a href="#rewardadpluginevents">RewardAdPluginEvents.FailedToShow</a></code> |
|
|
@@ -927,6 +1271,8 @@ addListener(eventName: RewardAdPluginEvents.FailedToShow, listenerFunc: (error:
|
|
|
927
1271
|
addListener(eventName: RewardAdPluginEvents.Showed, listenerFunc: () => void) => Promise<PluginListenerHandle>
|
|
928
1272
|
```
|
|
929
1273
|
|
|
1274
|
+
Listens for rewarded ad shown events.
|
|
1275
|
+
|
|
930
1276
|
| Param | Type |
|
|
931
1277
|
| ------------------ | ---------------------------------------------------------------------------- |
|
|
932
1278
|
| **`eventName`** | <code><a href="#rewardadpluginevents">RewardAdPluginEvents.Showed</a></code> |
|
|
@@ -937,17 +1283,35 @@ addListener(eventName: RewardAdPluginEvents.Showed, listenerFunc: () => void) =>
|
|
|
937
1283
|
--------------------
|
|
938
1284
|
|
|
939
1285
|
|
|
1286
|
+
### addListener(RewardAdPluginEvents.AdImpression, ...)
|
|
1287
|
+
|
|
1288
|
+
```typescript
|
|
1289
|
+
addListener(eventName: RewardAdPluginEvents.AdImpression, listenerFunc: (data: AdMobRevenueData) => void) => Promise<PluginListenerHandle>
|
|
1290
|
+
```
|
|
1291
|
+
|
|
1292
|
+
Listens for rewarded impression-level ad revenue events.
|
|
1293
|
+
|
|
1294
|
+
| Param | Type |
|
|
1295
|
+
| ------------------ | ---------------------------------------------------------------------------------- |
|
|
1296
|
+
| **`eventName`** | <code><a href="#rewardadpluginevents">RewardAdPluginEvents.AdImpression</a></code> |
|
|
1297
|
+
| **`listenerFunc`** | <code>(data: <a href="#admobrevenuedata">AdMobRevenueData</a>) => void</code> |
|
|
1298
|
+
|
|
1299
|
+
**Returns:** <code>Promise<<a href="#pluginlistenerhandle">PluginListenerHandle</a>></code>
|
|
1300
|
+
|
|
1301
|
+
--------------------
|
|
1302
|
+
|
|
1303
|
+
|
|
940
1304
|
### prepareRewardInterstitialAd(...)
|
|
941
1305
|
|
|
942
1306
|
```typescript
|
|
943
1307
|
prepareRewardInterstitialAd(options: RewardInterstitialAdOptions) => Promise<AdLoadInfo>
|
|
944
1308
|
```
|
|
945
1309
|
|
|
946
|
-
|
|
1310
|
+
Loads a rewarded interstitial ad and returns the loaded ad unit ID.
|
|
947
1311
|
|
|
948
|
-
| Param | Type | Description
|
|
949
|
-
| ------------- | ----------------------------------------------------------------------------------- |
|
|
950
|
-
| **`options`** | <code><a href="#rewardinterstitialadoptions">RewardInterstitialAdOptions</a></code> | <a href="#
|
|
1312
|
+
| Param | Type | Description |
|
|
1313
|
+
| ------------- | ----------------------------------------------------------------------------------- | ---------------------------------------------------------------------- |
|
|
1314
|
+
| **`options`** | <code><a href="#rewardinterstitialadoptions">RewardInterstitialAdOptions</a></code> | <a href="#rewardinterstitialadoptions">RewardInterstitialAdOptions</a> |
|
|
951
1315
|
|
|
952
1316
|
**Returns:** <code>Promise<<a href="#adloadinfo">AdLoadInfo</a>></code>
|
|
953
1317
|
|
|
@@ -956,13 +1320,17 @@ Prepare a reward video ad
|
|
|
956
1320
|
--------------------
|
|
957
1321
|
|
|
958
1322
|
|
|
959
|
-
### showRewardInterstitialAd()
|
|
1323
|
+
### showRewardInterstitialAd(...)
|
|
960
1324
|
|
|
961
1325
|
```typescript
|
|
962
|
-
showRewardInterstitialAd() => Promise<AdMobRewardInterstitialItem>
|
|
1326
|
+
showRewardInterstitialAd(options?: AdShowOptions | undefined) => Promise<AdMobRewardInterstitialItem>
|
|
963
1327
|
```
|
|
964
1328
|
|
|
965
|
-
|
|
1329
|
+
Shows a loaded rewarded interstitial ad and resolves when the user earns the reward.
|
|
1330
|
+
|
|
1331
|
+
| Param | Type | Description |
|
|
1332
|
+
| ------------- | ------------------------------------------------------- | -------------------------------------------------------------------------------------- |
|
|
1333
|
+
| **`options`** | <code><a href="#adshowoptions">AdShowOptions</a></code> | Optional. Pass { adId } to show a specific prepared ad instead of the most recent one. |
|
|
966
1334
|
|
|
967
1335
|
**Returns:** <code>Promise<<a href="#admobrewardinterstitialitem">AdMobRewardInterstitialItem</a>></code>
|
|
968
1336
|
|
|
@@ -977,6 +1345,8 @@ Show a reward video ad
|
|
|
977
1345
|
addListener(eventName: RewardInterstitialAdPluginEvents.FailedToLoad, listenerFunc: (error: AdMobError) => void) => Promise<PluginListenerHandle>
|
|
978
1346
|
```
|
|
979
1347
|
|
|
1348
|
+
Listens for rewarded interstitial ad load failures.
|
|
1349
|
+
|
|
980
1350
|
| Param | Type |
|
|
981
1351
|
| ------------------ | ---------------------------------------------------------------------------------------------------------- |
|
|
982
1352
|
| **`eventName`** | <code><a href="#rewardinterstitialadpluginevents">RewardInterstitialAdPluginEvents.FailedToLoad</a></code> |
|
|
@@ -993,6 +1363,8 @@ addListener(eventName: RewardInterstitialAdPluginEvents.FailedToLoad, listenerFu
|
|
|
993
1363
|
addListener(eventName: RewardInterstitialAdPluginEvents.Loaded, listenerFunc: (info: AdLoadInfo) => void) => Promise<PluginListenerHandle>
|
|
994
1364
|
```
|
|
995
1365
|
|
|
1366
|
+
Listens for rewarded interstitial ad load events.
|
|
1367
|
+
|
|
996
1368
|
| Param | Type |
|
|
997
1369
|
| ------------------ | ---------------------------------------------------------------------------------------------------- |
|
|
998
1370
|
| **`eventName`** | <code><a href="#rewardinterstitialadpluginevents">RewardInterstitialAdPluginEvents.Loaded</a></code> |
|
|
@@ -1009,6 +1381,8 @@ addListener(eventName: RewardInterstitialAdPluginEvents.Loaded, listenerFunc: (i
|
|
|
1009
1381
|
addListener(eventName: RewardInterstitialAdPluginEvents.Rewarded, listenerFunc: (reward: AdMobRewardInterstitialItem) => void) => Promise<PluginListenerHandle>
|
|
1010
1382
|
```
|
|
1011
1383
|
|
|
1384
|
+
Listens for earned reward events.
|
|
1385
|
+
|
|
1012
1386
|
| Param | Type |
|
|
1013
1387
|
| ------------------ | -------------------------------------------------------------------------------------------------------- |
|
|
1014
1388
|
| **`eventName`** | <code><a href="#rewardinterstitialadpluginevents">RewardInterstitialAdPluginEvents.Rewarded</a></code> |
|
|
@@ -1025,6 +1399,8 @@ addListener(eventName: RewardInterstitialAdPluginEvents.Rewarded, listenerFunc:
|
|
|
1025
1399
|
addListener(eventName: RewardInterstitialAdPluginEvents.Dismissed, listenerFunc: () => void) => Promise<PluginListenerHandle>
|
|
1026
1400
|
```
|
|
1027
1401
|
|
|
1402
|
+
Listens for rewarded interstitial ad dismissed events.
|
|
1403
|
+
|
|
1028
1404
|
| Param | Type |
|
|
1029
1405
|
| ------------------ | ------------------------------------------------------------------------------------------------------- |
|
|
1030
1406
|
| **`eventName`** | <code><a href="#rewardinterstitialadpluginevents">RewardInterstitialAdPluginEvents.Dismissed</a></code> |
|
|
@@ -1041,6 +1417,8 @@ addListener(eventName: RewardInterstitialAdPluginEvents.Dismissed, listenerFunc:
|
|
|
1041
1417
|
addListener(eventName: RewardInterstitialAdPluginEvents.FailedToShow, listenerFunc: (error: AdMobError) => void) => Promise<PluginListenerHandle>
|
|
1042
1418
|
```
|
|
1043
1419
|
|
|
1420
|
+
Listens for rewarded interstitial ad show failures.
|
|
1421
|
+
|
|
1044
1422
|
| Param | Type |
|
|
1045
1423
|
| ------------------ | ---------------------------------------------------------------------------------------------------------- |
|
|
1046
1424
|
| **`eventName`** | <code><a href="#rewardinterstitialadpluginevents">RewardInterstitialAdPluginEvents.FailedToShow</a></code> |
|
|
@@ -1057,6 +1435,8 @@ addListener(eventName: RewardInterstitialAdPluginEvents.FailedToShow, listenerFu
|
|
|
1057
1435
|
addListener(eventName: RewardInterstitialAdPluginEvents.Showed, listenerFunc: () => void) => Promise<PluginListenerHandle>
|
|
1058
1436
|
```
|
|
1059
1437
|
|
|
1438
|
+
Listens for rewarded interstitial ad shown events.
|
|
1439
|
+
|
|
1060
1440
|
| Param | Type |
|
|
1061
1441
|
| ------------------ | ---------------------------------------------------------------------------------------------------- |
|
|
1062
1442
|
| **`eventName`** | <code><a href="#rewardinterstitialadpluginevents">RewardInterstitialAdPluginEvents.Showed</a></code> |
|
|
@@ -1067,25 +1447,45 @@ addListener(eventName: RewardInterstitialAdPluginEvents.Showed, listenerFunc: ()
|
|
|
1067
1447
|
--------------------
|
|
1068
1448
|
|
|
1069
1449
|
|
|
1450
|
+
### addListener(RewardInterstitialAdPluginEvents.AdImpression, ...)
|
|
1451
|
+
|
|
1452
|
+
```typescript
|
|
1453
|
+
addListener(eventName: RewardInterstitialAdPluginEvents.AdImpression, listenerFunc: (data: AdMobRevenueData) => void) => Promise<PluginListenerHandle>
|
|
1454
|
+
```
|
|
1455
|
+
|
|
1456
|
+
Listens for rewarded interstitial impression-level ad revenue events.
|
|
1457
|
+
|
|
1458
|
+
| Param | Type |
|
|
1459
|
+
| ------------------ | ---------------------------------------------------------------------------------------------------------- |
|
|
1460
|
+
| **`eventName`** | <code><a href="#rewardinterstitialadpluginevents">RewardInterstitialAdPluginEvents.AdImpression</a></code> |
|
|
1461
|
+
| **`listenerFunc`** | <code>(data: <a href="#admobrevenuedata">AdMobRevenueData</a>) => void</code> |
|
|
1462
|
+
|
|
1463
|
+
**Returns:** <code>Promise<<a href="#pluginlistenerhandle">PluginListenerHandle</a>></code>
|
|
1464
|
+
|
|
1465
|
+
--------------------
|
|
1466
|
+
|
|
1467
|
+
|
|
1070
1468
|
### Interfaces
|
|
1071
1469
|
|
|
1072
1470
|
|
|
1073
1471
|
#### AdMobInitializationOptions
|
|
1074
1472
|
|
|
1075
|
-
| Prop | Type | Description
|
|
1076
|
-
| ---------------------------------- | ----------------------------------------------------------------- |
|
|
1077
|
-
| **`testingDevices`** | <code>string[]</code> |
|
|
1078
|
-
| **`initializeForTesting`** | <code>boolean</code> |
|
|
1079
|
-
| **`tagForChildDirectedTreatment`** | <code>boolean</code> | For purposes of the Children's Online Privacy Protection Act (COPPA), there is a setting called tagForChildDirectedTreatment.
|
|
1080
|
-
| **`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.
|
|
1081
|
-
| **`maxAdContentRating`** | <code><a href="#maxadcontentrating">MaxAdContentRating</a></code> |
|
|
1473
|
+
| Prop | Type | Description | Default | Since |
|
|
1474
|
+
| ---------------------------------- | ----------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------ | ----- |
|
|
1475
|
+
| **`testingDevices`** | <code>string[]</code> | Device IDs to register as test devices when {@link <a href="#admobinitializationoptions">AdMobInitializationOptions.initializeForTesting</a>} is `true`. Requests from registered devices receive test ads and do not generate invalid traffic. | | 1.2.0 |
|
|
1476
|
+
| **`initializeForTesting`** | <code>boolean</code> | Whether to register {@link <a href="#admobinitializationoptions">AdMobInitializationOptions.testingDevices</a>} as test devices. | <code>false</code> | 1.2.0 |
|
|
1477
|
+
| **`tagForChildDirectedTreatment`** | <code>boolean</code> | For purposes of the Children's Online Privacy Protection Act (COPPA), there is a setting called tagForChildDirectedTreatment. | | 3.1.0 |
|
|
1478
|
+
| **`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 |
|
|
1479
|
+
| **`maxAdContentRating`** | <code><a href="#maxadcontentrating">MaxAdContentRating</a></code> | The maximum ad content rating applied to all ad requests. Ads with a higher rating are excluded. | | 3.1.0 |
|
|
1082
1480
|
|
|
1083
1481
|
|
|
1084
1482
|
#### TrackingAuthorizationStatusInterface
|
|
1085
1483
|
|
|
1086
|
-
|
|
1087
|
-
|
|
1088
|
-
|
|
|
1484
|
+
The current iOS App Tracking Transparency authorization status.
|
|
1485
|
+
|
|
1486
|
+
| Prop | Type | Description |
|
|
1487
|
+
| ------------ | ------------------------------------------------------------------------ | --------------------------------------------------------------- |
|
|
1488
|
+
| **`status`** | <code>'authorized' \| 'denied' \| 'notDetermined' \| 'restricted'</code> | The authorization status reported by App Tracking Transparency. |
|
|
1089
1489
|
|
|
1090
1490
|
|
|
1091
1491
|
#### ApplicationMutedOptions
|
|
@@ -1097,47 +1497,48 @@ addListener(eventName: RewardInterstitialAdPluginEvents.Showed, listenerFunc: ()
|
|
|
1097
1497
|
|
|
1098
1498
|
#### ApplicationVolumeOptions
|
|
1099
1499
|
|
|
1100
|
-
| Prop | Type | Description
|
|
1101
|
-
| ------------ | ---------------------------------------------------------------------------------- |
|
|
1102
|
-
| **`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.
|
|
1500
|
+
| Prop | Type | Description | Since |
|
|
1501
|
+
| ------------ | ---------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----- |
|
|
1502
|
+
| **`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. Use a supported value from 0.0 (silent) to 1.0 (full volume). | 4.1.1 |
|
|
1103
1503
|
|
|
1104
1504
|
|
|
1105
|
-
####
|
|
1505
|
+
#### AdLoadInfo
|
|
1106
1506
|
|
|
1107
|
-
|
|
1507
|
+
Information returned after an ad loads successfully.
|
|
1108
1508
|
|
|
1109
|
-
| Prop
|
|
1110
|
-
|
|
|
1111
|
-
| **`
|
|
1112
|
-
| **`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 |
|
|
1113
|
-
| **`adId`** | <code>string</code> | The ad unit ID that you want to request | | 1.1.2 |
|
|
1114
|
-
| **`isTesting`** | <code>boolean</code> | You can use test mode of ad. | <code>false</code> | 1.1.2 |
|
|
1115
|
-
| **`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 |
|
|
1116
|
-
| **`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 |
|
|
1117
|
-
| **`immersiveMode`** | <code>boolean</code> | Sets a flag that controls if this interstitial or reward object will be displayed in immersive mode. Call this method before show. During show, if this flag is on and immersive mode is supported, SYSTEM_UI_FLAG_IMMERSIVE_STICKY &SYSTEM_UI_FLAG_HIDE_NAVIGATION will be turned on for interstitial or reward ad. | | 7.0.3 |
|
|
1509
|
+
| Prop | Type | Description |
|
|
1510
|
+
| -------------- | ------------------- | -------------------------------- |
|
|
1511
|
+
| **`adUnitId`** | <code>string</code> | The ad unit ID of the loaded ad. |
|
|
1118
1512
|
|
|
1119
1513
|
|
|
1120
|
-
####
|
|
1514
|
+
#### AppOpenAdOptions
|
|
1121
1515
|
|
|
1122
|
-
|
|
1123
|
-
| ------------ | ----------------------------------------- |
|
|
1124
|
-
| **`remove`** | <code>() => Promise<void></code> |
|
|
1516
|
+
Options for loading an App Open ad.
|
|
1125
1517
|
|
|
1518
|
+
| Prop | Type | Description |
|
|
1519
|
+
| ---------- | ------------------- | -------------------------------- |
|
|
1520
|
+
| **`adId`** | <code>string</code> | The App Open ad unit ID to load. |
|
|
1126
1521
|
|
|
1127
|
-
#### AdMobBannerSize
|
|
1128
1522
|
|
|
1129
|
-
|
|
1523
|
+
#### AdShowOptions
|
|
1130
1524
|
|
|
1131
|
-
|
|
1132
|
-
|
|
1133
|
-
|
|
|
1134
|
-
|
|
|
1525
|
+
Options for selecting a previously loaded ad to show or inspect.
|
|
1526
|
+
|
|
1527
|
+
| Prop | Type | Description | Since |
|
|
1528
|
+
| ---------- | ------------------- | ---------------------------------------------------------------------------------------------------------------------- | ----- |
|
|
1529
|
+
| **`adId`** | <code>string</code> | The ad unit ID of a previously prepared ad to target. If omitted, the operation targets the most recently prepared ad. | 8.0.1 |
|
|
1530
|
+
|
|
1531
|
+
|
|
1532
|
+
#### PluginListenerHandle
|
|
1533
|
+
|
|
1534
|
+
| Prop | Type |
|
|
1535
|
+
| ------------ | ----------------------------------------- |
|
|
1536
|
+
| **`remove`** | <code>() => Promise<void></code> |
|
|
1135
1537
|
|
|
1136
1538
|
|
|
1137
1539
|
#### AdMobError
|
|
1138
1540
|
|
|
1139
|
-
|
|
1140
|
-
https://developers.google.com/android/reference/com/google/android/gms/ads/AdError
|
|
1541
|
+
An error returned by the Google Mobile Ads SDK.
|
|
1141
1542
|
|
|
1142
1543
|
| Prop | Type | Description |
|
|
1143
1544
|
| ------------- | ------------------- | -------------------------------------- |
|
|
@@ -1145,6 +1546,48 @@ https://developers.google.com/android/reference/com/google/android/gms/ads/AdErr
|
|
|
1145
1546
|
| **`message`** | <code>string</code> | Gets the message describing the error. |
|
|
1146
1547
|
|
|
1147
1548
|
|
|
1549
|
+
#### AdMobRevenueData
|
|
1550
|
+
|
|
1551
|
+
Impression-level ad revenue data emitted by a paid event.
|
|
1552
|
+
|
|
1553
|
+
| Prop | Type | Description |
|
|
1554
|
+
| ------------------ | ------------------------------------------------------------- | ------------------------------------------------------------------------------------------------- |
|
|
1555
|
+
| **`adUnitId`** | <code>string</code> | The ad unit ID associated with the paid event. |
|
|
1556
|
+
| **`valueMicros`** | <code>number</code> | The ad value in micros, where 1,000,000 micros equals one currency unit. |
|
|
1557
|
+
| **`currencyCode`** | <code>string</code> | The ISO 4217 currency code for `valueMicros`. |
|
|
1558
|
+
| **`precision`** | <code><a href="#advalueprecision">AdValuePrecision</a></code> | The precision of the reported ad value. |
|
|
1559
|
+
| **`networkName`** | <code>string</code> | The mediation adapter class name that served the impression, or an empty string when unavailable. |
|
|
1560
|
+
| **`impressionId`** | <code>string</code> | The response identifier associated with the impression, or an empty string when unavailable. |
|
|
1561
|
+
|
|
1562
|
+
|
|
1563
|
+
#### BannerAdOptions
|
|
1564
|
+
|
|
1565
|
+
Options for displaying a banner ad.
|
|
1566
|
+
|
|
1567
|
+
This interface extends <a href="#adoptions">AdOptions</a>.
|
|
1568
|
+
|
|
1569
|
+
| Prop | Type | Description | Default | Since |
|
|
1570
|
+
| ------------------- | ------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------- | ----- |
|
|
1571
|
+
| **`adSize`** | <code><a href="#banneradsize">BannerAdSize</a></code> | The banner size to display. | <code>ADAPTIVE_BANNER</code> | 3.0.0 |
|
|
1572
|
+
| **`position`** | <code><a href="#banneradposition">BannerAdPosition</a></code> | The position where the banner is displayed. | <code>TOP_CENTER</code> | 1.1.2 |
|
|
1573
|
+
| **`adId`** | <code>string</code> | The ad unit ID to load. | | 1.1.2 |
|
|
1574
|
+
| **`isTesting`** | <code>boolean</code> | Whether to request a test ad. | <code>false</code> | 1.1.2 |
|
|
1575
|
+
| **`margin`** | <code>number</code> | The banner margin in logical display units (dp on Android and points on iOS). For `BOTTOM_CENTER`, this is the bottom margin. For `TOP_CENTER`, this is the top margin. | <code>0</code> | 1.1.2 |
|
|
1576
|
+
| **`npa`** | <code>boolean</code> | Whether to request non-personalized ads. | <code>false</code> | 1.2.0 |
|
|
1577
|
+
| **`immersiveMode`** | <code>boolean</code> | Whether to display a full-screen ad in immersive mode on Android. | | 7.0.3 |
|
|
1578
|
+
|
|
1579
|
+
|
|
1580
|
+
#### AdMobBannerSize
|
|
1581
|
+
|
|
1582
|
+
The displayed banner dimensions in logical display units (dp on Android and points on iOS).
|
|
1583
|
+
A hidden, removed, or failed banner can report both dimensions as `0`.
|
|
1584
|
+
|
|
1585
|
+
| Prop | Type | Description |
|
|
1586
|
+
| ------------ | ------------------- | ---------------------------- |
|
|
1587
|
+
| **`width`** | <code>number</code> | The displayed banner width. |
|
|
1588
|
+
| **`height`** | <code>number</code> | The displayed banner height. |
|
|
1589
|
+
|
|
1590
|
+
|
|
1148
1591
|
#### AdmobConsentInfo
|
|
1149
1592
|
|
|
1150
1593
|
| Prop | Type | Description | Since |
|
|
@@ -1164,68 +1607,65 @@ https://developers.google.com/android/reference/com/google/android/gms/ads/AdErr
|
|
|
1164
1607
|
| **`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 |
|
|
1165
1608
|
|
|
1166
1609
|
|
|
1167
|
-
#### AdLoadInfo
|
|
1168
|
-
|
|
1169
|
-
| Prop | Type |
|
|
1170
|
-
| -------------- | ------------------- |
|
|
1171
|
-
| **`adUnitId`** | <code>string</code> |
|
|
1172
|
-
|
|
1173
|
-
|
|
1174
1610
|
#### AdOptions
|
|
1175
1611
|
|
|
1176
|
-
|
|
1177
|
-
|
|
1178
|
-
|
|
|
1179
|
-
|
|
|
1180
|
-
| **`
|
|
1181
|
-
| **`
|
|
1182
|
-
| **`
|
|
1612
|
+
Common options for requesting an ad.
|
|
1613
|
+
|
|
1614
|
+
| Prop | Type | Description | Default | Since |
|
|
1615
|
+
| ------------------- | -------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------ | ----- |
|
|
1616
|
+
| **`adId`** | <code>string</code> | The ad unit ID to load. | | 1.1.2 |
|
|
1617
|
+
| **`isTesting`** | <code>boolean</code> | Whether to request a test ad. | <code>false</code> | 1.1.2 |
|
|
1618
|
+
| **`margin`** | <code>number</code> | The banner margin in logical display units (dp on Android and points on iOS). For `BOTTOM_CENTER`, this is the bottom margin. For `TOP_CENTER`, this is the top margin. | <code>0</code> | 1.1.2 |
|
|
1619
|
+
| **`npa`** | <code>boolean</code> | Whether to request non-personalized ads. | <code>false</code> | 1.2.0 |
|
|
1620
|
+
| **`immersiveMode`** | <code>boolean</code> | Whether to display a full-screen ad in immersive mode on Android. | | 7.0.3 |
|
|
1183
1621
|
|
|
1184
1622
|
|
|
1185
1623
|
#### RewardAdOptions
|
|
1186
1624
|
|
|
1187
|
-
|
|
1188
|
-
|
|
1189
|
-
|
|
|
1190
|
-
|
|
|
1191
|
-
| **`
|
|
1192
|
-
| **`
|
|
1193
|
-
| **`
|
|
1194
|
-
| **`
|
|
1625
|
+
Options for loading a rewarded ad.
|
|
1626
|
+
|
|
1627
|
+
| Prop | Type | Description | Default | Since |
|
|
1628
|
+
| ------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------ | ----- |
|
|
1629
|
+
| **`ssv`** | <code><a href="#atleastone">AtLeastOne</a><{ /** * A user identifier passed to the SSV callback. */ userId: string; /** * Custom data passed to the SSV callback. */ customData: string; }></code> | Server-side verification options for the rewarded ad. Provide at least one of `userId` or `customData`. | | |
|
|
1630
|
+
| **`adId`** | <code>string</code> | The ad unit ID to load. | | 1.1.2 |
|
|
1631
|
+
| **`isTesting`** | <code>boolean</code> | Whether to request a test ad. | <code>false</code> | 1.1.2 |
|
|
1632
|
+
| **`margin`** | <code>number</code> | The banner margin in logical display units (dp on Android and points on iOS). For `BOTTOM_CENTER`, this is the bottom margin. For `TOP_CENTER`, this is the top margin. | <code>0</code> | 1.1.2 |
|
|
1633
|
+
| **`npa`** | <code>boolean</code> | Whether to request non-personalized ads. | <code>false</code> | 1.2.0 |
|
|
1634
|
+
| **`immersiveMode`** | <code>boolean</code> | Whether to display a full-screen ad in immersive mode on Android. | | 7.0.3 |
|
|
1195
1635
|
|
|
1196
1636
|
|
|
1197
1637
|
#### AdMobRewardItem
|
|
1198
1638
|
|
|
1199
|
-
|
|
1200
|
-
https://developers.google.com/admob/android/rewarded-video-adapters?hl=en
|
|
1639
|
+
The reward earned by the user after viewing a rewarded ad.
|
|
1201
1640
|
|
|
1202
|
-
| Prop | Type | Description
|
|
1203
|
-
| ------------ | ------------------- |
|
|
1204
|
-
| **`type`** | <code>string</code> |
|
|
1205
|
-
| **`amount`** | <code>number</code> |
|
|
1641
|
+
| Prop | Type | Description |
|
|
1642
|
+
| ------------ | ------------------- | ------------------------------------------------ |
|
|
1643
|
+
| **`type`** | <code>string</code> | The reward item type configured for the ad unit. |
|
|
1644
|
+
| **`amount`** | <code>number</code> | The reward amount earned by the user. |
|
|
1206
1645
|
|
|
1207
1646
|
|
|
1208
1647
|
#### RewardInterstitialAdOptions
|
|
1209
1648
|
|
|
1210
|
-
|
|
1211
|
-
|
|
1212
|
-
|
|
|
1213
|
-
|
|
|
1214
|
-
| **`
|
|
1215
|
-
| **`
|
|
1216
|
-
| **`
|
|
1217
|
-
| **`
|
|
1649
|
+
Options for loading a rewarded interstitial ad.
|
|
1650
|
+
|
|
1651
|
+
| Prop | Type | Description | Default | Since |
|
|
1652
|
+
| ------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------ | ----- |
|
|
1653
|
+
| **`ssv`** | <code><a href="#atleastone">AtLeastOne</a><{ /** * A user identifier passed to the SSV callback. */ userId: string; /** * Custom data passed to the SSV callback. */ customData: string; }></code> | Server-side verification options for the rewarded interstitial ad. Provide at least one of `userId` or `customData`. | | |
|
|
1654
|
+
| **`adId`** | <code>string</code> | The ad unit ID to load. | | 1.1.2 |
|
|
1655
|
+
| **`isTesting`** | <code>boolean</code> | Whether to request a test ad. | <code>false</code> | 1.1.2 |
|
|
1656
|
+
| **`margin`** | <code>number</code> | The banner margin in logical display units (dp on Android and points on iOS). For `BOTTOM_CENTER`, this is the bottom margin. For `TOP_CENTER`, this is the top margin. | <code>0</code> | 1.1.2 |
|
|
1657
|
+
| **`npa`** | <code>boolean</code> | Whether to request non-personalized ads. | <code>false</code> | 1.2.0 |
|
|
1658
|
+
| **`immersiveMode`** | <code>boolean</code> | Whether to display a full-screen ad in immersive mode on Android. | | 7.0.3 |
|
|
1218
1659
|
|
|
1219
1660
|
|
|
1220
1661
|
#### AdMobRewardInterstitialItem
|
|
1221
1662
|
|
|
1222
|
-
|
|
1223
|
-
https://developers.google.com/admob/android/rewarded-video-adapters?hl=en
|
|
1663
|
+
The reward earned by the user after viewing a rewarded interstitial ad.
|
|
1224
1664
|
|
|
1225
|
-
| Prop | Type | Description
|
|
1226
|
-
| ------------ | ------------------- |
|
|
1227
|
-
| **`type`** | <code>string</code> |
|
|
1228
|
-
| **`amount`** | <code>number</code> |
|
|
1665
|
+
| Prop | Type | Description |
|
|
1666
|
+
| ------------ | ------------------- | ------------------------------------------------ |
|
|
1667
|
+
| **`type`** | <code>string</code> | The reward item type configured for the ad unit. |
|
|
1668
|
+
| **`amount`** | <code>number</code> | The reward amount earned by the user. |
|
|
1229
1669
|
|
|
1230
1670
|
|
|
1231
1671
|
### Type Aliases
|
|
@@ -1256,38 +1696,61 @@ From T, pick a set of properties whose keys are in the union K
|
|
|
1256
1696
|
| **`MatureAudience`** | <code>'MatureAudience'</code> | Content suitable only for mature audiences. |
|
|
1257
1697
|
|
|
1258
1698
|
|
|
1699
|
+
#### AppOpenAdPluginEvents
|
|
1700
|
+
|
|
1701
|
+
| Members | Value | Description |
|
|
1702
|
+
| ------------------ | ------------------------------------ | --------------------------------------------------------------------- |
|
|
1703
|
+
| **`Loaded`** | <code>'appOpenAdLoaded'</code> | Emits when an App Open ad has loaded. |
|
|
1704
|
+
| **`FailedToLoad`** | <code>'appOpenAdFailedToLoad'</code> | Emits when an App Open ad fails to load. |
|
|
1705
|
+
| **`Opened`** | <code>'appOpenAdOpened'</code> | Emits when an App Open ad is shown. |
|
|
1706
|
+
| **`Closed`** | <code>'appOpenAdClosed'</code> | Emits when an App Open ad is dismissed. |
|
|
1707
|
+
| **`FailedToShow`** | <code>'appOpenAdFailedToShow'</code> | Emits when a loaded App Open ad fails to show. |
|
|
1708
|
+
| **`AdImpression`** | <code>'appOpenAdImpression'</code> | Emits impression-level ad revenue data when a paid event is recorded. |
|
|
1709
|
+
|
|
1710
|
+
|
|
1711
|
+
#### AdValuePrecision
|
|
1712
|
+
|
|
1713
|
+
| Members | Value | Description |
|
|
1714
|
+
| ----------------------- | -------------- | --------------------------------------------------- |
|
|
1715
|
+
| **`Unknown`** | <code>0</code> | The ad value precision is unknown. |
|
|
1716
|
+
| **`Estimated`** | <code>1</code> | The ad value is estimated from aggregated data. |
|
|
1717
|
+
| **`PublisherProvided`** | <code>2</code> | The ad value was provided by the publisher. |
|
|
1718
|
+
| **`Precise`** | <code>3</code> | The ad value is the precise value paid for this ad. |
|
|
1719
|
+
|
|
1720
|
+
|
|
1259
1721
|
#### BannerAdSize
|
|
1260
1722
|
|
|
1261
|
-
| Members | Value | Description
|
|
1262
|
-
| ---------------------- | ------------------------------- |
|
|
1263
|
-
| **`BANNER`** | <code>'BANNER'</code> | Mobile Marketing Association (MMA) banner ad size (320x50 density-independent pixels).
|
|
1264
|
-
| **`FULL_BANNER`** | <code>'FULL_BANNER'</code> | Interactive Advertising Bureau (IAB) full banner ad size (468x60 density-independent pixels).
|
|
1265
|
-
| **`LARGE_BANNER`** | <code>'LARGE_BANNER'</code> | Large banner ad size (320x100 density-independent pixels).
|
|
1266
|
-
| **`MEDIUM_RECTANGLE`** | <code>'MEDIUM_RECTANGLE'</code> | Interactive Advertising Bureau (IAB) medium rectangle ad size (300x250 density-independent pixels).
|
|
1267
|
-
| **`LEADERBOARD`** | <code>'LEADERBOARD'</code> | Interactive Advertising Bureau (IAB) leaderboard ad size (728x90 density-independent pixels).
|
|
1268
|
-
| **`ADAPTIVE_BANNER`** | <code>'ADAPTIVE_BANNER'</code> | A dynamically sized banner that is full-width and auto-height.
|
|
1269
|
-
| **`SMART_BANNER`** | <code>'SMART_BANNER'</code> |
|
|
1723
|
+
| Members | Value | Description |
|
|
1724
|
+
| ---------------------- | ------------------------------- | ------------------------------------------------------------------------------------------------------------------------ |
|
|
1725
|
+
| **`BANNER`** | <code>'BANNER'</code> | Mobile Marketing Association (MMA) banner ad size (320x50 density-independent pixels). |
|
|
1726
|
+
| **`FULL_BANNER`** | <code>'FULL_BANNER'</code> | Interactive Advertising Bureau (IAB) full banner ad size (468x60 density-independent pixels). |
|
|
1727
|
+
| **`LARGE_BANNER`** | <code>'LARGE_BANNER'</code> | Large banner ad size (320x100 density-independent pixels). |
|
|
1728
|
+
| **`MEDIUM_RECTANGLE`** | <code>'MEDIUM_RECTANGLE'</code> | Interactive Advertising Bureau (IAB) medium rectangle ad size (300x250 density-independent pixels). |
|
|
1729
|
+
| **`LEADERBOARD`** | <code>'LEADERBOARD'</code> | Interactive Advertising Bureau (IAB) leaderboard ad size (728x90 density-independent pixels). |
|
|
1730
|
+
| **`ADAPTIVE_BANNER`** | <code>'ADAPTIVE_BANNER'</code> | A dynamically sized banner that is full-width and auto-height. |
|
|
1731
|
+
| **`SMART_BANNER`** | <code>'SMART_BANNER'</code> | A legacy smart banner sized to the screen width. Retained for compatibility; use `ADAPTIVE_BANNER` for new integrations. |
|
|
1270
1732
|
|
|
1271
1733
|
|
|
1272
1734
|
#### BannerAdPosition
|
|
1273
1735
|
|
|
1274
|
-
| Members | Value | Description
|
|
1275
|
-
| ------------------- | ---------------------------- |
|
|
1276
|
-
| **`TOP_CENTER`** | <code>'TOP_CENTER'</code> |
|
|
1277
|
-
| **`CENTER`** | <code>'CENTER'</code> |
|
|
1278
|
-
| **`BOTTOM_CENTER`** | <code>'BOTTOM_CENTER'</code> |
|
|
1736
|
+
| Members | Value | Description |
|
|
1737
|
+
| ------------------- | ---------------------------- | -------------------------------------------------------- |
|
|
1738
|
+
| **`TOP_CENTER`** | <code>'TOP_CENTER'</code> | Positions the banner at the top center of the screen. |
|
|
1739
|
+
| **`CENTER`** | <code>'CENTER'</code> | Positions the banner at the center of the screen. |
|
|
1740
|
+
| **`BOTTOM_CENTER`** | <code>'BOTTOM_CENTER'</code> | Positions the banner at the bottom center of the screen. |
|
|
1279
1741
|
|
|
1280
1742
|
|
|
1281
1743
|
#### BannerAdPluginEvents
|
|
1282
1744
|
|
|
1283
|
-
| Members | Value | Description
|
|
1284
|
-
| ------------------ | ----------------------------------- |
|
|
1285
|
-
| **`SizeChanged`** | <code>"bannerAdSizeChanged"</code> |
|
|
1286
|
-
| **`Loaded`** | <code>"bannerAdLoaded"</code> |
|
|
1287
|
-
| **`FailedToLoad`** | <code>"bannerAdFailedToLoad"</code> |
|
|
1288
|
-
| **`Opened`** | <code>"bannerAdOpened"</code> |
|
|
1289
|
-
| **`Closed`** | <code>"bannerAdClosed"</code> |
|
|
1290
|
-
| **`AdImpression`** | <code>"bannerAdImpression"</code> |
|
|
1745
|
+
| Members | Value | Description |
|
|
1746
|
+
| ------------------ | ----------------------------------- | --------------------------------------------------------------------- |
|
|
1747
|
+
| **`SizeChanged`** | <code>"bannerAdSizeChanged"</code> | Emits when the displayed banner size changes. |
|
|
1748
|
+
| **`Loaded`** | <code>"bannerAdLoaded"</code> | Emits when a banner ad has loaded. |
|
|
1749
|
+
| **`FailedToLoad`** | <code>"bannerAdFailedToLoad"</code> | Emits when a banner ad fails to load. |
|
|
1750
|
+
| **`Opened`** | <code>"bannerAdOpened"</code> | Emits when a banner opens an overlay after the user taps it. |
|
|
1751
|
+
| **`Closed`** | <code>"bannerAdClosed"</code> | Emits when the banner overlay is closed. |
|
|
1752
|
+
| **`AdImpression`** | <code>"bannerAdImpression"</code> | Emits when an impression is recorded for the banner ad. |
|
|
1753
|
+
| **`AdPaid`** | <code>"bannerAdPaid"</code> | Emits impression-level ad revenue data when a paid event is recorded. |
|
|
1291
1754
|
|
|
1292
1755
|
|
|
1293
1756
|
#### AdmobConsentStatus
|
|
@@ -1322,37 +1785,40 @@ From T, pick a set of properties whose keys are in the union K
|
|
|
1322
1785
|
|
|
1323
1786
|
#### InterstitialAdPluginEvents
|
|
1324
1787
|
|
|
1325
|
-
| Members | Value | Description
|
|
1326
|
-
| ------------------ | ----------------------------------------- |
|
|
1327
|
-
| **`Loaded`** | <code>'interstitialAdLoaded'</code> | Emits
|
|
1328
|
-
| **`FailedToLoad`** | <code>'interstitialAdFailedToLoad'</code> | Emits
|
|
1329
|
-
| **`Showed`** | <code>'interstitialAdShowed'</code> | Emits when
|
|
1330
|
-
| **`FailedToShow`** | <code>'interstitialAdFailedToShow'</code> | Emits when
|
|
1331
|
-
| **`Dismissed`** | <code>'interstitialAdDismissed'</code> | Emits when
|
|
1788
|
+
| Members | Value | Description |
|
|
1789
|
+
| ------------------ | ----------------------------------------- | --------------------------------------------------------------------- |
|
|
1790
|
+
| **`Loaded`** | <code>'interstitialAdLoaded'</code> | Emits when an interstitial ad has loaded and is ready to show. |
|
|
1791
|
+
| **`FailedToLoad`** | <code>'interstitialAdFailedToLoad'</code> | Emits when an interstitial ad fails to load. |
|
|
1792
|
+
| **`Showed`** | <code>'interstitialAdShowed'</code> | Emits when an interstitial ad is shown. |
|
|
1793
|
+
| **`FailedToShow`** | <code>'interstitialAdFailedToShow'</code> | Emits when a loaded interstitial ad fails to show. |
|
|
1794
|
+
| **`Dismissed`** | <code>'interstitialAdDismissed'</code> | Emits when an interstitial ad is dismissed. |
|
|
1795
|
+
| **`AdImpression`** | <code>'interstitialAdImpression'</code> | Emits impression-level ad revenue data when a paid event is recorded. |
|
|
1332
1796
|
|
|
1333
1797
|
|
|
1334
1798
|
#### RewardAdPluginEvents
|
|
1335
1799
|
|
|
1336
|
-
| Members | Value | Description
|
|
1337
|
-
| ------------------ | -------------------------------------------- |
|
|
1338
|
-
| **`Loaded`** | <code>'onRewardedVideoAdLoaded'</code> | Emits
|
|
1339
|
-
| **`FailedToLoad`** | <code>'onRewardedVideoAdFailedToLoad'</code> | Emits
|
|
1340
|
-
| **`Showed`** | <code>'onRewardedVideoAdShowed'</code> | Emits when
|
|
1341
|
-
| **`FailedToShow`** | <code>'onRewardedVideoAdFailedToShow'</code> | Emits when
|
|
1342
|
-
| **`Dismissed`** | <code>'onRewardedVideoAdDismissed'</code> | Emits when
|
|
1343
|
-
| **`Rewarded`** | <code>'onRewardedVideoAdReward'</code> | Emits when user
|
|
1800
|
+
| Members | Value | Description |
|
|
1801
|
+
| ------------------ | -------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
1802
|
+
| **`Loaded`** | <code>'onRewardedVideoAdLoaded'</code> | Emits when a rewarded ad has loaded and is ready to show. |
|
|
1803
|
+
| **`FailedToLoad`** | <code>'onRewardedVideoAdFailedToLoad'</code> | Emits when a rewarded ad fails to load. |
|
|
1804
|
+
| **`Showed`** | <code>'onRewardedVideoAdShowed'</code> | Emits when a rewarded ad is shown. |
|
|
1805
|
+
| **`FailedToShow`** | <code>'onRewardedVideoAdFailedToShow'</code> | Emits when a loaded rewarded ad fails to show. |
|
|
1806
|
+
| **`Dismissed`** | <code>'onRewardedVideoAdDismissed'</code> | Emits when a rewarded ad is dismissed. This event does not indicate whether the user earned a reward. Listen for `Rewarded` separately before granting the reward. |
|
|
1807
|
+
| **`Rewarded`** | <code>'onRewardedVideoAdReward'</code> | Emits when the user earns the advertised reward. |
|
|
1808
|
+
| **`AdImpression`** | <code>'onRewardedVideoAdImpression'</code> | Emits impression-level ad revenue data when a paid event is recorded. |
|
|
1344
1809
|
|
|
1345
1810
|
|
|
1346
1811
|
#### RewardInterstitialAdPluginEvents
|
|
1347
1812
|
|
|
1348
|
-
| Members | Value | Description
|
|
1349
|
-
| ------------------ | --------------------------------------------------- |
|
|
1350
|
-
| **`Loaded`** | <code>'onRewardedInterstitialAdLoaded'</code> | Emits
|
|
1351
|
-
| **`FailedToLoad`** | <code>'onRewardedInterstitialAdFailedToLoad'</code> | Emits
|
|
1352
|
-
| **`Showed`** | <code>'onRewardedInterstitialAdShowed'</code> | Emits when
|
|
1353
|
-
| **`FailedToShow`** | <code>'onRewardedInterstitialAdFailedToShow'</code> | Emits when
|
|
1354
|
-
| **`Dismissed`** | <code>'onRewardedInterstitialAdDismissed'</code> | Emits when
|
|
1355
|
-
| **`Rewarded`** | <code>'onRewardedInterstitialAdReward'</code> | Emits when user
|
|
1813
|
+
| Members | Value | Description |
|
|
1814
|
+
| ------------------ | --------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
|
1815
|
+
| **`Loaded`** | <code>'onRewardedInterstitialAdLoaded'</code> | Emits when a rewarded interstitial ad has loaded and is ready to show. |
|
|
1816
|
+
| **`FailedToLoad`** | <code>'onRewardedInterstitialAdFailedToLoad'</code> | Emits when a rewarded interstitial ad fails to load. |
|
|
1817
|
+
| **`Showed`** | <code>'onRewardedInterstitialAdShowed'</code> | Emits when a rewarded interstitial ad is shown. |
|
|
1818
|
+
| **`FailedToShow`** | <code>'onRewardedInterstitialAdFailedToShow'</code> | Emits when a loaded rewarded interstitial ad fails to show. |
|
|
1819
|
+
| **`Dismissed`** | <code>'onRewardedInterstitialAdDismissed'</code> | Emits when a rewarded interstitial ad is dismissed. This event does not indicate whether the user earned a reward. Listen for `Rewarded` separately before granting the reward. |
|
|
1820
|
+
| **`Rewarded`** | <code>'onRewardedInterstitialAdReward'</code> | Emits when the user earns the advertised reward. |
|
|
1821
|
+
| **`AdImpression`** | <code>'onRewardedInterstitialAdImpression'</code> | Emits impression-level ad revenue data when a paid event is recorded. |
|
|
1356
1822
|
|
|
1357
1823
|
</docgen-api>
|
|
1358
1824
|
|