Add firebase-specific screen_view params to Analytics (#5070)

firebase · Jul 16, 2021 · 02586c9 · 02586c9
1 parent 4cb5d8a
commit 02586c9
Show file tree

Hide file tree

Showing 6 changed files with 40 additions and 0 deletions.
diff --git a/.changeset/nasty-hats-hope.md b/.changeset/nasty-hats-hope.md
@@ -0,0 +1,6 @@
+---
+'@firebase/analytics-types': minor
+'firebase': minor
+---
+
+Add `firebase_screen` and `firebase_screen_class` to `logEvent()` overload for `screen_view` events.
diff --git a/common/api-review/analytics-exp.api.md b/common/api-review/analytics-exp.api.md
@@ -74,6 +74,8 @@ export interface EventParams {
     event_label?: string;
     // (undocumented)
     fatal?: boolean;
+    firebase_screen?: string;
+    firebase_screen_class?: string;
     // (undocumented)
     item_list_id?: string;
     // (undocumented)
@@ -295,6 +297,8 @@ export function logEvent(analyticsInstance: Analytics, eventName: 'purchase' | '
 export function logEvent(analyticsInstance: Analytics, eventName: 'screen_view', eventParams?: {
     app_name: string;
     screen_name: EventParams['screen_name'];
+    firebase_screen: EventParams['firebase_screen'];
+    firebase_screen_class: EventParams['firebase_screen_class'];
     app_id?: string;
     app_version?: string;
     app_installer_id?: string;

diff --git a/packages-exp/analytics-exp/src/api.ts b/packages-exp/analytics-exp/src/api.ts
@@ -450,6 +450,8 @@ export function logEvent(
   eventParams?: {
     app_name: string;
     screen_name: EventParams['screen_name'];
+    firebase_screen: EventParams['firebase_screen'];
+    firebase_screen_class: EventParams['firebase_screen_class'];
     app_id?: string;
     app_version?: string;
     app_installer_id?: string;

diff --git a/packages-exp/analytics-exp/src/public-types.ts b/packages-exp/analytics-exp/src/public-types.ts
@@ -279,6 +279,14 @@ export interface EventParams {
   number?: string;
   promotions?: Promotion[];
   screen_name?: string;
+  /**
+   * Firebase-specific. Use to log a `screen_name` to Firebase Analytics.
+   */
+  firebase_screen?: string;
+  /**
+   * Firebase-specific. Use to log a `screen_class` to Firebase Analytics.
+   */
+  firebase_screen_class?: string;
   search_term?: string;
   shipping?: Currency;
   tax?: Currency;

diff --git a/packages/analytics-types/index.d.ts b/packages/analytics-types/index.d.ts
@@ -249,6 +249,8 @@ export interface FirebaseAnalytics {
     eventParams?: {
       app_name: string;
       screen_name: EventParams['screen_name'];
+      firebase_screen: EventParams['firebase_screen'];
+      firebase_screen_class: EventParams['firebase_screen_class'];
       app_id?: string;
       app_version?: string;
       app_installer_id?: string;
@@ -546,6 +548,14 @@ export interface EventParams {
   number?: string;
   promotions?: Promotion[];
   screen_name?: string;
+  /**
+   * Firebase-specific. Use to log a `screen_name` to Firebase Analytics.
+   */
+  firebase_screen?: string;
+  /**
+   * Firebase-specific. Use to log a `screen_class` to Firebase Analytics.
+   */
+  firebase_screen_class?: string;
   search_term?: string;
   shipping?: Currency;
   tax?: Currency;

diff --git a/packages/firebase/index.d.ts b/packages/firebase/index.d.ts
@@ -4859,6 +4859,8 @@ declare namespace firebase.analytics {
       eventParams?: {
         app_name: string;
         screen_name: EventParams['screen_name'];
+        firebase_screen: EventParams['firebase_screen'];
+        firebase_screen_class: EventParams['firebase_screen_class'];
         app_id?: string;
         app_version?: string;
         app_installer_id?: string;
@@ -5167,6 +5169,14 @@ declare namespace firebase.analytics {
     number?: string;
     promotions?: Promotion[];
     screen_name?: string;
+    /**
+     * Firebase-specific. Use to log a `screen_name` to Firebase Analytics.
+     */
+    firebase_screen?: string;
+    /**
+     * Firebase-specific. Use to log a `screen_class` to Firebase Analytics.
+     */
+    firebase_screen_class?: string;
     search_term?: string;
     shipping?: Currency;
     tax?: Currency;