analytics package

Firebase Analytics Web SDK。この SDK は Node.js 環境では動作しません。

機能

関数説明
関数(アプリ、...)
getAnalytics(アプリ)指定されたアプリのAnalyticsインスタンスを返します。
InitializeAnalytics(アプリ、オプション)指定されたアプリのAnalyticsインスタンスを返します。
関数(analyticsInstance, ...)
getGoogleAnalyticsClientId(analyticsInstance) Web クライアントの一意の Google Analytics 識別子を取得します。 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, 有効)このデバイス上のこのアプリに対して 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, プロパティ, オプション) gtag configコマンドを使用して、指定されたすべてのパラメータを設定します。
関数()
isSupported()これはユーザーに提供されるパブリック静的メソッドで、4 つの異なるチェックをラップします。 1. ブラウザ拡張機能環境ではないか確認してください。 2. 現在のブラウザで Cookie が有効になっているかどうかを確認します。 3. IndexedDB がブラウザ環境でサポートされているかどうかを確認します。 4. 現在のブラウザコンテキストがIndexedDB.open()の使用に有効であるかどうかを確認します。
関数(同意設定, ...)
setConsent(同意設定) Firebase Analytics が初期化されると、すべての gtag 参照にわたってこのウェブアプリに該当するエンドユーザーの同意状態を設定します。 ConsentSettingsを使用して、個々の同意タイプの値を指定します。デフォルトでは、同意タイプは「許可」に設定されています。
関数(customParams, ...)
setDefaultEventParameters(customParams)自動イベントを含む、SDK からログに記録されるすべてのイベントに設定されるデータを追加します。 gtag の「set」コマンドを使用すると、渡された値は現在のページに保持され、後続のすべてのイベントとともに渡されます。
関数(オプション, ...)
設定(オプション)カスタムgtagまたはdataLayer名を使用するように Firebase Analytics を構成します。 gtag.jsスクリプトが Firebase Analytics とは独立してこのページにインストールされており、 gtag関数またはdataLayerのいずれかにデフォルト以外の名前を使用している場合に使用することを目的としています。 getAnalytics()を呼び出す前に呼び出す必要があります。そうしないと効果がありません。

インターフェース

インターフェース説明
分析Firebase 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 通貨タイプ。
カスタムイベント名推奨されるイベント名の標準リストにないカスタム イベント名の文字列。
イベント名文字列標準の Google Analytics イベント名を入力します。 logEvent任意のカスタム文字列も受け入れ、それをカスタム イベント名として解釈します。

関数(アプリ、...)

getAnalytics(アプリ)

指定されたアプリのAnalyticsインスタンスを返します。

サイン:

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

パラメーター

パラメータタイプ説明
アプリFirebaseApp使用するFirebaseApp

戻り値:

分析

InitializeAnalytics(アプリ、オプション)

指定されたアプリのAnalyticsインスタンスを返します。

サイン:

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

パラメーター

パラメータタイプ説明
アプリFirebaseApp使用するFirebaseApp
オプション分析設定

戻り値:

分析

関数(analyticsInstance, ...)

getGoogleAnalyticsClientId(analyticsInstance)

Web クライアントの一意の Google Analytics 識別子を取得します。 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;

パラメーター

パラメータタイプ説明
分析インスタンス分析
イベント名「支払い情報の追加」
イベントパラメータ{ クーポン?: EventParams ['クーポン'];通貨?: EventParams ['通貨'];項目?: EventParams ['アイテム']; Payment_type?: EventParams ['払いの種類'];値?: EventParams ['価値']; [キー: 文字列]: 任意; }
オプション分析コールオプション

戻り値:

空所

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;

パラメーター

パラメータタイプ説明
分析インスタンス分析
イベント名'購入' | '返金'
イベントパラメータ{ 値?: EventParams ['価値'];通貨?: EventParams ['通貨'];トランザクション ID: EventParams ['トランザクションID'];税金?: EventParams ['税'];発送?: EventParams ['配送'];項目?: EventParams ['アイテム'];クーポン?: EventParams ['クーポン'];所属?: EventParams ['所属']; [キー: 文字列]: 任意; }
オプション分析コールオプション

戻り値:

空所

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;

パラメーター

パラメータタイプ説明
分析インスタンス分析
イベント名'スクリーンビュー'
イベントパラメータ{ firebase_screen: EventParams ['firebase_screen']; firebase_screen_class: EventParams ['firebase_screen_class']; [キー: 文字列]: 任意; }
オプション分析コールオプション

