analytics package

Firebase Analytics Web SDK。此 SDK 无法在 Node.js 环境中工作。

函数

函数 说明
function(应用, ...)
getAnalytics(app) 返回给定应用的 Google Analytics 实例。
initializeAnalytics(app, options) 返回给定应用的 Google Analytics 实例。
function(analyticsInstance, ...)
getGoogleAnalyticsClientId(analyticsInstance) 检索网络客户端的唯一 Google Analytics 标识符。请参阅 client_id。
logEvent(analyticsInstance, eventName, eventParams, options) 发送具有指定 eventParams 的 Google Analytics 事件。此方法会自动将所记录的事件与此设备上的此 Firebase Web 应用实例相关联。如需查看推荐的事件参数列表，请参阅 GA4 参考文档。
logEvent(analyticsInstance, eventName, eventParams, options) 发送具有指定 eventParams 的 Google Analytics 事件。此方法会自动将所记录的事件与此设备上的此 Firebase Web 应用实例相关联。如需查看推荐的事件参数列表，请参阅 GA4 参考文档。
logEvent(analyticsInstance, eventName, eventParams, options) 发送具有指定 eventParams 的 Google Analytics 事件。此方法会自动将所记录的事件与此设备上的此 Firebase Web 应用实例相关联。请参阅跟踪屏幕浏览量。
logEvent(analyticsInstance, eventName, eventParams, options) 发送具有指定 eventParams 的 Google Analytics 事件。此方法会自动将所记录的事件与此设备上的此 Firebase Web 应用实例相关联。如需查看推荐的事件参数列表，请参阅 GA4 参考文档。
logEvent(analyticsInstance, eventName, eventParams, options) 发送具有指定 eventParams 的 Google Analytics 事件。此方法会自动将所记录的事件与此设备上的此 Firebase Web 应用实例相关联。如需查看推荐的事件参数列表，请参阅 GA4 参考文档。
logEvent(analyticsInstance, eventName, eventParams, options) 发送具有指定 eventParams 的 Google Analytics 事件。此方法会自动将所记录的事件与此设备上的此 Firebase Web 应用实例相关联。如需查看推荐的事件参数列表，请参阅 GA4 参考文档。
logEvent(analyticsInstance, eventName, eventParams, options) 发送具有指定 eventParams 的 Google Analytics 事件。此方法会自动将所记录的事件与此设备上的此 Firebase Web 应用实例相关联。如需查看推荐的事件参数列表，请参阅 GA4 参考文档。
logEvent(analyticsInstance, eventName, eventParams, options) 发送具有指定 eventParams 的 Google Analytics 事件。此方法会自动将所记录的事件与此设备上的此 Firebase Web 应用实例相关联。如需查看推荐的事件参数列表，请参阅 GA4 参考文档。
logEvent(analyticsInstance, eventName, eventParams, options) 发送具有指定 eventParams 的 Google Analytics 事件。此方法会自动将所记录的事件与此设备上的此 Firebase Web 应用实例相关联。如需查看推荐的事件参数列表，请参阅 GA4 参考文档。
logEvent(analyticsInstance, eventName, eventParams, options) 发送具有指定 eventParams 的 Google Analytics 事件。此方法会自动将所记录的事件与此设备上的此 Firebase Web 应用实例相关联。如需查看推荐的事件参数列表，请参阅 GA4 参考文档。
logEvent(analyticsInstance, eventName, eventParams, options) 发送具有指定 eventParams 的 Google Analytics 事件。此方法会自动将所记录的事件与此设备上的此 Firebase Web 应用实例相关联。如需查看推荐的事件参数列表，请参阅 GA4 参考文档。
logEvent(analyticsInstance, eventName, eventParams, options) 发送具有指定 eventParams 的 Google Analytics 事件。此方法会自动将所记录的事件与此设备上的此 Firebase Web 应用实例相关联。如需查看推荐的事件参数列表，请参阅 GA4 参考文档。
logEvent(analyticsInstance, eventName, eventParams, options) 发送具有指定 eventParams 的 Google Analytics 事件。此方法会自动将所记录的事件与此设备上的此 Firebase Web 应用实例相关联。如需查看推荐的事件参数列表，请参阅 GA4 参考文档。
logEvent(analyticsInstance, eventName, eventParams, options) 发送具有指定 eventParams 的 Google Analytics 事件。此方法会自动将所记录的事件与此设备上的此 Firebase Web 应用实例相关联。如需查看推荐的事件参数列表，请参阅 GA4 参考文档。
logEvent(analyticsInstance, eventName, eventParams, options) 发送具有指定 eventParams 的 Google Analytics 事件。此方法会自动将所记录的事件与此设备上的此 Firebase Web 应用实例相关联。如需查看推荐的事件参数列表，请参阅 GA4 参考文档。
logEvent(analyticsInstance, eventName, eventParams, options) 发送具有指定 eventParams 的 Google Analytics 事件。此方法会自动将所记录的事件与此设备上的此 Firebase Web 应用实例相关联。如需查看推荐的事件参数列表，请参阅 GA4 参考文档。
logEvent(analyticsInstance, eventName, eventParams, options) 发送具有指定 eventParams 的 Google Analytics 事件。此方法会自动将所记录的事件与此设备上的此 Firebase Web 应用实例相关联。如需查看推荐的事件参数列表，请参阅 GA4 参考文档。
logEvent(analyticsInstance, eventName, eventParams, options) 发送具有指定 eventParams 的 Google Analytics 事件。此方法会自动将所记录的事件与此设备上的此 Firebase Web 应用实例相关联。如需查看推荐的事件参数列表，请参阅 GA4 参考文档。
logEvent(analyticsInstance, eventName, eventParams, options) 发送具有指定 eventParams 的 Google Analytics 事件。此方法会自动将所记录的事件与此设备上的此 Firebase Web 应用实例相关联。请参阅衡量异常。
logEvent(analyticsInstance, eventName, eventParams, options) 发送具有指定 eventParams 的 Google Analytics 事件。此方法会自动将所记录的事件与此设备上的此 Firebase Web 应用实例相关联。如需查看推荐的事件参数列表，请参阅 GA4 参考文档。
logEvent(analyticsInstance, eventName, eventParams, options) 发送具有指定 eventParams 的 Google Analytics 事件。此方法会自动将所记录的事件与此设备上的此 Firebase Web 应用实例相关联。如需查看推荐的事件参数列表，请参阅 GA4 参考文档。
logEvent(analyticsInstance, eventName, eventParams, options) 发送具有指定 eventParams 的 Google Analytics 事件。此方法会自动将所记录的事件与此设备上的此 Firebase Web 应用实例相关联。请参阅网页浏览。
setAnalyticsCollectionEnabled(analyticsInstance, enabled) 设置是否在此设备上为此应用启用 Google Analytics 数据收集功能。设置全局 window['ga-disable-analyticsId'] = true;
setCurrentScreen(analyticsInstance, screenName, options) 使用 gtag config 命令设置 screen_name。
setUserId(analyticsInstance, id, options) 使用 gtag config 命令设置 user_id。
setUserProperties(analyticsInstance, properties, options) 使用 gtag config 命令设置指定的所有参数。
函数
isSupported() 这是向用户提供的公共静态方法，其中包含四种不同的检查：1.检查它是否不是浏览器扩展程序环境。2. 检查当前浏览器中是否启用了 Cookie。3. 检查浏览器环境是否支持 IndexedDB。4. 检查当前的浏览器上下文是否适用于使用 IndexedDB.open()。
function(consentSettings, ...)
setConsent(consentSettings) 完成 Firebase Analytics 初始化后，在所有 gtag 引用中设置此 Web 应用的最终用户同意情况。使用 ConsentSettings 来指定各个用户意见征求类型的值。默认情况下，用户意见征求类型会设置为“granted”。
function(customParams, ...)
setDefaultEventParameters(customParams) 添加将为从 SDK 记录的每个事件（包括自动事件）设置的数据。使用 gtag 的“set”命令，所传递的值将保留在当前网页上，并会随所有后续事件传递。
function(options, ...)
settings(options) 将 Firebase Analytics 配置为使用自定义的 gtag 或 dataLayer 名称。如果此页面上已独立于 Firebase Analytics 安装了 gtag.js 脚本，并且为 gtag 函数或 dataLayer 使用了非默认名称，则可以使用此脚本。必须在调用 getAnalytics() 之前调用，否则不会产生任何影响。

