react-native-google-mobile-ads 5.1.1 → 6.1.0

package/src/types/AdEventListener.ts

@@ -1,16 +1,34 @@
+/*
+ * 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 { AdEventType } from '../AdEventType';
-import { RewardedAdReward } from './RewardedAdReward';
+import { GAMAdEventType } from '../GAMAdEventType';
 import { RewardedAdEventType } from '../RewardedAdEventType';
+import { AppEvent } from './AppEvent';
+import { RewardedAdReward } from './RewardedAdReward';
 
-/**
- * A callback interface for all ad events.
- *
- * @param type The event type, e.g. `AdEventType.LOADED`.
- * @param error An optional JavaScript Error containing the error code and message.
- * @param data Optional data for the event, e.g. reward type and amount
- */
-export type AdEventListener = (
-  type: AdEventType | RewardedAdEventType,
-  error?: Error,
-  data?: RewardedAdReward,
-) => void;
+export type AdEventPayload<T extends AdEventType | RewardedAdEventType | GAMAdEventType = never> =
+  T extends AdEventType.ERROR
+    ? Error
+    : T extends RewardedAdEventType
+    ? RewardedAdReward
+    : T extends GAMAdEventType
+    ? AppEvent
+    : undefined;
+
+export type AdEventListener<T extends AdEventType | RewardedAdEventType | GAMAdEventType = never> =
+  (payload: AdEventPayload<T>) => void;

package/src/types/AdEventsListener.ts

@@ -0,0 +1,24 @@
+/*
+ * 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 { AdEventType } from '../AdEventType';
+import { GAMAdEventType } from '../GAMAdEventType';
+import { RewardedAdEventType } from '../RewardedAdEventType';
+import { AdEventPayload } from './AdEventListener';
+
+export type AdEventsListener<T extends AdEventType | RewardedAdEventType | GAMAdEventType = never> =
+  (eventInfo: { type: T; payload: AdEventPayload<T> }) => void;

package/src/types/AppEvent.ts

@@ -0,0 +1,14 @@
+/**
+ * An app event received from Google Ad Manager ads.
+ */
+export interface AppEvent {
+  /**
+   * The event name.
+   */
+  name: string;
+
+  /**
+   * The data received with the app event.
+   */
+  data?: string;
+}

package/src/types/BannerAdProps.ts

@@ -1,4 +1,5 @@
 import { BannerAdSize } from '../BannerAdSize';
+import { AppEvent } from './AppEvent';
 import { RequestOptions } from './RequestOptions';
 
 /**
@@ -33,7 +34,7 @@ import { RequestOptions } from './RequestOptions';
  * }
  * ```
  */
