@javascriptcommon/react-native-google-mobile-ads 16.3.3

package/src/types/RequestConfiguration.ts

@@ -0,0 +1,40 @@
+import { MaxAdContentRating } from '../MaxAdContentRating';
+
+/**
+ * The `RequestConfiguration` used when setting global ad settings via `setRequestConfiguration`.
+ */
+export interface RequestConfiguration {
+  /**
+   * The maximum ad content rating for all ads.  Google Mobile Ads returns ads at or below the specified level.
+   *
+   * Ratings are based on the [digital content label classifications](https://support.google.com/admob/answer/7562142).
+   */
+  maxAdContentRating?: MaxAdContentRating;
+
+  /**
+   * If `true`, indicates that you want your content treated as child-directed for purposes of COPPA.
+   *
+   * For purposes of the [Children's Online Privacy Protection Act (COPPA)](http://business.ftc.gov/privacy-and-security/children%27s-privacy),
+   * there is a setting called "tag for child-directed treatment". By setting this tag, you certify that this notification
+   * is accurate and you are authorized to act on behalf of the owner of the app. You understand that abuse of this
+   * setting may result in termination of your Google account.
+   */
+  tagForChildDirectedTreatment?: boolean;
+
+  /**
+   * If `true`, indicates that you want the ad request to be handled in a manner suitable for users under the age of consent.
+   *
+   * You can mark your ad requests to receive treatment for users in the European Economic Area (EEA) under the age of consent.
+   * This feature is designed to help facilitate compliance with the [General Data Protection Regulation (GDPR)](https://eur-lex.europa.eu/legal-content/EN/TXT/?uri=CELEX:32016R0679).
+   *
+   * See the [Google Mobile SDK docs](https://developers.google.com/admob/android/targeting#ad_content_filtering) for more information.
+   */
+  tagForUnderAgeOfConsent?: boolean;
+
+  /**
+   * An array of test device IDs to add to the allowlist.
+   *
+   * If using an emulator, set the device ID to `EMULATOR`.
+   */
+  testDeviceIdentifiers?: string[];
+}

package/src/types/RequestOptions.ts