接口

接口 说明
Analytics 一个 Firebase Analytics 实例。
AnalyticsCallOptions 可传递给 Analytics 方法调用的其他选项，例如 logEvent 等。
AnalyticsSettings Analytics 实例初始化选项。
ConsentSettings 每种用户意见征求类型的用户意见征求状态设置。如需了解详情，请参阅有关同意情况和用户意见征求类型的 GA4 参考文档。
ControlParams 标准 gtag.js 控制参数。如需了解详情，请参阅 GA4 参考文档。
CustomParams 用户可能传递给 gtag 的任何自定义参数。
EventParams 标准的 gtag.js 事件参数。如需了解详情，请参阅 GA4 参考文档。
GtagConfigParams gtag.js 可识别的一组常见 Google Analytics 配置设置。
资源项 标准 Google Analytics Item 类型。
促销 某些 Google Analytics 事件之前使用的字段。
SettingsOptions 为您的 Firebase Analytics 实例指定自定义选项。您必须在初始化 firebase.analytics() 之前设置这些变量。

类型别名

类型别名 说明
ConsentStatusString 表示是同意还是拒绝了特定的用户意见征求类型。
币种 标准的 Google Analytics 货币类型。
CustomEventName 不在推荐事件名称标准列表中的自定义事件名称字符串。
EventNameString 标准 Google Analytics 事件名称的类型。logEvent 还接受任何自定义字符串，并将其解读为自定义事件名称。

