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

package/lib/typescript/types/AdsConsent.interface.d.ts

@@ -1,3 +1,4 @@
+import { TCModel } from '@iabtcf/core';
 import { AdsConsentDebugGeography } from '../AdsConsentDebugGeography';
 import { AdsConsentStatus } from '../AdsConsentStatus';
 /**
@@ -9,246 +10,122 @@ import { AdsConsentStatus } from '../AdsConsentStatus';
  * It is recommended that you determine the status of a user's consent at every app launch. The user consent status is held
  * on the device until a condition changes which requires the user to consent again, such as a change in publishers.
  *
- * For more information, see [here](https://developers.google.com/admob/android/eu-consent#delay_app_measurement_optional).
+ * For more information, see [here](https://developers.google.com/admob/ump/android/quick-start#delay_app_measurement_optional).
  */
-/**
- * A AdProvider interface returned from `AdsConsent.getProviders`.
- */
-export interface AdProvider {
-    /**
-     * A provider company ID.
-     */
-    companyId: string;
-    /**
-     * A provider company name.
-     */
-    companyName: string;
-    /**
-     * A fully formed URL for the privacy policy of the provider.
-     */
-    privacyPolicyUrl: string;
-}
 export interface AdsConsentInterface {
     /**
-     * Requests user consent for a given list of publisher IDs.
-     *
-     * The list of publisher IDs can be obtained from the settings panel on the Google Mobile Ads console. If the list of
-     * publisher IDs has changed since the last time a user provided consent, their consent status will be reset to
-     * 'UNKNOWN' and they must provide consent again.
-     *
-     * If the request fails with the error "Could not parse Event FE preflight response", this means the state of your
-     * Google Mobile Ads account is not complete. Ensure you have validated your account and have setup valid payment
-     * information. This error is also thrown when a Publisher ID is invalid.
-     *
-     * The response from this method provides request location and consent status properties.
+     * Requests user consent information.
      *
-     * If request location is within the EEA or unknown, and the consent status is also unknown, you
-     * must request consent via the `showForm()` method or your own means.
-     *
-     * If the consent status is not unknown, the user has already previously provided consent for the current publisher
-     * scope.
+     * The response from this method provides information about consent form availability and consent status.
      *
      * #### Example
      *
      * ```js
      * import { AdsConsent } from 'react-native-google-mobile-ads';
      *
-     * const consent = await AdsConsent.requestInfoUpdate(['pub-6189033257628554']);
-     * console.log('User location within EEA or Unknown:', consent.isRequestLocationInEeaOrUnknown);
-     * console.log('User consent status:', consent.status);
+     * const consentInfo = await AdsConsent.requestInfoUpdate();
+     * console.log('A consent form is available:', consentInfo.isConsentFormAvailable);
+     * console.log('User consent status:', consentInfo.status);
      * ```
-     *
-     * @param publisherIds A list of publisher IDs found on your Google Mobile Ads dashboard.
+     * @param options An AdsConsentInfoOptions interface.
      */
-    requestInfoUpdate(publisherIds: string[]): Promise<AdsConsentInfo>;
+    requestInfoUpdate(options?: AdsConsentInfoOptions): Promise<AdsConsentInfo>;
     /**
      * Shows a Google-rendered user consent form.
      *
-     * The Google-rendered consent form is a full-screen configurable form that displays over your app content. The form
-     * allows the following configuration options:
-     *
-     *
-     * 1. Consent to view personalized ads (via `withPersonalizedAds`).
-     * 2. Consent to view non-personalized ads (via `withNonPersonalizedAds`).
-     * 3. Use a paid version of the app instead of viewing ads (via `withAdFree`).
-     *
-     * Every consent form requires a privacy policy URL which outlines the usage of your application.
-     *
-     * You should review the consent text carefully: what appears by default is a message that might be appropriate if
-     * you use Google to monetize your app.
-     *
-     * If providing an ad-free version of your app, ensure you handle this once the form has been handled by the user
-     * via the `userPrefersAdFree` property. The users preference on consent is automatically forwarded onto the Google
-     * Mobile SDKs and saved.
-     *
-     * If the user is outside of the EEA, the request form will error.
-     *
      * #### Example
      *
      * ```js
      * import { AdsConsent, AdsConsentStatus } from 'react-native-google-mobile-ads';
      *
      * async function requestConsent() {
-     *   const consent = await AdsConsent.requestInfoUpdate(['pub-6189033257628554']);
+     *   const consentInfo = await AdsConsent.requestInfoUpdate();
      *
      *   // Check if user requires consent
-     *   if (consent.isRequestLocationInEeaOrUnknown && consent.status === AdsConsentStatus.UNKNOWN) {
+     *   if (
+     *     consentInfo.isConsentFormAvailable &&
+     *     (consentInfo.status === AdsConsentStatus.UNKNOWN ||
+     *       consentInfo.status === AdsConsentStatus.REQUIRED)) {
      *     // Show a Google-rendered form
-     *     const result = await AdsConsent.showForm({
-     *       privacyPolicy: 'https://invertase.io/privacy-policy',
-     *       withPersonalizedAds: true,
-     *       withNonPersonalizedAds: true,
-     *       withAdFree: true,
-     *     });
-     *
-     *     console.log('User accepted personalized: ', result.status === AdsConsentStatus.PERSONALIZED);
-     *     console.log('User accepted non-personalized: ', result.status === AdsConsentStatus.NON_PERSONALIZED);
-     *     console.log('User prefers Ad Free version of app: ', result.userPrefersAdFree);
+     *     const formResult = await AdsConsent.showForm();
+     *
+     *     console.log('User consent obtained: ', formResult.status === AdsConsentStatus.OBTAINED);
      *   }
      * }
      *
      * ```
-     *
-     * @param options An AdsConsentFormOptions interface to control the Google-rendered form.
-     */
-    showForm(options: AdsConsentFormOptions): Promise<AdsConsentFormResult>;
-    /**
-     * Returns a list of ad providers currently in use for the given Google Mobile Ads App ID.
-     *
-     * If requesting consent from the user via your own method, this list of ad providers must be shown to the user
-     * for them to accept consent.
-     *
-     * #### Example
-     *
-     * ```js
-     * import { AdsConsent } from 'react-native-google-mobile-ads';
-     *
-     * const providers = await AdsConsent.getAdProviders();
-     * ```
      */
-    getAdProviders(): Promise<AdProvider[]>;
+    showForm(): Promise<AdsConsentFormResult>;
     /**
-     * Sets the debug geography to locally test consent.
-     *
-     * If debugging on an emulator (where location cannot be determined) or outside of the EEA,
-     * it is possible set your own location to test how your app handles different scenarios.
+     * Returns the value stored under the `IABTCF_TCString` key
+     * in NSUserDefaults (iOS) / SharedPreferences (Android) as
+     * defined by the IAB Europe Transparency & Consent Framework.
      *
-     * If using a real device, ensure you have set it as a test device via `addTestDevice()` otherwise this method will have
-     * no effect.
+     * More information available here:
+     * https://github.com/InteractiveAdvertisingBureau/GDPR-Transparency-and-Consent-Framework/blob/master/TCFv2/IAB%20Tech%20Lab%20-%20CMP%20API%20v2.md#in-app-details
      *
      * #### Example
      *
      * ```js
-     * import { AdsConsent, AdsConsentDebugGeography } from 'react-native-google-mobile-ads';
-     *
-     * // Set disabled
-     * await AdsConsentDebugGeography.setDebugGeography(AdsConsentDebugGeography.DISABLED);
+     * import { AdsConsent } from '@invertase/react-native-google-ads';
      *
-     * // Set within EEA
-     * await AdsConsentDebugGeography.setDebugGeography(AdsConsentDebugGeography.EEA);
-     *
-     * // Set outside EEA
-     * await AdsConsentDebugGeography.setDebugGeography(AdsConsentDebugGeography.NOT_EEA);
+     * const tcString = await AdsConsent.getTCString();
      * ```
-     *
-     * @param geography The debug geography location.
      */
-    setDebugGeography(geography: AdsConsentDebugGeography): Promise<void>;
+    getTCString(): Promise<string>;
     /**
-     * Manually update the consent status of the user.
-     *
-     * This method is used when providing your own means of user consent. If using the Google-rendered form via `showForm()`,
-     * the consent status is automatically set and calling this method is not required.
-     *
-     * This method can also be used to reset the consent status, by setting it to `AdsConsentStatus.UNKNOWN`, which may be useful in certain circumstances.
+     * Returns the TC Model of the saved IAB TCF 2.0 String.
      *
      * #### Example
      *
      * ```js
-     * import { AdsConsent, AdsConsentStatus } from 'react-native-google-mobile-ads';
+     * import { AdsConsent } from '@invertase/react-native-google-ads';
      *
-     * // User accepted personalized ads
-     * await AdsConsent.setStatus(AdsConsentStatus.PERSONALIZED);
+     * const tcModel = await AdsConsent.getTCModel();
      * ```
-     *
-     * @param status The user consent status.
      */
-    setStatus(status: AdsConsentStatus): Promise<void>;
+    getTCModel(): Promise<TCModel>;
     /**
-     * Returns the current consent status of the user.
-     *
-     * > The user consent status may change at any time, therefore don't reuse old values locally and always request the current value at any time consent is required.
+     * Provides information about a user's consent choices.
      *
      * #### Example
      *
      * ```js
-     * import { AdsConsent } from 'react-native-google-mobile-ads';
+     * import { AdsConsent } from '@invertase/react-native-google-ads';
      *
-     * const status = await AdsConsent.getStatus();
+     * const { storeAndAccessInformationOnDevice } = await AdsConsent.getUserChoices();
      * ```
      */
-    getStatus(): Promise<AdsConsentStatus>;
+    getUserChoices(): Promise<AdsConsentUserChoices>;
     /**
-     * If a publisher is aware that the user is under the age of consent, all ad requests must set TFUA (Tag For Users
-     * Under the Age of consent in Europe). This setting takes effect for all future ad requests.
-     *
-     * Once the TFUA setting is enabled, the Google-rendered consent form will fail to load. All ad requests that include
-     * TFUA will be made ineligible for personalized advertising and remarketing. TFUA disables requests to third-party
-     * ad technology providers, such as ad measurement pixels and third-party ad servers.
-     *
-     * To remove TFUA from ad requests, set the value to `false`.
+     * Resets the UMP SDK state.
      *
      * #### Example
      *
      * ```js
-     * import { AdsConsent } from 'react-native-google-mobile-ads';
+     * import { AdsConsent } from '@invertase/react-native-google-ads';
      *
-     * // User is under age of consent
-     * await AdsConsent.setTagForUnderAgeOfConsent(true);
+     * AdsConsent.reset();
      * ```
-     *
-     * @param tag The boolean value to tag for under age consent.
      */
-    setTagForUnderAgeOfConsent(tag: boolean): Promise<void>;
-    /**
-     * If using a real device to test, ensure the device ID is provided to the Google Mobile Ads SDK so any mock debug locations
-     * can take effect.
-     *
-     * Emulators are automatically on the allowlist and should require no action.
-     *
-     * If you are seeing real ad activity from a test device, examine logcat / console
-     * during execution in association with google mobile ads test device documentation to
-     * configure your device correctly.
-     *
-     * @param deviceIds An array of testing device ID.
-     */
-    addTestDevices(deviceIds: string[]): Promise<void>;
+    reset(): void;
 }
 /**
- * The options used to show on the Google-rendered consent form. At least one of `withAdFree`, `withPersonalizedAds` and `WithNonPersonalizedAds` needs to be set to `true`.
+ * The options used when requesting consent information.
  */
