analytics package

Firebase 向け Google アナリティクス ウェブ SDK。この SDK は Node.js 環境では動作しません。

関数

関数 説明
function(app, ...)
getAnalytics(app) 指定されたアプリの Analytics インスタンスを返します。
InitializeAnalytics(app, options) 指定されたアプリの Analytics インスタンスを返します。
function(analyticsInstance, ...)
getGoogleAnalyticsClientId(analyticsInstance) ウェブ クライアントの一意の Google アナリティクス ID を取得します。client_id をご覧ください。
logEvent(analyticsInstance, eventName, eventParams, options) 指定された eventParams で Google アナリティクス イベントを送信します。このメソッドは、記録されたイベントを自動的にこのデバイスのこの Firebase ウェブアプリ インスタンスに関連付けます。推奨されるイベント パラメータの一覧については、GA4 リファレンス ドキュメントをご覧ください。
logEvent(analyticsInstance, eventName, eventParams, options) 指定された eventParams で Google アナリティクス イベントを送信します。このメソッドは、記録されたイベントを自動的にこのデバイスのこの Firebase ウェブアプリ インスタンスに関連付けます。推奨されるイベント パラメータの一覧については、GA4 リファレンス ドキュメントをご覧ください。
logEvent(analyticsInstance, eventName, eventParams, options) 指定された eventParams で Google アナリティクス イベントを送信します。このメソッドは、記録されたこのイベントをこのデバイスのこの Firebase ウェブアプリ インスタンスに自動的に関連付けます。スクリーン ビューをトラッキングするをご覧ください。
logEvent(analyticsInstance, eventName, eventParams, options) 指定された eventParams で Google アナリティクス イベントを送信します。このメソッドは、記録されたイベントを自動的にこのデバイスのこの Firebase ウェブアプリ インスタンスに関連付けます。推奨されるイベント パラメータの一覧については、GA4 リファレンス ドキュメントをご覧ください。
logEvent(analyticsInstance, eventName, eventParams, options) 指定された eventParams で Google アナリティクス イベントを送信します。このメソッドは、記録されたイベントを自動的にこのデバイスのこの Firebase ウェブアプリ インスタンスに関連付けます。推奨されるイベント パラメータの一覧については、GA4 リファレンス ドキュメントをご覧ください。
logEvent(analyticsInstance, eventName, eventParams, options) 指定された eventParams で Google アナリティクス イベントを送信します。このメソッドは、記録されたイベントを自動的にこのデバイスのこの Firebase ウェブアプリ インスタンスに関連付けます。推奨されるイベント パラメータの一覧については、GA4 リファレンス ドキュメントをご覧ください。
logEvent(analyticsInstance, eventName, eventParams, options) 指定された eventParams で Google アナリティクス イベントを送信します。このメソッドは、記録されたイベントを自動的にこのデバイスのこの Firebase ウェブアプリ インスタンスに関連付けます。推奨されるイベント パラメータの一覧については、GA4 リファレンス ドキュメントをご覧ください。
logEvent(analyticsInstance, eventName, eventParams, options) 指定された eventParams で Google アナリティクス イベントを送信します。このメソッドは、記録されたイベントを自動的にこのデバイスのこの Firebase ウェブアプリ インスタンスに関連付けます。推奨されるイベント パラメータの一覧については、GA4 リファレンス ドキュメントをご覧ください。
logEvent(analyticsInstance, eventName, eventParams, options) 指定された eventParams で Google アナリティクス イベントを送信します。このメソッドは、記録されたイベントを自動的にこのデバイスのこの Firebase ウェブアプリ インスタンスに関連付けます。推奨されるイベント パラメータの一覧については、GA4 リファレンス ドキュメントをご覧ください。
logEvent(analyticsInstance, eventName, eventParams, options) 指定された eventParams で Google アナリティクス イベントを送信します。このメソッドは、記録されたイベントを自動的にこのデバイスのこの Firebase ウェブアプリ インスタンスに関連付けます。推奨されるイベント パラメータの一覧については、GA4 リファレンス ドキュメントをご覧ください。
logEvent(analyticsInstance, eventName, eventParams, options) 指定された eventParams で Google アナリティクス イベントを送信します。このメソッドは、記録されたイベントを自動的にこのデバイスのこの Firebase ウェブアプリ インスタンスに関連付けます。推奨されるイベント パラメータの一覧については、GA4 リファレンス ドキュメントをご覧ください。
logEvent(analyticsInstance, eventName, eventParams, options) 指定された eventParams で Google アナリティクス イベントを送信します。このメソッドは、記録されたイベントを自動的にこのデバイスのこの Firebase ウェブアプリ インスタンスに関連付けます。推奨されるイベント パラメータの一覧については、GA4 リファレンス ドキュメントをご覧ください。
logEvent(analyticsInstance, eventName, eventParams, options) 指定された eventParams で Google アナリティクス イベントを送信します。このメソッドは、記録されたイベントを自動的にこのデバイスのこの Firebase ウェブアプリ インスタンスに関連付けます。推奨されるイベント パラメータの一覧については、GA4 リファレンス ドキュメントをご覧ください。
logEvent(analyticsInstance, eventName, eventParams, options) 指定された eventParams で Google アナリティクス イベントを送信します。このメソッドは、記録されたイベントを自動的にこのデバイスのこの Firebase ウェブアプリ インスタンスに関連付けます。推奨されるイベント パラメータの一覧については、GA4 リファレンス ドキュメントをご覧ください。
logEvent(analyticsInstance, eventName, eventParams, options) 指定された eventParams で Google アナリティクス イベントを送信します。このメソッドは、記録されたイベントを自動的にこのデバイスのこの Firebase ウェブアプリ インスタンスに関連付けます。推奨されるイベント パラメータの一覧については、GA4 リファレンス ドキュメントをご覧ください。
logEvent(analyticsInstance, eventName, eventParams, options) 指定された eventParams で Google アナリティクス イベントを送信します。このメソッドは、記録されたイベントを自動的にこのデバイスのこの Firebase ウェブアプリ インスタンスに関連付けます。推奨されるイベント パラメータの一覧については、GA4 リファレンス ドキュメントをご覧ください。
logEvent(analyticsInstance, eventName, eventParams, options) 指定された eventParams で Google アナリティクス イベントを送信します。このメソッドは、記録されたイベントを自動的にこのデバイスのこの Firebase ウェブアプリ インスタンスに関連付けます。推奨されるイベント パラメータの一覧については、GA4 リファレンス ドキュメントをご覧ください。
logEvent(analyticsInstance, eventName, eventParams, options) 指定された eventParams で Google アナリティクス イベントを送信します。このメソッドは、記録されたイベントを自動的にこのデバイスのこの Firebase ウェブアプリ インスタンスに関連付けます。推奨されるイベント パラメータの一覧については、GA4 リファレンス ドキュメントをご覧ください。
logEvent(analyticsInstance, eventName, eventParams, options) 指定された eventParams で Google アナリティクス イベントを送信します。このメソッドは、記録されたこのイベントをこのデバイスのこの Firebase ウェブアプリ インスタンスに自動的に関連付けます。例外を測定するをご覧ください。
logEvent(analyticsInstance, eventName, eventParams, options) 指定された eventParams で Google アナリティクス イベントを送信します。このメソッドは、記録されたイベントを自動的にこのデバイスのこの Firebase ウェブアプリ インスタンスに関連付けます。推奨されるイベント パラメータの一覧については、GA4 リファレンス ドキュメントをご覧ください。
logEvent(analyticsInstance, eventName, eventParams, options) 指定された eventParams で Google アナリティクス イベントを送信します。このメソッドは、記録されたイベントを自動的にこのデバイスのこの Firebase ウェブアプリ インスタンスに関連付けます。推奨されるイベント パラメータの一覧については、GA4 リファレンス ドキュメントをご覧ください。
logEvent(analyticsInstance, eventName, eventParams, options) 指定された eventParams で Google アナリティクス イベントを送信します。このメソッドは、記録されたこのイベントをこのデバイスのこの Firebase ウェブアプリ インスタンスに自動的に関連付けます。ページビューをご覧ください。
setAnalyticsCollectionEnabled(analyticsInstance, enabled) このデバイスでこのアプリに対して Google アナリティクス コレクションを有効にするかどうかを設定します。グローバル 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 コマンドを使用して、指定されたすべてのパラメータを設定します。
function（）
isSupported() これはユーザーに提供されるパブリック静的メソッドで、次の 4 つのチェックをラップします。1.ブラウザの拡張機能環境ではないかどうかを確認します。2. 現在のブラウザで Cookie が有効になっているかどうかを確認します。3. IndexedDB がブラウザ環境でサポートされているかどうかを確認します。4. 現在のブラウザ コンテキストが IndexedDB.open() の使用に対して有効かどうかを確認します。
function(consentSettings, ...)
setConsent(consentSettings) Firebase Analytics が初期化されると、このウェブアプリに適用されるエンドユーザーの同意ステータスを、すべての gtag 参照にわたって設定します。個々の同意タイプの値を指定するには、ConsentSettings を使用します。デフォルトでは、同意タイプは「許可」に設定されています。
function(customParams, ...)
setDefaultEventParameters(customParams) SDK からログに記録されるすべてのイベント（自動イベントを含む）に設定されるデータを追加します。gtag の「set」を使用してコマンドを実行すると、渡される値は現在のページで保持され、後続のすべてのイベントとともに渡されます。
function(options, ...)
settings(options) gtag または dataLayer のカスタム名を使用するように Firebase Analytics を設定します。Firebase 向け Google アナリティクスとは別に gtag.js スクリプトがこのページにインストールされ、gtag 関数または dataLayer にデフォルト以外の名前を使用している場合に使用されます。getAnalytics() を呼び出す前に呼び出す必要があります。そうでない場合は機能しません。

