analytics package

Firebase Analytics Web SDK。這個 SDK 無法在 Node.js 環境中運作。

函式

函式 說明
功能(應用程式, ...)
getAnalytics(應用程式) 傳回指定應用程式的 Analytics 執行個體。
initializeAnalytics(應用程式、選項) 傳回指定應用程式的 Analytics 執行個體。
function(analyticsInstance, ...)
getGoogleAnalyticsClientId(analyticsInstance) 擷取網路用戶端的專屬 Google Analytics ID。請參閱 client_id。
logEvent(analyticsInstance, eventName, eventParams, 選項) 這個外掛程式能傳送指定 eventParams 的 Google Analytics 事件。這個方法會自動將此記錄的事件與這部裝置上的這個 Firebase 網頁應用程式執行個體建立關聯。如需建議事件參數的清單，請參閱 GA4 參考說明文件。
logEvent(analyticsInstance, eventName, eventParams, 選項) 這個外掛程式能傳送指定 eventParams 的 Google Analytics 事件。這個方法會自動將此記錄的事件與這部裝置上的這個 Firebase 網頁應用程式執行個體建立關聯。如需建議事件參數的清單，請參閱 GA4 參考說明文件。
logEvent(analyticsInstance, eventName, eventParams, 選項) 這個外掛程式能傳送指定 eventParams 的 Google Analytics 事件。這個方法會自動將這個記錄的事件與這部裝置上的這個 Firebase 網頁應用程式執行個體建立關聯。請參閱「追蹤畫面瀏覽」。
logEvent(analyticsInstance, eventName, eventParams, 選項) 這個外掛程式能傳送指定 eventParams 的 Google Analytics 事件。這個方法會自動將此記錄的事件與這部裝置上的這個 Firebase 網頁應用程式執行個體建立關聯。如需建議事件參數的清單，請參閱 GA4 參考說明文件。
logEvent(analyticsInstance, eventName, eventParams, 選項) 這個外掛程式能傳送指定 eventParams 的 Google Analytics 事件。這個方法會自動將此記錄的事件與這部裝置上的這個 Firebase 網頁應用程式執行個體建立關聯。如需建議事件參數的清單，請參閱 GA4 參考說明文件。
logEvent(analyticsInstance, eventName, eventParams, 選項) 這個外掛程式能傳送指定 eventParams 的 Google Analytics 事件。這個方法會自動將此記錄的事件與這部裝置上的這個 Firebase 網頁應用程式執行個體建立關聯。如需建議事件參數的清單，請參閱 GA4 參考說明文件。
logEvent(analyticsInstance, eventName, eventParams, 選項) 這個外掛程式能傳送指定 eventParams 的 Google Analytics 事件。這個方法會自動將此記錄的事件與這部裝置上的這個 Firebase 網頁應用程式執行個體建立關聯。如需建議事件參數的清單，請參閱 GA4 參考說明文件。
logEvent(analyticsInstance, eventName, eventParams, 選項) 這個外掛程式能傳送指定 eventParams 的 Google Analytics 事件。這個方法會自動將此記錄的事件與這部裝置上的這個 Firebase 網頁應用程式執行個體建立關聯。如需建議事件參數的清單，請參閱 GA4 參考說明文件。
logEvent(analyticsInstance, eventName, eventParams, 選項) 這個外掛程式能傳送指定 eventParams 的 Google Analytics 事件。這個方法會自動將此記錄的事件與這部裝置上的這個 Firebase 網頁應用程式執行個體建立關聯。如需建議事件參數的清單，請參閱 GA4 參考說明文件。
logEvent(analyticsInstance, eventName, eventParams, 選項) 這個外掛程式能傳送指定 eventParams 的 Google Analytics 事件。這個方法會自動將此記錄的事件與這部裝置上的這個 Firebase 網頁應用程式執行個體建立關聯。如需建議事件參數的清單，請參閱 GA4 參考說明文件。
logEvent(analyticsInstance, eventName, eventParams, 選項) 這個外掛程式能傳送指定 eventParams 的 Google Analytics 事件。這個方法會自動將此記錄的事件與這部裝置上的這個 Firebase 網頁應用程式執行個體建立關聯。如需建議事件參數的清單，請參閱 GA4 參考說明文件。
logEvent(analyticsInstance, eventName, eventParams, 選項) 這個外掛程式能傳送指定 eventParams 的 Google Analytics 事件。這個方法會自動將此記錄的事件與這部裝置上的這個 Firebase 網頁應用程式執行個體建立關聯。如需建議事件參數的清單，請參閱 GA4 參考說明文件。
logEvent(analyticsInstance, eventName, eventParams, 選項) 這個外掛程式能傳送指定 eventParams 的 Google Analytics 事件。這個方法會自動將此記錄的事件與這部裝置上的這個 Firebase 網頁應用程式執行個體建立關聯。如需建議事件參數的清單，請參閱 GA4 參考說明文件。
logEvent(analyticsInstance, eventName, eventParams, 選項) 這個外掛程式能傳送指定 eventParams 的 Google Analytics 事件。這個方法會自動將此記錄的事件與這部裝置上的這個 Firebase 網頁應用程式執行個體建立關聯。如需建議事件參數的清單，請參閱 GA4 參考說明文件。
logEvent(analyticsInstance, eventName, eventParams, 選項) 這個外掛程式能傳送指定 eventParams 的 Google Analytics 事件。這個方法會自動將此記錄的事件與這部裝置上的這個 Firebase 網頁應用程式執行個體建立關聯。如需建議事件參數的清單，請參閱 GA4 參考說明文件。
logEvent(analyticsInstance, eventName, eventParams, 選項) 這個外掛程式能傳送指定 eventParams 的 Google Analytics 事件。這個方法會自動將此記錄的事件與這部裝置上的這個 Firebase 網頁應用程式執行個體建立關聯。如需建議事件參數的清單，請參閱 GA4 參考說明文件。
logEvent(analyticsInstance, eventName, eventParams, 選項) 這個外掛程式能傳送指定 eventParams 的 Google Analytics 事件。這個方法會自動將此記錄的事件與這部裝置上的這個 Firebase 網頁應用程式執行個體建立關聯。如需建議事件參數的清單，請參閱 GA4 參考說明文件。
logEvent(analyticsInstance, eventName, eventParams, 選項) 這個外掛程式能傳送指定 eventParams 的 Google Analytics 事件。這個方法會自動將此記錄的事件與這部裝置上的這個 Firebase 網頁應用程式執行個體建立關聯。如需建議事件參數的清單，請參閱 GA4 參考說明文件。
logEvent(analyticsInstance, eventName, eventParams, 選項) 這個外掛程式能傳送指定 eventParams 的 Google Analytics 事件。這個方法會自動將此記錄的事件與這部裝置上的這個 Firebase 網頁應用程式執行個體建立關聯。請參閱「評估例外狀況」。
logEvent(analyticsInstance, eventName, eventParams, 選項) 這個外掛程式能傳送指定 eventParams 的 Google Analytics 事件。這個方法會自動將此記錄的事件與這部裝置上的這個 Firebase 網頁應用程式執行個體建立關聯。如需建議事件參數的清單，請參閱 GA4 參考說明文件。
logEvent(analyticsInstance, eventName, eventParams, 選項) 這個外掛程式能傳送指定 eventParams 的 Google Analytics 事件。這個方法會自動將此記錄的事件與這部裝置上的這個 Firebase 網頁應用程式執行個體建立關聯。如需建議事件參數的清單，請參閱 GA4 參考說明文件。
logEvent(analyticsInstance, eventName, eventParams, 選項) 這個外掛程式能傳送指定 eventParams 的 Google Analytics 事件。這個方法會自動將這個記錄的事件與這部裝置上的這個 Firebase 網頁應用程式執行個體建立關聯。請參閱「網頁瀏覽」一節。
setAnalyticsCollectionEnabled(analyticsInstance, enabled) 設定是否在這部裝置上啟用這個應用程式的 Google Analytics 資料收集功能。設為window['ga-disable-analyticsId'] = true;全域
setCurrentScreen(analyticsInstance, screenName, options) 使用 gtag config 指令設定 screen_name。
setUserId(analyticsInstance, id, 選項) 使用 gtag config 指令設定 user_id。
setUserProperties(analyticsInstance, 屬性, 選項) 使用 gtag config 指令設定所有指定的參數。
function()
isSupported() 這是提供給使用者的公開靜態方法，可納入四項不同的檢查：1.請確認這不是瀏覽器擴充功能環境。2. 檢查目前的瀏覽器是否已啟用 Cookie。3. 確認瀏覽器環境是否支援 IndexedDB。4. 檢查目前的瀏覽器環境是否適用於使用 IndexedDB.open()。
function(consentSettings, ...)
setConsent(consentSettings) 在 Firebase Analytics 初始化後，為這個網頁應用程式的所有 gtag 參照設定適用的使用者同意聲明狀態。請使用 ConsentSettings 指定個別同意聲明類型值。同意聲明類型預設為「已授權」。
function(customParams, ...)
setDefaultEventParameters(customParams) 加入將在 SDK 記錄的每個事件上設定的資料 (包括自動事件)。使用 gtag 的「set」指令，傳送的值會保留在目前的網頁上，並與所有後續事件一併傳送。
function(選項, ...)
settings(選項) 將 Firebase 數據分析設為使用自訂 gtag 或 dataLayer 名稱。如果這個頁面已安裝 gtag.js 指令碼 (與 Firebase Analytics 無關)，且 gtag 函式或 dataLayer 使用非預設名稱，就適合使用這個選項。必須先呼叫才能呼叫 getAnalytics()，否則無效。

