@firebase/analytics 0.7.10 → 0.7.11-canary.13550089f

package/CHANGELOG.md

@@ -1,5 +1,16 @@
 # @firebase/analytics
 
+## 0.7.11
+
+### Patch Changes
+
+- [`835f1d46a`](https://github.com/firebase/firebase-js-sdk/commit/835f1d46a6780535bc660ef7dc23293350d5fe43) [#6357](https://github.com/firebase/firebase-js-sdk/pull/6357) - Fix typo in GtagConfigParams
+
+- Updated dependencies [[`efe2000fc`](https://github.com/firebase/firebase-js-sdk/commit/efe2000fc499e2c85c4e5e0fef6741ff3bad2eb0)]:
+  - @firebase/util@1.6.2
+  - @firebase/component@0.5.16
+  - @firebase/installations@0.5.11
+
 ## 0.7.10
 
 ### Patch Changes

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
@@ -195,7 +227,7 @@ export declare interface GtagConfigParams {
      * If set to false, disables all advertising features with `gtag.js`.
      * See {@link https://developers.google.com/analytics/devguides/collection/ga4/display-features | Disable advertising features }
      */
-    'allow_google_signals?': boolean;
+    'allow_google_signals'?: boolean;
     /**
      * If set to false, disables all advertising personalization with `gtag.js`.
      * See {@link https://developers.google.com/analytics/devguides/collection/ga4/display-features | Disable advertising features }
@@ -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`.
  *
@@ -650,6 +693,15 @@ export declare function setAnalyticsCollectionEnabled(analyticsInstance: Analyti
  */
 export declare function setCurrentScreen(analyticsInstance: Analytics, screenName: string, options?: AnalyticsCallOptions): void;
 
+/**
+ * Adds data that will be set on every event logged from the SDK, including automatic ones.
+ * 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.
+ */
+export declare function setDefaultEventParameters(customParams: CustomParams): void;
+
 /**
  * Configures Firebase Analytics to use custom `gtag` or `dataLayer` names.
  * Intended to be used if `gtag.js` script has been installed on

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
@@ -195,7 +227,7 @@ export declare interface GtagConfigParams {
      * If set to false, disables all advertising features with `gtag.js`.
      * See {@link https://developers.google.com/analytics/devguides/collection/ga4/display-features | Disable advertising features }
      */
-    'allow_google_signals?': boolean;
+    'allow_google_signals'?: boolean;
     /**
      * If set to false, disables all advertising personalization with `gtag.js`.
      * See {@link https://developers.google.com/analytics/devguides/collection/ga4/display-features | Disable advertising features }
@@ -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`.
  *
@@ -650,6 +693,15 @@ export declare function setAnalyticsCollectionEnabled(analyticsInstance: Analyti
  */
 export declare function setCurrentScreen(analyticsInstance: Analytics, screenName: string, options?: AnalyticsCallOptions): void;
 
+/**
+ * Adds data that will be set on every event logged from the SDK, including automatic ones.
+ * 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.
+ */
+export declare function setDefaultEventParameters(customParams: CustomParams): void;
+
 /**
  * Configures Firebase Analytics to use custom `gtag` or `dataLayer` names.
  * Intended to be used if `gtag.js` script has been installed on