@capacitor-community/admob 8.0.0 → 8.1.0

package/dist/esm/interstitial/interstitial-ad-plugin-events.enum.js

@@ -2,24 +2,28 @@
 export var InterstitialAdPluginEvents;
 (function (InterstitialAdPluginEvents) {
     /**
-     * Emits after trying to prepare and Interstitial, when it is loaded and ready to be show
+     * Emits when an interstitial ad has loaded and is ready to show.
      */
     InterstitialAdPluginEvents["Loaded"] = "interstitialAdLoaded";
     /**
-     * Emits after trying to prepare and Interstitial, when it could not be loaded
+     * Emits when an interstitial ad fails to load.
      */
     InterstitialAdPluginEvents["FailedToLoad"] = "interstitialAdFailedToLoad";
     /**
-     * Emits when the Interstitial ad is visible to the user
+     * Emits when an interstitial ad is shown.
      */
     InterstitialAdPluginEvents["Showed"] = "interstitialAdShowed";
     /**
-     * Emits when the Interstitial ad is failed to show
+     * Emits when a loaded interstitial ad fails to show.
      */
     InterstitialAdPluginEvents["FailedToShow"] = "interstitialAdFailedToShow";
     /**
-     * Emits when the Interstitial ad is not visible to the user anymore.
+     * Emits when an interstitial ad is dismissed.
      */
     InterstitialAdPluginEvents["Dismissed"] = "interstitialAdDismissed";
+    /**
+     * Emits impression-level ad revenue data when a paid event is recorded.
+     */
+    InterstitialAdPluginEvents["AdImpression"] = "interstitialAdImpression";
 })(InterstitialAdPluginEvents || (InterstitialAdPluginEvents = {}));
 //# sourceMappingURL=interstitial-ad-plugin-events.enum.js.map

package/dist/esm/interstitial/interstitial-ad-plugin-events.enum.js.map

@@ -1 +1 @@
-{"version":3,"file":"interstitial-ad-plugin-events.enum.js","sourceRoot":"","sources":["../../../src/interstitial/interstitial-ad-plugin-events.enum.ts"],"names":[],"mappings":"AAAA,oFAAoF;AACpF,MAAM,CAAN,IAAY,0BAqBX;AArBD,WAAY,0BAA0B;IACpC;;OAEG;IACH,6DAA+B,CAAA;IAC/B;;OAEG;IACH,yEAA2C,CAAA;IAC3C;;OAEG;IACH,6DAA+B,CAAA;IAC/B;;OAEG;IACH,yEAA2C,CAAA;IAC3C;;OAEG;IACH,mEAAoC,CAAA;AACtC,CAAC,EArBW,0BAA0B,KAA1B,0BAA0B,QAqBrC"}
+{"version":3,"file":"interstitial-ad-plugin-events.enum.js","sourceRoot":"","sources":["../../../src/interstitial/interstitial-ad-plugin-events.enum.ts"],"names":[],"mappings":"AAAA,oFAAoF;AACpF,MAAM,CAAN,IAAY,0BAyBX;AAzBD,WAAY,0BAA0B;IACpC;;OAEG;IACH,6DAA+B,CAAA;IAC/B;;OAEG;IACH,yEAA2C,CAAA;IAC3C;;OAEG;IACH,6DAA+B,CAAA;IAC/B;;OAEG;IACH,yEAA2C,CAAA;IAC3C;;OAEG;IACH,mEAAoC,CAAA;IACpC;;OAEG;IACH,uEAAyC,CAAA;AAC3C,CAAC,EAzBW,0BAA0B,KAA1B,0BAA0B,QAyBrC"}

package/dist/esm/interstitial/interstitial-definitions.interface.d.ts

@@ -1,11 +1,11 @@
 import type { PluginListenerHandle } from '@capacitor/core';
 import type { ValidateAllEventsEnumAreImplemented } from '../private/validate-all-events-implemented.type';