-export interface AdsConsentFormOptions {
+export interface AdsConsentInfoOptions {
     /**
-     * A fully formed HTTP or HTTPS privacy policy URL for your application.
-     *
-     * Users will have the option to visit this web page before consenting to ads.
+     * Sets the debug geography to locally test consent.
      */
-    privacyPolicy: string;
+    debugGeography?: AdsConsentDebugGeography;
     /**
      * Set to `true` to provide the option for the user to accept being shown personalized ads, defaults to `false`.
      */
-    withPersonalizedAds?: boolean;
-    /**
-     * Set to `true` to provide the option for the user to accept being shown non-personalized ads, defaults to `false`.
-     */
-    withNonPersonalizedAds?: boolean;
+    tagForUnderAgeOfConsent?: boolean;
     /**
-     * Set to `true` to provide the option for the user to choose an ad-free version of your app, defaults to `false`.
-     *
-     * If the user chooses this option, you must handle it as required (e.g. navigating to a paid version of the app,
-     * or a subscribe view).
+     * An array of test device IDs to allow.
      */
-    withAdFree?: boolean;
+    testDeviceIdentifiers?: string[];
 }
 /**
  * The result of a Google-rendered consent form.
@@ -257,15 +134,12 @@ export interface AdsConsentFormResult {
     /**
      * The consent status of the user after closing the consent form.
      *
-     * - UNKNOWN: The form was unable to determine the users consent status.
-     * - NON_PERSONALIZED: The user has accepted non-personalized ads.
-     * - PERSONALIZED: The user has accepted personalized ads.
+     *  - `UNKNOWN`: Unknown consent status.
+     *  - `REQUIRED`: User consent required but not yet obtained.
+     *  - `NOT_REQUIRED`: User consent not required.
+     *  - `OBTAINED`: User consent already obtained.
      */
     status: AdsConsentStatus;
-    /**
-     * If `true`, the user requested an ad-free version of your application.
-     */
-    userPrefersAdFree: boolean;
 }
 /**
  * The result of requesting info about a users consent status.
@@ -274,13 +148,188 @@ export interface AdsConsentInfo {
     /**
      * The consent status of the user.
      *
-     * - UNKNOWN: The consent status is unknown and the user must provide consent to show ads if they are within the EEA or location is also unknown.
-     * - NON_PERSONALIZED: The user has accepted non-personalized ads.
-     * - PERSONALIZED: The user has accepted personalized ads.
+     *  - `UNKNOWN`: Unknown consent status.
+     *  - `REQUIRED`: User consent required but not yet obtained.
+     *  - `NOT_REQUIRED`: User consent not required.
+     *  - `OBTAINED`: User consent already obtained.
      */
     status: AdsConsentStatus;
     /**
-     * If `true` the user is within the EEA or their location could not be determined.
+     * If `true` a consent form is available.
+     */
+    isConsentFormAvailable: boolean;
+}
+/**
+ * The options used when requesting consent information.
+ *
+ * https://vendor-list.consensu.org/v2/vendor-list.json
+ * https://github.com/InteractiveAdvertisingBureau/GDPR-Transparency-and-Consent-Framework
+ */
+export interface AdsConsentUserChoices {
+    /**
+     * Your device can be identified based on a scan of your device's
+     * unique combination of characteristics.
+     *
+     * Vendors can:
+     *   - Create an identifier using data collected via actively scanning a device for
+     *   - specific characteristics, e.g. installed fonts or screen resolution.
+     *   - Use such an identifier to re-identify a device.
+     */
+    activelyScanDeviceCharacteristicsForIdentification: boolean;
+    /**
+     * Market research can be used to learn more about the audiences who visit sites/apps and view ads.
+     *
+     * To apply market research to generate audience insights vendors can:
+     *   - Provide aggregate reporting to advertisers or their representatives about
+     *     the audiences reached by their ads, through panel-based and similarly derived insights.
+     *   - Provide aggregate reporting to publishers about the audiences that were served or
+     *     interacted with content and/or ads on their property by applying
+     *     panel-based and similarly derived insights.
+     *   - Associate offline data with an online user for the purposes of
+     *     market research to generate audience insights if vendors have declared to match and
+     *     combine offline data sources (Feature 1)
+     *   - Combine this information with other information previously collected including from
+     *     across websites and apps.
+     *
+     * Vendors cannot:
+     *   - Measure the performance and effectiveness of ads that a specific user was served or
+     *     interacted with, without a Legal Basis to measure ad performance.
+     *   - Measure which content a specific user was served and how they interacted with it,
+     *     without a Legal Basis to measure content performance.
+     */
+    applyMarketResearchToGenerateAudienceInsights: boolean;
+    /**
+     * A profile can be built about you and your interests to show you personalised ads
+     * that are relevant to you.
+     *
+     * To create a personalised ads profile vendors can:
+     *   - Collect information about a user, including a user's activity, interests,
+     *     demographic information, or location, to create or edit a user profile for use
+     *     in personalised advertising.
+     *   - Combine this information with other information previously collected,
+     *     including from across websites and apps, to create or edit a user profile
+     *     for use in personalised advertising.
+     */
+    createAPersonalisedAdsProfile: boolean;
+    /**
+     * A profile can be built about you and your interests to show you personalised content
+     * that is relevant to you.
+     *
+     * To create a personalised content profile vendors can:
+     *   - Collect information about a user, including a user's activity, interests, visits to
+     *     sites or apps, demographic information, or location, to create or edit a user profile
+     *     for personalising content.
+     *   - Combine this information with other information previously collected,
+     *     including from across websites and apps, to create or edit a user profile for use
+     *     in personalising content.
+     */
+    createAPersonalisedContentProfile: boolean;
+    /**
+     * Your data can be used to improve existing systems and software,
+     * and to develop new products
+     *
+     * To develop new products and improve products vendors can:
+     *   - Use information to improve their existing products with new features and
+     *     to develop new products
+     *   - Create new models and algorithms through machine learning
+     *
+     * Vendors cannot:
+     *   - Conduct any other data processing operation allowed under
+     *     a different purpose under this purpose
+     */
+    developAndImproveProducts: boolean;
+    /**
+     * The performance and effectiveness of ads that you see or interact with can be measured.
+     *
+     * To measure ad performance vendors can:
+     *   - Measure whether and how ads were delivered to and interacted with by a user
+     *   - Provide reporting about ads including their effectiveness and performance
+     *   - Provide reporting about users who interacted with ads using data observed during
+     *     the course of the user's interaction with that ad
+     *   - Provide reporting to publishers about the ads displayed on their property
+     *   - Measure whether an ad is serving in a suitable editorial environment (brand-safe) context
+     *   - Determine the percentage of the ad that had the opportunity to be seen and
+     *     the duration of that opportunity
+     *   - Combine this information with other information previously collected,
+     *     including from across websites and apps
+     *
+     * Vendors cannot:
+     *   - Apply panel- or similarly-derived audience insights data to ad measurement data
+     *     without a Legal Basis to apply market research to generate audience insights (Purpose 9)
+     */
+    measureAdPerformance: boolean;
+    /**
+     * The performance and effectiveness of content that you see or interact with can be measured.
+     *
+     * To measure content performance vendors can:
+     *   - Measure and report on how content was delivered to and interacted with by users.
+     *   - Provide reporting, using directly measurable or known information, about users who
+     *     interacted with the content
+     *   - Combine this information with other information previously collected,
+     *     including from across websites and apps.
+     *
+     * Vendors cannot:
+     *   - Measure whether and how ads (including native ads) were delivered to and
+     *     interacted with by a user.
+     *   - Apply panel- or similarly derived audience insights data to ad measurement
+     *     data without a Legal Basis to apply market research to generate audience insights (Purpose 9)
+     */
+    measureContentPerformance: boolean;
+    /**
+     * Ads can be shown to you based on the content you’re viewing,
+     * the app you’re using, your approximate location, or your device type.
+     *
+     * To do basic ad selection vendors can:
+     *  - Use real-time information about the context in which the ad will be shown,
+     *    to show the ad, including information about the content and the device, such as:
+     *    device type and capabilities, user agent, URL, IP address
+     *  - Use a user’s non-precise geolocation data
+     *  - Control the frequency of ads shown to a user.
+     *  - Sequence the order in which ads are shown to a user.
+     *  - Prevent an ad from serving in an unsuitable editorial (brand-unsafe) context
+     *
+     * Vendors cannot:
+     *  - Create a personalised ads profile using this information for the selection of
+     *    future ads without a separate legal basis to create a personalised ads profile.
+     *  - N.B. Non-precise means only an approximate location involving at least a radius
+     *    of 500 meters is permitted.
+     */
+    selectBasicAds: boolean;
+    /**
+     * Personalised ads can be shown to you based on a profile about you.
+     *
+     * To select personalised ads vendors can:
+     *   - Select personalised ads based on a user profile or other historical user data,
+     *     including a user’s prior activity, interests, visits to sites or apps, location,
+     *     or demographic information.
+     */
+    selectPersonalisedAds: boolean;
+    /**
+     * Personalised content can be shown to you based on a profile about you.
+     *
+     * To select personalised content vendors can:
+     *   - Select personalised content based on a user profile or other historical user data,
+     *     including a user’s prior activity, interests, visits to sites or apps, location,
+     *     or demographic information.
+     */
+    selectPersonalisedContent: boolean;
+    /**
+     * Cookies, device identifiers, or other information can be stored or
+     * accessed on your device for the purposes presented to you.
+     *
+     * Vendors can:
+     *   - Store and access information on the device such as cookies and
+     *     device identifiers presented to a user.
+     */
+    storeAndAccessInformationOnDevice: boolean;
+    /**
+     * Your precise geolocation data can be used in support of one or more purposes.
+     * This means your location can be accurate to within several meters.
+     *
+     * Vendors can:
+     *   - Collect and process precise geolocation data in support of one or more purposes.
+     *   - Precise geolocation means that there are no restrictions on the precision of
+     *     a user's location; this can be accurate to within several meters.
      */
-    isRequestLocationInEeaOrUnknown: boolean;
+    usePreciseGeolocationData: boolean;
 }