インターフェース

インターフェース 説明
アナリティクス Firebase 向け Google アナリティクスのインスタンス。
AnalyticsCallOptions アナリティクスのメソッド呼び出しに渡すことができるその他のオプション（logEvent など）。
AnalyticsSettings Analytics インスタンスの初期化オプション。
ConsentSettings 同意タイプごとの同意ステータスの設定。詳しくは、同意ステータスと同意タイプに関する GA4 リファレンス ドキュメントをご覧ください。
ControlParams 標準の gtag.js コントロール パラメータ。詳しくは、GA4 のリファレンス ドキュメントをご覧ください。
CustomParams ユーザーが gtag に渡すことができるカスタム パラメータ。
EventParams 標準の gtag.js イベント パラメータ。詳しくは、GA4 のリファレンス ドキュメントをご覧ください。
GtagConfigParams gtag.js で認識される共通の Google アナリティクス設定のセット。
項目 Google アナリティクスの標準の Item タイプ。
プロモーション 一部の Google アナリティクス イベントで以前使用されていたフィールド。
SettingsOptions Firebase 向け Google アナリティクス インスタンスのカスタム オプションを指定します。firebase.analytics() を初期化する前に、これらを設定する必要があります。

型エイリアス

型エイリアス 説明
ConsentStatusString 特定の同意タイプが許可または拒否されているかどうか。
通貨 Google アナリティクスの標準の通貨タイプです。
CustomEventName 推奨イベント名の標準リストに含まれていないカスタム イベント名の文字列。
EventNameString 標準の Google アナリティクス イベント名のタイプ。logEvent は任意のカスタム文字列を受け入れ、カスタム イベント名として解釈します。

