react-native-google-mobile-ads/src/AdsConsent.ts

React Native Google Mobile Ads is an easy way to monetize mobile apps with targeted, in-app advertising.

/*
 * 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 { TCModel, TCString } from '@iabtcf/core';
import { AdsConsentPurposes } from './AdsConsentPurposes';
import { AdsConsentSpecialFeatures } from './AdsConsentSpecialFeatures';
import { isPropertySet, isArray, isBoolean, isObject, isString } from './common';
import {
  AdsConsentInterface,
  AdsConsentDebugGeography,
  AdsConsentInfoOptions,
} from './specs/modules/NativeConsentModule';
import native from './specs/modules/NativeConsentModule';

export const AdsConsent: AdsConsentInterface = {
  requestInfoUpdate(options: AdsConsentInfoOptions = {}) {
    if (!isObject(options)) {
      throw new Error("AdsConsent.requestInfoUpdate(*) 'options' expected an object value.");
    }

    if (
      isPropertySet(options, 'debugGeography') &&
      options.debugGeography !== AdsConsentDebugGeography.DISABLED &&
      options.debugGeography !== AdsConsentDebugGeography.EEA &&
      options.debugGeography !== AdsConsentDebugGeography.NOT_EEA &&
      options.debugGeography !== AdsConsentDebugGeography.REGULATED_US_STATE &&
      options.debugGeography !== AdsConsentDebugGeography.OTHER
    ) {
      throw new Error(
        "AdsConsent.requestInfoUpdate(*) 'options.debugGeography' expected one of AdsConsentDebugGeography.DISABLED, AdsConsentDebugGeography.EEA, AdsConsentDebugGeography.NOT_EEA, AdsConsentDebugGeography.REGULATED_US_STATE or AdsConsentDebugGeography.OTHER.",
      );
    }

    if (
      isPropertySet(options, 'tagForUnderAgeOfConsent') &&
      !isBoolean(options.tagForUnderAgeOfConsent)
    ) {
      throw new Error(
        "AdsConsent.requestInfoUpdate(*) 'options.tagForUnderAgeOfConsent' expected a boolean value.",
      );
    }

    if (isPropertySet(options, 'testDeviceIdentifiers')) {
      if (!isArray(options.testDeviceIdentifiers)) {
        throw new Error(
          "AdsConsent.requestInfoUpdate(*) 'options.testDeviceIdentifiers' expected an array of string values.",
        );
      }

      for (const deviceId of options.testDeviceIdentifiers ?? []) {
        if (!isString(deviceId)) {
          throw new Error(
            "AdsConsent.requestInfoUpdate(*) 'options.testDeviceIdentifiers' expected an array of string values.",
          );
        }
      }
    }

    return native.requestInfoUpdate(options);
  },

  showForm() {
    return native.showForm();
  },

  showPrivacyOptionsForm() {
    return native.showPrivacyOptionsForm();
  },

  loadAndShowConsentFormIfRequired() {
    return native.loadAndShowConsentFormIfRequired();
  },

  getConsentInfo() {
    return native.getConsentInfo();
  },

  async gatherConsent(options: AdsConsentInfoOptions = {}) {
    await this.requestInfoUpdate(options);
    return this.loadAndShowConsentFormIfRequired();
  },

  reset() {
    return native.reset();
  },

  getTCString() {
    return native.getTCString();
  },

  async getTCModel() {
    const tcString = await native.getTCString();
    return TCString.decode(tcString);
  },

  getGdprApplies() {
    return native.getGdprApplies();
  },

  getPurposeConsents() {
    return native.getPurposeConsents();
  },

  getPurposeLegitimateInterests() {
    return native.getPurposeLegitimateInterests();
  },

  async getUserChoices() {
    const tcString = await native.getTCString();

    let tcModel: TCModel;

    try {
      tcModel = TCString.decode(tcString);
    } catch (e) {
      tcModel = new TCModel();

      if (__DEV__) {
        // eslint-disable-next-line no-console
        console.warn(`Failed to decode tcString ${tcString}:`, e);
      }
    }

    return {
      activelyScanDeviceCharacteristicsForIdentification: tcModel.specialFeatureOptins.has(
        AdsConsentSpecialFeatures.ACTIVELY_SCAN_DEVICE_CHARACTERISTICS_FOR_IDENTIFICATION,
      ),
      applyMarketResearchToGenerateAudienceInsights: tcModel.purposeConsents.has(
        AdsConsentPurposes.APPLY_MARKET_RESEARCH_TO_GENERATE_AUDIENCE_INSIGHTS,
      ),
      createAPersonalisedAdsProfile: tcModel.purposeConsents.has(
        AdsConsentPurposes.CREATE_A_PERSONALISED_ADS_PROFILE,
      ),
      createAPersonalisedContentProfile: tcModel.purposeConsents.has(
        AdsConsentPurposes.CREATE_A_PERSONALISED_CONTENT_PROFILE,
      ),
      developAndImproveProducts: tcModel.purposeConsents.has(
        AdsConsentPurposes.DEVELOP_AND_IMPROVE_PRODUCTS,
      ),
      measureAdPerformance: tcModel.purposeConsents.has(AdsConsentPurposes.MEASURE_AD_PERFORMANCE),
      measureContentPerformance: tcModel.purposeConsents.has(
        AdsConsentPurposes.MEASURE_CONTENT_PERFORMANCE,
      ),
      selectBasicAds: tcModel.purposeConsents.has(AdsConsentPurposes.SELECT_BASIC_ADS),
      selectPersonalisedAds: tcModel.purposeConsents.has(
        AdsConsentPurposes.SELECT_PERSONALISED_ADS,
      ),
      selectPersonalisedContent: tcModel.purposeConsents.has(
        AdsConsentPurposes.SELECT_PERSONALISED_CONTENT,
      ),
      storeAndAccessInformationOnDevice: tcModel.purposeConsents.has(
        AdsConsentPurposes.STORE_AND_ACCESS_INFORMATION_ON_DEVICE,
      ),
      usePreciseGeolocationData: tcModel.specialFeatureOptins.has(
        AdsConsentSpecialFeatures.USE_PRECISE_GEOLOCATION_DATA,
      ),
    };
  },
};