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