介面

介面 說明
數據分析 Firebase Analytics 執行個體。
Analytics 撥號選項 可傳遞至 Analytics 方法呼叫的其他選項，例如 logEvent 等。
Analytics 設定 Analytics 執行個體初始化選項。
同意聲明設定 每種同意聲明類型的同意聲明狀態設定。詳情請參閱 GA4 同意聲明狀態和同意聲明類型參考說明文件。
ControlParams 標準 gtag.js 控制項參數。詳情請參閱 GA4 參考說明文件。
CustomParams 使用者可能傳遞至 gtag 的任何自訂參數。
EventParams 標準 gtag.js 事件參數。詳情請參閱 GA4 參考說明文件。
GtagConfigParams gtag.js 可辨識的一組常用 Google Analytics 設定。
項目 標準 Google Analytics Item類型。
促銷活動 部分 Google Analytics 事件先前使用的欄位。
設定選項 指定 Firebase Analytics 執行個體的自訂選項。必須先設定這些項目，才能初始化 firebase.analytics()。

型別別名

類型別名 說明
同意聲明狀態字串 特定同意聲明類型是否已授予或拒絕。
貨幣 標準 Google Analytics 貨幣類型。
CustomEventName 任何未列在建議事件名稱標準清單中的自訂事件名稱字串。
EventNameString 標準 Google Analytics 事件名稱的類型。logEvent 也接受任何自訂字串，並將其解讀為自訂事件名稱。