function(应用, ...)

getAnalytics(应用)

返回给定应用的 Google Analytics 实例。

签名：

export declare function getAnalytics(app?: FirebaseApp): Analytics;

参数

参数 类型 说明
应用 FirebaseApp 要使用的 FirebaseApp。

返回：

Analytics

initializeAnalytics(app, options)

返回给定应用的 Google Analytics 实例。

签名：

export declare function initializeAnalytics(app: FirebaseApp, options?: AnalyticsSettings): Analytics;

参数

参数 类型 说明
应用 FirebaseApp 要使用的 FirebaseApp。
选项 AnalyticsSettings

返回：

Analytics

function(analyticsInstance, ...)

getGoogleAnalyticsClientId(analyticsInstance)

检索网络客户端的唯一 Google Analytics 标识符。请参阅 client_id。

签名：

export declare function getGoogleAnalyticsClientId(analyticsInstance: Analytics): Promise<string>;

参数

参数 类型 说明
analyticsInstance Analytics

返回：

承诺<字符串>

logEvent(analyticsInstance, eventName, eventParams, options)

发送具有指定 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;

参数

参数 类型 说明
analyticsInstance Analytics
eventName “add_payment_info”
eventParams { coupon?:EventParams['coupon'];货币？：EventParams['currency'];项？：EventParams['items'];payment_type?：EventParams['payment_type'];值？：EventParams['value'];[键：字符串]：任意；}
选项 AnalyticsCallOptions

返回：

void

logEvent(analyticsInstance, eventName, eventParams, options)

发送具有指定 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;

参数

参数 类型 说明
analyticsInstance Analytics
eventName “purchase”|'refund' [退款]
eventParams { value?:EventParams['value'];货币？：EventParams['currency'];transaction_id：EventParams['transaction_id'];税费？EventParams['tax'];运费：EventParams['shipping'];项？：EventParams['items'];优惠券？：EventParams['coupon'];联属机构？：EventParams['affiliate'];[键：字符串]：任意；}
选项 AnalyticsCallOptions