関数（アプリ、...）

getAnalytics(app)

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

署名:

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

パラメータ

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

戻り値:

アナリティクス

初期化アナリティクス(アプリ, オプション)

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

署名:

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

パラメータ

パラメータ 型 説明
アプリ FirebaseApp 使用する FirebaseApp。
オプション AnalyticsSettings

戻り値:

アナリティクス

function（analyticsInstance, ...）

getGoogleAnalyticsClientId(analyticsInstance)

ウェブ クライアントの一意の Google アナリティクス ID を取得します。client_id をご覧ください。

署名:

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

パラメータ

パラメータ 型 説明
analyticsInstance アナリティクス

戻り値:

Promise<文字列>

logEvent(analyticsInstance, eventName, eventParams, options)

指定された eventParams で Google アナリティクス イベントを送信します。このメソッドは、ログに記録されたイベントを、このデバイス上のこの 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;

パラメータ

パラメータ 型 説明
analyticsInstance アナリティクス
eventName 「add_payment_info」
eventParams { coupon?:EventParams['coupon'];currency?:EventParams['currency'];items?:EventParams['items'];payment_type?:EventParams['payment_type'];value?:EventParams['value'];[キー: 文字列]: 任意;}
オプション AnalyticsCallOptions

戻り値:

void

logEvent(analyticsInstance, eventName, eventParams, options)