function(應用程式, ...)

getAnalytics(應用程式)

傳回指定應用程式的 Analytics 執行個體。

簽名：

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

參數

參數 類型 說明
應用程式 Firebase 應用程式 要使用的 FirebaseApp。

傳回：

數據分析

InitialAnalytics(應用程式, 選項)

傳回指定應用程式的 Analytics 執行個體。

簽名：

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

參數

參數 類型 說明
應用程式 Firebase 應用程式 要使用的 FirebaseApp。
選項 Analytics 設定

傳回：

數據分析

function(analyticsInstance, ...)

getGoogleAnalyticsClientId(analyticsInstance)

擷取網路用戶端的專屬 Google Analytics ID。請參閱 client_id。

簽名：

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

參數

參數 類型 說明
數據分析執行個體 數據分析

傳回：

承諾<字串>

logEvent(analyticsInstance, eventName, eventParams, 選項)

這個外掛程式能傳送指定eventParams的 Google Analytics 事件。這個方法會自動將此記錄的事件與這部裝置上的這個 Firebase 網頁應用程式執行個體建立關聯。

如需建議的事件參數清單，請參閱 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;

參數

參數 類型 說明
數據分析執行個體 數據分析
事件名稱 「add_payment_info」
event 參數 { coupon?:EventParams['coupon'];？EventParams['currency'];項目？EventParams['items'];payments_type?：EventParams['payment_type'];值？EventParams['value'];[key: string]: any;}
選項 Analytics 撥號選項