返回：

void

logEvent(analyticsInstance, eventName, eventParams, options)

发送具有指定 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;

参数

参数 类型 说明
analyticsInstance Analytics
eventName “screen_view”
eventParams { firebase_screen: EventParams['firebase_screen'];firebase_screen_class：EventParams['firebase_screen_class'];[键：字符串]：任意；}
选项 AnalyticsCallOptions

返回：

void

logEvent(analyticsInstance, eventName, eventParams, options)

发送具有指定 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;

参数

参数 类型 说明
analyticsInstance Analytics
eventName “搜索”|“view_search_results”
eventParams { search_term?:EventParams['search_term'];[键：字符串]：任意；}
选项 AnalyticsCallOptions

返回：

void

logEvent(analyticsInstance, eventName, eventParams, options)

发送具有指定 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;

参数

参数 类型 说明
analyticsInstance Analytics
eventName “select_content”
eventParams { content_type?：EventParams['content_type'];item_id?：EventParams['item_id'];[键：字符串]：任意；}
选项 AnalyticsCallOptions

返回：

void

logEvent(analyticsInstance, eventName, eventParams, options)

发送具有指定 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;

参数

参数 类型 说明
analyticsInstance Analytics
eventName “select_item”
eventParams { items?:EventParams['items'];item_list_name?：事件参数['item_list_name'];item_list_id?：事件参数['item_list_id'];[键：字符串]：任意；}
选项 AnalyticsCallOptions

返回：

void

logEvent(analyticsInstance, eventName, eventParams, options)

发送具有指定 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;

参数

参数 类型 说明
analyticsInstance Analytics
eventName “select_promotion”|“view_promotion”
eventParams { items?:EventParams['items'];promotion_id?:EventParams['promotion_id'];promotion_name?：EventParams['promotion_name'];[键：字符串]：任意；}
选项 AnalyticsCallOptions

返回：

void

logEvent(analyticsInstance, eventName, eventParams, options)

发送具有指定 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;

参数

参数 类型 说明
analyticsInstance Analytics
eventName “set_checkout_option”
eventParams { checkout_step?：EventParams['checkout_step'];checkout_option?：EventParams['checkout_option'];[键：字符串]：任意；}
选项 AnalyticsCallOptions

返回：

void

logEvent(analyticsInstance, eventName, eventParams, options)

发送具有指定 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;

参数

参数 类型 说明
analyticsInstance Analytics
eventName “分享”
eventParams {方法？：EventParams['method'];content_type?：EventParams['content_type'];item_id?：EventParams['item_id'];[键：字符串]：任意；}
选项 AnalyticsCallOptions

返回：

void

logEvent(analyticsInstance, eventName, eventParams, options)

发送具有指定 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;

参数

参数 类型 说明
analyticsInstance Analytics
eventName “sign_up”
eventParams {方法？：EventParams['method'];[键：字符串]：任意；}
选项 AnalyticsCallOptions

返回：

void

logEvent(analyticsInstance, eventName, eventParams, options)

发送具有指定 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;

参数

参数 类型 说明
analyticsInstance Analytics
eventName “timing_complete”
eventParams { name: string;value：数字；event_category?：字符串；event_label?：字符串；[键：字符串]：任意；}
选项 AnalyticsCallOptions

返回：

void

logEvent(analyticsInstance, eventName, eventParams, options)

发送具有指定 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;

参数

参数 类型 说明
analyticsInstance Analytics
eventName “add_shipping_info”
eventParams { coupon?:EventParams['coupon'];货币？：EventParams['currency'];项？：EventParams['items'];shipping_tier?：EventParams['shipping_tier'];值？：EventParams['value'];[键：字符串]：任意；}
选项 AnalyticsCallOptions

返回：

void

logEvent(analyticsInstance, eventName, eventParams, options)

发送具有指定 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;

参数

