From d33c2ed1c097e4553a770dce807b1b030a3e0d00 Mon Sep 17 00:00:00 2001 From: Christina Holland Date: Thu, 24 Jun 2021 16:21:36 -0700 Subject: [PATCH 1/4] Add firebase-specific screen_view params to Analytics --- common/api-review/analytics-exp.api.md | 4 ++++ packages-exp/analytics-exp/src/api.ts | 2 ++ packages-exp/analytics-exp/src/public-types.ts | 8 ++++++++ packages/analytics-types/index.d.ts | 10 ++++++++++ packages/firebase/index.d.ts | 10 ++++++++++ 5 files changed, 34 insertions(+) diff --git a/common/api-review/analytics-exp.api.md b/common/api-review/analytics-exp.api.md index 35172fa0f8f..b9debc18710 100644 --- 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 index c0ff7f337fc..e644cba77ac 100644 --- 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 index 13076472589..b8cd9f8f706 100644 --- 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 index b2632793d43..e33abc1ced5 100644 --- 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 index 18c4e7e1b47..546e126285e 100644 --- a/packages/firebase/index.d.ts +++ b/packages/firebase/index.d.ts @@ -4858,6 +4858,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; @@ -5166,6 +5168,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; From 511fc90b72750183b8820e1b3e22c87196d69d75 Mon Sep 17 00:00:00 2001 From: Christina Holland Date: Thu, 24 Jun 2021 16:26:35 -0700 Subject: [PATCH 2/4] Add changeset. --- .changeset/nasty-hats-hope.md | 6 ++++++ 1 file changed, 6 insertions(+) create mode 100644 .changeset/nasty-hats-hope.md diff --git a/.changeset/nasty-hats-hope.md b/.changeset/nasty-hats-hope.md new file mode 100644 index 00000000000..4e9f22d4cf8 --- /dev/null +++ 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. From 0daf9b55c7490b4f48c10ff2fe996d76fd13c696 Mon Sep 17 00:00:00 2001 From: Christina Holland Date: Thu, 15 Jul 2021 16:01:54 -0700 Subject: [PATCH 3/4] Add ticks to literals --- packages-exp/analytics-exp/src/public-types.ts | 4 ++-- packages/analytics-types/index.d.ts | 4 ++-- 2 files changed, 4 insertions(+), 4 deletions(-) diff --git a/packages-exp/analytics-exp/src/public-types.ts b/packages-exp/analytics-exp/src/public-types.ts index b8cd9f8f706..2da29cc567c 100644 --- a/packages-exp/analytics-exp/src/public-types.ts +++ b/packages-exp/analytics-exp/src/public-types.ts @@ -280,11 +280,11 @@ export interface EventParams { promotions?: Promotion[]; screen_name?: string; /** - * Firebase-specific. Use to log a screen_name to Firebase Analytics. + * 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-specific. Use to log a `screen_class` to Firebase Analytics. */ firebase_screen_class?: string; search_term?: string; diff --git a/packages/analytics-types/index.d.ts b/packages/analytics-types/index.d.ts index e33abc1ced5..eaa29212691 100644 --- a/packages/analytics-types/index.d.ts +++ b/packages/analytics-types/index.d.ts @@ -549,11 +549,11 @@ export interface EventParams { promotions?: Promotion[]; screen_name?: string; /** - * Firebase-specific. Use to log a screen_name to Firebase Analytics. + * 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-specific. Use to log a `screen_class` to Firebase Analytics. */ firebase_screen_class?: string; search_term?: string; From 579ee34572f97c07f2152725ede56b2323a79f08 Mon Sep 17 00:00:00 2001 From: Christina Holland Date: Thu, 15 Jul 2021 16:03:14 -0700 Subject: [PATCH 4/4] One more place? --- packages/firebase/index.d.ts | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/packages/firebase/index.d.ts b/packages/firebase/index.d.ts index 546e126285e..0a776c77f12 100644 --- a/packages/firebase/index.d.ts +++ b/packages/firebase/index.d.ts @@ -5169,11 +5169,11 @@ declare namespace firebase.analytics { promotions?: Promotion[]; screen_name?: string; /** - * Firebase-specific. Use to log a screen_name to Firebase Analytics. + * 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-specific. Use to log a `screen_class` to Firebase Analytics. */ firebase_screen_class?: string; search_term?: string;