Firebase Analytics Web SDK。此 SDK 不适用于 Node.js 环境。
功能
功能 | 描述 |
---|---|
函数(应用程序,...) | |
获取分析(应用程序) | 返回给定应用程序的Analytics实例。 |
初始化分析(应用程序,选项) | 返回给定应用程序的Analytics实例。 |
函数(analyticsInstance,...) | |
获取GoogleAnalyticsClientId(analyticsInstance) | 检索 Web 客户端的唯一 Google Analytics 标识符。查看client_id 。 |
logEvent(analyticsInstance, eventName, eventParams, 选项) | 使用给定的eventParams 发送 Google Analytics 事件。此方法会自动将此记录的事件与此设备上的此 Firebase Web 应用实例关联起来。推荐的事件参数列表可以在GA4 参考文档中找到。 |
logEvent(analyticsInstance, eventName, eventParams, 选项) | 使用给定的eventParams 发送 Google Analytics 事件。此方法会自动将此记录的事件与此设备上的此 Firebase Web 应用实例关联起来。推荐的事件参数列表可以在GA4 参考文档中找到。 |
logEvent(analyticsInstance, eventName, eventParams, 选项) | 使用给定的eventParams 发送 Google Analytics 事件。此方法会自动将此记录的事件与此设备上的此 Firebase Web 应用实例关联起来。请参阅跟踪屏幕浏览量。 |
logEvent(analyticsInstance, eventName, eventParams, 选项) | 使用给定的eventParams 发送 Google Analytics 事件。此方法会自动将此记录的事件与此设备上的此 Firebase Web 应用实例关联起来。推荐的事件参数列表可以在GA4 参考文档中找到。 |
logEvent(analyticsInstance, eventName, eventParams, 选项) | 使用给定的eventParams 发送 Google Analytics 事件。此方法会自动将此记录的事件与此设备上的此 Firebase Web 应用实例关联起来。推荐的事件参数列表可以在GA4 参考文档中找到。 |
logEvent(analyticsInstance, eventName, eventParams, 选项) | 使用给定的eventParams 发送 Google Analytics 事件。此方法会自动将此记录的事件与此设备上的此 Firebase Web 应用实例关联起来。推荐的事件参数列表可以在GA4 参考文档中找到。 |
logEvent(analyticsInstance, eventName, eventParams, 选项) | 使用给定的eventParams 发送 Google Analytics 事件。此方法会自动将此记录的事件与此设备上的此 Firebase Web 应用实例关联起来。推荐的事件参数列表可以在GA4 参考文档中找到。 |
logEvent(analyticsInstance, eventName, eventParams, 选项) | 使用给定的eventParams 发送 Google Analytics 事件。此方法会自动将此记录的事件与此设备上的此 Firebase Web 应用实例关联起来。推荐的事件参数列表可以在GA4 参考文档中找到。 |
logEvent(analyticsInstance, eventName, eventParams, 选项) | 使用给定的eventParams 发送 Google Analytics 事件。此方法会自动将此记录的事件与此设备上的此 Firebase Web 应用实例关联起来。推荐的事件参数列表可以在GA4 参考文档中找到。 |
logEvent(analyticsInstance, eventName, eventParams, 选项) | 使用给定的eventParams 发送 Google Analytics 事件。此方法会自动将此记录的事件与此设备上的此 Firebase Web 应用实例关联起来。推荐的事件参数列表可以在GA4 参考文档中找到。 |
logEvent(analyticsInstance, eventName, eventParams, 选项) | 使用给定的eventParams 发送 Google Analytics 事件。此方法会自动将此记录的事件与此设备上的此 Firebase Web 应用实例关联起来。推荐的事件参数列表可以在GA4 参考文档中找到。 |
logEvent(analyticsInstance, eventName, eventParams, 选项) | 使用给定的eventParams 发送 Google Analytics 事件。此方法会自动将此记录的事件与此设备上的此 Firebase Web 应用实例关联起来。推荐的事件参数列表可以在GA4 参考文档中找到。 |
logEvent(analyticsInstance, eventName, eventParams, 选项) | 使用给定的eventParams 发送 Google Analytics 事件。此方法会自动将此记录的事件与此设备上的此 Firebase Web 应用实例关联起来。推荐的事件参数列表可以在GA4 参考文档中找到。 |
logEvent(analyticsInstance, eventName, eventParams, 选项) | 使用给定的eventParams 发送 Google Analytics 事件。此方法会自动将此记录的事件与此设备上的此 Firebase Web 应用实例关联起来。推荐的事件参数列表可以在GA4 参考文档中找到。 |
logEvent(analyticsInstance, eventName, eventParams, 选项) | 使用给定的eventParams 发送 Google Analytics 事件。此方法会自动将此记录的事件与此设备上的此 Firebase Web 应用实例关联起来。推荐的事件参数列表可以在GA4 参考文档中找到。 |
logEvent(analyticsInstance, eventName, eventParams, 选项) | 使用给定的eventParams 发送 Google Analytics 事件。此方法会自动将此记录的事件与此设备上的此 Firebase Web 应用实例关联起来。推荐的事件参数列表可以在GA4 参考文档中找到。 |
logEvent(analyticsInstance, eventName, eventParams, 选项) | 使用给定的eventParams 发送 Google Analytics 事件。此方法会自动将此记录的事件与此设备上的此 Firebase Web 应用实例关联起来。推荐的事件参数列表可以在GA4 参考文档中找到。 |
logEvent(analyticsInstance, eventName, eventParams, 选项) | 使用给定的eventParams 发送 Google Analytics 事件。此方法会自动将此记录的事件与此设备上的此 Firebase Web 应用实例关联起来。推荐的事件参数列表可以在GA4 参考文档中找到。 |
logEvent(analyticsInstance, eventName, eventParams, 选项) | 使用给定的eventParams 发送 Google Analytics 事件。此方法会自动将此记录的事件与此设备上的此 Firebase Web 应用实例关联起来。请参阅衡量例外情况。 |
logEvent(analyticsInstance, eventName, eventParams, 选项) | 使用给定的eventParams 发送 Google Analytics 事件。此方法会自动将此记录的事件与此设备上的此 Firebase Web 应用实例关联起来。推荐的事件参数列表可以在GA4 参考文档中找到。 |
logEvent(analyticsInstance, eventName, eventParams, 选项) | 使用给定的eventParams 发送 Google Analytics 事件。此方法会自动将此记录的事件与此设备上的此 Firebase Web 应用实例关联起来。推荐的事件参数列表可以在GA4 参考文档中找到。 |
logEvent(analyticsInstance, eventName, eventParams, 选项) | 使用给定的eventParams 发送 Google Analytics 事件。此方法会自动将此记录的事件与此设备上的此 Firebase Web 应用实例关联起来。查看页面浏览量。 |
setAnalyticsCollectionEnabled(analyticsInstance,启用) | 设置是否在此设备上为此应用启用 Google Analytics 收集。设置全局window['ga-disable-analyticsId'] = true; |
setCurrentScreen(analyticsInstance,屏幕名称,选项) | 使用 gtag config 命令设置screen_name 。 |
setUserId(analyticsInstance,id,选项) | 使用 gtag config 命令设置user_id 。 |
setUserProperties(analyticsInstance,属性,选项) | 使用 gtag config 命令设置指定的所有参数。 |
功能() | |
isSupported() | 这是提供给用户的公共静态方法,它包装了四种不同的检查: 1.检查是否不是浏览器扩展环境。 2. 检查当前浏览器是否启用cookie。 3. 检查浏览器环境是否支持IndexedDB。 4. 检查当前浏览器上下文对于使用IndexedDB.open() 是否有效。 |
函数(同意设置,...) | |
setConsent(同意设置) | Firebase Analytics 初始化后,在所有 gtag 引用中设置此 Web 应用的适用最终用户同意状态。使用ConsentSettings指定个人同意类型值。默认情况下,同意类型设置为“已授予”。 |
函数(自定义参数,...) | |
setDefaultEventParameters(自定义参数) | 添加将为从 SDK 记录的每个事件(包括自动事件)设置的数据。使用 gtag 的“set”命令,传递的值会保留在当前页面上,并与所有后续事件一起传递。 |
功能(选项,...) | |
设置(选项) | 将 Firebase Analytics 配置为使用自定义gtag 或dataLayer 名称。如果gtag.js 脚本已独立于 Firebase Analytics 安装在此页面上,并且gtag 函数或dataLayer 使用非默认名称,则应使用该脚本。必须在调用getAnalytics() 之前调用,否则不会有任何效果。 |
接口
界面 | 描述 |
---|---|
分析 | Firebase Analytics 的实例。 |
分析呼叫选项 | 可以传递给 Analytics 方法调用的其他选项,例如logEvent 等。 |
分析设置 | Analytics实例初始化选项。 |
同意设置 | 每种同意类型的同意状态设置。有关更多信息,请参阅GA4 参考文档了解同意状态和同意类型。 |
控制参数 | 标准gtag.js 控制参数。有关更多信息,请参阅GA4 参考文档。 |
自定义参数 | 用户可以传递给gtag 任何自定义参数。 |
事件参数 | 标准gtag.js 事件参数。有关更多信息,请参阅GA4 参考文档。 |
Gtag配置参数 | gtag.js 识别的一组常见 Google Analytics 配置设置。 |
物品 | 标准 Google Analytics Item 类型。 |
晋升 | 之前由一些 Google Analytics 事件使用的字段。 |
设置选项 | 为您的 Firebase Analytics 实例指定自定义选项。您必须在初始化firebase.analytics() 之前设置这些。 |
类型别名
类型别名 | 描述 |
---|---|
同意状态字符串 | 特定同意类型是否已被授予或拒绝。 |
货币 | 标准 Google Analytics 货币类型。 |
自定义事件名称 | 不在建议事件名称的标准列表中的任何自定义事件名称字符串。 |
事件名称字符串 | 输入标准 Google Analytics 事件名称。 logEvent 还接受任何自定义字符串并将其解释为自定义事件名称。 |
函数(应用程序,...)
获取分析(应用程序)
返回给定应用程序的Analytics实例。
签名:
export declare function getAnalytics(app?: FirebaseApp): Analytics;
参数
范围 | 类型 | 描述 |
---|---|---|
应用程序 | Firebase应用程序 | 要使用的FirebaseApp 。 |
返回:
初始化分析(应用程序,选项)
返回给定应用程序的Analytics实例。
签名:
export declare function initializeAnalytics(app: FirebaseApp, options?: AnalyticsSettings): Analytics;
参数
范围 | 类型 | 描述 |
---|---|---|
应用程序 | Firebase应用程序 | 要使用的FirebaseApp 。 |
选项 | 分析设置 |
返回:
函数(analyticsInstance,...)
获取GoogleAnalyticsClientId(analyticsInstance)
检索 Web 客户端的唯一 Google Analytics 标识符。查看client_id 。
签名:
export declare function getGoogleAnalyticsClientId(analyticsInstance: Analytics): Promise<string>;
参数
范围 | 类型 | 描述 |
---|---|---|
分析实例 | 分析 |
返回:
承诺<字符串>
logEvent(analyticsInstance, eventName, eventParams, 选项)
使用给定的eventParams
发送 Google Analytics 事件。此方法会自动将此记录的事件与此设备上的此 Firebase Web 应用实例关联起来。
推荐的事件参数列表可以在GA4 参考文档中找到。
签名:
export declare function logEvent(analyticsInstance: Analytics, eventName: 'add_payment_info', eventParams?: {
coupon?: EventParams['coupon'];
currency?: EventParams['currency'];
items?: EventParams['items'];
payment_type?: EventParams['payment_type'];
value?: EventParams['value'];
[key: string]: any;
}, options?: AnalyticsCallOptions): void;
参数
范围 | 类型 | 描述 |
---|---|---|
分析实例 | 分析 | |
事件名称 | '添加付款信息' | |
事件参数 | { 优惠券?: EventParams ['优惠券'];货币?: EventParams ['货币'];项目?:事件参数['项目']; payment_type?:事件参数['付款方式']; value?:事件参数['价值']; [键:字符串]:任意; } | |
选项 | 分析呼叫选项 |
返回:
空白
logEvent(analyticsInstance, eventName, eventParams, 选项)
使用给定的eventParams
发送 Google Analytics 事件。此方法会自动将此记录的事件与此设备上的此 Firebase Web 应用实例关联起来。
推荐的事件参数列表可以在GA4 参考文档中找到。
签名:
export declare function logEvent(analyticsInstance: Analytics, eventName: 'purchase' | 'refund', eventParams?: {
value?: EventParams['value'];
currency?: EventParams['currency'];
transaction_id: EventParams['transaction_id'];
tax?: EventParams['tax'];
shipping?: EventParams['shipping'];
items?: EventParams['items'];
coupon?: EventParams['coupon'];
affiliation?: EventParams['affiliation'];
[key: string]: any;
}, options?: AnalyticsCallOptions): void;
参数
范围 | 类型 | 描述 |
---|---|---|
分析实例 | 分析 | |
事件名称 | '购买' | '退款' | |
事件参数 | { value?:事件参数['价值'];货币?: EventParams ['货币']; transaction_id:事件参数['交易id'];税?: EventParams ['税'];运输?: EventParams ['船运'];项目?:事件参数['项目'];优惠券?: EventParams ['优惠券'];隶属关系?: EventParams ['联系']; [键:字符串]:任意; } | |
选项 | 分析呼叫选项 |
返回:
空白
logEvent(analyticsInstance, eventName, eventParams, 选项)
使用给定的eventParams
发送 Google Analytics 事件。此方法会自动将此记录的事件与此设备上的此 Firebase Web 应用实例关联起来。
请参阅跟踪屏幕浏览量。
签名:
export declare function logEvent(analyticsInstance: Analytics, eventName: 'screen_view', eventParams?: {
firebase_screen: EventParams['firebase_screen'];
firebase_screen_class: EventParams['firebase_screen_class'];
[key: string]: any;
}, options?: AnalyticsCallOptions): void;
参数
范围 | 类型 | 描述 |
---|---|---|
分析实例 | 分析 | |
事件名称 | '屏幕视图' | |
事件参数 | { firebase_screen:事件参数['firebase_screen']; firebase_screen_class:事件参数['firebase_screen_class']; [键:字符串]:任意; } | |
选项 | 分析呼叫选项 |
返回:
空白
logEvent(analyticsInstance, eventName, eventParams, 选项)
使用给定的eventParams
发送 Google Analytics 事件。此方法会自动将此记录的事件与此设备上的此 Firebase Web 应用实例关联起来。
推荐的事件参数列表可以在GA4 参考文档中找到。
签名:
export declare function logEvent(analyticsInstance: Analytics, eventName: 'search' | 'view_search_results', eventParams?: {
search_term?: EventParams['search_term'];
[key: string]: any;
}, options?: AnalyticsCallOptions): void;
参数
范围 | 类型 | 描述 |
---|---|---|
分析实例 | 分析 | |
事件名称 | '搜索' | '查看搜索结果' | |
事件参数 | { search_term?:事件参数['搜索词']; [键:字符串]:任意; } | |
选项 | 分析呼叫选项 |
返回:
空白
logEvent(analyticsInstance, eventName, eventParams, 选项)
使用给定的eventParams
发送 Google Analytics 事件。此方法会自动将此记录的事件与此设备上的此 Firebase Web 应用实例关联起来。
推荐的事件参数列表可以在GA4 参考文档中找到。
签名:
export declare function logEvent(analyticsInstance: Analytics, eventName: 'select_content', eventParams?: {
content_type?: EventParams['content_type'];
item_id?: EventParams['item_id'];
[key: string]: any;
}, options?: AnalyticsCallOptions): void;
参数
范围 | 类型 | 描述 |
---|---|---|
分析实例 | 分析 | |
事件名称 | '选择内容' | |
事件参数 | { content_type?:事件参数['内容类型']; item_id?:事件参数['item_id']; [键:字符串]:任意; } | |
选项 | 分析呼叫选项 |
返回:
空白
logEvent(analyticsInstance, eventName, eventParams, 选项)
使用给定的eventParams
发送 Google Analytics 事件。此方法会自动将此记录的事件与此设备上的此 Firebase Web 应用实例关联起来。
推荐的事件参数列表可以在GA4 参考文档中找到。
签名:
export declare function logEvent(analyticsInstance: Analytics, eventName: 'select_item', eventParams?: {
items?: EventParams['items'];
item_list_name?: EventParams['item_list_name'];
item_list_id?: EventParams['item_list_id'];
[key: string]: any;
}, options?: AnalyticsCallOptions): void;
参数
范围 | 类型 | 描述 |
---|---|---|
分析实例 | 分析 | |
事件名称 | '选择物品' | |
事件参数 | { items?:事件参数['项目']; item_list_name?:事件参数['项目列表名称']; item_list_id?:事件参数['item_list_id']; [键:字符串]:任意; } | |
选项 | 分析呼叫选项 |
返回:
空白
logEvent(analyticsInstance, eventName, eventParams, 选项)
使用给定的eventParams
发送 Google Analytics 事件。此方法会自动将此记录的事件与此设备上的此 Firebase Web 应用实例关联起来。
推荐的事件参数列表可以在GA4 参考文档中找到。
签名:
export declare function logEvent(analyticsInstance: Analytics, eventName: 'select_promotion' | 'view_promotion', eventParams?: {
items?: EventParams['items'];
promotion_id?: EventParams['promotion_id'];
promotion_name?: EventParams['promotion_name'];
[key: string]: any;
}, options?: AnalyticsCallOptions): void;
参数
范围 | 类型 | 描述 |
---|---|---|
分析实例 | 分析 | |
事件名称 | '选择促销' | '查看促销' | |
事件参数 | { items?:事件参数['项目']; Promotion_id?:事件参数['促销_id'];促销名称?: EventParams ['促销名称']; [键:字符串]:任意; } | |
选项 | 分析呼叫选项 |
返回:
空白
logEvent(analyticsInstance, eventName, eventParams, 选项)
使用给定的eventParams
发送 Google Analytics 事件。此方法会自动将此记录的事件与此设备上的此 Firebase Web 应用实例关联起来。
推荐的事件参数列表可以在GA4 参考文档中找到。
签名:
export declare function logEvent(analyticsInstance: Analytics, eventName: 'set_checkout_option', eventParams?: {
checkout_step?: EventParams['checkout_step'];
checkout_option?: EventParams['checkout_option'];
[key: string]: any;
}, options?: AnalyticsCallOptions): void;
参数
范围 | 类型 | 描述 |
---|---|---|
分析实例 | 分析 | |
事件名称 | '设置结帐选项' | |
事件参数 | { checkout_step?:事件参数['结账步骤']; checkout_option?:事件参数['结账选项']; [键:字符串]:任意; } | |
选项 | 分析呼叫选项 |
返回:
空白
logEvent(analyticsInstance, eventName, eventParams, 选项)
使用给定的eventParams
发送 Google Analytics 事件。此方法会自动将此记录的事件与此设备上的此 Firebase Web 应用实例关联起来。
推荐的事件参数列表可以在GA4 参考文档中找到。
签名:
export declare function logEvent(analyticsInstance: Analytics, eventName: 'share', eventParams?: {
method?: EventParams['method'];
content_type?: EventParams['content_type'];
item_id?: EventParams['item_id'];
[key: string]: any;
}, options?: AnalyticsCallOptions): void;
参数
范围 | 类型 | 描述 |
---|---|---|
分析实例 | 分析 | |
事件名称 | '分享' | |
事件参数 | { 方法?:事件参数['方法']; content_type?: EventParams ['内容类型']; item_id?:事件参数['item_id']; [键:字符串]:任意; } | |
选项 | 分析呼叫选项 |
返回:
空白
logEvent(analyticsInstance, eventName, eventParams, 选项)
使用给定的eventParams
发送 Google Analytics 事件。此方法会自动将此记录的事件与此设备上的此 Firebase Web 应用实例关联起来。
推荐的事件参数列表可以在GA4 参考文档中找到。
签名:
export declare function logEvent(analyticsInstance: Analytics, eventName: 'sign_up', eventParams?: {
method?: EventParams['method'];
[key: string]: any;
}, options?: AnalyticsCallOptions): void;
参数
范围 | 类型 | 描述 |
---|---|---|
分析实例 | 分析 | |
事件名称 | '报名' | |
事件参数 | { 方法?:事件参数['方法']; [键:字符串]:任意; } | |
选项 | 分析呼叫选项 |
返回:
空白
logEvent(analyticsInstance, eventName, eventParams, 选项)
使用给定的eventParams
发送 Google Analytics 事件。此方法会自动将此记录的事件与此设备上的此 Firebase Web 应用实例关联起来。
推荐的事件参数列表可以在GA4 参考文档中找到。
签名:
export declare function logEvent(analyticsInstance: Analytics, eventName: 'timing_complete', eventParams?: {
name: string;
value: number;
event_category?: string;
event_label?: string;
[key: string]: any;
}, options?: AnalyticsCallOptions): void;
参数
范围 | 类型 | 描述 |
---|---|---|
分析实例 | 分析 | |
事件名称 | '计时完成' | |
事件参数 | { 名称:字符串;值:数字;事件类别?:字符串;事件标签?:字符串; [键:字符串]:任意; } | |
选项 | 分析呼叫选项 |
返回:
空白
logEvent(analyticsInstance, eventName, eventParams, 选项)
使用给定的eventParams
发送 Google Analytics 事件。此方法会自动将此记录的事件与此设备上的此 Firebase Web 应用实例关联起来。
推荐的事件参数列表可以在GA4 参考文档中找到。
签名:
export declare function logEvent(analyticsInstance: Analytics, eventName: 'add_shipping_info', eventParams?: {
coupon?: EventParams['coupon'];
currency?: EventParams['currency'];
items?: EventParams['items'];
shipping_tier?: EventParams['shipping_tier'];
value?: EventParams['value'];
[key: string]: any;
}, options?: AnalyticsCallOptions): void;
参数
范围 | 类型 | 描述 |
---|---|---|
分析实例 | 分析 | |
事件名称 | 'add_shipping_info' | |
事件参数 | { 优惠券?: EventParams ['优惠券'];货币?: EventParams ['货币'];项目?:事件参数['项目']; Shipping_tier?: EventParams ['shipping_tier']; value?:事件参数['价值']; [键:字符串]:任意; } | |
选项 | 分析呼叫选项 |
返回:
空白
logEvent(analyticsInstance, eventName, eventParams, 选项)
使用给定的eventParams
发送 Google Analytics 事件。此方法会自动将此记录的事件与此设备上的此 Firebase Web 应用实例关联起来。
推荐的事件参数列表可以在GA4 参考文档中找到。
签名:
export declare function logEvent(analyticsInstance: Analytics, eventName: 'view_cart' | 'view_item', eventParams?: {
currency?: EventParams['currency'];
items?: EventParams['items'];
value?: EventParams['value'];
[key: string]: any;
}, options?: AnalyticsCallOptions): void;
参数
范围 | 类型 | 描述 |
---|---|---|
分析实例 | 分析 | |
事件名称 | '查看购物车' | '查看项目' | |
事件参数 | { 货币?: EventParams ['货币'];项目?:事件参数['项目']; value?:事件参数['价值']; [键:字符串]:任意; } | |
选项 | 分析呼叫选项 |
返回:
空白
logEvent(analyticsInstance, eventName, eventParams, 选项)
使用给定的eventParams
发送 Google Analytics 事件。此方法会自动将此记录的事件与此设备上的此 Firebase Web 应用实例关联起来。
推荐的事件参数列表可以在GA4 参考文档中找到。
签名:
export declare function logEvent(analyticsInstance: Analytics, eventName: 'view_item_list', eventParams?: {
items?: EventParams['items'];
item_list_name?: EventParams['item_list_name'];
item_list_id?: EventParams['item_list_id'];
[key: string]: any;
}, options?: AnalyticsCallOptions): void;
参数
范围 | 类型 | 描述 |
---|---|---|
分析实例 | 分析 | |
事件名称 | '查看项目列表' | |
事件参数 | { items?:事件参数['项目']; item_list_name?:事件参数['项目列表名称']; item_list_id?:事件参数['item_list_id']; [键:字符串]:任意; } | |
选项 | 分析呼叫选项 |
返回:
空白
logEvent(analyticsInstance, eventName, eventParams, 选项)
使用给定的eventParams
发送 Google Analytics 事件。此方法会自动将此记录的事件与此设备上的此 Firebase Web 应用实例关联起来。
推荐的事件参数列表可以在GA4 参考文档中找到。
签名:
export declare function logEvent<T extends string>(analyticsInstance: Analytics, eventName: CustomEventName<T>, eventParams?: {
[key: string]: any;
}, options?: AnalyticsCallOptions): void;
参数
范围 | 类型 | 描述 |
---|---|---|
分析实例 | 分析 | |
事件名称 | 自定义事件名称<T> | |
事件参数 | { [键:字符串]:任意; } | |
选项 | 分析呼叫选项 |
返回:
空白
logEvent(analyticsInstance, eventName, eventParams, 选项)
使用给定的eventParams
发送 Google Analytics 事件。此方法会自动将此记录的事件与此设备上的此 Firebase Web 应用实例关联起来。
推荐的事件参数列表可以在GA4 参考文档中找到。
签名:
export declare function logEvent(analyticsInstance: Analytics, eventName: 'add_to_cart' | 'add_to_wishlist' | 'remove_from_cart', eventParams?: {
currency?: EventParams['currency'];
value?: EventParams['value'];
items?: EventParams['items'];
[key: string]: any;
}, options?: AnalyticsCallOptions): void;
参数
范围 | 类型 | 描述 |
---|---|---|
分析实例 | 分析 | |
事件名称 | '添加到购物车' | '添加到愿望清单' | '从购物车中删除' | |
事件参数 | { 货币?: EventParams ['货币']; value?:事件参数['价值'];项目?:事件参数['项目']; [键:字符串]:任意; } | |
选项 | 分析呼叫选项 |
返回:
空白
logEvent(analyticsInstance, eventName, eventParams, 选项)
使用给定的eventParams
发送 Google Analytics 事件。此方法会自动将此记录的事件与此设备上的此 Firebase Web 应用实例关联起来。
推荐的事件参数列表可以在GA4 参考文档中找到。
签名:
export declare function logEvent(analyticsInstance: Analytics, eventName: 'begin_checkout', eventParams?: {
currency?: EventParams['currency'];
coupon?: EventParams['coupon'];
value?: EventParams['value'];
items?: EventParams['items'];
[key: string]: any;
}, options?: AnalyticsCallOptions): void;
参数
范围 | 类型 | 描述 |
---|---|---|
分析实例 | 分析 | |
事件名称 | '开始结账' | |
事件参数 | { 货币?: EventParams ['货币'];优惠券?: EventParams ['优惠券']; value?:事件参数['价值'];项目?:事件参数['项目']; [键:字符串]:任意; } | |
选项 | 分析呼叫选项 |
返回:
空白
logEvent(analyticsInstance, eventName, eventParams, 选项)
使用给定的eventParams
发送 Google Analytics 事件。此方法会自动将此记录的事件与此设备上的此 Firebase Web 应用实例关联起来。
推荐的事件参数列表可以在GA4 参考文档中找到。
签名:
export declare function logEvent(analyticsInstance: Analytics, eventName: 'checkout_progress', eventParams?: {
currency?: EventParams['currency'];
coupon?: EventParams['coupon'];
value?: EventParams['value'];
items?: EventParams['items'];
checkout_step?: EventParams['checkout_step'];
checkout_option?: EventParams['checkout_option'];
[key: string]: any;
}, options?: AnalyticsCallOptions): void;
参数
范围 | 类型 | 描述 |
---|---|---|
分析实例 | 分析 | |
事件名称 | '结账进度' | |
事件参数 | { 货币?: EventParams ['货币'];优惠券?: EventParams ['优惠券']; value?:事件参数['价值'];项目?:事件参数['项目']; checkout_step?:事件参数['结账步骤']; checkout_option?:事件参数['结账选项']; [键:字符串]:任意; } | |
选项 | 分析呼叫选项 |
返回:
空白
logEvent(analyticsInstance, eventName, eventParams, 选项)
使用给定的eventParams
发送 Google Analytics 事件。此方法会自动将此记录的事件与此设备上的此 Firebase Web 应用实例关联起来。
请参阅衡量例外情况。
签名:
export declare function logEvent(analyticsInstance: Analytics, eventName: 'exception', eventParams?: {
description?: EventParams['description'];
fatal?: EventParams['fatal'];
[key: string]: any;
}, options?: AnalyticsCallOptions): void;
参数
范围 | 类型 | 描述 |
---|---|---|
分析实例 | 分析 | |
事件名称 | '例外' | |
事件参数 | { 描述?:事件参数['描述'];致命?: EventParams ['致命的']; [键:字符串]:任意; } | |
选项 | 分析呼叫选项 |
返回:
空白
logEvent(analyticsInstance, eventName, eventParams, 选项)
使用给定的eventParams
发送 Google Analytics 事件。此方法会自动将此记录的事件与此设备上的此 Firebase Web 应用实例关联起来。
推荐的事件参数列表可以在GA4 参考文档中找到。
签名:
export declare function logEvent(analyticsInstance: Analytics, eventName: 'generate_lead', eventParams?: {
value?: EventParams['value'];
currency?: EventParams['currency'];
[key: string]: any;
}, options?: AnalyticsCallOptions): void;
参数
范围 | 类型 | 描述 |
---|---|---|
分析实例 | 分析 | |
事件名称 | '生成线索' | |
事件参数 | { value?:事件参数['价值'];货币?: EventParams ['货币']; [键:字符串]:任意; } | |
选项 | 分析呼叫选项 |
返回:
空白
logEvent(analyticsInstance, eventName, eventParams, 选项)
使用给定的eventParams
发送 Google Analytics 事件。此方法会自动将此记录的事件与此设备上的此 Firebase Web 应用实例关联起来。
推荐的事件参数列表可以在GA4 参考文档中找到。
签名:
export declare function logEvent(analyticsInstance: Analytics, eventName: 'login', eventParams?: {
method?: EventParams['method'];
[key: string]: any;
}, options?: AnalyticsCallOptions): void;
参数
范围 | 类型 | 描述 |
---|---|---|
分析实例 | 分析 | |
事件名称 | '登录' | |
事件参数 | { 方法?:事件参数['方法']; [键:字符串]:任意; } | |
选项 | 分析呼叫选项 |
返回:
空白
logEvent(analyticsInstance, eventName, eventParams, 选项)
使用给定的eventParams
发送 Google Analytics 事件。此方法会自动将此记录的事件与此设备上的此 Firebase Web 应用实例关联起来。
查看页面浏览量。
签名:
export declare function logEvent(analyticsInstance: Analytics, eventName: 'page_view', eventParams?: {
page_title?: string;
page_location?: string;
page_path?: string;
[key: string]: any;
}, options?: AnalyticsCallOptions): void;
参数
范围 | 类型 | 描述 |
---|---|---|
分析实例 | 分析 | |
事件名称 | '页面预览' | |
事件参数 | { 页面标题?:字符串; page_location?:字符串; page_path?:字符串; [键:字符串]:任意; } | |
选项 | 分析呼叫选项 |
返回:
空白
setAnalyticsCollectionEnabled(analyticsInstance,启用)
设置是否在此设备上为此应用启用 Google Analytics 收集。设置全局window['ga-disable-analyticsId'] = true;
签名:
export declare function setAnalyticsCollectionEnabled(analyticsInstance: Analytics, enabled: boolean): void;
参数
范围 | 类型 | 描述 |
---|---|---|
分析实例 | 分析 | 分析实例。 |
已启用 | 布尔值 | 如果为 true,则启用收集,如果为 false,则禁用收集。 |
返回:
空白
setCurrentScreen(analyticsInstance,屏幕名称,选项)
使用
eventName
作为 'screen_view' 并添加相关的eventParams
。请参阅跟踪屏幕浏览量。
使用 gtag config
命令设置screen_name
。
签名:
export declare function setCurrentScreen(analyticsInstance: Analytics, screenName: string, options?: AnalyticsCallOptions): void;
参数
范围 | 类型 | 描述 |
---|---|---|
分析实例 | 分析 | 分析实例。 |
屏幕名称 | 细绳 | 要设置的屏幕名称。 |
选项 | 分析呼叫选项 |
返回:
空白
setUserId(analyticsInstance,id,选项)
使用 gtag config
命令设置user_id
。
签名:
export declare function setUserId(analyticsInstance: Analytics, id: string | null, options?: AnalyticsCallOptions): void;
参数
范围 | 类型 | 描述 |
---|---|---|
分析实例 | 分析 | 分析实例。 |
ID | 字符串|无效的 | 要设置的用户 ID。 |
选项 | 分析呼叫选项 |
返回:
空白
setUserProperties(analyticsInstance,属性,选项)
使用 gtag config
命令设置指定的所有参数。
签名:
export declare function setUserProperties(analyticsInstance: Analytics, properties: CustomParams, options?: AnalyticsCallOptions): void;
参数
范围 | 类型 | 描述 |
---|---|---|
分析实例 | 分析 | |
特性 | 自定义参数 | |
选项 | 分析呼叫选项 |
返回:
空白
功能()
isSupported()
这是提供给用户的公共静态方法,它包装了四种不同的检查:
- 检查是否不是浏览器扩展环境。 2. 检查当前浏览器是否启用cookie。 3. 检查浏览器环境是否支持IndexedDB。 4. 检查当前浏览器上下文对于使用
IndexedDB.open()
是否有效。
签名:
export declare function isSupported(): Promise<boolean>;
返回:
承诺<布尔值>
函数(同意设置,...)
setConsent(同意设置)
Firebase Analytics 初始化后,在所有 gtag 引用中设置此 Web 应用的适用最终用户同意状态。
使用ConsentSettings指定个人同意类型值。默认情况下,同意类型设置为“已授予”。
签名:
export declare function setConsent(consentSettings: ConsentSettings): void;
参数
范围 | 类型 | 描述 |
---|---|---|
同意设置 | 同意设置 | 映射 gtag.js 的适用最终用户同意状态。 |
返回:
空白
函数(自定义参数,...)
setDefaultEventParameters(自定义参数)
添加将为从 SDK 记录的每个事件(包括自动事件)设置的数据。使用 gtag 的“set”命令,传递的值会保留在当前页面上,并与所有后续事件一起传递。
签名:
export declare function setDefaultEventParameters(customParams: CustomParams): void;
参数
范围 | 类型 | 描述 |
---|---|---|
自定义参数 | 自定义参数 | 用户可以传递给 gtag.js 的任何自定义参数。 |
返回:
空白
功能(选项,...)
设置(选项)
将 Firebase Analytics 配置为使用自定义gtag
或dataLayer
名称。如果gtag.js
脚本已独立于 Firebase Analytics 安装在此页面上,并且使用gtag
函数或dataLayer
的非默认名称,则可使用。必须在调用getAnalytics()
之前调用,否则不会有任何效果。
签名:
export declare function settings(options: SettingsOptions): void;
参数
范围 | 类型 | 描述 |
---|---|---|
选项 | 设置选项 | 自定义 gtag 和 dataLayer 名称。 |
返回:
空白
同意状态字符串
特定同意类型是否已被授予或拒绝。
签名:
export declare type ConsentStatusString = 'granted' | 'denied';
货币
标准 Google Analytics 货币类型。
签名:
export declare type Currency = string | number;
自定义事件名称
不在建议事件名称的标准列表中的任何自定义事件名称字符串。
签名:
export declare type CustomEventName<T> = T extends EventNameString ? never : T;
事件名称字符串
输入标准 Google Analytics 事件名称。 logEvent
还接受任何自定义字符串并将其解释为自定义事件名称。
签名:
export declare type EventNameString = 'add_payment_info' | 'add_shipping_info' | 'add_to_cart' | 'add_to_wishlist' | 'begin_checkout' | 'checkout_progress' | 'exception' | 'generate_lead' | 'login' | 'page_view' | 'purchase' | 'refund' | 'remove_from_cart' | 'screen_view' | 'search' | 'select_content' | 'select_item' | 'select_promotion' | 'set_checkout_option' | 'share' | 'sign_up' | 'timing_complete' | 'view_cart' | 'view_item' | 'view_item_list' | 'view_promotion' | 'view_search_results';