analytics package

SDK Web Firebase Analytics. SDK ini tidak berfungsi di lingkungan Node.js.

Fungsi

Antarmuka

Ketik Alias

fungsi(aplikasi, ...)

getAnalytics(aplikasi)

Mengembalikan instance Analytics untuk aplikasi tertentu.

Tanda tangan:

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

Parameter

Pengembalian:

Analisis

inisialisasiAnalytics(aplikasi, opsi)

Mengembalikan instance Analytics untuk aplikasi tertentu.

Tanda tangan:

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

Parameter

Pengembalian:

Analisis

fungsi(analyticsInstance, ...)

dapatkanGoogleAnalyticsClientId(analyticsInstance)

Mengambil pengidentifikasi Google Analytics unik untuk klien web. Lihat client_id .

Tanda tangan:

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

Parameter

Pengembalian:

Janji<string>

logEvent(analyticsInstance, eventName, eventParams, opsi)

Mengirimkan peristiwa Google Analytics dengan eventParams tertentu . Metode ini secara otomatis mengaitkan peristiwa yang dicatat dalam log ini dengan instance aplikasi web Firebase di perangkat ini.

Daftar parameter peristiwa yang direkomendasikan dapat ditemukan di dokumentasi referensi GA4 .

Tanda tangan:

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;

Parameter

Pengembalian:

ruang kosong

logEvent(analyticsInstance, eventName, eventParams, opsi)

Mengirimkan peristiwa Google Analytics dengan eventParams tertentu . Metode ini secara otomatis mengaitkan peristiwa yang dicatat dalam log ini dengan instance aplikasi web Firebase di perangkat ini.

Daftar parameter peristiwa yang direkomendasikan dapat ditemukan di dokumentasi referensi GA4 .

Tanda tangan:

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;

Parameter

Pengembalian:

ruang kosong

logEvent(analyticsInstance, eventName, eventParams, opsi)

Mengirimkan peristiwa Google Analytics dengan eventParams tertentu . Metode ini secara otomatis mengaitkan peristiwa yang dicatat dalam log ini dengan instance aplikasi web Firebase di perangkat ini.

Lihat Melacak Tampilan Layar .

Tanda tangan:

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;

Parameter

Pengembalian:

ruang kosong

logEvent(analyticsInstance, eventName, eventParams, opsi)

Mengirimkan peristiwa Google Analytics dengan eventParams tertentu . Metode ini secara otomatis mengaitkan peristiwa yang dicatat dalam log ini dengan instance aplikasi web Firebase di perangkat ini.

Daftar parameter peristiwa yang direkomendasikan dapat ditemukan di dokumentasi referensi GA4 .

Tanda tangan:

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

Parameter

Pengembalian:

ruang kosong

logEvent(analyticsInstance, eventName, eventParams, opsi)

Mengirimkan peristiwa Google Analytics dengan eventParams tertentu . Metode ini secara otomatis mengaitkan peristiwa yang dicatat dalam log ini dengan instance aplikasi web Firebase di perangkat ini.

Daftar parameter peristiwa yang direkomendasikan dapat ditemukan di dokumentasi referensi GA4 .

Tanda tangan:

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;

Parameter

Pengembalian:

ruang kosong

logEvent(analyticsInstance, eventName, eventParams, opsi)

Mengirimkan peristiwa Google Analytics dengan eventParams tertentu . Metode ini secara otomatis mengaitkan peristiwa yang dicatat dalam log ini dengan instance aplikasi web Firebase di perangkat ini.

Daftar parameter peristiwa yang direkomendasikan dapat ditemukan di dokumentasi referensi GA4 .

Tanda tangan:

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;

Parameter

Pengembalian:

ruang kosong

logEvent(analyticsInstance, eventName, eventParams, opsi)

Mengirimkan peristiwa Google Analytics dengan eventParams tertentu . Metode ini secara otomatis mengaitkan peristiwa yang dicatat dalam log ini dengan instance aplikasi web Firebase di perangkat ini.

Daftar parameter peristiwa yang direkomendasikan dapat ditemukan di dokumentasi referensi GA4 .

Tanda tangan:

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;

Parameter

Pengembalian:

ruang kosong

logEvent(analyticsInstance, eventName, eventParams, opsi)

Mengirimkan peristiwa Google Analytics dengan eventParams tertentu . Metode ini secara otomatis mengaitkan peristiwa yang dicatat dalam log ini dengan instance aplikasi web Firebase di perangkat ini.

Daftar parameter peristiwa yang direkomendasikan dapat ditemukan di dokumentasi referensi GA4 .

Tanda tangan:

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;

Parameter

Pengembalian:

ruang kosong

logEvent(analyticsInstance, eventName, eventParams, opsi)

Mengirimkan peristiwa Google Analytics dengan eventParams tertentu . Metode ini secara otomatis mengaitkan peristiwa yang dicatat dalam log ini dengan instance aplikasi web Firebase di perangkat ini.