-import type { AdLoadInfo, AdMobError, AdOptions } from '../shared';
+import type { AdLoadInfo, AdMobError, AdMobRevenueData, AdOptions, AdShowOptions } from '../shared';
 import type { InterstitialAdPluginEvents } from './interstitial-ad-plugin-events.enum';
 export type InterstitialDefinitionsHasAllEvents = ValidateAllEventsEnumAreImplemented<InterstitialAdPluginEvents, InterstitialDefinitions>;
 export interface InterstitialDefinitions {
     /**
-     * Prepare interstitial banner
+     * Loads an interstitial ad and returns the loaded ad unit ID.
      *
      * @group Interstitial
      * @param options AdOptions
@@ -13,15 +13,35 @@ export interface InterstitialDefinitions {
      */
     prepareInterstitial(options: AdOptions): Promise<AdLoadInfo>;
     /**
-     * Show interstitial ad when it’s ready
+     * Shows a loaded interstitial ad.
      *
      * @group Interstitial
+     * @param options Optional. Pass { adId } to show a specific prepared ad instead of the most recent one.
      * @since 1.1.2
      */
-    showInterstitial(): Promise<void>;
+    showInterstitial(options?: AdShowOptions): Promise<void>;
+    /**
+     * Listens for interstitial ad load failures.
+     */
     addListener(eventName: InterstitialAdPluginEvents.FailedToLoad, listenerFunc: (error: AdMobError) => void): Promise<PluginListenerHandle>;
+    /**
+     * Listens for interstitial ad load events.
+     */
     addListener(eventName: InterstitialAdPluginEvents.Loaded, listenerFunc: (info: AdLoadInfo) => void): Promise<PluginListenerHandle>;
+    /**
+     * Listens for interstitial ad dismissed events.
+     */
     addListener(eventName: InterstitialAdPluginEvents.Dismissed, listenerFunc: () => void): Promise<PluginListenerHandle>;
+    /**
+     * Listens for interstitial ad show failures.
+     */
     addListener(eventName: InterstitialAdPluginEvents.FailedToShow, listenerFunc: (error: AdMobError) => void): Promise<PluginListenerHandle>;
+    /**
+     * Listens for interstitial ad shown events.
+     */
     addListener(eventName: InterstitialAdPluginEvents.Showed, listenerFunc: () => void): Promise<PluginListenerHandle>;
+    /**
+     * Listens for interstitial impression-level ad revenue events.
+     */
+    addListener(eventName: InterstitialAdPluginEvents.AdImpression, listenerFunc: (data: AdMobRevenueData) => void): Promise<PluginListenerHandle>;
 }

package/dist/esm/reward/reward-ad-options.interface.d.ts

@@ -2,22 +2,23 @@ import type { AdOptions } from '../shared/ad-options.interface';
 type AtLeastOne<T> = {
     [K in keyof T]: Pick<T, K>;
 }[keyof T];
