@firebase/analytics 0.7.11-canary.69e2ee064 → 0.7.11-canary.7cad614ec

package/dist/analytics-public.d.ts

@@ -42,6 +42,38 @@ export declare interface AnalyticsSettings {
     config?: GtagConfigParams | EventParams;
 }
 
+/**
+ * Consent status settings for each consent type.
+ * For more information, see
+ * {@link https://developers.google.com/tag-platform/tag-manager/templates/consent-apis
+ * | the GA4 reference documentation for consent state and consent types}.
+ * @public
+ */
+export declare interface ConsentSettings {
+    /** Enables storage, such as cookies, related to advertising */
+    ad_storage?: ConsentStatusString;
+    /** Enables storage, such as cookies, related to analytics (for example, visit duration) */
+    analytics_storage?: ConsentStatusString;
+    /**
+     * Enables storage that supports the functionality of the website or app such as language settings
+     */
+    functionality_storage?: ConsentStatusString;
+    /** Enables storage related to personalization such as video recommendations */
+    personalization_storage?: ConsentStatusString;
+    /**
+     * Enables storage related to security such as authentication functionality, fraud prevention,
+     * and other user protection.
+     */
+    security_storage?: ConsentStatusString;
+    [key: string]: unknown;
+}
+
+/**
+ * Whether a particular consent type has been granted or denied.
+ * @public
+ */
+export declare type ConsentStatusString = 'granted' | 'denied';
+
 /**
  * Standard `gtag.js` control parameters.
  * For more information, see
@@ -637,6 +669,17 @@ export declare interface Promotion {
  */
 export declare function setAnalyticsCollectionEnabled(analyticsInstance: Analytics, enabled: boolean): void;
 
+/**
+ * Sets the applicable end user consent state for this web app across all gtag references once
+ * Firebase Analytics is initialized.
+ *
+ * Use the {@link ConsentSettings} to specify individual consent type values. By default consent
+ * types are set to "granted".
+ * @public
+ * @param consentSettings - Maps the applicable end user consent state for gtag.js.
+ */
+export declare function setConsent(consentSettings: ConsentSettings): void;
+
 /**
  * Use gtag `config` command to set `screen_name`.
  *
@@ -655,7 +698,7 @@ export declare function setCurrentScreen(analyticsInstance: Analytics, screenNam
  * With gtag's "set" command, the values passed persist on the current page and are passed with
  * all subsequent events.
  * @public
- * @param customParams Any custom params the user may pass to gtag.js.
+ * @param customParams - Any custom params the user may pass to gtag.js.
  */
 export declare function setDefaultEventParameters(customParams: CustomParams): void;
 

package/dist/analytics.d.ts

@@ -42,6 +42,38 @@ export declare interface AnalyticsSettings {
     config?: GtagConfigParams | EventParams;
 }
 
+/**
+ * Consent status settings for each consent type.
+ * For more information, see
+ * {@link https://developers.google.com/tag-platform/tag-manager/templates/consent-apis
+ * | the GA4 reference documentation for consent state and consent types}.
+ * @public
+ */
+export declare interface ConsentSettings {
+    /** Enables storage, such as cookies, related to advertising */
+    ad_storage?: ConsentStatusString;
+    /** Enables storage, such as cookies, related to analytics (for example, visit duration) */
+    analytics_storage?: ConsentStatusString;
+    /**
+     * Enables storage that supports the functionality of the website or app such as language settings
+     */
+    functionality_storage?: ConsentStatusString;
+    /** Enables storage related to personalization such as video recommendations */
+    personalization_storage?: ConsentStatusString;
+    /**
+     * Enables storage related to security such as authentication functionality, fraud prevention,
+     * and other user protection.
+     */
+    security_storage?: ConsentStatusString;
+    [key: string]: unknown;
+}
+
+/**
+ * Whether a particular consent type has been granted or denied.
+ * @public
+ */
+export declare type ConsentStatusString = 'granted' | 'denied';
+
 /**
  * Standard `gtag.js` control parameters.
  * For more information, see
@@ -637,6 +669,17 @@ export declare interface Promotion {
  */
 export declare function setAnalyticsCollectionEnabled(analyticsInstance: Analytics, enabled: boolean): void;
 
+/**
+ * Sets the applicable end user consent state for this web app across all gtag references once
+ * Firebase Analytics is initialized.
+ *
+ * Use the {@link ConsentSettings} to specify individual consent type values. By default consent
+ * types are set to "granted".
+ * @public
+ * @param consentSettings - Maps the applicable end user consent state for gtag.js.
+ */
+export declare function setConsent(consentSettings: ConsentSettings): void;
+
 /**
  * Use gtag `config` command to set `screen_name`.
  *
@@ -655,7 +698,7 @@ export declare function setCurrentScreen(analyticsInstance: Analytics, screenNam
  * With gtag's "set" command, the values passed persist on the current page and are passed with
  * all subsequent events.
  * @public
- * @param customParams Any custom params the user may pass to gtag.js.
+ * @param customParams - Any custom params the user may pass to gtag.js.
  */
 export declare function setDefaultEventParameters(customParams: CustomParams): void;
 