戻り値:

空所

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_term?: EventParams ['検索語']; [キー: 文字列]: 任意; }
オプション分析コールオプション

戻り値:

空所

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;

パラメーター

パラメータタイプ説明
分析インスタンス分析
イベント名'コンテンツの選択'
イベントパラメータ{ content_type?: EventParams ['コンテンツタイプ']; item_id?: EventParams ['アイテムID']; [キー: 文字列]: 任意; }
オプション分析コールオプション

戻り値:

空所

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;

パラメーター

パラメータタイプ説明
分析インスタンス分析
イベント名'アイテムを選択'
イベントパラメータ{ アイテム?: EventParams ['アイテム']; item_list_name?: EventParams ['アイテムリスト名']; item_list_id?: EventParams ['アイテムリストID']; [キー: 文字列]: 任意; }
オプション分析コールオプション

戻り値:

空所

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;

パラメーター

パラメータタイプ説明
分析インスタンス分析
イベント名'セレクトプロモーション' | 'ビュー_プロモーション'
イベントパラメータ{ アイテム?: EventParams ['アイテム']; Promotion_id?: EventParams ['プロモーション ID'];プロモーション名?: EventParams ['プロモーション名']; [キー: 文字列]: 任意; }
オプション分析コールオプション

戻り値:

空所

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'
イベントパラメータ{ checkout_step?: EventParams ['チェックアウトステップ']; checkout_option?: EventParams ['チェックアウトオプション']; [キー: 文字列]: 任意; }
オプション分析コールオプション

戻り値:

空所

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;

パラメーター

パラメータタイプ説明
分析インスタンス分析
イベント名'共有'
イベントパラメータ{ メソッド?: EventParams ['方法']; content_type?: EventParams ['コンテンツタイプ']; item_id?: EventParams ['アイテムID']; [キー: 文字列]: 任意; }
オプション分析コールオプション

戻り値:

空所

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;

パラメーター

パラメータタイプ説明
分析インスタンス分析
イベント名'サインアップ'
イベントパラメータ{ メソッド?: EventParams ['方法']; [キー: 文字列]: 任意; }
オプション分析コールオプション

戻り値:

空所

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;

パラメーター

パラメータタイプ説明
分析インスタンス分析
イベント名'タイミング完了'
イベントパラメータ{ 名前: 文字列;値: 数値;イベントカテゴリ?: 文字列;イベントラベル?: 文字列; [キー: 文字列]: 任意; }
オプション分析コールオプション

戻り値:

空所

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'
イベントパラメータ{ クーポン?: EventParams ['クーポン'];通貨?: EventParams ['通貨'];項目?: EventParams ['アイテム']; Shipping_tier?: EventParams ['shipping_tier'];値?: EventParams ['価値']; [キー: 文字列]: 任意; }
オプション分析コールオプション

戻り値:

空所

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;

パラメーター

パラメータタイプ説明
分析インスタンス分析
イベント名'ビューカート' | 'アイテムの表示'
イベントパラメータ{ 通貨?: EventParams ['通貨'];項目?: EventParams ['アイテム'];値?: EventParams ['価値']; [キー: 文字列]: 任意; }
オプション分析コールオプション

戻り値:

空所

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'
イベントパラメータ{ アイテム?: EventParams ['アイテム']; item_list_name?: EventParams ['アイテムリスト名']; item_list_id?: EventParams ['アイテムリストID']; [キー: 文字列]: 任意; }
オプション分析コールオプション

戻り値:

空所

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;

パラメーター

パラメータタイプ説明
分析インスタンス分析
イベント名カスタムイベント名<T>
イベントパラメータ{ [キー: 文字列]: 任意; }
オプション分析コールオプション

戻り値:

空所

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;

パラメーター

パラメータタイプ説明
分析インスタンス分析
イベント名'カートに追加' | 'ウィッシュリストに追加' | 「カートから削除」
イベントパラメータ{ 通貨?: EventParams ['通貨'];値?: EventParams ['価値'];項目?: EventParams ['アイテム']; [キー: 文字列]: 任意; }
オプション分析コールオプション

戻り値:

空所

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;

パラメーター

パラメータタイプ説明
分析インスタンス分析
イベント名'チェックアウトの開始'
イベントパラメータ{ 通貨?: EventParams ['通貨'];クーポン?: EventParams ['クーポン'];値?: EventParams ['価値'];項目?: EventParams ['アイテム']; [キー: 文字列]: 任意; }
オプション分析コールオプション

