@ququplay/admob 6.0.0 → 7.0.1

package/README.md

@@ -6,8 +6,7 @@
 </p>
 
 <p align="center">
-  <img src="https://img.shields.io/maintenance/yes/2024?style=flat-square" />
-  <!-- <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> -->
+  <img src="https://img.shields.io/maintenance/yes/2025?style=flat-square" />
   <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>
 <br>
   <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>
@@ -16,14 +15,15 @@
 
 ## Maintainers
 
-| Maintainer          | GitHub                              | Social                                | Sponsoring Company                             |
-| ------------------- | ----------------------------------- | ------------------------------------- | ---------------------------------------------- |
-| Masahiko Sakakibara | [rdlabo](https://github.com/rdlabo) | [@rdlabo](https://twitter.com/rdlabo) | RELATION DESIGN LABO, GENERAL INC. ASSOCIATION |
-| Saninn Salas Diaz | [Saninn Salas Diaz](https://github.com/distante) | [@SaninnSalas](https://twitter.com/SaninnSalas) | |
+| Maintainer          | GitHub                                           | Social                                          | Sponsoring Company                             |
+| ------------------- | ------------------------------------------------ | ----------------------------------------------- | ---------------------------------------------- |
+| Masahiko Sakakibara | [rdlabo](https://github.com/rdlabo)              | [@rdlabo](https://twitter.com/rdlabo)           | RELATION DESIGN LABO, GENERAL INC. ASSOCIATION |
+| Saninn Salas Diaz   | [Saninn Salas Diaz](https://github.com/distante) | [@SaninnSalas](https://twitter.com/SaninnSalas) |                                                |
 
 Maintenance Status: Actively Maintained
 
 ## Contributors ✨
+
 <a href="https://github.com/capacitor-community/admob/graphs/contributors">
   <img src="https://contrib.rocks/image?repo=capacitor-community/admob" />
 </a>
@@ -42,24 +42,11 @@ Made with [contributors-img](https://contrib.rocks).
 | **Android** | ![](demo/screenshots/md_banner.png)  | ![](demo/screenshots/md_interstitial.png)  | ![](demo/screenshots/md_reward.png)  |
 
 ## Installation
-If you use capacitor 5:
-
-```
-% npm install --save @capacitor-community/admob@5.0.0
-% npx cap update
-```
-
-If you use capacitor 4:
-
-```
-% npm install --save @capacitor-community/admob@4.0.0
-% npx cap update
-```
 
-capacitor 3:
+If you use capacitor 6:
 
 ```
-% npm install --save @capacitor-community/admob@3.3.0
+% npm install --save @capacitor-community/admob@6
 % npx cap update
 ```
 
@@ -119,34 +106,34 @@ import { AdMob } from '@capacitor-community/admob';
 
 export async function initialize(): Promise<void> {
   await AdMob.initialize();
- 
+
   const [trackingInfo, consentInfo] = await Promise.all([
-   AdMob.trackingAuthorizationStatus(),
-   AdMob.requestConsentInfo(),
+    AdMob.trackingAuthorizationStatus(),
+    AdMob.requestConsentInfo(),
   ]);
- 
+
   if (trackingInfo.status === 'notDetermined') {
-   /**
-    * If you want to explain TrackingAuthorization before showing the iOS dialog,
-    * you can show the modal here.
-    * ex)
-    * const modal = await this.modalCtrl.create({
-    *   component: RequestTrackingPage,
-    * });
-    * await modal.present();
-    * await modal.onDidDismiss();  // Wait for close modal
-    **/
- 
-   await AdMob.requestTrackingAuthorization();
+    /**
+     * If you want to explain TrackingAuthorization before showing the iOS dialog,
+     * you can show the modal here.
+     * ex)
+     * const modal = await this.modalCtrl.create({
+     *   component: RequestTrackingPage,
+     * });
+     * await modal.present();
+     * await modal.onDidDismiss();  // Wait for close modal
+     **/
+
+    await AdMob.requestTrackingAuthorization();
   }
 
   const authorizationStatus = await AdMob.trackingAuthorizationStatus();
   if (
-          authorizationStatus.status === 'authorized' &&
-          consentInfo.isConsentFormAvailable &&
-          consentInfo.status === AdmobConsentStatus.REQUIRED
+    authorizationStatus.status === 'authorized' &&
+    consentInfo.isConsentFormAvailable &&
+    consentInfo.status === AdmobConsentStatus.REQUIRED
   ) {
-   await AdMob.showConsentForm();
+    await AdMob.showConsentForm();
   }
 }
 ```
@@ -180,10 +167,10 @@ async showConsent() {
 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).
 
 ```ts
-  const consentInfo = await AdMob.requestConsentInfo({
-    debugGeography: AdmobConsentDebugGeography.EEA,
-    testDeviceIdentifiers: ['YOUR_DEVICE_ID']
-  });
+const consentInfo = await AdMob.requestConsentInfo({
+  debugGeography: AdmobConsentDebugGeography.EEA,
+  testDeviceIdentifiers: ['YOUR_DEVICE_ID'],
+});
 ```
 
 **Note**: When testing, if you choose not consent (Manage -> Confirm Choices). The ads may not load/show. Even on testing enviroment. This is normal. It will work on Production so don't worry.
@@ -193,38 +180,53 @@ If you testing on real device, you have to set `debugGeography` and add your dev
 1. AdMob.initialize
 2. AdMob.requestConsentInfo
 3. AdMob.showConsentForm (If consent form required )
-3/ AdMob.showBanner
+   3/ AdMob.showBanner
 
 ### Show Banner
 
 ```ts
-import { AdMob, BannerAdOptions, BannerAdSize, BannerAdPosition, BannerAdPluginEvents, AdMobBannerSize } from '@capacitor-community/admob';
+import {
+  AdMob,
+  BannerAdOptions,
+  BannerAdSize,
+  BannerAdPosition,
+  BannerAdPluginEvents,
+  AdMobBannerSize,
+} from '@capacitor-community/admob';
 
 export async function banner(): Promise<void> {
-    AdMob.addListener(BannerAdPluginEvents.Loaded, () => {
-      // Subscribe Banner Event Listener
-    });
+  AdMob.addListener(BannerAdPluginEvents.Loaded, () => {
+    // Subscribe Banner Event Listener
+  });
 
-    AdMob.addListener(BannerAdPluginEvents.SizeChanged, (size: AdMobBannerSize) => {
+  AdMob.addListener(
+    BannerAdPluginEvents.SizeChanged,
+    (size: AdMobBannerSize) => {
       // Subscribe Change Banner Size
-    });
-
-    const options: BannerAdOptions = {
-      adId: 'YOUR ADID',
-      adSize: BannerAdSize.BANNER,
-      position: BannerAdPosition.BOTTOM_CENTER,
-      margin: 0,
-      // isTesting: true
-      // npa: true
-    };
-    AdMob.showBanner(options);
+    },
+  );
+
+  const options: BannerAdOptions = {
+    adId: 'YOUR ADID',
+    adSize: BannerAdSize.BANNER,
+    position: BannerAdPosition.BOTTOM_CENTER,
+    margin: 0,
+    // isTesting: true
+    // npa: true
+  };
+  AdMob.showBanner(options);
 }
 ```
 
 ### Show Interstitial
 
 ```ts
-import { AdMob, AdOptions, AdLoadInfo, InterstitialAdPluginEvents } from '@capacitor-community/admob';
+import {
+  AdMob,
+  AdOptions,
+  AdLoadInfo,
+  InterstitialAdPluginEvents,
+} from '@capacitor-community/admob';
 
 export async function interstitial(): Promise<void> {
   AdMob.addListener(InterstitialAdPluginEvents.Loaded, (info: AdLoadInfo) => {
@@ -244,17 +246,26 @@ export async function interstitial(): Promise<void> {
 ### Show RewardVideo
 
 ```ts
-import { AdMob, RewardAdOptions, AdLoadInfo, RewardAdPluginEvents, AdMobRewardItem } from '@capacitor-community/admob';
+import {
+  AdMob,
+  RewardAdOptions,
+  AdLoadInfo,
+  RewardAdPluginEvents,
+  AdMobRewardItem,
+} from '@capacitor-community/admob';
 
 export async function rewardVideo(): Promise<void> {
   AdMob.addListener(RewardAdPluginEvents.Loaded, (info: AdLoadInfo) => {
     // Subscribe prepared rewardVideo
   });
 
-  AdMob.addListener(RewardAdPluginEvents.Rewarded, (rewardItem: AdMobRewardItem) => {
-    // Subscribe user rewarded
-    console.log(rewardItem);
-  });
+  AdMob.addListener(
+    RewardAdPluginEvents.Rewarded,
+    (rewardItem: AdMobRewardItem) => {
+      // Subscribe user rewarded
+      console.log(rewardItem);
+    },
+  );
 
   const options: RewardAdOptions = {
     adId: 'YOUR ADID',
@@ -271,27 +282,31 @@ export async function rewardVideo(): Promise<void> {
 ```
 
 ## Server-side Verification Notice
+
 SSV callbacks are only fired on Production Adverts, therefore test Ads will not fire off your SSV callback.
 
 For E2E tests or just for validating the data in your `RewardAdOptions` work as expected, you can add a custom GET
 request to your mock endpoint after the `RewardAdPluginEvents.Rewarded` similar to this:
+
 ```ts
 AdMob.addListener(RewardAdPluginEvents.Rewarded, async () => {
   // ...
   if (ENVIRONMENT_IS_DEVELOPMENT) {
     try {
-      const url = `https://your-staging-ssv-endpoint` + new URLSearchParams({
-        'ad_network': 'TEST',
-        'ad_unit': 'TEST',
-        'custom_data': customData, // <-- passed CustomData
-        'reward_amount': 'TEST',
-        'reward_item': 'TEST',
-        'timestamp': 'TEST',
-        'transaction_id': 'TEST',
-        'user_id': userId, // <-- Passed UserID
-        'signature': 'TEST',
-        'key_id': 'TEST'
-      });
+      const url =
+        `https://your-staging-ssv-endpoint` +
+        new URLSearchParams({
+          ad_network: 'TEST',
+          ad_unit: 'TEST',
+          custom_data: customData, // <-- passed CustomData
+          reward_amount: 'TEST',
+          reward_item: 'TEST',
+          timestamp: 'TEST',
+          transaction_id: 'TEST',
+          user_id: userId, // <-- Passed UserID
+          signature: 'TEST',
+          key_id: 'TEST',
+        });
       await fetch(url);
     } catch (err) {
       console.error(err);
@@ -301,8 +316,8 @@ AdMob.addListener(RewardAdPluginEvents.Rewarded, async () => {
 });
 ```
 
-
 ## Index
+
 <docgen-index>
 
 * [`initialize(...)`](#initialize)
@@ -338,6 +353,14 @@ AdMob.addListener(RewardAdPluginEvents.Rewarded, async () => {
 * [`addListener(RewardAdPluginEvents.Dismissed, ...)`](#addlistenerrewardadplugineventsdismissed-)
 * [`addListener(RewardAdPluginEvents.FailedToShow, ...)`](#addlistenerrewardadplugineventsfailedtoshow-)
 * [`addListener(RewardAdPluginEvents.Showed, ...)`](#addlistenerrewardadplugineventsshowed-)
+* [`prepareRewardInterstitialAd(...)`](#preparerewardinterstitialad)
+* [`showRewardInterstitialAd()`](#showrewardinterstitialad)
+* [`addListener(RewardInterstitialAdPluginEvents.FailedToLoad, ...)`](#addlistenerrewardinterstitialadplugineventsfailedtoload-)
+* [`addListener(RewardInterstitialAdPluginEvents.Loaded, ...)`](#addlistenerrewardinterstitialadplugineventsloaded-)
+* [`addListener(RewardInterstitialAdPluginEvents.Rewarded, ...)`](#addlistenerrewardinterstitialadplugineventsrewarded-)
+* [`addListener(RewardInterstitialAdPluginEvents.Dismissed, ...)`](#addlistenerrewardinterstitialadplugineventsdismissed-)
+* [`addListener(RewardInterstitialAdPluginEvents.FailedToShow, ...)`](#addlistenerrewardinterstitialadplugineventsfailedtoshow-)
+* [`addListener(RewardInterstitialAdPluginEvents.Showed, ...)`](#addlistenerrewardinterstitialadplugineventsshowed-)
 * [Interfaces](#interfaces)
 * [Type Aliases](#type-aliases)
 * [Enums](#enums)
@@ -345,13 +368,14 @@ AdMob.addListener(RewardAdPluginEvents.Rewarded, async () => {
 </docgen-index>
 
 ## API
+
 <docgen-api>
 <!--Update the source file JSDoc comments and rerun docgen to update the docs below-->
 
 ### initialize(...)
 
 ```typescript
-initialize(options?: AdMobInitializationOptions) => Promise<void>
+initialize(options?: AdMobInitializationOptions | undefined) => Promise<void>
 ```
 
 Initialize AdMob with <a href="#admobinitializationoptions">AdMobInitializationOptions</a>
@@ -360,6 +384,8 @@ Initialize AdMob with <a href="#admobinitializationoptions">AdMobInitializationO
 | ------------- | --------------------------------------------------------------------------------- | -------------------------------------------------------------------- |
 | **`options`** | <code><a href="#admobinitializationoptions">AdMobInitializationOptions</a></code> | <a href="#admobinitializationoptions">AdMobInitializationOptions</a> |
 
+**Since:** 1.1.2
+
 --------------------
 
 
@@ -373,6 +399,8 @@ Confirm requestTrackingAuthorization status (iOS &gt;14)
 
 **Returns:** <code>Promise&lt;<a href="#trackingauthorizationstatusinterface">TrackingAuthorizationStatusInterface</a>&gt;</code>
 
+**Since:** 3.1.0
+
 --------------------
 
 
@@ -385,6 +413,8 @@ requestTrackingAuthorization() => Promise<void>
 request requestTrackingAuthorization (iOS &gt;14).
 This is deprecated method. We recommend UMP Consent.
 
+**Since:** 5.2.0
+
 --------------------
 
 
@@ -400,6 +430,8 @@ Report application mute state to AdMob SDK
 | ------------- | --------------------------------------------------------------------------- |
 | **`options`** | <code><a href="#applicationmutedoptions">ApplicationMutedOptions</a></code> |
 
+**Since:** 4.1.1
+
 --------------------
 
 
@@ -415,6 +447,8 @@ Report application volume to AdMob SDK
 | ------------- | ----------------------------------------------------------------------------- |
 | **`options`** | <code><a href="#applicationvolumeoptions">ApplicationVolumeOptions</a></code> |
 
+**Since:** 4.1.1
+
 --------------------
 
 
@@ -430,6 +464,8 @@ Show a banner Ad
 | ------------- | ----------------------------------------------------------- | ---------------------------------- |
 | **`options`** | <code><a href="#banneradoptions">BannerAdOptions</a></code> | <a href="#adoptions">AdOptions</a> |
 
+**Since:** 1.1.2
+
 --------------------
 
 
@@ -441,6 +477,8 @@ hideBanner() => Promise<void>
 
 Hide the banner, remove it from screen, but can show it later
 
+**Since:** 1.1.2
+
 --------------------
 
 
@@ -452,6 +490,8 @@ resumeBanner() => Promise<void>
 
 Resume the banner, show it after hide
 
+**Since:** 1.1.2
+
 --------------------
 
 
@@ -463,6 +503,8 @@ removeBanner() => Promise<void>
 
 Destroy the banner, remove it from screen.
 
+**Since:** 1.1.2
+
 --------------------
 
 
@@ -479,6 +521,8 @@ addListener(eventName: BannerAdPluginEvents.SizeChanged, listenerFunc: (info: Ad
 
 **Returns:** <code>Promise&lt;<a href="#pluginlistenerhandle">PluginListenerHandle</a>&gt;</code>
 
+**Since:** 3.0.0
+
 --------------------
 
 
@@ -497,6 +541,8 @@ Notice: request loaded Banner ad
 
 **Returns:** <code>Promise&lt;<a href="#pluginlistenerhandle">PluginListenerHandle</a>&gt;</code>
 
+**Since:** 3.0.0
+
 --------------------
 
 
@@ -515,6 +561,8 @@ Notice: request failed Banner ad
 
 **Returns:** <code>Promise&lt;<a href="#pluginlistenerhandle">PluginListenerHandle</a>&gt;</code>
 
+**Since:** 3.0.0
+
 --------------------
 
 
@@ -533,6 +581,8 @@ Notice: full-screen banner view will be presented in response to the user clicki
 
 **Returns:** <code>Promise&lt;<a href="#pluginlistenerhandle">PluginListenerHandle</a>&gt;</code>
 
+**Since:** 3.0.0
+
 --------------------
 
 
@@ -551,6 +601,8 @@ Notice: The full-screen banner view will been dismissed.
 
 **Returns:** <code>Promise&lt;<a href="#pluginlistenerhandle">PluginListenerHandle</a>&gt;</code>
 
+**Since:** 3.0.0
+
 --------------------
 
 
@@ -569,13 +621,15 @@ Unimplemented
 
 **Returns:** <code>Promise&lt;<a href="#pluginlistenerhandle">PluginListenerHandle</a>&gt;</code>
 
+**Since:** 3.0.0
+
 --------------------
 
 
 ### requestConsentInfo(...)
 
 ```typescript
-requestConsentInfo(options?: AdmobConsentRequestOptions) => Promise<AdmobConsentInfo>
+requestConsentInfo(options?: AdmobConsentRequestOptions | undefined) => Promise<AdmobConsentInfo>
 ```
 
 Request user consent information
@@ -586,6 +640,8 @@ Request user consent information
 
 **Returns:** <code>Promise&lt;<a href="#admobconsentinfo">AdmobConsentInfo</a>&gt;</code>
 
+**Since:** 5.0.0
+
 --------------------
 
 
@@ -599,6 +655,8 @@ Shows a google user consent form (rendered from your GDPR message config).
 
 **Returns:** <code>Promise&lt;<a href="#admobconsentinfo">AdmobConsentInfo</a>&gt;</code>
 
+**Since:** 5.0.0
+
 --------------------
 
 
@@ -610,6 +668,8 @@ resetConsentInfo() => Promise<void>
 
 Resets the UMP SDK state. Call requestConsentInfo function again to allow user modify their consent
 
+**Since:** 5.0.0
+
 --------------------
 
 
@@ -627,6 +687,8 @@ Prepare interstitial banner
 
 **Returns:** <code>Promise&lt;<a href="#adloadinfo">AdLoadInfo</a>&gt;</code>
 
+**Since:** 1.1.2
+
 --------------------
 
 
@@ -638,6 +700,8 @@ showInterstitial() => Promise<void>
 
 Show interstitial ad when it’s ready
 
+**Since:** 1.1.2
+
 --------------------
 
 
@@ -735,6 +799,8 @@ Prepare a reward video ad
 
 **Returns:** <code>Promise&lt;<a href="#adloadinfo">AdLoadInfo</a>&gt;</code>
 
+**Since:** 1.1.2
+
 --------------------
 
 
@@ -748,6 +814,8 @@ Show a reward video ad
 
 **Returns:** <code>Promise&lt;<a href="#admobrewarditem">AdMobRewardItem</a>&gt;</code>
 
+**Since:** 1.1.2
+
 --------------------
 
 
@@ -847,18 +915,148 @@ addListener(eventName: RewardAdPluginEvents.Showed, listenerFunc: () => void) =>
 --------------------
 
 
+### prepareRewardInterstitialAd(...)
+
+```typescript
+prepareRewardInterstitialAd(options: RewardInterstitialAdOptions) => Promise<AdLoadInfo>
+```
+
+Prepare a reward video ad
+
+| Param         | Type                                                                                | Description                                    |
+| ------------- | ----------------------------------------------------------------------------------- | ---------------------------------------------- |
+| **`options`** | <code><a href="#rewardinterstitialadoptions">RewardInterstitialAdOptions</a></code> | <a href="#rewardadoptions">RewardAdOptions</a> |
+
+**Returns:** <code>Promise&lt;<a href="#adloadinfo">AdLoadInfo</a>&gt;</code>
+
+**Since:** 1.1.2
+
+--------------------
+
+
+### showRewardInterstitialAd()
+
+```typescript
+showRewardInterstitialAd() => Promise<AdMobRewardInterstitialItem>
+```
+
+Show a reward video ad
+
+**Returns:** <code>Promise&lt;<a href="#admobrewardinterstitialitem">AdMobRewardInterstitialItem</a>&gt;</code>
+
+**Since:** 1.1.2
+
+--------------------
+
+
+### addListener(RewardInterstitialAdPluginEvents.FailedToLoad, ...)
+
+```typescript
+addListener(eventName: RewardInterstitialAdPluginEvents.FailedToLoad, listenerFunc: (error: AdMobError) => void) => Promise<PluginListenerHandle>
+```
+
+| Param              | Type                                                                                                       |
+| ------------------ | ---------------------------------------------------------------------------------------------------------- |
+| **`eventName`**    | <code><a href="#rewardinterstitialadpluginevents">RewardInterstitialAdPluginEvents.FailedToLoad</a></code> |
+| **`listenerFunc`** | <code>(error: <a href="#admoberror">AdMobError</a>) =&gt; void</code>                                      |
+
+**Returns:** <code>Promise&lt;<a href="#pluginlistenerhandle">PluginListenerHandle</a>&gt;</code>
+
+--------------------
+
+
+### addListener(RewardInterstitialAdPluginEvents.Loaded, ...)
+
+```typescript
+addListener(eventName: RewardInterstitialAdPluginEvents.Loaded, listenerFunc: (info: AdLoadInfo) => void) => Promise<PluginListenerHandle>
+```
+
+| Param              | Type                                                                                                 |
+| ------------------ | ---------------------------------------------------------------------------------------------------- |
+| **`eventName`**    | <code><a href="#rewardinterstitialadpluginevents">RewardInterstitialAdPluginEvents.Loaded</a></code> |
+| **`listenerFunc`** | <code>(info: <a href="#adloadinfo">AdLoadInfo</a>) =&gt; void</code>                                 |
+
+**Returns:** <code>Promise&lt;<a href="#pluginlistenerhandle">PluginListenerHandle</a>&gt;</code>
+
+--------------------
+
+
+### addListener(RewardInterstitialAdPluginEvents.Rewarded, ...)
+
+```typescript
+addListener(eventName: RewardInterstitialAdPluginEvents.Rewarded, listenerFunc: (reward: AdMobRewardInterstitialItem) => void) => Promise<PluginListenerHandle>
+```
+
+| Param              | Type                                                                                                     |
+| ------------------ | -------------------------------------------------------------------------------------------------------- |
+| **`eventName`**    | <code><a href="#rewardinterstitialadpluginevents">RewardInterstitialAdPluginEvents.Rewarded</a></code>   |
+| **`listenerFunc`** | <code>(reward: <a href="#admobrewardinterstitialitem">AdMobRewardInterstitialItem</a>) =&gt; void</code> |
+
+**Returns:** <code>Promise&lt;<a href="#pluginlistenerhandle">PluginListenerHandle</a>&gt;</code>
+
+--------------------
+
+
+### addListener(RewardInterstitialAdPluginEvents.Dismissed, ...)
+
+```typescript
+addListener(eventName: RewardInterstitialAdPluginEvents.Dismissed, listenerFunc: () => void) => Promise<PluginListenerHandle>
+```
+
+| Param              | Type                                                                                                    |
+| ------------------ | ------------------------------------------------------------------------------------------------------- |
+| **`eventName`**    | <code><a href="#rewardinterstitialadpluginevents">RewardInterstitialAdPluginEvents.Dismissed</a></code> |
+| **`listenerFunc`** | <code>() =&gt; void</code>                                                                              |
+
+**Returns:** <code>Promise&lt;<a href="#pluginlistenerhandle">PluginListenerHandle</a>&gt;</code>
+
+--------------------
+
+
+### addListener(RewardInterstitialAdPluginEvents.FailedToShow, ...)
+
+```typescript
+addListener(eventName: RewardInterstitialAdPluginEvents.FailedToShow, listenerFunc: (error: AdMobError) => void) => Promise<PluginListenerHandle>
+```
+
+| Param              | Type                                                                                                       |
+| ------------------ | ---------------------------------------------------------------------------------------------------------- |
+| **`eventName`**    | <code><a href="#rewardinterstitialadpluginevents">RewardInterstitialAdPluginEvents.FailedToShow</a></code> |
+| **`listenerFunc`** | <code>(error: <a href="#admoberror">AdMobError</a>) =&gt; void</code>                                      |
+
+**Returns:** <code>Promise&lt;<a href="#pluginlistenerhandle">PluginListenerHandle</a>&gt;</code>
+
+--------------------
+
+
+### addListener(RewardInterstitialAdPluginEvents.Showed, ...)
+
+```typescript
+addListener(eventName: RewardInterstitialAdPluginEvents.Showed, listenerFunc: () => void) => Promise<PluginListenerHandle>
+```
+
+| Param              | Type                                                                                                 |
+| ------------------ | ---------------------------------------------------------------------------------------------------- |
+| **`eventName`**    | <code><a href="#rewardinterstitialadpluginevents">RewardInterstitialAdPluginEvents.Showed</a></code> |
+| **`listenerFunc`** | <code>() =&gt; void</code>                                                                           |
+
+**Returns:** <code>Promise&lt;<a href="#pluginlistenerhandle">PluginListenerHandle</a>&gt;</code>
+
+--------------------
+
+
 ### Interfaces
 
 
 #### AdMobInitializationOptions
 
-| Prop                               | Type                                                              | Description                                                                                                                                                                                                                                                 |
-| ---------------------------------- | ----------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
-| **`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'). |
-| **`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.                                                                               |
-| **`tagForChildDirectedTreatment`** | <code>boolean</code>                                              | For purposes of the Children's Online Privacy Protection Act (COPPA), there is a setting called tagForChildDirectedTreatment.                                                                                                                               |
-| **`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.                                                                                                                    |
-| **`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.                                                                                                                          |
+| Prop                               | Type                                                              | Description                                                                                                                                                                                                                                                 | Default            | Since |
+| ---------------------------------- | ----------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------ | ----- |
+| **`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 |
+| **`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 |
+| **`tagForChildDirectedTreatment`** | <code>boolean</code>                                              | For purposes of the Children's Online Privacy Protection Act (COPPA), there is a setting called tagForChildDirectedTreatment.                                                                                                                               |                    | 3.1.0 |
+| **`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 |
+| **`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 |
 
 
 #### TrackingAuthorizationStatusInterface
@@ -870,26 +1068,26 @@ addListener(eventName: RewardAdPluginEvents.Showed, listenerFunc: () => void) =>
 
 #### ApplicationMutedOptions
 
-| Prop        | Type                 | Description                                                                                                                                                                                                                                                                                           |
-| ----------- | -------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
-| **`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. |
+| Prop        | Type                 | Description                                                                                                                                                                                                                                                                                           | Since |
+| ----------- | -------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----- |
+| **`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 |
 
 
 #### ApplicationVolumeOptions
 
-| Prop         | Type                                                                               | Description                                                                                                                                                                                                                          |
-| ------------ | ---------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
-| **`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. |
+| Prop         | Type                                                                               | Description                                                                                                                                                                                                                          | Since |
+| ------------ | ---------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ----- |
+| **`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 |
 
 
 #### BannerAdOptions
 
 This interface extends <a href="#adoptions">AdOptions</a>
 
-| Prop           | Type                                                          | Description                                                                                                                               |
-| -------------- | ------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------- |
-| **`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 |
-| **`position`** | <code><a href="#banneradposition">BannerAdPosition</a></code> | Set Banner Ad position. TOP_CENTER or CENTER or BOTTOM_CENTER                                                                             |
+| Prop           | Type                                                          | Description                                                                                                                               | Default                      | Since |
+| -------------- | ------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------- | ----- |
+| **`adSize`**   | <code><a href="#banneradsize">BannerAdSize</a></code>         | Banner Ad Size, defaults to ADAPTIVE_BANNER. IT can be: ADAPTIVE_BANNER, SMART_BANNER, BANNER, MEDIUM_RECTANGLE, FULL_BANNER, LEADERBOARD | <code>ADAPTIVE_BANNER</code> | 3.0.0 |
+| **`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 |
 
 
 #### PluginListenerHandle
@@ -922,19 +1120,19 @@ https://developers.google.com/android/reference/com/google/android/gms/ads/AdErr
 
 #### AdmobConsentInfo
 
-| Prop                         | Type                                                              | Description                                           |
-| ---------------------------- | ----------------------------------------------------------------- | ----------------------------------------------------- |
-| **`status`**                 | <code><a href="#admobconsentstatus">AdmobConsentStatus</a></code> | The consent status of the user.                       |
-| **`isConsentFormAvailable`** | <code>boolean</code>                                              | If `true` a consent form is available and vice versa. |
+| Prop                         | Type                                                              | Description                                           | Since |
+| ---------------------------- | ----------------------------------------------------------------- | ----------------------------------------------------- | ----- |
+| **`status`**                 | <code><a href="#admobconsentstatus">AdmobConsentStatus</a></code> | The consent status of the user.                       | 5.0.0 |
+| **`isConsentFormAvailable`** | <code>boolean</code>                                              | If `true` a consent form is available and vice versa. | 5.0.0 |
 
 
 #### AdmobConsentRequestOptions
 
-| Prop                          | Type                                                                              | Description                                                                                                  |
-| ----------------------------- | --------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------ |
-| **`debugGeography`**          | <code><a href="#admobconsentdebuggeography">AdmobConsentDebugGeography</a></code> | Sets the debug geography to test the consent locally.                                                        |
-| **`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. |
-| **`tagForUnderAgeOfConsent`** | <code>boolean</code>                                                              | Set to `true` to provide the option for the user to accept being shown personalized ads.                     |
+| Prop                          | Type                                                                              | Description                                                                                                  | Default            | Since |
+| ----------------------------- | --------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------ | ------------------ | ----- |
+| **`debugGeography`**          | <code><a href="#admobconsentdebuggeography">AdmobConsentDebugGeography</a></code> | Sets the debug geography to test the consent locally.                                                        |                    | 5.0.0 |
+| **`testDeviceIdentifiers`**   | <code>string[]</code>                                                             | An array of test device IDs to allow. Note: On iOS, the ID may renew if you uninstall and reinstall the app. |                    | 5.0.0 |
+| **`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 |
 
 
 #### AdLoadInfo
@@ -946,12 +1144,12 @@ https://developers.google.com/android/reference/com/google/android/gms/ads/AdErr
 
 #### AdOptions
 
-| Prop            | Type                 | Description                                                                                                                                  |
-| --------------- | -------------------- | -------------------------------------------------------------------------------------------------------------------------------------------- |
-| **`adId`**      | <code>string</code>  | The ad unit ID that you want to request                                                                                                      |
-| **`isTesting`** | <code>boolean</code> | You can use test mode of ad.                                                                                                                 |
-| **`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. |
-| **`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             |
+| Prop            | Type                 | Description                                                                                                                                  | Default            | Since |
+| --------------- | -------------------- | -------------------------------------------------------------------------------------------------------------------------------------------- | ------------------ | ----- |
+| **`adId`**      | <code>string</code>  | The ad unit ID that you want to request                                                                                                      |                    | 1.1.2 |
+| **`isTesting`** | <code>boolean</code> | You can use test mode of ad.                                                                                                                 | <code>false</code> | 1.1.2 |
+| **`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 |
+| **`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 |
 
 
 #### RewardAdOptions
@@ -972,6 +1170,24 @@ https://developers.google.com/admob/android/rewarded-video-adapters?hl=en
 | **`amount`** | <code>number</code> | Rewarded amount user got |
 
 
+#### RewardInterstitialAdOptions
+
+| Prop      | Type                                                                                                                                                                                                                                               | Description                                                                                                                                                                                     |
+| --------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| **`ssv`** | <code><a href="#atleastone">AtLeastOne</a>&lt;{ /** * 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; }&gt;</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. |
+
+
+#### AdMobRewardInterstitialItem
+
+For more information
+https://developers.google.com/admob/android/rewarded-video-adapters?hl=en
+
+| Prop         | Type                | Description              |
+| ------------ | ------------------- | ------------------------ |
+| **`type`**   | <code>string</code> | Rewarded type user got   |
+| **`amount`** | <code>number</code> | Rewarded amount user got |
+
+
 ### Type Aliases
 
 
@@ -1075,6 +1291,18 @@ From T, pick a set of properties whose keys are in the union K
 | **`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. |
 | **`Rewarded`**     | <code>'onRewardedVideoAdReward'</code>       | Emits when user get rewarded from AdReward                                                                                                                                                                                                                                                                                                             |
 
+
+#### RewardInterstitialAdPluginEvents
+
+| Members            | Value                                               | Description                                                                                                                                                                                                                                                                                                                                            |
+| ------------------ | --------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
+| **`Loaded`**       | <code>'onRewardedInterstitialAdLoaded'</code>       | Emits after trying to prepare a RewardAd and the Video is loaded and ready to be show                                                                                                                                                                                                                                                                  |
+| **`FailedToLoad`** | <code>'onRewardedInterstitialAdFailedToLoad'</code> | Emits after trying to prepare a RewardAd when it could not be loaded                                                                                                                                                                                                                                                                                   |
+| **`Showed`**       | <code>'onRewardedInterstitialAdShowed'</code>       | Emits when the AdReward video is visible to the user                                                                                                                                                                                                                                                                                                   |
+| **`FailedToShow`** | <code>'onRewardedInterstitialAdFailedToShow'</code> | Emits when the AdReward video is failed to show                                                                                                                                                                                                                                                                                                        |
+| **`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. |
+| **`Rewarded`**     | <code>'onRewardedInterstitialAdReward'</code>       | Emits when user get rewarded from AdReward                                                                                                                                                                                                                                                                                                             |
+
 </docgen-api>
 
 ## TROUBLE SHOOTING