傳回：

void

logEvent(analyticsInstance, eventName, eventParams, 選項)

這個外掛程式能傳送指定eventParams的 Google Analytics 事件。這個方法會自動將此記錄的事件與這部裝置上的這個 Firebase 網頁應用程式執行個體建立關聯。

如需建議的事件參數清單，請參閱 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;

參數

參數 類型 說明
數據分析執行個體 數據分析
事件名稱 「purchase」|「refund」
event 參數 { value?:EventParams['value'];？EventParams['currency'];transaction_id：EventParams['transaction_id'];稅金？：EventParams['tax'];運費？EventParams['shipping'];項目？EventParams['items'];優待券？EventParams['coupon'];是否有聯盟關係？EventParams['affiliation'];[key: string]: any;}
選項 Analytics 撥號選項

傳回：

void

logEvent(analyticsInstance, eventName, eventParams, 選項)

這個外掛程式能傳送指定eventParams的 Google Analytics 事件。這個方法會自動將此記錄的事件與這部裝置上的這個 Firebase 網頁應用程式執行個體建立關聯。

請參閱「追蹤畫面瀏覽」。

簽名：

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;

參數

參數 類型 說明
數據分析執行個體 數據分析
事件名稱 「screen_view」
event 參數 { firebase_screen：EventParams['firebase_screen'];firebase_screen_class：EventParams['firebase_screen_class'];[key: string]: any;}
選項 Analytics 撥號選項

傳回：

void

logEvent(analyticsInstance, eventName, eventParams, 選項)

這個外掛程式能傳送指定eventParams的 Google Analytics 事件。這個方法會自動將此記錄的事件與這部裝置上的這個 Firebase 網頁應用程式執行個體建立關聯。

如需建議的事件參數清單，請參閱 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」|「view_search_results」
event 參數 { search_term?:EventParams['search_term'];[key: string]: any;}
選項 Analytics 撥號選項

傳回：

void

logEvent(analyticsInstance, eventName, eventParams, 選項)

這個外掛程式能傳送指定eventParams的 Google Analytics 事件。這個方法會自動將此記錄的事件與這部裝置上的這個 Firebase 網頁應用程式執行個體建立關聯。

如需建議的事件參數清單，請參閱 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;

參數

參數 類型 說明
數據分析執行個體 數據分析
事件名稱 「select_content」
event 參數 { content_type?:EventParams['content_type'];item_id?：EventParams['item_id'];[key: string]: any;}
選項 Analytics 撥號選項

傳回：

void

logEvent(analyticsInstance, eventName, eventParams, 選項)

這個外掛程式能傳送指定eventParams的 Google Analytics 事件。這個方法會自動將此記錄的事件與這部裝置上的這個 Firebase 網頁應用程式執行個體建立關聯。

如需建議的事件參數清單，請參閱 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;

參數

參數 類型 說明
數據分析執行個體 數據分析
事件名稱 「select_item」
event 參數 { 個項目？：EventParams['items'];item_list_name?：EventParams['item_list_name'];item_list_id?：EventParams['item_list_id'];[key: string]: any;}
選項 Analytics 撥號選項

傳回：

void

logEvent(analyticsInstance, eventName, eventParams, 選項)

這個外掛程式能傳送指定eventParams的 Google Analytics 事件。這個方法會自動將此記錄的事件與這部裝置上的這個 Firebase 網頁應用程式執行個體建立關聯。

如需建議的事件參數清單，請參閱 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;

參數

參數 類型 說明
數據分析執行個體 數據分析
事件名稱 「select_promotion」|「view_promotion」
event 參數 { 個項目？：EventParams['items'];promotion_id?:EventParams['promotion_id'];promotion_name?:EventParams['promotion_name'];[key: string]: any;}
選項 Analytics 撥號選項

