react-native-google-mobile-ads 6.0.0 → 6.2.0

package/src/ads/RewardedInterstitialAd.ts

@@ -0,0 +1,143 @@
+/*
+ * Copyright (c) 2016-present Invertase Limited & Contributors
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this library except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *   http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ *
+ */
+
+import { isString } from '../common';
+import { MobileAds } from '../MobileAds';
+import { validateAdRequestOptions } from '../validateAdRequestOptions';
+import { MobileAd } from './MobileAd';
+import { AdEventType } from '../AdEventType';
+import { RewardedAdEventType } from '../RewardedAdEventType';
+import { AdEventListener } from '../types/AdEventListener';
+import { AdEventsListener } from '../types/AdEventsListener';
+import { RequestOptions } from '../types/RequestOptions';
+
+/**
+ * A class for interacting and showing Rewarded Interstitial Ads.
+ *
+ * An Rewarded Interstitial advert can be pre-loaded and shown at a suitable point in your apps flow, such as at the end of a level
+ * in a game. The content of a rewarded interstital advert can be controlled via your Google Mobile Ads dashboard. Typically users are rewarded
+ * after completing a specific advert action (e.g. watching a video or submitting an option via an interactive form).
+ * Events (such as the user earning a reward or closing a rewarded interstital advert early) are sent back for you to handle accordingly
+ * within your application.
+ *
+ * #### Example
+ *
+ * First create a new Rewarded Interstitial instance, passing in your Ad Unit ID from the Google Mobile Ads configuration console, and any additional
+ * request options. The example below will present a test advert, and only request a non-personalized ad.
+ *
+ * ```js
+ * import { RewardedInterstitialAd, TestIds } from 'react-native-google-mobile-ads';
+ *
+ * const rewardedInterstitial = RewardedInterstitialAd.createForAdRequest(TestIds.REWARDED_INTERSTITIAL, {
+ *     requestNonPersonalizedAdsOnly: true,
+ * });
+ *  ```
+ *
+ * Each advert needs to be loaded from Google Mobile Ads before being shown. It is recommended this is performed before the user
+ * reaches the checkpoint to show the advert, so it's ready to go. Before loading the advert, we need to setup
+ * event listeners to listen for updates from Google Mobile Ads, such as advert loaded or failed to load.
+ *
+ * Event types match the `AdEventType` or `RewardedAdEventType` interface. The potential user reward for rewarded interstitial
+ * adverts are passed back to the event handler on advert load and when the user earns the reward.
+ *
+ * ```js
+ * import { RewardedAdEventType } from 'react-native-google-mobile-ads';
+ *
+ * rewardedInterstitial.addAdEventListener(RewardedAdEventType.LOADED. () => {
+ *   rewarded.show();
+ * });
+ * rewardedInterstitial.addAdEventListener(RewardedAdEventType.EARNED_REWARD. (reward) => {
+ *   console.log('User earned reward of ', reward);
+ * });
+ *
+ * rewardedInterstitial.load();
+ *  ```
+ *
+ * The rewarded interstitial advert will be presented to the user, and several more events can be triggered such as the user clicking the
+ * advert, closing it or completing the action.
+ */
+export class RewardedInterstitialAd extends MobileAd {
+  protected static _rewardedInterstitialRequest = 0;
+  /**
+   * Creates a new RewardedInterstitialAd instance.
+   *
+   * #### Example
+   *
+   * ```js
+   * import { RewardedInterstitialAd, RewardedAdEventType, TestIds } from 'react-native-google-mobile-ads';
+   *
+   * const rewardedInterstitialAd = await RewardedInterstitialAd.createForAdRequest(TestIds.REWARDED_INTERSTITIAL, {
+   *   requestAgent: 'CoolAds',
+   * });
+   *
+   * rewardedInterstitialAd.addAdEventListener(RewardedAdEventType.LOADED. () => {
+   *   rewardedInterstitialAd.show();
+   * });
+   * rewardedInterstitialAd.addAdEventListener(RewardedAdEventType.EARNED_REWARD. (reward) => {
+   *   console.log('User earned reward of ', reward);
+   * });
+   *
+   * rewardedInterstitialAd.load();
+   * ```
+   *
+   * @param adUnitId The Ad Unit ID for the Rewarded Interstitial Ad. You can find this on your Google Mobile Ads dashboard.
+   * @param requestOptions Optional RequestOptions used to load the ad.
+   */
+  static createForAdRequest(adUnitId: string, requestOptions?: RequestOptions) {
+    if (!isString(adUnitId)) {
+      throw new Error(
+        "RewardedInterstitialAd.createForAdRequest(*) 'adUnitId' expected an string value.",
+      );
+    }
+
+    let options = {};
+    try {
+      options = validateAdRequestOptions(requestOptions);
+    } catch (e) {
+      if (e instanceof Error) {
+        throw new Error(`RewardedInterstitialAd.createForAdRequest(_, *) ${e.message}.`);
+      }
+    }
+
+    const requestId = RewardedInterstitialAd._rewardedInterstitialRequest++;
+    return new RewardedInterstitialAd(
+      'rewarded_interstitial',
+      MobileAds(),
+      requestId,
+      adUnitId,
+      options,
+    );
+  }
+
+  addAdEventsListener<T extends AdEventType | RewardedAdEventType>(
+    listener: AdEventsListener<T>,
+  ): () => void {
+    return this._addAdEventsListener(listener);
+  }
+
+  addAdEventListener<T extends AdEventType | RewardedAdEventType>(
+    type: T,
+    listener: AdEventListener<T>,
+  ) {
+    if (type === AdEventType.LOADED) {
+      throw new Error(
+        'RewardedInterstitialAd.addAdEventListener(*) use RewardedAdEventType.LOADED instead of AdEventType.LOADED.',
+      );
+    }
+    return this._addAdEventListener(type, listener);
+  }
+}