指定された eventParams で Google アナリティクス イベントを送信します。このメソッドは、ログに記録されたイベントを、このデバイス上のこの 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;

パラメータ

パラメータ 型 説明
analyticsInstance アナリティクス
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'];関係性の有無:EventParams['affiliation'];[キー: 文字列]: 任意;}
オプション AnalyticsCallOptions

戻り値:

void

logEvent(analyticsInstance, eventName, eventParams, options)

指定された eventParams で Google アナリティクス イベントを送信します。このメソッドは、ログに記録されたイベントを、このデバイス上のこの 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;

パラメータ

パラメータ 型 説明
analyticsInstance アナリティクス
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 アナリティクス イベントを送信します。このメソッドは、ログに記録されたイベントを、このデバイス上のこの 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;

パラメータ

パラメータ 型 説明
analyticsInstance アナリティクス
eventName 「search」|「view_search_results」
eventParams { search_term?:EventParams['search_term'];[キー: 文字列]: 任意;}
オプション AnalyticsCallOptions

戻り値:

void

logEvent(analyticsInstance, eventName, eventParams, options)

指定された eventParams で Google アナリティクス イベントを送信します。このメソッドは、ログに記録されたイベントを、このデバイス上のこの 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;

パラメータ

パラメータ 型 説明
analyticsInstance アナリティクス
eventName 「select_content」
eventParams { content_type?:EventParams['content_type'];item_id?:EventParams['item_id'];[キー: 文字列]: 任意;}
オプション AnalyticsCallOptions

戻り値:

void

logEvent(analyticsInstance, eventName, eventParams, options)

指定された eventParams で Google アナリティクス イベントを送信します。このメソッドは、ログに記録されたイベントを、このデバイス上のこの 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;

パラメータ

パラメータ 型 説明
analyticsInstance アナリティクス
eventName 「select_item」
eventParams { items?:EventParams['items'];item_list_name?:EventParams['item_list_name'];item_list_id?:EventParams['item_list_id'];[キー: 文字列]: 任意;}
オプション AnalyticsCallOptions

戻り値:

void

logEvent(analyticsInstance, eventName, eventParams, options)

指定された eventParams で Google アナリティクス イベントを送信します。このメソッドは、ログに記録されたイベントを、このデバイス上のこの 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;

パラメータ

パラメータ 型 説明
analyticsInstance アナリティクス
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 アナリティクス イベントを送信します。このメソッドは、ログに記録されたイベントを、このデバイス上のこの 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;

パラメータ

パラメータ 型 説明
analyticsInstance アナリティクス
eventName 「set_checkout_option」
eventParams { checkout_step?:EventParams['checkout_step'];checkout_option?:EventParams['checkout_option'];[キー: 文字列]: 任意;}
オプション AnalyticsCallOptions

戻り値:

void

logEvent(analyticsInstance, eventName, eventParams, options)

指定された eventParams で Google アナリティクス イベントを送信します。このメソッドは、ログに記録されたイベントを、このデバイス上のこの 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;

パラメータ

パラメータ 型 説明
analyticsInstance アナリティクス
eventName '共有'
eventParams { method?:EventParams['method'];content_type?:EventParams['content_type'];item_id?:EventParams['item_id'];[キー: 文字列]: 任意;}
オプション AnalyticsCallOptions

戻り値:

void

logEvent(analyticsInstance, eventName, eventParams, options)

指定された eventParams で Google アナリティクス イベントを送信します。このメソッドは、ログに記録されたイベントを、このデバイス上のこの Firebase ウェブアプリ インスタンスに自動的に関連付けます。

推奨イベント パラメータのリストについては、GA4 リファレンス ドキュメントをご覧ください。

署名:

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

パラメータ

パラメータ 型 説明
analyticsInstance アナリティクス
eventName 「sign_up」
eventParams { method?:EventParams['method'];[キー: 文字列]: 任意;}
オプション AnalyticsCallOptions

戻り値:

void

logEvent(analyticsInstance, eventName, eventParams, options)

指定された eventParams で Google アナリティクス イベントを送信します。このメソッドは、ログに記録されたイベントを、このデバイス上のこの 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;

パラメータ