傳回：

void

logEvent(analyticsInstance, eventName, eventParams, 選項)

這個外掛程式能傳送指定eventParams的 Google Analytics 事件。這個方法會自動將此記錄的事件與這部裝置上的這個 Firebase 網頁應用程式執行個體建立關聯。

如需建議的事件參數清單，請參閱 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;

參數

參數 類型 說明
數據分析執行個體 數據分析
事件名稱 「set_checkout_option」
event 參數 { checkout_step?:EventParams['checkout_step'];Checkout_option?：EventParams['checkout_option'];[key: string]: any;}
選項 Analytics 撥號選項

傳回：

void

logEvent(analyticsInstance, eventName, eventParams, 選項)

這個外掛程式能傳送指定eventParams的 Google Analytics 事件。這個方法會自動將此記錄的事件與這部裝置上的這個 Firebase 網頁應用程式執行個體建立關聯。

如需建議的事件參數清單，請參閱 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;

參數

參數 類型 說明
數據分析執行個體 數據分析
事件名稱 「分享」
event 參數 { 方法？：EventParams['method'];content_type?:EventParams['content_type'];item_id?：EventParams['item_id'];[key: string]: any;}
選項 Analytics 撥號選項

傳回：

void

logEvent(analyticsInstance, eventName, eventParams, 選項)

這個外掛程式能傳送指定eventParams的 Google Analytics 事件。這個方法會自動將此記錄的事件與這部裝置上的這個 Firebase 網頁應用程式執行個體建立關聯。

如需建議的事件參數清單，請參閱 GA4 參考說明文件。

簽名：

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

參數

參數 類型 說明
數據分析執行個體 數據分析
事件名稱 「sign_up」
event 參數 { 方法？：EventParams['method'];[key: string]: any;}
選項 Analytics 撥號選項

傳回：

void

logEvent(analyticsInstance, eventName, eventParams, 選項)

這個外掛程式能傳送指定eventParams的 Google Analytics 事件。這個方法會自動將此記錄的事件與這部裝置上的這個 Firebase 網頁應用程式執行個體建立關聯。

如需建議的事件參數清單，請參閱 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;

參數

參數 類型 說明
數據分析執行個體 數據分析
事件名稱 「timing_complete」
event 參數 { name: string;值：數字；event_category?: string;event_label?: string;[key: string]: any;}
選項 Analytics 撥號選項

傳回：

void

logEvent(analyticsInstance, eventName, eventParams, 選項)

這個外掛程式能傳送指定eventParams的 Google Analytics 事件。這個方法會自動將此記錄的事件與這部裝置上的這個 Firebase 網頁應用程式執行個體建立關聯。

如需建議的事件參數清單，請參閱 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」
event 參數 { coupon?:EventParams['coupon'];？EventParams['currency'];項目？EventParams['items'];shipping_tier?：EventParams['shipping_tier'];值？EventParams['value'];[key: string]: any;}
選項 Analytics 撥號選項

傳回：

void

logEvent(analyticsInstance, eventName, eventParams, 選項)

這個外掛程式能傳送指定eventParams的 Google Analytics 事件。這個方法會自動將此記錄的事件與這部裝置上的這個 Firebase 網頁應用程式執行個體建立關聯。

如需建議的事件參數清單，請參閱 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;

參數

參數 類型 說明
數據分析執行個體 數據分析
事件名稱 「view_cart」|「view_item」
event 參數 { 貨幣？：EventParams['currency'];項目？EventParams['items'];值？EventParams['value'];[key: string]: any;}
選項 Analytics 撥號選項

傳回：

void

logEvent(analyticsInstance, eventName, eventParams, 選項)

這個外掛程式能傳送指定eventParams的 Google Analytics 事件。這個方法會自動將此記錄的事件與這部裝置上的這個 Firebase 網頁應用程式執行個體建立關聯。

如需建議的事件參數清單，請參閱 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;

參數