+/**
+ * Options for loading a rewarded ad.
+ */
 export interface RewardAdOptions extends AdOptions {
     /**
-     * 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.
+     * Server-side verification options for the rewarded ad.
+     * Provide at least one of `userId` or `customData`.
      *
      * @see https://support.google.com/admob/answer/9603226?hl=en-GB
      */
     ssv?: AtLeastOne<{
         /**
-         * An optional UserId to pass to your SSV callback function.
+         * A user identifier passed to the SSV callback.
          */
         userId: string;
         /**
-         * An optional custom set of data to pass to your SSV callback function.
+         * Custom data passed to the SSV callback.
          */
         customData: string;
     }>;

package/dist/esm/reward/reward-ad-plugin-events.enum.d.ts

@@ -1,32 +1,33 @@
 export declare enum RewardAdPluginEvents {
     /**
-     * Emits after trying to prepare a RewardAd and the Video is loaded and ready to be show
+     * Emits when a rewarded ad has loaded and is ready to show.
      */
     Loaded = "onRewardedVideoAdLoaded",
     /**
-     * Emits after trying to prepare a RewardAd when it could not be loaded
+     * Emits when a rewarded ad fails to load.
      */
     FailedToLoad = "onRewardedVideoAdFailedToLoad",
     /**
-     * Emits when the AdReward video is visible to the user
+     * Emits when a rewarded ad is shown.
      */
     Showed = "onRewardedVideoAdShowed",
     /**
-     * Emits when the AdReward video is failed to show
+     * Emits when a loaded rewarded ad fails to show.
      */
     FailedToShow = "onRewardedVideoAdFailedToShow",
     /**
-     * Emits when the AdReward video is not visible to the user anymore.
+     * Emits when a rewarded ad is dismissed.
      *
-     * **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.
+     * This event does not indicate whether the user earned a reward. Listen for
+     * `Rewarded` separately before granting the reward.
      */
     Dismissed = "onRewardedVideoAdDismissed",
     /**
-     * Emits when user get rewarded from AdReward
+     * Emits when the user earns the advertised reward.
      */
-    Rewarded = "onRewardedVideoAdReward"
+    Rewarded = "onRewardedVideoAdReward",
+    /**
+     * Emits impression-level ad revenue data when a paid event is recorded.
+     */
+    AdImpression = "onRewardedVideoAdImpression"
 }

package/dist/esm/reward/reward-ad-plugin-events.enum.js

@@ -2,34 +2,35 @@
 export var RewardAdPluginEvents;
 (function (RewardAdPluginEvents) {
     /**
-     * Emits after trying to prepare a RewardAd and the Video is loaded and ready to be show
+     * Emits when a rewarded ad has loaded and is ready to show.
      */
     RewardAdPluginEvents["Loaded"] = "onRewardedVideoAdLoaded";
     /**
-     * Emits after trying to prepare a RewardAd when it could not be loaded
+     * Emits when a rewarded ad fails to load.
      */
     RewardAdPluginEvents["FailedToLoad"] = "onRewardedVideoAdFailedToLoad";
     /**
-     * Emits when the AdReward video is visible to the user
+     * Emits when a rewarded ad is shown.
      */
     RewardAdPluginEvents["Showed"] = "onRewardedVideoAdShowed";
     /**
-     * Emits when the AdReward video is failed to show
+     * Emits when a loaded rewarded ad fails to show.
      */
     RewardAdPluginEvents["FailedToShow"] = "onRewardedVideoAdFailedToShow";
     /**
-     * Emits when the AdReward video is not visible to the user anymore.
+     * Emits when a rewarded ad is dismissed.
      *
-     * **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.
+     * This event does not indicate whether the user earned a reward. Listen for
+     * `Rewarded` separately before granting the reward.
      */
     RewardAdPluginEvents["Dismissed"] = "onRewardedVideoAdDismissed";
     /**
-     * Emits when user get rewarded from AdReward
+     * Emits when the user earns the advertised reward.
      */
     RewardAdPluginEvents["Rewarded"] = "onRewardedVideoAdReward";
+    /**
+     * Emits impression-level ad revenue data when a paid event is recorded.
+     */
+    RewardAdPluginEvents["AdImpression"] = "onRewardedVideoAdImpression";
 })(RewardAdPluginEvents || (RewardAdPluginEvents = {}));
 //# sourceMappingURL=reward-ad-plugin-events.enum.js.map

package/dist/esm/reward/reward-ad-plugin-events.enum.js.map

@@ -1 +1 @@
-{"version":3,"file":"reward-ad-plugin-events.enum.js","sourceRoot":"","sources":["../../../src/reward/reward-ad-plugin-events.enum.ts"],"names":[],"mappings":"AAAA,oFAAoF;AACpF,MAAM,CAAN,IAAY,oBA+BX;AA/BD,WAAY,oBAAoB;IAC9B;;OAEG;IACH,0DAAkC,CAAA;IAClC;;OAEG;IACH,sEAA8C,CAAA;IAC9C;;OAEG;IACH,0DAAkC,CAAA;IAClC;;OAEG;IACH,sEAA8C,CAAA;IAC9C;;;;;;;;OAQG;IACH,gEAAuC,CAAA;IACvC;;OAEG;IACH,4DAAmC,CAAA;AACrC,CAAC,EA/BW,oBAAoB,KAApB,oBAAoB,QA+B/B"}
+{"version":3,"file":"reward-ad-plugin-events.enum.js","sourceRoot":"","sources":["../../../src/reward/reward-ad-plugin-events.enum.ts"],"names":[],"mappings":"AAAA,oFAAoF;AACpF,MAAM,CAAN,IAAY,oBAgCX;AAhCD,WAAY,oBAAoB;IAC9B;;OAEG;IACH,0DAAkC,CAAA;IAClC;;OAEG;IACH,sEAA8C,CAAA;IAC9C;;OAEG;IACH,0DAAkC,CAAA;IAClC;;OAEG;IACH,sEAA8C,CAAA;IAC9C;;;;;OAKG;IACH,gEAAuC,CAAA;IACvC;;OAEG;IACH,4DAAmC,CAAA;IACnC;;OAEG;IACH,oEAA4C,CAAA;AAC9C,CAAC,EAhCW,oBAAoB,KAApB,oBAAoB,QAgC/B"}

package/dist/esm/reward/reward-definitions.interface.d.ts

@@ -1,13 +1,13 @@
 import type { PluginListenerHandle } from '@capacitor/core';
 import type { ValidateAllEventsEnumAreImplemented } from '../private/validate-all-events-implemented.type';
-import type { AdLoadInfo, AdMobError } from '../shared';
+import type { AdLoadInfo, AdMobError, AdMobRevenueData, AdShowOptions } from '../shared';
 import type { RewardAdOptions } from './reward-ad-options.interface';
 import type { RewardAdPluginEvents } from './reward-ad-plugin-events.enum';
 import type { AdMobRewardItem } from './reward-item.interface';
 export type RewardDefinitionsHasAllEvents = ValidateAllEventsEnumAreImplemented<RewardAdPluginEvents, RewardDefinitions>;
 export interface RewardDefinitions {
     /**
-     * Prepare a reward video ad
+     * Loads a rewarded ad and returns the loaded ad unit ID.
      *
      * @group RewardVideo
      * @param options RewardAdOptions
@@ -15,16 +15,39 @@ export interface RewardDefinitions {
      */
     prepareRewardVideoAd(options: RewardAdOptions): Promise<AdLoadInfo>;
     /**
-     * Show a reward video ad
+     * Shows a loaded rewarded ad and resolves when the user earns the reward.
      *
      * @group RewardVideo
+     * @param options Optional. Pass { adId } to show a specific prepared ad instead of the most recent one.
      * @since 1.1.2
      */
-    showRewardVideoAd(): Promise<AdMobRewardItem>;
+    showRewardVideoAd(options?: AdShowOptions): Promise<AdMobRewardItem>;
+    /**
+     * Listens for rewarded ad load failures.
+     */
     addListener(eventName: RewardAdPluginEvents.FailedToLoad, listenerFunc: (error: AdMobError) => void): Promise<PluginListenerHandle>;
+    /**
+     * Listens for rewarded ad load events.
+     */
     addListener(eventName: RewardAdPluginEvents.Loaded, listenerFunc: (info: AdLoadInfo) => void): Promise<PluginListenerHandle>;
+    /**
+     * Listens for earned reward events.
+     */
     addListener(eventName: RewardAdPluginEvents.Rewarded, listenerFunc: (reward: AdMobRewardItem) => void): Promise<PluginListenerHandle>;
+    /**
+     * Listens for rewarded ad dismissed events.
+     */
     addListener(eventName: RewardAdPluginEvents.Dismissed, listenerFunc: () => void): Promise<PluginListenerHandle>;
+    /**
+     * Listens for rewarded ad show failures.
+     */
     addListener(eventName: RewardAdPluginEvents.FailedToShow, listenerFunc: (error: AdMobError) => void): Promise<PluginListenerHandle>;
+    /**
+     * Listens for rewarded ad shown events.
+     */
     addListener(eventName: RewardAdPluginEvents.Showed, listenerFunc: () => void): Promise<PluginListenerHandle>;
+    /**
+     * Listens for rewarded impression-level ad revenue events.
+     */
+    addListener(eventName: RewardAdPluginEvents.AdImpression, listenerFunc: (data: AdMobRevenueData) => void): Promise<PluginListenerHandle>;
 }

package/dist/esm/reward/reward-item.interface.d.ts

@@ -1,14 +1,13 @@
 /**
- * For more information
- * https://developers.google.com/admob/android/rewarded-video-adapters?hl=en
+ * The reward earned by the user after viewing a rewarded ad.
  */
 export interface AdMobRewardItem {
     /**
-     * Rewarded type user got
+     * The reward item type configured for the ad unit.
      */
     type: string;
     /**
-     * Rewarded amount user got
+     * The reward amount earned by the user.
      */
     amount: number;
 }

package/dist/esm/reward-interstitial/reward-interstitial-ad-options.interface.d.ts

@@ -2,22 +2,23 @@ import type { AdOptions } from '../shared/ad-options.interface';
 type AtLeastOne<T> = {
     [K in keyof T]: Pick<T, K>;
 }[keyof T];
+/**
+ * Options for loading a rewarded interstitial ad.
+ */
 export interface RewardInterstitialAdOptions extends AdOptions {
     /**
-     * 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.
+     * Server-side verification options for the rewarded interstitial ad.
+     * Provide at least one of `userId` or `customData`.
      *
      * @see https://support.google.com/admob/answer/9603226?hl=en-GB
      */
     ssv?: AtLeastOne<{
         /**
-         * An optional UserId to pass to your SSV callback function.
+         * A user identifier passed to the SSV callback.
          */
         userId: string;
         /**
-         * An optional custom set of data to pass to your SSV callback function.
+         * Custom data passed to the SSV callback.
          */
         customData: string;
     }>;

package/dist/esm/reward-interstitial/reward-interstitial-ad-plugin-events.enum.d.ts

@@ -1,32 +1,33 @@
 export declare enum RewardInterstitialAdPluginEvents {
     /**
-     * Emits after trying to prepare a RewardAd and the Video is loaded and ready to be show
+     * Emits when a rewarded interstitial ad has loaded and is ready to show.
      */
     Loaded = "onRewardedInterstitialAdLoaded",
     /**
-     * Emits after trying to prepare a RewardAd when it could not be loaded
+     * Emits when a rewarded interstitial ad fails to load.
      */
     FailedToLoad = "onRewardedInterstitialAdFailedToLoad",
     /**
-     * Emits when the AdReward video is visible to the user
+     * Emits when a rewarded interstitial ad is shown.
      */
     Showed = "onRewardedInterstitialAdShowed",
     /**
-     * Emits when the AdReward video is failed to show
+     * Emits when a loaded rewarded interstitial ad fails to show.
      */
     FailedToShow = "onRewardedInterstitialAdFailedToShow",
     /**
-     * Emits when the AdReward video is not visible to the user anymore.
+     * Emits when a rewarded interstitial ad is dismissed.
      *
-     * **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.
+     * This event does not indicate whether the user earned a reward. Listen for
+     * `Rewarded` separately before granting the reward.
      */
     Dismissed = "onRewardedInterstitialAdDismissed",
     /**
-     * Emits when user get rewarded from AdReward
+     * Emits when the user earns the advertised reward.
      */
-    Rewarded = "onRewardedInterstitialAdReward"
+    Rewarded = "onRewardedInterstitialAdReward",
+    /**
+     * Emits impression-level ad revenue data when a paid event is recorded.
+     */
+    AdImpression = "onRewardedInterstitialAdImpression"
 }

package/dist/esm/reward-interstitial/reward-interstitial-ad-plugin-events.enum.js

@@ -2,34 +2,35 @@
 export var RewardInterstitialAdPluginEvents;
 (function (RewardInterstitialAdPluginEvents) {
     /**
-     * Emits after trying to prepare a RewardAd and the Video is loaded and ready to be show
+     * Emits when a rewarded interstitial ad has loaded and is ready to show.
      */
     RewardInterstitialAdPluginEvents["Loaded"] = "onRewardedInterstitialAdLoaded";
     /**
-     * Emits after trying to prepare a RewardAd when it could not be loaded
+     * Emits when a rewarded interstitial ad fails to load.
      */
     RewardInterstitialAdPluginEvents["FailedToLoad"] = "onRewardedInterstitialAdFailedToLoad";
     /**
-     * Emits when the AdReward video is visible to the user
+     * Emits when a rewarded interstitial ad is shown.
      */
     RewardInterstitialAdPluginEvents["Showed"] = "onRewardedInterstitialAdShowed";
     /**
-     * Emits when the AdReward video is failed to show
+     * Emits when a loaded rewarded interstitial ad fails to show.
      */
     RewardInterstitialAdPluginEvents["FailedToShow"] = "onRewardedInterstitialAdFailedToShow";
     /**
-     * Emits when the AdReward video is not visible to the user anymore.
+     * Emits when a rewarded interstitial ad is dismissed.
      *
-     * **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.
+     * This event does not indicate whether the user earned a reward. Listen for
+     * `Rewarded` separately before granting the reward.
      */
     RewardInterstitialAdPluginEvents["Dismissed"] = "onRewardedInterstitialAdDismissed";
     /**
-     * Emits when user get rewarded from AdReward
+     * Emits when the user earns the advertised reward.
      */
     RewardInterstitialAdPluginEvents["Rewarded"] = "onRewardedInterstitialAdReward";
+    /**
+     * Emits impression-level ad revenue data when a paid event is recorded.
+     */
+    RewardInterstitialAdPluginEvents["AdImpression"] = "onRewardedInterstitialAdImpression";
 })(RewardInterstitialAdPluginEvents || (RewardInterstitialAdPluginEvents = {}));
 //# sourceMappingURL=reward-interstitial-ad-plugin-events.enum.js.map

package/dist/esm/reward-interstitial/reward-interstitial-ad-plugin-events.enum.js.map

@@ -1 +1 @@
-{"version":3,"file":"reward-interstitial-ad-plugin-events.enum.js","sourceRoot":"","sources":["../../../src/reward-interstitial/reward-interstitial-ad-plugin-events.enum.ts"],"names":[],"mappings":"AAAA,oFAAoF;AACpF,MAAM,CAAN,IAAY,gCA+BX;AA/BD,WAAY,gCAAgC;IAC1C;;OAEG;IACH,6EAAyC,CAAA;IACzC;;OAEG;IACH,yFAAqD,CAAA;IACrD;;OAEG;IACH,6EAAyC,CAAA;IACzC;;OAEG;IACH,yFAAqD,CAAA;IACrD;;;;;;;;OAQG;IACH,mFAA+C,CAAA;IAC/C;;OAEG;IACH,+EAA2C,CAAA;AAC7C,CAAC,EA/BW,gCAAgC,KAAhC,gCAAgC,QA+B3C"}
+{"version":3,"file":"reward-interstitial-ad-plugin-events.enum.js","sourceRoot":"","sources":["../../../src/reward-interstitial/reward-interstitial-ad-plugin-events.enum.ts"],"names":[],"mappings":"AAAA,oFAAoF;AACpF,MAAM,CAAN,IAAY,gCAgCX;AAhCD,WAAY,gCAAgC;IAC1C;;OAEG;IACH,6EAAyC,CAAA;IACzC;;OAEG;IACH,yFAAqD,CAAA;IACrD;;OAEG;IACH,6EAAyC,CAAA;IACzC;;OAEG;IACH,yFAAqD,CAAA;IACrD;;;;;OAKG;IACH,mFAA+C,CAAA;IAC/C;;OAEG;IACH,+EAA2C,CAAA;IAC3C;;OAEG;IACH,uFAAmD,CAAA;AACrD,CAAC,EAhCW,gCAAgC,KAAhC,gCAAgC,QAgC3C"}

package/dist/esm/reward-interstitial/reward-interstitial-definitions.interface.d.ts

@@ -1,30 +1,53 @@
 import type { PluginListenerHandle } from '@capacitor/core';
 import type { ValidateAllEventsEnumAreImplemented } from '../private/validate-all-events-implemented.type';
-import type { AdLoadInfo, AdMobError } from '../shared';
+import type { AdLoadInfo, AdMobError, AdMobRevenueData, AdShowOptions } from '../shared';
 import type { RewardInterstitialAdOptions } from './reward-interstitial-ad-options.interface';
 import type { RewardInterstitialAdPluginEvents } from './reward-interstitial-ad-plugin-events.enum';
 import type { AdMobRewardInterstitialItem } from './reward-interstitial-item.interface';
 export type RewardInterstitialDefinitionsHasAllEvents = ValidateAllEventsEnumAreImplemented<RewardInterstitialAdPluginEvents, RewardInterstitialDefinitions>;
 export interface RewardInterstitialDefinitions {
     /**
-     * Prepare a reward video ad
+     * Loads a rewarded interstitial ad and returns the loaded ad unit ID.
      *
-     * @group RewardVideo
-     * @param options RewardAdOptions
+     * @group RewardInterstitial
+     * @param options RewardInterstitialAdOptions
      * @since 1.1.2
      */
     prepareRewardInterstitialAd(options: RewardInterstitialAdOptions): Promise<AdLoadInfo>;
     /**
-     * Show a reward video ad
+     * Shows a loaded rewarded interstitial ad and resolves when the user earns the reward.
      *
-     * @group RewardVideo
+     * @group RewardInterstitial
+     * @param options Optional. Pass { adId } to show a specific prepared ad instead of the most recent one.
      * @since 1.1.2
      */
-    showRewardInterstitialAd(): Promise<AdMobRewardInterstitialItem>;
+    showRewardInterstitialAd(options?: AdShowOptions): Promise<AdMobRewardInterstitialItem>;
+    /**
+     * Listens for rewarded interstitial ad load failures.
+     */
     addListener(eventName: RewardInterstitialAdPluginEvents.FailedToLoad, listenerFunc: (error: AdMobError) => void): Promise<PluginListenerHandle>;
+    /**
+     * Listens for rewarded interstitial ad load events.
+     */
     addListener(eventName: RewardInterstitialAdPluginEvents.Loaded, listenerFunc: (info: AdLoadInfo) => void): Promise<PluginListenerHandle>;
+    /**
+     * Listens for earned reward events.
+     */
     addListener(eventName: RewardInterstitialAdPluginEvents.Rewarded, listenerFunc: (reward: AdMobRewardInterstitialItem) => void): Promise<PluginListenerHandle>;
+    /**
+     * Listens for rewarded interstitial ad dismissed events.
+     */
     addListener(eventName: RewardInterstitialAdPluginEvents.Dismissed, listenerFunc: () => void): Promise<PluginListenerHandle>;
+    /**
+     * Listens for rewarded interstitial ad show failures.
+     */
     addListener(eventName: RewardInterstitialAdPluginEvents.FailedToShow, listenerFunc: (error: AdMobError) => void): Promise<PluginListenerHandle>;
+    /**
+     * Listens for rewarded interstitial ad shown events.
+     */
     addListener(eventName: RewardInterstitialAdPluginEvents.Showed, listenerFunc: () => void): Promise<PluginListenerHandle>;
+    /**
+     * Listens for rewarded interstitial impression-level ad revenue events.
+     */
+    addListener(eventName: RewardInterstitialAdPluginEvents.AdImpression, listenerFunc: (data: AdMobRevenueData) => void): Promise<PluginListenerHandle>;
 }

package/dist/esm/reward-interstitial/reward-interstitial-item.interface.d.ts

@@ -1,14 +1,13 @@
 /**
- * For more information
- * https://developers.google.com/admob/android/rewarded-video-adapters?hl=en
+ * The reward earned by the user after viewing a rewarded interstitial ad.
  */
 export interface AdMobRewardInterstitialItem {
     /**
-     * Rewarded type user got
+     * The reward item type configured for the ad unit.
      */
     type: string;
     /**
-     * Rewarded amount user got
+     * The reward amount earned by the user.
      */
     amount: number;
 }

package/dist/esm/shared/ad-load-info.interface.d.ts

@@ -1,3 +1,9 @@
+/**
+ * Information returned after an ad loads successfully.
+ */
 export interface AdLoadInfo {
+    /**
+     * The ad unit ID of the loaded ad.
+     */
     adUnitId: string;
 }

package/dist/esm/shared/ad-mob-revenue-data.interface.d.ts

@@ -0,0 +1,50 @@
+/**
+ * The precision of an impression-level ad value.
+ */
+export declare enum AdValuePrecision {
+    /**
+     * The ad value precision is unknown.
+     */
+    Unknown = 0,
+    /**
+     * The ad value is estimated from aggregated data.
+     */
+    Estimated = 1,
+    /**
+     * The ad value was provided by the publisher.
+     */
+    PublisherProvided = 2,
+    /**
+     * The ad value is the precise value paid for this ad.
+     */
+    Precise = 3
+}
+/**
+ * Impression-level ad revenue data emitted by a paid event.
+ */
+export interface AdMobRevenueData {
+    /**
+     * The ad unit ID associated with the paid event.
+     */
+    adUnitId: string;
+    /**
+     * The ad value in micros, where 1,000,000 micros equals one currency unit.
+     */
+    valueMicros: number;
+    /**
+     * The ISO 4217 currency code for `valueMicros`.
+     */
+    currencyCode: string;
+    /**
+     * The precision of the reported ad value.
+     */
+    precision: AdValuePrecision;
+    /**
+     * The mediation adapter class name that served the impression, or an empty string when unavailable.
+     */
+    networkName: string;
+    /**
+     * The response identifier associated with the impression, or an empty string when unavailable.
+     */
+    impressionId: string;
+}

package/dist/esm/shared/ad-mob-revenue-data.interface.js

@@ -0,0 +1,23 @@
+/**
+ * The precision of an impression-level ad value.
+ */
+export var AdValuePrecision;
+(function (AdValuePrecision) {
+    /**
+     * The ad value precision is unknown.
+     */
+    AdValuePrecision[AdValuePrecision["Unknown"] = 0] = "Unknown";
+    /**
+     * The ad value is estimated from aggregated data.
+     */
+    AdValuePrecision[AdValuePrecision["Estimated"] = 1] = "Estimated";
+    /**
+     * The ad value was provided by the publisher.
+     */
+    AdValuePrecision[AdValuePrecision["PublisherProvided"] = 2] = "PublisherProvided";
+    /**
+     * The ad value is the precise value paid for this ad.
+     */
+    AdValuePrecision[AdValuePrecision["Precise"] = 3] = "Precise";
+})(AdValuePrecision || (AdValuePrecision = {}));
+//# sourceMappingURL=ad-mob-revenue-data.interface.js.map

package/dist/esm/shared/ad-mob-revenue-data.interface.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ad-mob-revenue-data.interface.js","sourceRoot":"","sources":["../../../src/shared/ad-mob-revenue-data.interface.ts"],"names":[],"mappings":"AAAA;;GAEG;AACH,MAAM,CAAN,IAAY,gBAoBX;AApBD,WAAY,gBAAgB;IAC1B;;OAEG;IACH,6DAAW,CAAA;IAEX;;OAEG;IACH,iEAAa,CAAA;IAEb;;OAEG;IACH,iFAAqB,CAAA;IAErB;;OAEG;IACH,6DAAW,CAAA;AACb,CAAC,EApBW,gBAAgB,KAAhB,gBAAgB,QAoB3B"}