Daftar parameter peristiwa yang direkomendasikan dapat ditemukan di dokumentasi referensi GA4 .

Tanda tangan:

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;

Parameter

Pengembalian:

ruang kosong

logEvent(analyticsInstance, eventName, eventParams, opsi)

Mengirimkan peristiwa Google Analytics dengan eventParams tertentu . Metode ini secara otomatis mengaitkan peristiwa yang dicatat dalam log ini dengan instance aplikasi web Firebase di perangkat ini.

Daftar parameter peristiwa yang direkomendasikan dapat ditemukan di dokumentasi referensi GA4 .

Tanda tangan:

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

Parameter

Pengembalian:

ruang kosong

logEvent(analyticsInstance, eventName, eventParams, opsi)

Mengirimkan peristiwa Google Analytics dengan eventParams tertentu . Metode ini secara otomatis mengaitkan peristiwa yang dicatat dalam log ini dengan instance aplikasi web Firebase di perangkat ini.

Daftar parameter peristiwa yang direkomendasikan dapat ditemukan di dokumentasi referensi GA4 .

Tanda tangan:

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;

Parameter

Pengembalian:

ruang kosong

logEvent(analyticsInstance, eventName, eventParams, opsi)

Mengirimkan peristiwa Google Analytics dengan eventParams tertentu . Metode ini secara otomatis mengaitkan peristiwa yang dicatat dalam log ini dengan instance aplikasi web Firebase di perangkat ini.

Daftar parameter peristiwa yang direkomendasikan dapat ditemukan di dokumentasi referensi GA4 .

Tanda tangan:

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;

Parameter

Pengembalian:

ruang kosong

logEvent(analyticsInstance, eventName, eventParams, opsi)

Mengirimkan peristiwa Google Analytics dengan eventParams tertentu . Metode ini secara otomatis mengaitkan peristiwa yang dicatat dalam log ini dengan instance aplikasi web Firebase di perangkat ini.

Daftar parameter peristiwa yang direkomendasikan dapat ditemukan di dokumentasi referensi GA4 .

Tanda tangan:

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;

Parameter

Pengembalian:

ruang kosong

logEvent(analyticsInstance, eventName, eventParams, opsi)

Mengirimkan peristiwa Google Analytics dengan eventParams tertentu . Metode ini secara otomatis mengaitkan peristiwa yang dicatat dalam log ini dengan instance aplikasi web Firebase di perangkat ini.

Daftar parameter peristiwa yang direkomendasikan dapat ditemukan di dokumentasi referensi GA4 .

Tanda tangan:

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;

Parameter

Pengembalian:

ruang kosong

logEvent(analyticsInstance, eventName, eventParams, opsi)

Mengirimkan peristiwa Google Analytics dengan eventParams tertentu . Metode ini secara otomatis mengaitkan peristiwa yang dicatat dalam log ini dengan instance aplikasi web Firebase di perangkat ini.

Daftar parameter peristiwa yang direkomendasikan dapat ditemukan di dokumentasi referensi GA4 .

Tanda tangan:

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

Parameter

Pengembalian:

ruang kosong

logEvent(analyticsInstance, eventName, eventParams, opsi)

Mengirimkan peristiwa Google Analytics dengan eventParams tertentu . Metode ini secara otomatis mengaitkan peristiwa yang dicatat dalam log ini dengan instance aplikasi web Firebase di perangkat ini.

Daftar parameter peristiwa yang direkomendasikan dapat ditemukan di dokumentasi referensi GA4 .

Tanda tangan:

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;

Parameter

Pengembalian:

ruang kosong

logEvent(analyticsInstance, eventName, eventParams, opsi)

Mengirimkan peristiwa Google Analytics dengan eventParams tertentu . Metode ini secara otomatis mengaitkan peristiwa yang dicatat dalam log ini dengan instance aplikasi web Firebase di perangkat ini.

Daftar parameter peristiwa yang direkomendasikan dapat ditemukan di dokumentasi referensi GA4 .

Tanda tangan:

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;

Parameter

Pengembalian:

ruang kosong

logEvent(analyticsInstance, eventName, eventParams, opsi)

Mengirimkan peristiwa Google Analytics dengan eventParams tertentu . Metode ini secara otomatis mengaitkan peristiwa yang dicatat dalam log ini dengan instance aplikasi web Firebase di perangkat ini.

Daftar parameter peristiwa yang direkomendasikan dapat ditemukan di dokumentasi referensi GA4 .

Tanda tangan:

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;

Parameter

Pengembalian:

ruang kosong

logEvent(analyticsInstance, eventName, eventParams, opsi)

Mengirimkan peristiwa Google Analytics dengan eventParams tertentu . Metode ini secara otomatis mengaitkan peristiwa yang dicatat dalam log ini dengan instance aplikasi web Firebase di perangkat ini.

Lihat Mengukur pengecualian .

Tanda tangan:

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

Parameter

Pengembalian:

ruang kosong

logEvent(analyticsInstance, eventName, eventParams, opsi)