參數 類型 說明
數據分析執行個體 數據分析
事件名稱 「view_item_list」
event 參數 { 個項目？：EventParams['items'];item_list_name?：EventParams['item_list_name'];item_list_id?：EventParams['item_list_id'];[key: string]: any;}
選項 Analytics 撥號選項

傳回：

void

logEvent(analyticsInstance, eventName, eventParams, 選項)

這個外掛程式能傳送指定eventParams的 Google Analytics 事件。這個方法會自動將此記錄的事件與這部裝置上的這個 Firebase 網頁應用程式執行個體建立關聯。

如需建議的事件參數清單，請參閱 GA4 參考說明文件。

簽名：

export declare function logEvent<T extends string>(analyticsInstance: Analytics, eventName: CustomEventName<T>, eventParams?: {
    [key: string]: any;
}, options?: AnalyticsCallOptions): void;

參數

參數 類型 說明
數據分析執行個體 數據分析
事件名稱 CustomEventName<T>
event 參數 { [key: string]: any;}
選項 Analytics 撥號選項

傳回：

void

logEvent(analyticsInstance, eventName, eventParams, 選項)

這個外掛程式能傳送指定eventParams的 Google Analytics 事件。這個方法會自動將此記錄的事件與這部裝置上的這個 Firebase 網頁應用程式執行個體建立關聯。

如需建議的事件參數清單，請參閱 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;

參數

參數 類型 說明
數據分析執行個體 數據分析
事件名稱 「add_to_cart」|「add_to_wishlist」|「remove_from_cart」
event 參數 { 貨幣？：EventParams['currency'];值？EventParams['value'];項目？EventParams['items'];[key: string]: any;}
選項 Analytics 撥號選項

傳回：

void

logEvent(analyticsInstance, eventName, eventParams, 選項)

這個外掛程式能傳送指定eventParams的 Google Analytics 事件。這個方法會自動將此記錄的事件與這部裝置上的這個 Firebase 網頁應用程式執行個體建立關聯。

如需建議的事件參數清單，請參閱 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;

參數

參數 類型 說明
數據分析執行個體 數據分析
事件名稱 「begin_checkout」
event 參數 { 貨幣？：EventParams['currency'];優待券？EventParams['coupon'];值？EventParams['value'];項目？EventParams['items'];[key: string]: any;}
選項 Analytics 撥號選項

傳回：

void

logEvent(analyticsInstance, eventName, eventParams, 選項)

這個外掛程式能傳送指定eventParams的 Google Analytics 事件。這個方法會自動將此記錄的事件與這部裝置上的這個 Firebase 網頁應用程式執行個體建立關聯。

如需建議的事件參數清單，請參閱 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;

參數

參數 類型 說明
數據分析執行個體 數據分析
事件名稱 「checkout_progress」
event 參數 { 貨幣？：EventParams['currency'];優待券？EventParams['coupon'];值？EventParams['value'];項目？EventParams['items'];Checkout_step?：EventParams['checkout_step'];Checkout_option?：EventParams['checkout_option'];[key: string]: any;}
選項 Analytics 撥號選項

傳回：

void

logEvent(analyticsInstance, eventName, eventParams, 選項)

這個外掛程式能傳送指定eventParams的 Google Analytics 事件。這個方法會自動將此記錄的事件與這部裝置上的這個 Firebase 網頁應用程式執行個體建立關聯。

請參閱「評估例外狀況」一節。。

簽名：

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

參數

參數 類型 說明
數據分析執行個體 數據分析
事件名稱 「例外狀況」
event 參數 {說明？：EventParams['description'];嚴重？：EventParams['fatal'];[key: string]: any;}
選項 Analytics 撥號選項

傳回：

void

logEvent(analyticsInstance, eventName, eventParams, 選項)

這個外掛程式能傳送指定eventParams的 Google Analytics 事件。這個方法會自動將此記錄的事件與這部裝置上的這個 Firebase 網頁應用程式執行個體建立關聯。

如需建議的事件參數清單，請參閱 GA4 參考說明文件。

簽名：

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

參數

參數 類型 說明
數據分析執行個體 數據分析
事件名稱 「generate_lead」
event 參數 { value?:EventParams['value'];？EventParams['currency'];[key: string]: any;}
選項 Analytics 撥號選項

