Skip to content

Add firebase-specific screen_view params to Analytics #5070

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 4 commits into from
Jul 16, 2021
Merged

Add firebase-specific screen_view params to Analytics #5070

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
d33c2ed
Add firebase-specific screen_view params to Analytics
hsubox76 Jun 24, 2021
511fc90
Add changeset.
hsubox76 Jun 24, 2021
0daf9b5
Add ticks to literals
hsubox76 Jul 15, 2021
579ee34
One more place?
hsubox76 Jul 15, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 6 additions & 0 deletions .changeset/nasty-hats-hope.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
---
'@firebase/analytics-types': minor
'firebase': minor
---

Add `firebase_screen` and `firebase_screen_class` to `logEvent()` overload for `screen_view` events.
4 changes: 4 additions & 0 deletions common/api-review/analytics-exp.api.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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)
Expand Down Expand Up @@ -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;
Expand Down
2 changes: 2 additions & 0 deletions packages-exp/analytics-exp/src/api.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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;
Expand Down
8 changes: 8 additions & 0 deletions packages-exp/analytics-exp/src/public-types.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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;
Expand Down
10 changes: 10 additions & 0 deletions packages/analytics-types/index.d.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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;
Expand Down Expand Up @@ -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;
Expand Down
10 changes: 10 additions & 0 deletions packages/firebase/index.d.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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;
Expand Down Expand Up @@ -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;
Expand Down