package/src/hooks/useFullScreenAd.ts

@@ -21,6 +21,7 @@ import { AdEventType } from '../AdEventType';
 import { AppOpenAd } from '../ads/AppOpenAd';
 import { InterstitialAd } from '../ads/InterstitialAd';
 import { RewardedAd } from '../ads/RewardedAd';
+import { RewardedInterstitialAd } from '../ads/RewardedInterstitialAd';
 import { RewardedAdEventType } from '../RewardedAdEventType';
 import { AdStates, AdHookReturns } from '../types/AdStates';
 import { AdShowOptions } from '../types/AdShowOptions';
@@ -36,9 +37,9 @@ const initialState: AdStates = {
   isEarnedReward: false,
 };
 
-export function useFullScreenAd<T extends InterstitialAd | RewardedAd | AppOpenAd | null>(
-  ad: T,
-): AdHookReturns {
+export function useFullScreenAd<
+  T extends AppOpenAd | InterstitialAd | RewardedAd | RewardedInterstitialAd | null,
+>(ad: T): AdHookReturns {
   const [state, setState] = useReducer<Reducer<AdStates, Partial<AdStates>>>(
     (prevState, newState) => ({ ...prevState, ...newState }),
     initialState,

package/src/hooks/useRewardedAd.ts

@@ -33,7 +33,7 @@ import { useFullScreenAd } from './useFullScreenAd';
 export function useRewardedAd(
   adUnitId: string | null,
   requestOptions: RequestOptions = {},
-): Omit<AdHookReturns, 'adReward'> {
+): AdHookReturns {
   const [rewardedAd, setRewardedAd] = useState<RewardedAd | null>(null);
 
   useDeepCompareEffect(() => {

package/src/hooks/useRewardedInterstitialAd.ts

@@ -0,0 +1,47 @@
+/*
+ * Copyright (c) 2016-present Invertase Limited & Contributors
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this library except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *   http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ *
+ */
+
+import { useState } from 'react';
+import useDeepCompareEffect from 'use-deep-compare-effect';
+
+import { RewardedInterstitialAd } from '../ads/RewardedInterstitialAd';
+import { AdHookReturns } from '../types/AdStates';
+import { RequestOptions } from '../types/RequestOptions';
+
+import { useFullScreenAd } from './useFullScreenAd';
+
+/**
+ * React Hook for Rewarded Interstitial Ad.
+ *
+ * @param adUnitId The Ad Unit ID for the Rewarded Interstitial Ad. You can find this on your Google Mobile Ads dashboard. You can destroy ad instance by setting this value to null.
+ * @param requestOptions Optional RequestOptions used to load the ad.
+ */
+export function useRewardedInterstitialAd(
+  adUnitId: string | null,
+  requestOptions: RequestOptions = {},
+): AdHookReturns {
+  const [rewardedInterstitialAd, setRewardedInterstitialAd] =
+    useState<RewardedInterstitialAd | null>(null);
+
+  useDeepCompareEffect(() => {
+    setRewardedInterstitialAd(() => {
+      return adUnitId ? RewardedInterstitialAd.createForAdRequest(adUnitId, requestOptions) : null;
+    });
+  }, [adUnitId, requestOptions]);
+
+  return useFullScreenAd(rewardedInterstitialAd);
+}

package/src/index.ts

@@ -35,10 +35,12 @@ export { AdsConsent } from './AdsConsent';
 export { AppOpenAd } from './ads/AppOpenAd';
 export { InterstitialAd } from './ads/InterstitialAd';
 export { RewardedAd } from './ads/RewardedAd';
+export { RewardedInterstitialAd } from './ads/RewardedInterstitialAd';
 export { BannerAd } from './ads/BannerAd';
 export { GAMBannerAd } from './ads/GAMBannerAd';
 export { GAMInterstitialAd } from './ads/GAMInterstitialAd';
 export { useAppOpenAd } from './hooks/useAppOpenAd';
 export { useInterstitialAd } from './hooks/useInterstitialAd';
 export { useRewardedAd } from './hooks/useRewardedAd';
+export { useRewardedInterstitialAd } from './hooks/useRewardedInterstitialAd';
 export * from './types';

package/src/types/GoogleMobileAdsNativeModule.ts

@@ -3,14 +3,23 @@ import { RequestConfiguration } from './RequestConfiguration';
 import { RequestOptions } from './RequestOptions';
 import { AdShowOptions } from './AdShowOptions';
 
+type AdLoadFunction = (requestId: number, adUnitId: string, requestOptions: RequestOptions) => void;
+type AdShowFunction = (
+  requestId: number,
+  adUnitId: string,
+  showOptions?: AdShowOptions,
+) => Promise<void>;
+
 export interface GoogleMobileAdsNativeModule {
   initialize(): Promise<AdapterStatus[]>;
   setRequestConfiguration(requestConfiguration?: RequestConfiguration): Promise<void>;
-  openAdInspector(): () => Promise<void>;
-  appOpenLoad(requestId: number, adUnitId: string, requestOptions: RequestOptions): void;
-  appOpenShow(requestId: number, adUnitId: string, showOptions?: AdShowOptions): Promise<void>;
-  interstitialLoad(requestId: number, adUnitId: string, requestOptions: RequestOptions): void;
-  interstitialShow(requestId: number, adUnitId: string, showOptions?: AdShowOptions): Promise<void>;
-  rewardedLoad(requestId: number, adUnitId: string, requestOptions: RequestOptions): void;
-  rewardedShow(requestId: number, adUnitId: string, showOptions?: AdShowOptions): Promise<void>;
+  openAdInspector(): Promise<void>;
+  appOpenLoad: AdLoadFunction;
+  appOpenShow: AdShowFunction;
+  interstitialLoad: AdLoadFunction;
+  interstitialShow: AdShowFunction;
+  rewardedLoad: AdLoadFunction;
+  rewardedShow: AdShowFunction;
+  rewardedInterstitialLoad: AdLoadFunction;
+  rewardedInterstitialShow: AdShowFunction;
 }

package/src/types/MobileAdsModule.interface.ts

@@ -39,7 +39,7 @@ export interface MobileAdsModuleInterface {
    *
    * @see https://developers.google.com/ad-manager/mobile-ads-sdk/android/ad-inspector
    */
-  openAdInspector(): () => Promise<void>;
+  openAdInspector(): Promise<void>;
 
   /**
    * The native module instance for the Google Mobile Ads service.

package/src/version.ts

@@ -1,2 +1,2 @@
 // Generated by genversion.
-export const version = '6.0.0';
+export const version = '6.2.0';