パラメータ 型 説明
analyticsInstance アナリティクス
eventName 「timing_complete」
eventParams { name: string;value: number;event_category?: 文字列;event_label?: 文字列;[キー: 文字列]: 任意;}
オプション AnalyticsCallOptions

戻り値:

void

logEvent(analyticsInstance, eventName, eventParams, options)

指定された eventParams で Google アナリティクス イベントを送信します。このメソッドは、ログに記録されたイベントを、このデバイス上のこの 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;

パラメータ

パラメータ 型 説明
analyticsInstance アナリティクス
eventName 「add_shipping_info」
eventParams { coupon?:EventParams['coupon'];currency?:EventParams['currency'];items?:EventParams['items'];shipping_tier?:EventParams['shipping_tier'];value?:EventParams['value'];[キー: 文字列]: any;}
オプション AnalyticsCallOptions

戻り値:

void

logEvent(analyticsInstance, eventName, eventParams, options)

指定された eventParams で Google アナリティクス イベントを送信します。このメソッドは、ログに記録されたイベントを、このデバイス上のこの 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;

パラメータ

パラメータ 型 説明
analyticsInstance アナリティクス
eventName 「view_cart」|「view_item」
eventParams { currency?:EventParams['currency'];items?:EventParams['items'];value?:EventParams['value'];[キー: 文字列]: 任意;}
オプション AnalyticsCallOptions

戻り値:

void

logEvent(analyticsInstance, eventName, eventParams, options)

指定された eventParams で Google アナリティクス イベントを送信します。このメソッドは、ログに記録されたイベントを、このデバイス上のこの 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;

パラメータ

パラメータ 型 説明
analyticsInstance アナリティクス
eventName 「view_item_list」
eventParams { items?:EventParams['items'];item_list_name?:EventParams['item_list_name'];item_list_id?:EventParams['item_list_id'];[キー: 文字列]: 任意;}
オプション AnalyticsCallOptions

戻り値:

void

logEvent(analyticsInstance, eventName, eventParams, options)

指定された eventParams で Google アナリティクス イベントを送信します。このメソッドは、ログに記録されたイベントを、このデバイス上のこの Firebase ウェブアプリ インスタンスに自動的に関連付けます。

推奨イベント パラメータのリストについては、GA4 リファレンス ドキュメントをご覧ください。

署名:

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

パラメータ

パラメータ 型 説明
analyticsInstance アナリティクス
eventName CustomEventName<T>
eventParams { [キー: 文字列]: 任意;}
オプション AnalyticsCallOptions

戻り値:

void

logEvent(analyticsInstance, eventName, eventParams, options)

指定された eventParams で Google アナリティクス イベントを送信します。このメソッドは、ログに記録されたイベントを、このデバイス上のこの 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;

パラメータ

パラメータ 型 説明
analyticsInstance アナリティクス
eventName 「カートに追加」|「add_to_wishlist」|「カートからの削除」
eventParams { currency?:EventParams['currency'];value?:EventParams['value'];items?:EventParams['items'];[キー: 文字列]: 任意;}
オプション AnalyticsCallOptions

戻り値:

void

logEvent(analyticsInstance, eventName, eventParams, options)

指定された eventParams で Google アナリティクス イベントを送信します。このメソッドは、ログに記録されたイベントを、このデバイス上のこの 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;

パラメータ

パラメータ 型 説明
analyticsInstance アナリティクス
eventName 「begin_checkout」
eventParams { currency?:EventParams['currency'];coupon?:EventParams['coupon'];value?:EventParams['value'];items?:EventParams['items'];[キー: 文字列]: 任意;}
オプション AnalyticsCallOptions

戻り値:

void

logEvent(analyticsInstance, eventName, eventParams, options)

指定された eventParams で Google アナリティクス イベントを送信します。このメソッドは、ログに記録されたイベントを、このデバイス上のこの 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;

パラメータ

パラメータ 型 説明
analyticsInstance アナリティクス
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'];[キー: 文字列]: 任意;}
オプション AnalyticsCallOptions

戻り値:

void

logEvent(analyticsInstance, eventName, eventParams, options)

指定された eventParams で Google アナリティクス イベントを送信します。このメソッドは、ログに記録されたイベントを、このデバイス上のこの Firebase ウェブアプリ インスタンスに自動的に関連付けます。

