react-native-google-mobile-ads 4.2.0 → 5.1.0

package/src/hooks/useInterstitialAd.ts

@@ -0,0 +1,46 @@
+/*
+ * 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 { InterstitialAd } from '../ads/InterstitialAd';
+import { AdHookReturns } from '../types/AdStates';
+import { RequestOptions } from '../types/RequestOptions';
+
+import { useFullScreenAd } from './useFullScreenAd';
+
+/**
+ * React Hook for Interstitial Ad.
+ *
+ * @param adUnitId The Ad Unit ID for the 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 useInterstitialAd(
+  adUnitId: string | null,
+  requestOptions: RequestOptions = {},
+): Omit<AdHookReturns, 'adReward'> {
+  const [interstitialAd, setInterstitialAd] = useState<InterstitialAd | null>(null);
+
+  useDeepCompareEffect(() => {
+    setInterstitialAd(() => {
+      return adUnitId ? InterstitialAd.createForAdRequest(adUnitId, requestOptions) : null;
+    });
+  }, [adUnitId, requestOptions]);
+
+  return useFullScreenAd(interstitialAd);
+}

package/src/hooks/useRewardedAd.ts

@@ -0,0 +1,46 @@
+/*
+ * 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 { RewardedAd } from '../ads/RewardedAd';
+import { AdHookReturns } from '../types/AdStates';
+import { RequestOptions } from '../types/RequestOptions';
+
+import { useFullScreenAd } from './useFullScreenAd';
+
+/**
+ * React Hook for Rewarded Ad.
+ *
+ * @param adUnitId The Ad Unit ID for the Rewarded 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 useRewardedAd(
+  adUnitId: string | null,
+  requestOptions: RequestOptions = {},
+): Omit<AdHookReturns, 'adReward'> {
+  const [rewardedAd, setRewardedAd] = useState<RewardedAd | null>(null);
+
+  useDeepCompareEffect(() => {
+    setRewardedAd(() => {
+      return adUnitId ? RewardedAd.createForAdRequest(adUnitId, requestOptions) : null;
+    });
+  }, [adUnitId, requestOptions]);
+
+  return useFullScreenAd(rewardedAd);
+}

package/src/index.ts

@@ -22,6 +22,8 @@ export const SDK_VERSION = version;
 
 export { default, MobileAds } from './MobileAds';
 export { AdsConsentDebugGeography } from './AdsConsentDebugGeography';
+export { AdsConsentPurposes } from './AdsConsentPurposes';
+export { AdsConsentSpecialFeatures } from './AdsConsentSpecialFeatures';
 export { AdsConsentStatus } from './AdsConsentStatus';
 export { MaxAdContentRating } from './MaxAdContentRating';
 export { TestIds } from './TestIds';
@@ -33,3 +35,6 @@ export { AppOpenAd } from './ads/AppOpenAd';
 export { InterstitialAd } from './ads/InterstitialAd';
 export { RewardedAd } from './ads/RewardedAd';
 export { BannerAd } from './ads/BannerAd';
+export { useAppOpenAd } from './hooks/useAppOpenAd';
+export { useInterstitialAd } from './hooks/useInterstitialAd';
+export { useRewardedAd } from './hooks/useRewardedAd';

package/src/types/AdStates.ts

@@ -0,0 +1,87 @@
+import { AdShowOptions } from './AdShowOptions';
+import { RewardedAdReward } from './RewardedAdReward';
+
+export interface AdStates {
+  /**
+   * Whether the ad is loaded and ready to to be shown to the user.
+   */
+  isLoaded: boolean;
+  /**
+   * Whether the ad is opened.
+   */
+  isOpened: boolean;
+  /**
+   * Whether the user clicked the advert.
+   */
+  isClicked: boolean;
+  /**
+   * Whether the user closed the ad and has returned back to your application.
+   */
+  isClosed: boolean;
+  /**
+   * JavaScript Error containing the error code and message thrown by the Ad.
+   */
+  error?: Error;
+  /**
+   * Loaded reward item of the Rewarded Ad.
+   */
+  reward?: RewardedAdReward;
+  /**
+   * Whether the user earned the reward by Rewarded Ad.
+   */
+  isEarnedReward?: boolean;
+}
+
+export interface AdHookReturns extends AdStates {
+  /**
+   * Whether your ad is showing.
+   * The value is equal with `isOpened && !isClosed`.
+   */
+  isShowing: boolean;
+  /**
+   * Start loading the advert with the provided RequestOptions.
+   * #### Example
+   *
+   * ```jsx
+   * export default function App() {
+   *   const interstitial = useInterstitialAd(TestIds.INTERSTITIAL, {
+   *     requestNonPersonalizedAdsOnly: true,
+   *   });
+   *   useEffect(() => {
+   *     interstitial.load();
+   *   }, [interstitial.load]);
+   * }
+   * ```
+   */
+  load: () => void;
+  /**
+   * Show the loaded advert to the user.
+   *
+   * #### Example
+   *
+   * ```jsx
+   * export default function App() {
+   *   const interstitial = useInterstitialAd(TestIds.INTERSTITIAL, {
+   *     requestNonPersonalizedAdsOnly: true,
+   *   });
+   *   return (
+   *     <View>
+   *       <Button
+   *         title="Navigate to next screen"
+   *         onPress={() => {
+   *           if (interstitial.isLoaded) {
+   *             interstitial.show();
+   *           } else {
+   *             navigation.navigate('NextScreen');
+   *           }
+   *         }}
+   *       />
+   *     </View>
+   *   )
+   * }
+   * ```
+   *
+   * @param showOptions An optional `AdShowOptions` interface.
+   */
+  show: (showOptions?: AdShowOptions) => void;
+}