Skip to content

Commit 7aee62e

Browse files
hsubox76hsubox76
authored
Create modularized Analytics package. (#4116)
1 parent 04a0fea commit 7aee62e

39 files changed

+4772
-2
lines changed

‎.changeset/config.json

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,8 @@
1515
"firebase-messaging-integration-test",
1616
"@firebase/app-exp",
1717
"@firebase/app-types-exp",
18+
"@firebase/analytics-exp",
19+
"@firebase/analytics-types-exp",
1820
"@firebase/auth-exp",
1921
"@firebase/auth-compat",
2022
"@firebase/auth-types-exp",

‎common/api-review/analytics-exp.api.md

Lines changed: 243 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,243 @@
1+
## API Report File for "@firebase/analytics-exp"
2+
3+
> Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/).
4+
5+
```ts
6+
7+
import { Analytics } from '@firebase/analytics-types-exp';
8+
import { AnalyticsCallOptions } from '@firebase/analytics-types-exp';
9+
import { ControlParams } from '@firebase/analytics-types-exp';
10+
import { CustomParams } from '@firebase/analytics-types-exp';
11+
import { EventNameString } from '@firebase/analytics-types-exp';
12+
import { EventParams } from '@firebase/analytics-types-exp';
13+
import { FirebaseApp } from '@firebase/app-types-exp';
14+
import { Item } from '@firebase/analytics-types-exp';
15+
import { Promotion } from '@firebase/analytics-types-exp';
16+
import { SettingsOptions } from '@firebase/analytics-types-exp';
17+
18+
export { Analytics }
19+
20+
export { AnalyticsCallOptions }
21+
22+
export { ControlParams }
23+
24+
// @public
25+
export type CustomEventName<T> = T extends EventNameString ? never : T;
26+
27+
export { CustomParams }
28+
29+
export { EventParams }
30+
31+
// @public
32+
export function getAnalytics(app: FirebaseApp): Analytics;
33+
34+
// @public
35+
export function isSupported(): Promise<boolean>;
36+
37+
export { Item }
38+
39+
// @public
40+
export function logEvent(analyticsInstance: Analytics, eventName: 'add_payment_info', eventParams?: {
41+
coupon?: EventParams['coupon'];
42+
currency?: EventParams['currency'];
43+
items?: EventParams['items'];
44+
payment_type?: EventParams['payment_type'];
45+
value?: EventParams['value'];
46+
[key: string]: any;
47+
}, options?: AnalyticsCallOptions): void;
48+
49+
// @public
50+
export function logEvent(analyticsInstance: Analytics, eventName: 'add_shipping_info', eventParams: {
51+
coupon?: EventParams['coupon'];
52+
currency?: EventParams['currency'];
53+
items?: EventParams['items'];
54+
shipping_tier?: EventParams['shipping_tier'];
55+
value?: EventParams['value'];
56+
[key: string]: any;
57+
}, options?: AnalyticsCallOptions): void;
58+
59+
// @public
60+
export function logEvent(analyticsInstance: Analytics, eventName: 'add_to_cart' | 'add_to_wishlist' | 'remove_from_cart', eventParams: {
61+
currency?: EventParams['currency'];
62+
value?: EventParams['value'];
63+
items?: EventParams['items'];
64+
[key: string]: any;
65+
}, options?: AnalyticsCallOptions): void;
66+
67+
// @public
68+
export function logEvent(analyticsInstance: Analytics, eventName: 'begin_checkout', eventParams: {
69+
currency?: EventParams['currency'];
70+
coupon?: EventParams['coupon'];
71+
value?: EventParams['value'];
72+
items?: EventParams['items'];
73+
[key: string]: any;
74+
}, options?: AnalyticsCallOptions): void;
75+
76+
// @public
77+
export function logEvent(analyticsInstance: Analytics, eventName: 'checkout_progress', eventParams: {
78+
currency?: EventParams['currency'];
79+
coupon?: EventParams['coupon'];
80+
value?: EventParams['value'];
81+
items?: EventParams['items'];
82+
checkout_step?: EventParams['checkout_step'];
83+
checkout_option?: EventParams['checkout_option'];
84+
[key: string]: any;
85+
}, options?: AnalyticsCallOptions): void;
86+
87+
// @public
88+
export function logEvent(analyticsInstance: Analytics, eventName: 'exception', eventParams: {
89+
description?: EventParams['description'];
90+
fatal?: EventParams['fatal'];
91+
[key: string]: any;
92+
}, options?: AnalyticsCallOptions): void;
93+
94+
// @public
95+
export function logEvent(analyticsInstance: Analytics, eventName: 'generate_lead', eventParams: {
96+
value?: EventParams['value'];
97+
currency?: EventParams['currency'];
98+
transaction_id?: EventParams['transaction_id'];
99+
[key: string]: any;
100+
}, options?: AnalyticsCallOptions): void;
101+
102+
// @public
103+
export function logEvent(analyticsInstance: Analytics, eventName: 'login', eventParams: {
104+
method?: EventParams['method'];
105+
[key: string]: any;
106+
}, options?: AnalyticsCallOptions): void;
107+
108+
// @public
109+
export function logEvent(analyticsInstance: Analytics, eventName: 'page_view', eventParams: {
110+
page_title?: string;
111+
page_location?: string;
112+
page_path?: string;
113+
[key: string]: any;
114+
}, options?: AnalyticsCallOptions): void;
115+
116+
// @public
117+
export function logEvent(analyticsInstance: Analytics, eventName: 'purchase' | 'refund', eventParams: {
118+
value?: EventParams['value'];
119+
currency?: EventParams['currency'];
120+
transaction_id: EventParams['transaction_id'];
121+
tax?: EventParams['tax'];
122+
shipping?: EventParams['shipping'];
123+
items?: EventParams['items'];
124+
coupon?: EventParams['coupon'];
125+
affiliation?: EventParams['affiliation'];
126+
[key: string]: any;
127+
}, options?: AnalyticsCallOptions): void;
128+
129+
// @public
130+
export function logEvent(analyticsInstance: Analytics, eventName: 'screen_view', eventParams: {
131+
app_name: string;
132+
screen_name: EventParams['screen_name'];
133+
app_id?: string;
134+
app_version?: string;
135+
app_installer_id?: string;
136+
[key: string]: any;
137+
}, options?: AnalyticsCallOptions): void;
138+
139+
// @public
140+
export function logEvent(analyticsInstance: Analytics, eventName: 'search' | 'view_search_results', eventParams: {
141+
search_term?: EventParams['search_term'];
142+
[key: string]: any;
143+
}, options?: AnalyticsCallOptions): void;
144+
145+
// @public
146+
export function logEvent(analyticsInstance: Analytics, eventName: 'select_content', eventParams: {
147+
items?: EventParams['items'];
148+
promotions?: EventParams['promotions'];
149+
content_type?: EventParams['content_type'];
150+
content_id?: EventParams['content_id'];
151+
[key: string]: any;
152+
}, options?: AnalyticsCallOptions): void;
153+
154+
// @public
155+
export function logEvent(analyticsInstance: Analytics, eventName: 'select_item', eventParams: {
156+
items?: EventParams['items'];
157+
item_list_name?: EventParams['item_list_name'];
158+
item_list_id?: EventParams['item_list_id'];
159+
[key: string]: any;
160+
}, options?: AnalyticsCallOptions): void;
161+
162+
// @public
163+
export function logEvent(analyticsInstance: Analytics, eventName: 'select_promotion' | 'view_promotion', eventParams: {
164+
items?: EventParams['items'];
165+
promotion_id?: EventParams['promotion_id'];
166+
promotion_name?: EventParams['promotion_name'];
167+
[key: string]: any;
168+
}, options?: AnalyticsCallOptions): void;
169+
170+
// @public
171+
export function logEvent(analyticsInstance: Analytics, eventName: 'set_checkout_option', eventParams: {
172+
checkout_step?: EventParams['checkout_step'];
173+
checkout_option?: EventParams['checkout_option'];
174+
[key: string]: any;
175+
}, options?: AnalyticsCallOptions): void;
176+
177+
// @public
178+
export function logEvent(analyticsInstance: Analytics, eventName: 'share', eventParams: {
179+
method?: EventParams['method'];
180+
content_type?: EventParams['content_type'];
181+
content_id?: EventParams['content_id'];
182+
[key: string]: any;
183+
}, options?: AnalyticsCallOptions): void;
184+
185+
// @public
186+
export function logEvent(analyticsInstance: Analytics, eventName: 'sign_up', eventParams: {
187+
method?: EventParams['method'];
188+
[key: string]: any;
189+
}, options?: AnalyticsCallOptions): void;
190+
191+
// @public
192+
export function logEvent(analyticsInstance: Analytics, eventName: 'timing_complete', eventParams: {
193+
name: string;
194+
value: number;
195+
event_category?: string;
196+
event_label?: string;
197+
[key: string]: any;
198+
}, options?: AnalyticsCallOptions): void;
199+
200+
// @public
201+
export function logEvent(analyticsInstance: Analytics, eventName: 'view_cart' | 'view_item', eventParams: {
202+
currency?: EventParams['currency'];
203+
items?: EventParams['items'];
204+
value?: EventParams['value'];
205+
[key: string]: any;
206+
}, options?: AnalyticsCallOptions): void;
207+
208+
// @public
209+
export function logEvent(analyticsInstance: Analytics, eventName: 'view_item_list', eventParams: {
210+
items?: EventParams['items'];
211+
item_list_name?: EventParams['item_list_name'];
212+
item_list_id?: EventParams['item_list_id'];
213+
[key: string]: any;
214+
}, options?: AnalyticsCallOptions): void;
215+
216+
// @public
217+
export function logEvent<T extends string>(analyticsInstance: Analytics, eventName: CustomEventName<T>, eventParams?: {
218+
[key: string]: any;
219+
}, options?: AnalyticsCallOptions): void;
220+
221+
export { Promotion }
222+
223+
// @public
224+
export function setAnalyticsCollectionEnabled(analyticsInstance: Analytics, enabled: boolean): void;
225+
226+
// @public
227+
export function setCurrentScreen(analyticsInstance: Analytics, screenName: string, options?: AnalyticsCallOptions): void;
228+
229+
// @public
230+
export function settings(options: SettingsOptions): void;
231+
232+
export { SettingsOptions }
233+
234+
// @public
235+
export function setUserId(analyticsInstance: Analytics, id: string, options?: AnalyticsCallOptions): void;
236+
237+
// @public
238+
export function setUserProperties(analyticsInstance: Analytics, properties: CustomParams, options?: AnalyticsCallOptions): void;
239+
240+
241+
// (No @packageDocumentation comment for this package)
242+
243+
```

0 commit comments

Comments
 (0)