例外を測定するをご覧ください。

署名:

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

パラメータ

パラメータ 型 説明
analyticsInstance アナリティクス
eventName '例外'
eventParams { description?:EventParams['description'];致命的な？:EventParams['fatal'];[キー: 文字列]: any;}
オプション AnalyticsCallOptions

戻り値:

void

logEvent(analyticsInstance, eventName, eventParams, options)

指定された eventParams で Google アナリティクス イベントを送信します。このメソッドは、ログに記録されたイベントを、このデバイス上のこの Firebase ウェブアプリ インスタンスに自動的に関連付けます。

推奨イベント パラメータのリストについては、GA4 リファレンス ドキュメントをご覧ください。

署名:

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

パラメータ

パラメータ 型 説明
analyticsInstance アナリティクス
eventName 「generate_lead」
eventParams { value?:EventParams['value'];currency?:EventParams['currency'];[キー: 文字列]: 任意;}
オプション AnalyticsCallOptions

戻り値:

void

logEvent(analyticsInstance, eventName, eventParams, options)

指定された eventParams で Google アナリティクス イベントを送信します。このメソッドは、ログに記録されたイベントを、このデバイス上のこの Firebase ウェブアプリ インスタンスに自動的に関連付けます。

推奨イベント パラメータのリストについては、GA4 リファレンス ドキュメントをご覧ください。

署名:

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

パラメータ

パラメータ 型 説明
analyticsInstance アナリティクス
eventName 「login」
eventParams { method?:EventParams['method'];[キー: 文字列]: 任意;}
オプション AnalyticsCallOptions

戻り値:

void

logEvent(analyticsInstance, eventName, eventParams, options)

指定された eventParams で Google アナリティクス イベントを送信します。このメソッドは、ログに記録されたイベントを、このデバイス上のこの 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;

パラメータ

パラメータ 型 説明
analyticsInstance アナリティクス
eventName 「page_view」
eventParams { page_title?: string;page_location?: string;page_path?: string;[キー: 文字列]: 任意;}
オプション AnalyticsCallOptions

戻り値:

void

setAnalyticsCollectionEnabled(analyticsInstance, enabled)

このデバイスでこのアプリに対して Google アナリティクス コレクションを有効にするかどうかを設定します。グローバル window['ga-disable-analyticsId'] = true; を設定します。

署名:

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

パラメータ

パラメータ 型 説明
analyticsInstance アナリティクス 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 インスタンス。
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 インスタンス。
id 文字列 |null 設定するユーザー ID。
オプション AnalyticsCallOptions

戻り値:

void

setUserProperties(analyticsInstance, properties, options)

gtag の config コマンドを使用して、指定したすべてのパラメータを設定します。

署名:

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

パラメータ

パラメータ 型 説明
analyticsInstance アナリティクス
プロパティ CustomParams
オプション AnalyticsCallOptions

戻り値:

void

関数

isSupported()

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

  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;

パラメータ

パラメータ 型 説明
同意設定 ConsentSettings 該当するエンドユーザーの同意ステータスを gtag.js にマッピングします。

戻り値:

void

function(customParams, ...)

setDefaultEventParameters(customParams)

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

署名:

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

パラメータ

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

戻り値:

void

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

設定（オプション）

gtag または dataLayer のカスタム名を使用するように Firebase Analytics を設定します。Firebase 向け Google アナリティクスとは別に gtag.js スクリプトがこのページにインストールされ、gtag 関数または dataLayer にデフォルト以外の名前を使用している場合に使用されます。getAnalytics() を呼び出す前に呼び出す必要があります。そうでない場合は機能しません。

署名:

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

パラメータ

パラメータ 型 説明
オプション SettingsOptions gtag および dataLayer のカスタム名

戻り値:

void

同意ステータス文字列

特定の同意タイプが許可または拒否されているかどうか。

署名:

export declare type ConsentStatusString = 'granted' | 'denied';

通貨

Google アナリティクスの標準通貨タイプ。

署名:

export declare type Currency = string | number;

CustomEventName

推奨イベント名の標準リストに含まれていないカスタム イベント名の文字列。

署名:

export declare type CustomEventName<T> = T extends EventNameString ? never : T;

EventNameString

標準の Google アナリティクス イベント名のタイプ。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';