package/dist/esm/index.esm.js

@@ -277,8 +277,14 @@ measurementIdToAppId) {
                         _a.sent();
                         return [3 /*break*/, 5];
                     case 4:
-                        // If SET, second arg must be params.
-                        gtagCore("set" /* SET */, idOrNameOrParams);
+                        if (command === "consent" /* CONSENT */) {
+                            // If CONFIG, second arg must be measurementId.
+                            gtagCore("consent" /* CONSENT */, 'update', gtagParams);
+                        }
+                        else {
+                            // If SET, second arg must be params.
+                            gtagCore("set" /* SET */, idOrNameOrParams);
+                        }
                         _a.label = 5;
                     case 5: return [3 /*break*/, 7];
                     case 6:
@@ -821,6 +827,19 @@ function setAnalyticsCollectionEnabled$1(initializationPromise, enabled) {
         });
     });
 }
+/**
+ * Consent parameters to default to during 'gtag' initialization.
+ */
+var defaultConsentSettingsForInit;
+/**
+ * Sets the variable {@link defaultConsentSettingsForInit} for use in the initialization of
+ * analytics.
+ *
+ * @param consentSettings Maps the applicable end user consent state for gtag.js.
+ */
+function _setConsentDefaultForInit(consentSettings) {
+    defaultConsentSettingsForInit = consentSettings;
+}
 /**
  * Sets the variable `defaultEventParametersForInit` for use in the initialization of
  * analytics.
@@ -931,6 +950,11 @@ function _initializeAnalytics(app, dynamicConfigPromisesList, measurementIdToApp
                     if (!findGtagScriptOnPage()) {
                         insertScriptTag(dataLayerName, dynamicConfig.measurementId);
                     }
+                    // Detects if there are consent settings that need to be configured.
+                    if (defaultConsentSettingsForInit) {
+                        gtagCore("consent" /* CONSENT */, 'default', defaultConsentSettingsForInit);
+                        _setConsentDefaultForInit(undefined);
+                    }
                     // This command initializes gtag.js and only needs to be called once for the entire web app,
                     // but since it is idempotent, we can call it multiple times.
                     // We keep it together with other initialization logic for better code structure.
@@ -1253,7 +1277,7 @@ function setAnalyticsCollectionEnabled(analyticsInstance, enabled) {
  * With gtag's "set" command, the values passed persist on the current page and are passed with
  * all subsequent events.
  * @public
- * @param customParams Any custom params the user may pass to gtag.js.
+ * @param customParams - Any custom params the user may pass to gtag.js.
  */
 function setDefaultEventParameters(customParams) {
     // Check if reference to existing gtag function on window object exists
@@ -1278,10 +1302,28 @@ function setDefaultEventParameters(customParams) {
 function logEvent(analyticsInstance, eventName, eventParams, options) {
     analyticsInstance = getModularInstance(analyticsInstance);
     logEvent$1(wrappedGtagFunction, initializationPromisesMap[analyticsInstance.app.options.appId], eventName, eventParams, options).catch(function (e) { return logger.error(e); });
+}
+/**
+ * Sets the applicable end user consent state for this web app across all gtag references once
+ * Firebase Analytics is initialized.
+ *
+ * Use the {@link ConsentSettings} to specify individual consent type values. By default consent
+ * types are set to "granted".
+ * @public
+ * @param consentSettings - Maps the applicable end user consent state for gtag.js.
+ */
+function setConsent(consentSettings) {
+    // Check if reference to existing gtag function on window object exists
+    if (wrappedGtagFunction) {
+        wrappedGtagFunction("consent" /* CONSENT */, 'update', consentSettings);
+    }
+    else {
+        _setConsentDefaultForInit(consentSettings);
+    }
 }
 
 var name = "@firebase/analytics";
-var version = "0.7.11-canary.69e2ee064";
+var version = "0.7.11-canary.7cad614ec";
 
 /**
  * Firebase Analytics
@@ -1318,5 +1360,5 @@ function registerAnalytics() {
 }
 registerAnalytics();
 
-export { getAnalytics, initializeAnalytics, isSupported, logEvent, setAnalyticsCollectionEnabled, setCurrentScreen, setDefaultEventParameters, setUserId, setUserProperties, settings };
+export { getAnalytics, initializeAnalytics, isSupported, logEvent, setAnalyticsCollectionEnabled, setConsent, setCurrentScreen, setDefaultEventParameters, setUserId, setUserProperties, settings };
 //# sourceMappingURL=index.esm.js.map