参数 类型 说明
analyticsInstance Analytics
eventName “view_cart”|“view_item”
eventParams { currency?:EventParams['currency'];项？：EventParams['items'];值？：EventParams['value'];[键：字符串]：任意；}
选项 AnalyticsCallOptions

返回：

void

logEvent(analyticsInstance, eventName, eventParams, options)

发送具有指定 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;

参数

参数 类型 说明
analyticsInstance Analytics
eventName “view_item_list”
eventParams { items?:EventParams['items'];item_list_name?：事件参数['item_list_name'];item_list_id?：事件参数['item_list_id'];[键：字符串]：任意；}
选项 AnalyticsCallOptions

返回：

void

logEvent(analyticsInstance, eventName, eventParams, options)

发送具有指定 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;

参数

参数 类型 说明
analyticsInstance Analytics
eventName CustomEventName<T>
eventParams { [键: 字符串]: 任意;}
选项 AnalyticsCallOptions

返回：

void

logEvent(analyticsInstance, eventName, eventParams, options)

发送具有指定 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;

参数

参数 类型 说明
analyticsInstance Analytics
eventName “add_to_cart”|“add_to_wishlist”|“remove_from_cart”
eventParams { currency?:EventParams['currency'];值？：EventParams['value'];项？：EventParams['items'];[键：字符串]：任意；}
选项 AnalyticsCallOptions

返回：

void

logEvent(analyticsInstance, eventName, eventParams, options)

发送具有指定 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;

参数

参数 类型 说明
analyticsInstance Analytics
eventName “begin_checkout”
eventParams { currency?:EventParams['currency'];优惠券？：EventParams['coupon'];值？：EventParams['value'];项？：EventParams['items'];[键：字符串]：任意；}
选项 AnalyticsCallOptions

返回：

void

logEvent(analyticsInstance, eventName, eventParams, options)

发送具有指定 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;

参数

参数 类型 说明
analyticsInstance Analytics
eventName “checkout_progress”
eventParams { currency?:EventParams['currency'];优惠券？：EventParams['coupon'];值？：EventParams['value'];项？：EventParams['items'];checkout_step?：EventParams['checkout_step'];checkout_option?：EventParams['checkout_option'];[键：字符串]：任意；}
选项 AnalyticsCallOptions

返回：

void

logEvent(analyticsInstance, eventName, eventParams, options)

发送具有指定 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;

参数

参数 类型 说明
analyticsInstance Analytics
eventName “exception”
eventParams { description?:EventParams['description'];严重？：EventParams['fatal'];[键：字符串]：任意；}
选项 AnalyticsCallOptions

返回：

void

logEvent(analyticsInstance, eventName, eventParams, options)

发送具有指定 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;

参数

参数 类型 说明
analyticsInstance Analytics
eventName “generate_lead”
eventParams { value?:EventParams['value'];货币？：EventParams['currency'];[键：字符串]：任意；}
选项 AnalyticsCallOptions

返回：

void

logEvent(analyticsInstance, eventName, eventParams, options)

发送具有指定 eventParams 的 Google Analytics 事件。此方法会自动将所记录的事件与此设备上的此 Firebase Web 应用实例相关联。

如需查看推荐的事件参数列表，请参阅 GA4 参考文档。

签名：

export declare function logEvent(analyticsInstance: Analytics, eventName: 'login', eventParams?: {
    method?: EventParams['method'];
    [key: string]: any;
}, options?: AnalyticsCallOptions): void;

参数

参数 类型 说明
analyticsInstance Analytics
eventName “登录”
eventParams {方法？：EventParams['method'];[键：字符串]：任意；}
选项 AnalyticsCallOptions

返回：

void

logEvent(analyticsInstance, eventName, eventParams, options)

发送具有指定 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;

参数

参数 类型 说明
analyticsInstance Analytics
eventName “page_view”
eventParams { page_title?: string;page_location?: 字符串;page_path?：字符串；[键：字符串]：任意；}
选项 AnalyticsCallOptions

返回：

void