@@ -0,0 +1,137 @@
+/**
+ * Collapsible Placement.
+ * The collapsible placement defines how the expanded region anchors to the banner ad.
+ */
+export type CollapsiblePlacement = 'top' | 'bottom';
+
+export interface ServerSideVerificationOptions {
+  /**
+   * User identifier.
+   * If no user identifier is provided by the app, this query parameter will not be present in the SSV callback.
+   */
+  userId?: string;
+
+  /**
+   * Custom data string.
+   * If no custom data string is provided by the app, this query parameter value will not be present in the SSV callback.
+   */
+  customData?: string;
+}
+
+/**
+ * The `RequestOptions` interface. Used when passing additional request options before an advert is loaded.
+ */
+export interface RequestOptions {
+  /**
+   * If `true` only non-personalized ads will be loaded.
+   *
+   * Google serves personalized ads by default. This option must be `true` if users who are within the EEA have only
+   * given consent to non-personalized ads.
+   */
+  requestNonPersonalizedAdsOnly?: boolean;
+
+  /**
+   * Attaches additional properties to an ad request for direct campaign delivery.
+   *
+   * Takes an array of string key/value pairs.
+   *
+   * #### Example
+   *
+   * Attaches `?campaign=abc&user=123` to the ad request:
+   *
+   * ```js
+   * await Interstitial.createForAdRequest('ca-app-pub-3940256099942544/1033173712', {
+   *   networkExtras: {
+   *     campaign: 'abc',
+   *     user: '123',
+   *   },
+   * });
+   */
+  networkExtras?: { [key: string]: string } & { collapsible?: CollapsiblePlacement };
+
+  /**
+   * An array of keywords to be sent when loading the ad.
+   *
+   * Setting keywords helps deliver more specific ads to a user based on the keywords.
+   *
+   * #### Example
+   *
+   * ```js
+   * await Interstitial.createForAdRequest('ca-app-pub-3940256099942544/1033173712', {
+   *   keywords: ['fashion', 'clothing'],
+   * });
+   * ```
+   */
+  keywords?: string[];
+
+  /**
+   * Sets a content URL for targeting purposes.
+   *
+   * Max length of 512.
+   */
+  contentUrl?: string;
+
+  /**
+   * key-value pairs used for custom targeting
+   *
+   * Takes an object of keys with values of string, number, or arrays of strings/numbers.
+   */
+  customTargeting?: Record<string, string | number | (string | 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
+   * third party ad network called "CoolAds network" mediates requests to the Mobile Ads SDK, it should call this
+   * method with "CoolAds".
+   *
+   * #### Example
+   *
+   * ```js
+   * await Interstitial.createForAdRequest('ca-app-pub-3940256099942544/1033173712', {
+   *   requestAgent: 'CoolAds',
+   * });
+   * ```
+   */
+  requestAgent?: string;
+
+  /**
+   * Server Side Verification(SSV) Options
+   * See [Google Mobile SDK Docs](https://developers.google.com/admob/android/ssv) for more information.
+   */
+  serverSideVerificationOptions?: ServerSideVerificationOptions;
+
+  /**
+   * Publisher provided identifier (PPID) for use in frequency capping, audience segmentation and targeting,
+   * sequential ad rotation, and other audience-based ad delivery controls across devices.
+   * See [this article](https://support.google.com/admanager/answer/2880055) for more information.
+   */
+  publisherProvidedId?: string;
+
+  /**
+   * Publisher Provided Signals (PPS) for Google Ad Manager.
+   *
+   * PPS allows publishers to send IAB taxonomy signals to help ad buyers
+   * evaluate and bid on inventory more effectively.
+   *
+   * Keys are IAB taxonomy names (e.g. `IAB_CONTENT_2_2`, `IAB_AUDIENCE_1_1`).
+   * Values are arrays of taxonomy IDs as integers.
+   *
+   * On Android, values are passed as `putIntegerArrayList` in the extras Bundle.
+   * On iOS, values are passed as `NSArray<NSNumber>` in GADExtras.
+   *
+   * @see https://developers.google.com/ad-manager/mobile-ads-sdk/android/targeting#publisher_provided_signals
+   * @see https://developers.google.com/ad-manager/mobile-ads-sdk/ios/targeting#publisher_provided_signals
+   *
+   * #### Example
+   *
+   * ```js
+   * await Interstitial.createForAdRequest('/12345/ad-unit', {
+   *   publisherProvidedSignals: {
+   *     IAB_CONTENT_2_2: [533, 483],    // Soccer, Sports
+   *     IAB_AUDIENCE_1_1: [6, 284],     // Sports & Fitness, Soccer
+   *   },
+   * });
+   * ```
+   */
+  publisherProvidedSignals?: { [key: string]: number[] };
+}

package/src/types/RewardedAdReward.ts

@@ -0,0 +1,14 @@
+/**
+ * A `RewardedAdReward` returned from rewarded ads.
+ */
+export interface RewardedAdReward {
+  /**
+   * The reward name, e.g. 'coins', 'diamonds'.
+   */
+  type: string;
+
+  /**
+   * The number value of the reward, e.g. 10
+   */
+  amount: number;
+}

package/src/types/index.ts

@@ -0,0 +1,29 @@
+/*
+ * 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 './AdShowOptions';
+export * from './AdStates';
+export * from './BannerAdProps';
+export * from './PaidEventListener';
+export * from './RequestConfiguration';
+export * from './RequestOptions';
+export * from './RewardedAdReward';
+export * from './AppEvent';
+export * from './NativeAdRequestOptions';

package/src/validateAdRequestConfiguration.ts

@@ -0,0 +1,66 @@
+/*
+ * 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 { isPropertySet, isArray, isBoolean, isObject } from './common';
+import { MaxAdContentRating } from './MaxAdContentRating';
+import { RequestConfiguration } from './types/RequestConfiguration';
+
+export function validateAdRequestConfiguration(requestConfiguration: RequestConfiguration) {
+  const out: RequestConfiguration = {};
+
+  if (!isObject(requestConfiguration)) {
+    throw new Error("'requestConfiguration' expected an object value");
+  }
+
+  if (requestConfiguration.maxAdContentRating) {
+    if (!Object.values(MaxAdContentRating).includes(requestConfiguration.maxAdContentRating)) {
+      throw new Error(
+        `'requestConfiguration.maxAdContentRating' expected one of ${Object.values(MaxAdContentRating).join(', ')}`,
+      );
+    }
+
+    out.maxAdContentRating = requestConfiguration.maxAdContentRating;
+  }
+
+  if (isPropertySet(requestConfiguration, 'tagForChildDirectedTreatment')) {
+    if (!isBoolean(requestConfiguration.tagForChildDirectedTreatment)) {
+      throw new Error(
+        "'requestConfiguration.tagForChildDirectedTreatment' expected a boolean value",
+      );
+    }
+
+    out.tagForChildDirectedTreatment = requestConfiguration.tagForChildDirectedTreatment;
+  }
+
+  if (isPropertySet(requestConfiguration, 'tagForUnderAgeOfConsent')) {
+    if (!isBoolean(requestConfiguration.tagForUnderAgeOfConsent)) {
+      throw new Error("'requestConfiguration.tagForUnderAgeOfConsent' expected a boolean value");
+    }
+
+    out.tagForUnderAgeOfConsent = requestConfiguration.tagForUnderAgeOfConsent;
+  }
+
+  if (isPropertySet(requestConfiguration, 'testDeviceIdentifiers')) {
+    if (!isArray(requestConfiguration.testDeviceIdentifiers)) {
+      throw new Error("'requestConfiguration.testDeviceIdentifiers' expected an array value");
+    }
+
+    out.testDeviceIdentifiers = requestConfiguration.testDeviceIdentifiers;
+  }
+
+  return out;
+}

package/src/validateAdRequestOptions.ts

@@ -0,0 +1,154 @@
+/*
+ * 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 {
+  isPropertySet,
+  isArray,
+  isBoolean,
+  isObject,
+  isString,
+  isUndefined,
+  isValidUrl,
+} from './common';
+import { version } from './version';
+import { RequestOptions } from './types/RequestOptions';
+
+export function validateAdRequestOptions(options?: RequestOptions) {
+  const out: RequestOptions = {
+    requestAgent: `rn-invertase-${version}`,
+  };
+
+  if (isUndefined(options)) {
+    return out;
+  }
+
+  if (!isObject(options)) {
+    throw new Error("'options' expected an object value");
+  }
+
+  if (isPropertySet(options, 'requestNonPersonalizedAdsOnly')) {
+    if (!isBoolean(options.requestNonPersonalizedAdsOnly)) {
+      throw new Error("'options.requestNonPersonalizedAdsOnly' expected a boolean value");
+    }
+
+    out.requestNonPersonalizedAdsOnly = options.requestNonPersonalizedAdsOnly;
+  }
+
+  if (options.networkExtras) {
+    if (!isObject(options.networkExtras)) {
+      throw new Error("'options.networkExtras' expected an object of key/value pairs");
+    }
+
+    Object.entries(options.networkExtras).forEach(([key, value]) => {
+      if (!isString(value)) {
+        throw new Error(`'options.networkExtras' expected a string value for object key "${key}"`);
+      }
+    });
+
+    out.networkExtras = options.networkExtras;
+  }
+
+  if (options.keywords) {
+    if (!isArray(options.keywords)) {
+      throw new Error("'options.keywords' expected an array containing string values");
+    }
+
+    for (let i = 0; i < options.keywords.length; i++) {
+      const keyword = options.keywords[i];
+
+      if (!isString(keyword)) {
+        throw new Error("'options.keywords' expected an array containing string values");
+      }
+    }
+
+    out.keywords = options.keywords;
+  }
+
+  if (options.contentUrl) {
+    if (!isString(options.contentUrl)) {
+      throw new Error("'options.contentUrl' expected a string value");
+    }
+
+    if (!isValidUrl(options.contentUrl)) {
+      throw new Error("'options.contentUrl' expected a valid HTTP or HTTPS url.");
+    }
+
+    if (options.contentUrl.length > 512) {
+      throw new Error("'options.contentUrl' maximum length of a content URL is 512 characters.");
+    }
+
+    out.contentUrl = options.contentUrl;
+  }
+
+  if (options.requestAgent) {
+    if (!isString(options.requestAgent)) {
+      throw new Error("'options.requestAgent' expected a string value");
+    }
+
+    out.requestAgent = options.requestAgent;
+  }
+
+  if (options.serverSideVerificationOptions) {
+    if (!isObject(options.serverSideVerificationOptions)) {
+      throw new Error(
+        "'options.serverSideVerificationOptions' expected an object of key/value pairs",
+      );
+    }
+
+    const ssvOptions = options.serverSideVerificationOptions;
+
+    if (ssvOptions.userId && !isString(ssvOptions.userId)) {
+      throw new Error("'options.serverSideVerificationOptions.userId' expected a string value");
+    }
+
+    if (ssvOptions.customData && !isString(ssvOptions.customData)) {
+      throw new Error("'options.serverSideVerificationOptions.customData' expected a string value");
+    }
+
+    out.serverSideVerificationOptions = options.serverSideVerificationOptions;
+  }
+
+  if (options.customTargeting) {
+    if (!isObject(options.customTargeting)) {
+      throw new Error("'options.customTargeting' expected an object of key/value pairs");
+    }
+    out.customTargeting = options.customTargeting;
+  }
+
+  if (options.publisherProvidedId) {
+    if (!isString(options.publisherProvidedId)) {
+      throw new Error("'options.publisherProvidedId' expected a string value");
+    }
+    out.publisherProvidedId = options.publisherProvidedId;
+  }
+
+  if (options.publisherProvidedSignals) {
+    if (!isObject(options.publisherProvidedSignals)) {
+      throw new Error("'options.publisherProvidedSignals' expected an object of key/value pairs");
+    }
+
+    Object.entries(options.publisherProvidedSignals).forEach(([key, value]) => {
+      if (!isArray(value)) {
+        throw new Error(`'options.publisherProvidedSignals.${key}' expected an array of numbers`);
+      }
+    });
+
+    out.publisherProvidedSignals = options.publisherProvidedSignals;
+  }
+
+  return out;
+}

package/src/validateAdShowOptions.ts

@@ -0,0 +1,41 @@
+/*
+ * 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 { isPropertySet, isBoolean, isObject, isUndefined } from './common';
+import { AdShowOptions } from './types/AdShowOptions';
+
+export function validateAdShowOptions(options?: AdShowOptions) {
+  const out: AdShowOptions = {};
+
+  if (isUndefined(options)) {
+    return out;
+  }
+
+  if (!isObject(options)) {
+    throw new Error("'options' expected an object value");
+  }
+
+  if (isPropertySet(options, 'immersiveModeEnabled')) {
+    if (!isBoolean(options.immersiveModeEnabled)) {
+      throw new Error("'options.immersiveModeEnabled' expected a boolean value");
+    }
+
+    out.immersiveModeEnabled = options.immersiveModeEnabled;
+  }
+
+  return out;
+}

package/src/validateNativeAdRequestOptions.ts

@@ -0,0 +1,50 @@
+/*
+ * 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 { isBoolean, isUndefined, isNumber } from './common';
+import { validateAdRequestOptions } from './validateAdRequestOptions';
+import type { NativeAdRequestOptions } from './types/NativeAdRequestOptions';
+
+export function validateNativeAdRequestOptions(
+  options?: NativeAdRequestOptions,
+): NativeAdRequestOptions {
+  const base = validateAdRequestOptions(options);
+  const out: NativeAdRequestOptions = { ...base };
+
+  if (!isUndefined(options?.adChoicesPlacement)) {
+    if (!isNumber(options.adChoicesPlacement)) {
+      throw new Error("'options.adChoicesPlacement' expected a number value");
+    }
+    out.adChoicesPlacement = options.adChoicesPlacement;
+  }
+
+  if (!isUndefined(options?.aspectRatio)) {
+    if (!isNumber(options.aspectRatio)) {
+      throw new Error("'options.aspectRatio' expected a number value");
+    }
+    out.aspectRatio = options.aspectRatio;
+  }
+
+  if (!isUndefined(options?.startVideoMuted)) {
+    if (!isBoolean(options.startVideoMuted)) {
+      throw new Error("'options.startVideoMuted' expected a boolean value");
+    }
+    out.startVideoMuted = options.startVideoMuted;
+  }
+
+  return out;
+}

package/src/version.ts

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