package/lib/typescript/version.d.ts

@@ -1 +1 @@
-export declare const version = "4.2.0";
+export declare const version = "5.1.0";

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "react-native-google-mobile-ads",
-  "version": "4.2.0",
+  "version": "5.1.0",
   "author": "Invertase <oss@invertase.io> (http://invertase.io)",
   "description": "React Native Google Mobile Ads is an easy way to monetize mobile apps with targeted, in-app advertising.",
   "main": "lib/commonjs/index.js",
@@ -41,14 +41,16 @@
   ],
   "sdkVersions": {
     "ios": {
-      "googleAds": "8.13.0"
+      "googleMobileAds": "8.13.0",
+      "googleUmp": "2.0.0"
     },
     "android": {
       "minSdk": 16,
       "targetSdk": 30,
       "compileSdk": 31,
       "buildTools": "31.0.0",
-      "googleAds": "19.8.0"
+      "googleMobileAds": "20.5.0",
+      "googleUmp": "2.0.0"
     }
   },
   "react-native-builder-bob": {
@@ -70,7 +72,7 @@
     "lint:ios:check": "clang-format --glob=\"ios/**/*.{h,cpp,m,mm}\" --style=Google -n -Werror",
     "lint:ios:fix": "clang-format -i --glob=\"ios/**/*.{h,cpp,m,mm}\" --style=Google",
     "lint:markdown:check": "prettier --check \"docs/**/*.md[x]\"",
-    "lint:markdown:fix": "prettier --write \"docs/**/*.md\"",
+    "lint:markdown:fix": "prettier --write \"docs/**/*.md[x]\"",
     "lint:report": "eslint --output-file=eslint-report.json --format=json . --ext .js,.jsx,.ts,.tsx",
     "lint:spellcheck": "spellchecker --quiet --files=\"docs/**/*.md\" --dictionaries=\"./.spellcheck.dict.txt\" --reports=\"spelling.json\" --plugins spell indefinite-article repeated-words syntax-mentions syntax-urls frontmatter",
     "tsc:compile": "tsc --project . --noEmit",
@@ -96,6 +98,10 @@
     "tests:ios:test-cover-reuse": "cd example && node_modules/.bin/nyc yarn detox test --configuration ios.sim.debug --reuse --loglevel warn",
     "tests:ios:pod:install": "cd example && cd ios && rm -rf example.xcworkspace && rm -f Podfile.lock && pod install --repo-update && cd .."
   },
+  "dependencies": {
+    "@iabtcf/core": "^1.4.0",
+    "use-deep-compare-effect": "^1.8.1"
+  },
   "devDependencies": {
     "@babel/core": "^7.16.0",
     "@babel/preset-env": "^7.16.4",