-export type BannerAdProps = {
+export interface BannerAdProps {
   /**
    * The Google Mobile Ads unit ID for the banner.
    */
@@ -44,7 +45,7 @@ export type BannerAdProps = {
    *
    * Inventory must be available for the banner size specified, otherwise a no-fill error will be sent to `onAdFailedToLoad`.
    */
-  size: BannerAdSize;
+  size: BannerAdSize | string;
 
   /**
    * The request options for this banner.
@@ -54,7 +55,7 @@ export type BannerAdProps = {
   /**
    * When an ad has finished loading.
    */
-  onAdLoaded?: () => void;
+  onAdLoaded?: (dimensions: { width: number; height: number }) => void;
 
   /**
    * When an ad has failed to load. Callback contains an Error.
@@ -70,4 +71,80 @@ export type BannerAdProps = {
    * Called when the user is about to return to the app after tapping on an ad.
    */
   onAdClosed?: () => void;
-};
+}
+
+/**
+ * An interface for a GAM Banner advert component.
+ *
+ * #### Example
+ *
+ * The `GAMBannerAd` interface is exposed as a React component, allowing you to integrate ads within your existing React
+ * Native code base. The component itself is isolated, meaning any standard `View` props (e.g. `style`) are not
+ * forwarded on. It is recommended you wrap the `GAMBannerAd` within your own `View` if you wish to apply custom props for use-cases
+ * such as positioning.
+ *
+ * ```js
+ * import { GAMBannerAd, BannerAdSize, TestIds } from 'react-native-google-mobile-ads';
+ *
+ * function HomeScreen() {
+ *   return (
+ *     <GAMBannerAd
+ *       unitId={TestIds.GAM_BANNER}
+ *       sizes={[BannerAdSize.FULL_BANNER]}
+ *       requestOptions={{
+ *         requestNonPersonalizedAdsOnly: true,
+ *       }}
+ *       onAdLoaded={() => {
+ *         console.log('Advert loaded');
+ *       }}
+ *       onAdFailedToLoad={(error) => {
+ *         console.error('Advert failed to load: ', error);
+ *       }}
+ *     />
+ *   );
+ * }
+ * ```
+ */
+export interface GAMBannerAdProps extends Omit<BannerAdProps, 'size'> {
+  /**
+   * The available sizes of the banner. Can be a array of predefined sizes via `BannerAdSize` or custom dimensions, e.g. `300x200`.
+   *
+   * Inventory must be available for the banner sizes specified, otherwise a no-fill error will be sent to `onAdFailedToLoad`.
+   */
+  sizes: BannerAdSize[] | string[];
+
+  /**
+   * Whether to enable the manual impression counting.
+   *
+   * #### Example
+   *
+   * After setting this value to `true`, call `recordManualImpression()` from the ref object.
+   *
+   * ```js
+   * import { GAMBannerAd, BannerAdSize, TestIds } from 'react-native-google-mobile-ads';
+   *
+   * function HomeScreen() {
+   *   const ref = useRef<GAMBannerAd>(null);
+   *
+   *   const recordManualImpression = () => {
+   *     ref.current?.recordManualImpression();
+   *   }
+   *
+   *   return (
+   *     <GAMBannerAd
+   *       ref={ref}
+   *       unitId={TestIds.GAM_BANNER}
+   *       sizes={[BannerAdSize.FULL_BANNER]}
+   *       manualImpressionsEnabled={true}
+   *     />
+   *   );
+   * }
+   * ```
+   */
+  manualImpressionsEnabled?: boolean;
+
+  /**
+   * When an ad received Ad Manager specific app events.
+   */
+  onAppEvent?: (appEvent: AppEvent) => void;
+}

package/src/types/GoogleMobileAdsNativeModule.ts

@@ -3,13 +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>;
-  appOpenLoad(requestId: number, adUnitId: string, requestOptions: RequestOptions): void;
-  appOpenShow(requestId: number, showOptions?: AdShowOptions): Promise<void>;
-  interstitialLoad(requestId: number, adUnitId: string, requestOptions: RequestOptions): void;
-  interstitialShow(requestId: number, 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/MobileAd.interface.ts

@@ -1,4 +1,22 @@
+/*
+ * 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 { AdEventListener } from './AdEventListener';
+import { AdEventsListener } from './AdEventsListener';
 import { AdShowOptions } from './AdShowOptions';
 
 /**
@@ -22,6 +40,26 @@ export interface MobileAdInterface {
    */
   load(): void;
 
+  /**
+   * Show the loaded advert to the user.
+   *
+   * #### Example
+   *
+   * ```js
+   * // Create InterstitialAd/RewardedAd
+   * const advert = InterstitialAd.createForAdRequest('...');
+   *
+   * advert.addAdEventListener(AdEventType.LOADED, () => {
+   *   advert.show({
+   *     immersiveModeEnabled: true,
+   *   });
+   * });
+   * ```
+   *
+   * @param showOptions An optional `AdShowOptions` interface.
+   */
+  show(showOptions?: AdShowOptions): Promise<void>;
+
   /**
    * Listen to ad events. See AdEventTypes for more information.
    *
@@ -33,8 +71,7 @@ export interface MobileAdInterface {
    * // Create InterstitialAd/RewardedAd
    * const advert = InterstitialAd.createForAdRequest('...');
    *
-   * const unsubscribe = advert.onAdEvent((type) => {
-   *
+   * const unsubscribe = advert.addAdEventsListener(({ type, payload }) => {
    * });
    *
    * // Sometime later...
@@ -43,10 +80,12 @@ export interface MobileAdInterface {
    *
    * @param listener A listener callback containing a event type, error and data.
    */
-  onAdEvent(listener: AdEventListener): () => void;
+  addAdEventsListener<T extends never>(listener: AdEventsListener<T>): () => void;
 
   /**
-   * Show the loaded advert to the user.
+   * Listen to ad events. See AdEventTypes for more information.
+   *
+   * Returns an unsubscriber function to stop listening to further events.
    *
    * #### Example
    *
@@ -54,16 +93,21 @@ export interface MobileAdInterface {
    * // Create InterstitialAd/RewardedAd
    * const advert = InterstitialAd.createForAdRequest('...');
    *
-   * advert.onAdEvent((type) => {
-   *   if (type === AdEventType.LOADED) {
-   *     advert.show({
-   *       immersiveModeEnabled: true,
-   *     });
-   *   }
+   * const unsubscribe = advert.addAdEventListener(AdEventType.Loaded, () => {
+   *
    * });
+   *
+   * // Sometime later...
+   * unsubscribe();
    * ```
    *
-   * @param showOptions An optional `AdShowOptions` interface.
+   * @param type The event type, e.g. `AdEventType.LOADED`.
+   * @param listener A listener callback containing a event type, error and data.
    */
-  show(showOptions?: AdShowOptions): Promise<void>;
+  addAdEventListener<T extends never>(type: T, listener: AdEventListener<T>): void;
+
+  /**
+   * Remove all registered event listeners.
+   */
+  removeAllListeners(): void;
 }

package/src/types/MobileAdsModule.interface.ts

@@ -31,6 +31,16 @@ export interface MobileAdsModuleInterface {
    */
   setRequestConfiguration(requestConfiguration: RequestConfiguration): Promise<void>;
 
+  /**
+   * Opens the Ad Inspector. Ad inspector is an in-app overlay that enables authorized devices to perform real-time analysis of test ad requests directly within a mobile app.
+   *
+   * The promise will resolve when the inspector is closed.
+   * Also, the promise will reject if ad inspector is closed due to an error.
+   *
+   * @see https://developers.google.com/ad-manager/mobile-ads-sdk/android/ad-inspector
+   */
+  openAdInspector(): Promise<void>;
+
   /**
    * The native module instance for the Google Mobile Ads service.
    */

package/src/types/RequestOptions.ts

@@ -72,30 +72,6 @@ export interface RequestOptions {
    */
   customTargeting?: { [key: string]: string };
 
-  /**
-   * The latitude and longitude location of the user.
-   *
-   * Ensure your app requests location permissions from the user.
-   *
-   * #### Example
-   *
-   * ```js
-   * await Interstitial.createForAdRequest('ca-app-pub-3940256099942544/1033173712', {
-   *   location: [53.481073, -2.237074],
-   * });
-   * ```
-   */
-  location?: [number, number];
-
-  /**
-   * Sets the location accuracy if the location is set, in meters.
-   *
-   * This option is only applied to iOS devices. On Android, this option has no effect.
-   *
-   * @ios
-   */
-  locationAccuracy?: number;
-
   /**
    * Sets the request agent string to identify the ad request's origin. Third party libraries that reference the Mobile
    * Ads SDK should call this method to denote the platform from which the ad request originated. For example, if a

package/src/types/index.ts

@@ -0,0 +1,28 @@
+/*
+ * 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.
+ *
+ */
+
+export * from './AdapterStatus';
+export * from './AdEventListener';
+export * from './AdEventsListener';
+export * from './AdsConsent.interface';
+export * from './AdShowOptions';
+export * from './AdStates';
+export * from './BannerAdProps';
+export * from './RequestConfiguration';
+export * from './RequestOptions';
+export * from './RewardedAdReward';
+export * from './AppEvent';

package/src/validateAdRequestOptions.ts

@@ -19,7 +19,6 @@ import {
   hasOwnProperty,
   isArray,
   isBoolean,
-  isNumber,
   isObject,
   isString,
   isUndefined,
@@ -92,50 +91,6 @@ export function validateAdRequestOptions(options?: RequestOptions) {
     out.contentUrl = options.contentUrl;
   }
 
-  if (options.location) {
-    const error = new Error(
-      "'options.location' expected an array value containing a latitude & longitude number value.",
-    );
-
-    if (!isArray(options.location)) {
-      throw error;
-    }
-
-    const [latitude, longitude] = options.location;
-
-    if (!isNumber(latitude) || !isNumber(longitude)) {
-      throw error;
-    }
-
-    if (latitude < -90 || latitude > 90) {
-      throw new Error(
-        `'options.location' latitude value must be a number between -90 and 90, but was: ${latitude}`,
-      );
-    }
-
-    if (longitude < -180 || longitude > 180) {
-      throw new Error(
-        `'options.location' longitude value must be a number between -180 and 180, but was: ${latitude}`,
-      );
-    }
-
-    out.location = [latitude, longitude];
-  }
-
-  if (hasOwnProperty(options, 'locationAccuracy')) {
-    if (!isNumber(options.locationAccuracy)) {
-      throw new Error("'options.locationAccuracy' expected a number value.");
-    }
-
-    if (isNumber(options.locationAccuracy) && options.locationAccuracy < 0) {
-      throw new Error("'options.locationAccuracy' expected a number greater than 0.");
-    }
-
-    out.locationAccuracy = options.locationAccuracy;
-  } else {
-    out.locationAccuracy = 5;
-  }
-
   if (options.requestAgent) {
     if (!isString(options.requestAgent)) {
       throw new Error("'options.requestAgent' expected a string value");

package/src/version.ts

@@ -1,2 +1,2 @@
-// generated by genversion
-export const version = '5.1.1';
+// Generated by genversion.
+export const version = '6.1.0';