戻り値:

空所

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;

パラメーター

パラメータタイプ説明
分析インスタンス分析
イベント名'チェックアウト_進行状況'
イベントパラメータ{ 通貨?: EventParams ['通貨'];クーポン?: EventParams ['クーポン'];値?: EventParams ['価値'];項目?: EventParams ['アイテム']; checkout_step?: EventParams ['チェックアウトステップ']; checkout_option?: EventParams ['チェックアウトオプション']; [キー: 文字列]: 任意; }
オプション分析コールオプション

戻り値:

空所

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;

パラメーター

パラメータタイプ説明
分析インスタンス分析
イベント名'例外'
イベントパラメータ{ 説明?: EventParams ['説明'];致命的?: EventParams ['致命的']; [キー: 文字列]: 任意; }
オプション分析コールオプション

戻り値:

空所

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;

パラメーター

パラメータタイプ説明
分析インスタンス分析
イベント名「リードの生成」
イベントパラメータ{ 値?: EventParams ['価値'];通貨?: EventParams ['通貨']; [キー: 文字列]: 任意; }
オプション分析コールオプション

戻り値:

空所

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;

パラメーター

パラメータタイプ説明
分析インスタンス分析
イベント名'ログイン'
イベントパラメータ{ メソッド?: EventParams ['方法']; [キー: 文字列]: 任意; }
オプション分析コールオプション

戻り値:

空所

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_title?: 文字列;ページの場所?: 文字列;ページパス?: 文字列; [キー: 文字列]: 任意; }
オプション分析コールオプション

戻り値:

空所

setAnalyticsCollectionEnabled(analyticsInstance, 有効)

このデバイス上のこのアプリに対して Google Analytics 収集を有効にするかどうかを設定します。グローバルwindow['ga-disable-analyticsId'] = true;

サイン:

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

パラメーター

パラメータタイプ説明
分析インスタンス分析アナリティクスインスタンス。
有効ブール値true の場合は収集が有効になり、false の場合は収集が無効になります。

戻り値:

空所

setCurrentScreen(analyticsInstance, screenName, options)

「screen_view」としてeventNameとともに使用し、関連するeventParamsを追加します「スクリーンビューの追跡」を参照してください。

gtag configコマンドを使用してscreen_nameを設定します

サイン:

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

パラメーター

パラメータタイプ説明
分析インスタンス分析アナリティクスインスタンス。
ハンドルネーム設定するスクリーン名。
オプション分析コールオプション

戻り値:

空所

setUserId(analyticsInstance, id, options)

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;

パラメーター

パラメータタイプ説明
分析インスタンス分析
プロパティCustomParams
オプション分析コールオプション

戻り値:

空所

関数()

isSupported()

これはユーザーに提供されるパブリック静的メソッドで、4 つの異なるチェックをラップします。

  1. ブラウザ拡張機能環境ではないか確認してください。 2. 現在のブラウザで Cookie が有効になっているかどうかを確認します。 3. IndexedDB がブラウザ環境でサポートされているかどうかを確認します。 4. 現在のブラウザコンテキストがIndexedDB.open()の使用に有効であるかどうかを確認します。

サイン:

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

戻り値:

Promise<ブール値>

関数(同意設定, ...)

setConsent(同意設定)

Firebase Analytics が初期化されると、すべての gtag 参照にわたってこのウェブアプリに該当するエンドユーザーの同意状態を設定します。

ConsentSettingsを使用して、個々の同意タイプの値を指定します。デフォルトでは、同意タイプは「許可」に設定されています。

サイン:

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

パラメーター

パラメータタイプ説明
同意設定同意設定gtag.js に該当するエンド ユーザーの同意状態をマップします。

戻り値:

空所

関数(customParams, ...)

setDefaultEventParameters(customParams)

自動イベントを含む、SDK からログに記録されるすべてのイベントに設定されるデータを追加します。 gtag の「set」コマンドを使用すると、渡された値は現在のページに保持され、後続のすべてのイベントとともに渡されます。

サイン:

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

パラメーター

パラメータタイプ説明
カスタムパラメータCustomParamsユーザーが gtag.js に渡すことができるカスタム パラメータ。

戻り値:

空所

関数(オプション, ...)

設定(オプション)

カスタムgtagまたはdataLayer名を使用するように Firebase Analytics を構成します。 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';