setAnalyticsCollectionEnabled(analyticsInstance, enabled)

设置是否在此设备上为此应用启用 Google Analytics 数据收集功能。设置全局 window['ga-disable-analyticsId'] = true;

签名：

export declare function setAnalyticsCollectionEnabled(analyticsInstance: Analytics, enabled: boolean): void;

参数

参数 类型 说明
analyticsInstance Analytics Analytics 实例。
已启用 布尔值 如果为 true，则启用收集；如果为 false，则停用收集。

返回：

void

setCurrentScreen(analyticsInstance, screenName, options)

<ph type="x-smartling-placeholder">
</ph>

与 eventName 用作“screen_view”并添加相关的eventParams。请参阅跟踪屏幕浏览量。

使用 gtag config 命令设置 screen_name。

签名：

export declare function setCurrentScreen(analyticsInstance: Analytics, screenName: string, options?: AnalyticsCallOptions): void;

参数

参数 类型 说明
analyticsInstance Analytics Analytics 实例。
screenName 字符串 要设置的屏幕名称。
选项 AnalyticsCallOptions

返回：

void

setUserId(analyticsInstance, id, options)

使用 gtag config 命令设置 user_id。

签名：

export declare function setUserId(analyticsInstance: Analytics, id: string | null, options?: AnalyticsCallOptions): void;

参数

参数 类型 说明
analyticsInstance Analytics Analytics 实例。
id 字符串 |null 要设置的用户 ID。
选项 AnalyticsCallOptions

返回：

void

setUserProperties(analyticsInstance, properties, options)

使用 gtag config 命令设置指定的所有参数。

签名：

export declare function setUserProperties(analyticsInstance: Analytics, properties: CustomParams, options?: AnalyticsCallOptions): void;

参数

参数 类型 说明
analyticsInstance Analytics
properties CustomParams
选项 AnalyticsCallOptions

返回：

void

function()

isSupported()

这是向用户提供的公共静态方法，其中包含四种不同的检查：

  1. 检查它是否不是浏览器扩展程序环境。2. 检查当前浏览器中是否启用了 Cookie。3. 检查浏览器环境是否支持 IndexedDB。4. 检查当前的浏览器上下文是否适用于使用 IndexedDB.open()。

签名：

export declare function isSupported(): Promise<boolean>;

返回：

Promise&lt;boolean&gt;

function(consentSettings, ...)

setConsent(consentSettings)

完成 Firebase Analytics 初始化后，在所有 gtag 引用中设置此 Web 应用的最终用户同意情况。

使用 ConsentSettings 可指定各个用户意见征求类型的值。默认情况下，用户意见征求类型会设置为“granted”。

签名：

export declare function setConsent(consentSettings: ConsentSettings): void;

参数

参数 类型 说明
意见征求设置 ConsentSettings 映射 gtag.js 适用的最终用户同意情况。

返回：

void

function(customParams, ...)

setDefaultEventParameters(customParams)

添加将为从 SDK 记录的每个事件（包括自动事件）设置的数据。使用 gtag 的“set”命令，所传递的值将保留在当前网页上，并会随所有后续事件传递。

签名：

export declare function setDefaultEventParameters(customParams: CustomParams): void;

参数

参数 类型 说明
customParams CustomParams 用户可能传递给 gtag.js 的任何自定义参数。

返回：

void

function(options, ...)

设置（选项）

将 Firebase Analytics 配置为使用自定义的 gtag 或 dataLayer 名称。如果此页面上已独立于 Firebase Analytics 安装了 gtag.js 脚本，并且为 gtag 函数或 dataLayer 使用了非默认名称，则可以使用此脚本。必须在调用 getAnalytics() 之前调用，否则不会产生任何影响。

签名：

export declare function settings(options: SettingsOptions): void;

参数

参数 类型 说明
选项 SettingsOptions 自定义 gtag 和 dataLayer 名称。

返回：

void

ConsentStatusString

表示是同意还是拒绝了特定的用户意见征求类型。

签名：

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';