Mengirimkan peristiwa Google Analytics dengan eventParams tertentu . Metode ini secara otomatis mengaitkan peristiwa yang dicatat dalam log ini dengan instance aplikasi web Firebase di perangkat ini.

Daftar parameter peristiwa yang direkomendasikan dapat ditemukan di dokumentasi referensi GA4 .

Tanda tangan:

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

Parameter

Pengembalian:

ruang kosong

logEvent(analyticsInstance, eventName, eventParams, opsi)

Mengirimkan peristiwa Google Analytics dengan eventParams tertentu . Metode ini secara otomatis mengaitkan peristiwa yang dicatat dalam log ini dengan instance aplikasi web Firebase di perangkat ini.

Daftar parameter peristiwa yang direkomendasikan dapat ditemukan di dokumentasi referensi GA4 .

Tanda tangan:

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

Parameter

Pengembalian:

ruang kosong

logEvent(analyticsInstance, eventName, eventParams, opsi)

Mengirimkan peristiwa Google Analytics dengan eventParams tertentu . Metode ini secara otomatis mengaitkan peristiwa yang dicatat dalam log ini dengan instance aplikasi web Firebase di perangkat ini.

Lihat Tampilan halaman .

Tanda tangan:

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;

Parameter

Pengembalian:

ruang kosong

setAnalyticsCollectionEnabled(analyticsInstance, diaktifkan)

Menyetel apakah pengumpulan Google Analytics diaktifkan untuk aplikasi ini di perangkat ini. Menyetel window['ga-disable-analyticsId'] = true;

Tanda tangan:

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

Parameter

Pengembalian:

ruang kosong

setCurrentScreen(analyticsInstance, nama layar, opsi)

Gunakan dengan eventName sebagai 'screen_view' dan tambahkan eventParams yang relevan . Lihat Melacak Tampilan Layar .

Gunakan perintah gtag config untuk menyetel screen_name .

Tanda tangan:

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

Parameter

Pengembalian:

ruang kosong

setUserId(analyticsInstance, id, opsi)

Gunakan perintah gtag config untuk menyetel user_id .

Tanda tangan:

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

Parameter

Pengembalian:

ruang kosong

setUserProperties(analyticsInstance, properti, opsi)

Gunakan perintah gtag config untuk menyetel semua parameter yang ditentukan.

Tanda tangan:

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

Parameter

Pengembalian:

ruang kosong

fungsi()

didukung()

Ini adalah metode statis publik yang diberikan kepada pengguna yang menggabungkan empat pemeriksaan berbeda:

1. Periksa apakah itu bukan lingkungan ekstensi browser. 2. Periksa apakah cookie diaktifkan di browser saat ini. 3. Periksa apakah IndexedDB didukung oleh lingkungan browser. 4. Periksa apakah konteks browser saat ini valid untuk menggunakan IndexedDB.open() .

Tanda tangan:

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

Pengembalian:

Janji<boolean>

fungsi (pengaturan persetujuan, ...)

setPersetujuan(Pengaturan Persetujuan)

Menetapkan status izin pengguna akhir yang berlaku untuk aplikasi web ini di seluruh referensi gtag setelah Firebase Analytics diinisialisasi.

Gunakan ConsentSettings untuk menentukan nilai jenis izin individual. Secara default, jenis izin disetel ke "diberikan".

Tanda tangan:

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

Parameter

Pengembalian:

ruang kosong

fungsi(params khusus, ...)

setDefaultEventParameters(customParams)

Menambahkan data yang akan disetel pada setiap peristiwa yang dicatat dari SDK, termasuk peristiwa otomatis. Dengan perintah "set" gtag, nilai yang diteruskan akan tetap ada di halaman saat ini dan diteruskan bersama semua peristiwa berikutnya.

Tanda tangan:

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

Parameter

Pengembalian:

ruang kosong

fungsi(pilihan, ...)

pengaturan (pilihan)

Mengonfigurasi Firebase Analytics untuk menggunakan nama gtag atau dataLayer khusus. Ditujukan untuk digunakan jika skrip gtag.js telah diinstal di halaman ini secara independen dari Firebase Analytics, dan menggunakan nama non-default untuk fungsi gtag atau dataLayer . Harus dipanggil sebelum memanggil getAnalytics() atau tidak akan berpengaruh apa pun.

Tanda tangan:

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

Parameter

Pengembalian:

ruang kosong

PersetujuanStatusString

Apakah jenis persetujuan tertentu telah diberikan atau ditolak.

Tanda tangan:

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

Mata uang

Jenis mata uang Google Analytics standar.

Tanda tangan:

export declare type Currency = string | number;

NamaAcara Khusus

String nama peristiwa khusus apa pun yang tidak ada dalam daftar standar nama peristiwa yang direkomendasikan.

Tanda tangan:

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

String Nama Peristiwa

Ketik nama peristiwa Google Analytics standar. logEvent juga menerima string khusus apa pun dan menafsirkannya sebagai nama peristiwa khusus.

Tanda tangan:

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