傳回：

void

logEvent(analyticsInstance, eventName, eventParams, 選項)

這個外掛程式能傳送指定eventParams的 Google Analytics 事件。這個方法會自動將此記錄的事件與這部裝置上的這個 Firebase 網頁應用程式執行個體建立關聯。

如需建議的事件參數清單，請參閱 GA4 參考說明文件。

簽名：

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

參數

參數 類型 說明
數據分析執行個體 數據分析
事件名稱 「登入」
event 參數 { 方法？：EventParams['method'];[key: string]: any;}
選項 Analytics 撥號選項

傳回：

void

logEvent(analyticsInstance, eventName, eventParams, 選項)

這個外掛程式能傳送指定eventParams的 Google Analytics 事件。這個方法會自動將此記錄的事件與這部裝置上的這個 Firebase 網頁應用程式執行個體建立關聯。

請參閱網頁瀏覽。

簽名：

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_view」
event 參數 { page_title?: string;page_location?：字串；page_path?: string;[key: string]: any;}
選項 Analytics 撥號選項

傳回：

void

setAnalyticsCollectionEnabled(analyticsInstance, enabled)

設定是否在這部裝置上啟用這個應用程式的 Google Analytics 資料收集功能。設為window['ga-disable-analyticsId'] = true;全域

簽名：

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

參數

參數 類型 說明
數據分析執行個體 數據分析 Analytics 執行個體。
已啟用 布林值 設為 true 時啟用集合，設為 false 時則會停用。

傳回：

void

setCurrentScreen(analyticsInstance, screenName, options)

與 eventName 搭配使用，做為「screen_view」並新增相關eventParams。請參閱「追蹤畫面瀏覽」。

使用 gtag config 指令設定「screen_name」。

簽名：

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

參數

參數 類型 說明
數據分析執行個體 數據分析 Analytics 執行個體。
螢幕名稱 字串 要設定的畫面名稱。
選項 Analytics 撥號選項

傳回：

void

setUserId(analyticsInstance, id, 選項)

使用 gtag config 指令設定「user_id」。

簽名：

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

參數

參數 類型 說明
數據分析執行個體 數據分析 Analytics 執行個體。
id 字串 |空值 要設定的使用者 ID，
選項 Analytics 撥號選項

傳回：

void

setUserProperties(analyticsInstance, 屬性, 選項)

使用 gtag config 指令設定所有指定的參數。

簽名：

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

參數

參數 類型 說明
數據分析執行個體 數據分析
屬性 CustomParams
選項 Analytics 撥號選項

傳回：

void

function()

is supported()

這是提供給使用者的公開靜態方法，可納入四項不同的檢查：

  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 參照設定適用的使用者同意聲明狀態。

使用 ConsentSettings 指定個別同意聲明類型值。同意聲明類型預設為「已授權」。

簽名：

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

參數

參數 類型 說明
同意聲明設定 同意聲明設定 對應 gtag.js 適用的使用者同意聲明狀態。

傳回：

void

function(customParams, ...)

setDefaultEventParameters(customParams)

加入將在 SDK 記錄的每個事件上設定的資料 (包括自動事件)。使用 gtag 的「set」指令，傳送的值會保留在目前的網頁上，並與所有後續事件一併傳送。

簽名：

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

參數

參數 類型 說明
customParams CustomParams 使用者可以傳送至 gtag.js 的任何自訂參數。

傳回：

void

function(選項, ...)

settings(選項)

將 Firebase 數據分析設為使用自訂 gtag 或 dataLayer 名稱。如果這個頁面已安裝 gtag.js 指令碼 (與 Firebase Analytics 無關)，且 gtag 函式或 dataLayer 使用非預設名稱，則應使用這個選項。必須先呼叫才能呼叫 getAnalytics()，否則無效。

簽名：

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

參數

參數 類型 說明
選項 設定選項 自訂 gtag 和 dataLayer 名稱。

傳回：

void

同意聲明狀態字串

特定同意聲明類型是否已授予或拒絕。

簽名：

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