analytics package

Firebase Analytics Web SDK. SDK này không hoạt động trong môi trường Node.js.

Hàm

Chức năng Mô tả
hàm(app, ...)
getAnalytics(ứng dụng) Trả về một bản sao Analytics cho ứng dụng cụ thể.
startupAnalytics(ứng dụng, lựa chọn) Trả về một bản sao Analytics cho ứng dụng cụ thể.
function(analyticsInstance, ...)
getGoogleAnalyticsClientId(analyticsInstance) Truy xuất giá trị nhận dạng Google Analytics duy nhất cho ứng dụng web. Hãy xem client_id.
logEvent(analyticsInstance, eventName, eventParams, options) Gửi một sự kiện Google Analytics với eventParams đã cho. Phương thức này sẽ tự động liên kết sự kiện đã ghi lại này với phiên bản ứng dụng web Firebase này trên thiết bị này.Bạn có thể xem danh sách các thông số sự kiện được đề xuất trong tài liệu tham khảo về GA4.
logEvent(analyticsInstance, eventName, eventParams, options) Gửi một sự kiện Google Analytics với eventParams đã cho. Phương thức này sẽ tự động liên kết sự kiện đã ghi lại này với phiên bản ứng dụng web Firebase này trên thiết bị này.Bạn có thể xem danh sách các thông số sự kiện được đề xuất trong tài liệu tham khảo về GA4.
logEvent(analyticsInstance, eventName, eventParams, options) Gửi một sự kiện Google Analytics với eventParams đã cho. Phương thức này sẽ tự động liên kết sự kiện đã ghi lại này với phiên bản ứng dụng web Firebase này trên thiết bị này.Xem bài viết Theo dõi lượt xem màn hình.
logEvent(analyticsInstance, eventName, eventParams, options) Gửi một sự kiện Google Analytics với eventParams đã cho. Phương thức này sẽ tự động liên kết sự kiện đã ghi lại này với phiên bản ứng dụng web Firebase này trên thiết bị này.Bạn có thể xem danh sách các thông số sự kiện được đề xuất trong tài liệu tham khảo về GA4.
logEvent(analyticsInstance, eventName, eventParams, options) Gửi một sự kiện Google Analytics với eventParams đã cho. Phương thức này sẽ tự động liên kết sự kiện đã ghi lại này với phiên bản ứng dụng web Firebase này trên thiết bị này.Bạn có thể xem danh sách các thông số sự kiện được đề xuất trong tài liệu tham khảo về GA4.
logEvent(analyticsInstance, eventName, eventParams, options) Gửi một sự kiện Google Analytics với eventParams đã cho. Phương thức này sẽ tự động liên kết sự kiện đã ghi lại này với phiên bản ứng dụng web Firebase này trên thiết bị này.Bạn có thể xem danh sách các thông số sự kiện được đề xuất trong tài liệu tham khảo về GA4.
logEvent(analyticsInstance, eventName, eventParams, options) Gửi một sự kiện Google Analytics với eventParams đã cho. Phương thức này sẽ tự động liên kết sự kiện đã ghi lại này với phiên bản ứng dụng web Firebase này trên thiết bị này.Bạn có thể xem danh sách các thông số sự kiện được đề xuất trong tài liệu tham khảo về GA4.
logEvent(analyticsInstance, eventName, eventParams, options) Gửi một sự kiện Google Analytics với eventParams đã cho. Phương thức này sẽ tự động liên kết sự kiện đã ghi lại này với phiên bản ứng dụng web Firebase này trên thiết bị này.Bạn có thể xem danh sách các thông số sự kiện được đề xuất trong tài liệu tham khảo về GA4.
logEvent(analyticsInstance, eventName, eventParams, options) Gửi một sự kiện Google Analytics với eventParams đã cho. Phương thức này sẽ tự động liên kết sự kiện đã ghi lại này với phiên bản ứng dụng web Firebase này trên thiết bị này.Bạn có thể xem danh sách các thông số sự kiện được đề xuất trong tài liệu tham khảo về GA4.
logEvent(analyticsInstance, eventName, eventParams, options) Gửi một sự kiện Google Analytics với eventParams đã cho. Phương thức này sẽ tự động liên kết sự kiện đã ghi lại này với phiên bản ứng dụng web Firebase này trên thiết bị này.Bạn có thể xem danh sách các thông số sự kiện được đề xuất trong tài liệu tham khảo về GA4.
logEvent(analyticsInstance, eventName, eventParams, options) Gửi một sự kiện Google Analytics với eventParams đã cho. Phương thức này sẽ tự động liên kết sự kiện đã ghi lại này với phiên bản ứng dụng web Firebase này trên thiết bị này.Bạn có thể xem danh sách các thông số sự kiện được đề xuất trong tài liệu tham khảo về GA4.
logEvent(analyticsInstance, eventName, eventParams, options) Gửi một sự kiện Google Analytics với eventParams đã cho. Phương thức này sẽ tự động liên kết sự kiện đã ghi lại này với phiên bản ứng dụng web Firebase này trên thiết bị này.Bạn có thể xem danh sách các thông số sự kiện được đề xuất trong tài liệu tham khảo về GA4.
logEvent(analyticsInstance, eventName, eventParams, options) Gửi một sự kiện Google Analytics với eventParams đã cho. Phương thức này sẽ tự động liên kết sự kiện đã ghi lại này với phiên bản ứng dụng web Firebase này trên thiết bị này.Bạn có thể xem danh sách các thông số sự kiện được đề xuất trong tài liệu tham khảo về GA4.
logEvent(analyticsInstance, eventName, eventParams, options) Gửi một sự kiện Google Analytics với eventParams đã cho. Phương thức này sẽ tự động liên kết sự kiện đã ghi lại này với phiên bản ứng dụng web Firebase này trên thiết bị này.Bạn có thể xem danh sách các thông số sự kiện được đề xuất trong tài liệu tham khảo về GA4.
logEvent(analyticsInstance, eventName, eventParams, options) Gửi một sự kiện Google Analytics với eventParams đã cho. Phương thức này sẽ tự động liên kết sự kiện đã ghi lại này với phiên bản ứng dụng web Firebase này trên thiết bị này.Bạn có thể xem danh sách các thông số sự kiện được đề xuất trong tài liệu tham khảo về GA4.
logEvent(analyticsInstance, eventName, eventParams, options) Gửi một sự kiện Google Analytics với eventParams đã cho. Phương thức này sẽ tự động liên kết sự kiện đã ghi lại này với phiên bản ứng dụng web Firebase này trên thiết bị này.Bạn có thể xem danh sách các thông số sự kiện được đề xuất trong tài liệu tham khảo về GA4.
logEvent(analyticsInstance, eventName, eventParams, options) Gửi một sự kiện Google Analytics với eventParams đã cho. Phương thức này sẽ tự động liên kết sự kiện đã ghi lại này với phiên bản ứng dụng web Firebase này trên thiết bị này.Bạn có thể xem danh sách các thông số sự kiện được đề xuất trong tài liệu tham khảo về GA4.
logEvent(analyticsInstance, eventName, eventParams, options) Gửi một sự kiện Google Analytics với eventParams đã cho. Phương thức này sẽ tự động liên kết sự kiện đã ghi lại này với phiên bản ứng dụng web Firebase này trên thiết bị này.Bạn có thể xem danh sách các thông số sự kiện được đề xuất trong tài liệu tham khảo về GA4.
logEvent(analyticsInstance, eventName, eventParams, options) Gửi một sự kiện Google Analytics với eventParams đã cho. Phương thức này tự động liên kết sự kiện đã ghi lại này với phiên bản ứng dụng web Firebase này trên thiết bị này.Xem bài viết Đo lường các trường hợp ngoại lệ.
logEvent(analyticsInstance, eventName, eventParams, options) Gửi một sự kiện Google Analytics với eventParams đã cho. Phương thức này sẽ tự động liên kết sự kiện đã ghi lại này với phiên bản ứng dụng web Firebase này trên thiết bị này.Bạn có thể xem danh sách các thông số sự kiện được đề xuất trong tài liệu tham khảo về GA4.
logEvent(analyticsInstance, eventName, eventParams, options) Gửi một sự kiện Google Analytics với eventParams đã cho. Phương thức này sẽ tự động liên kết sự kiện đã ghi lại này với phiên bản ứng dụng web Firebase này trên thiết bị này.Bạn có thể xem danh sách các thông số sự kiện được đề xuất trong tài liệu tham khảo về GA4.
logEvent(analyticsInstance, eventName, eventParams, options) Gửi một sự kiện Google Analytics với eventParams đã cho. Phương thức này tự động liên kết sự kiện đã ghi lại này với phiên bản ứng dụng web Firebase này trên thiết bị này.Xem Số lượt xem trang.
setAnalyticsCollectionEnabled(analyticsInstance, đã bật) Đặt xem bộ sưu tập Google Analytics có được bật cho ứng dụng này trên thiết bị này hay không. Đặt window['ga-disable-analyticsId'] = true; chung
setCurrentScreen(analyticsInstance, screenName, tuỳ chọn) Sử dụng lệnh config của gtag để đặt screen_name.
setUserId(analyticsInstance; id; options) Sử dụng lệnh config của gtag để đặt user_id.
setUserProperties(analyticsInstance, thuộc tính, tuỳ chọn) Sử dụng lệnh config của gtag để đặt tất cả các thông số được chỉ định.
hàm()
isHỗ trợ() Đây là một phương thức tĩnh công khai được cung cấp cho người dùng gói 4 bước kiểm tra khác nhau:1. Kiểm tra xem đó có phải không phải là môi trường tiện ích của trình duyệt hay không. 2. Kiểm tra xem cookie có được bật trong trình duyệt hiện tại không. 3. Kiểm tra xem IndexedDB có được môi trường trình duyệt hỗ trợ hay không. 4. Kiểm tra xem ngữ cảnh hiện tại của trình duyệt có hợp lệ để sử dụng IndexedDB.open() hay không.
hàm(consentSettings, ...)
setConsent(consentSettings) Đặt trạng thái đồng ý của người dùng cuối hiện hành cho ứng dụng web này trên tất cả các tệp tham chiếu gtag sau khi khởi chạy Firebase Analytics.Sử dụng ConsentSettings để chỉ định từng giá trị loại đồng ý. Theo mặc định, các loại đồng ý được đặt thành "đã đồng ý".
hàm(customParams, ...)
setDefaultEventParameters(customParams) Thêm dữ liệu sẽ được đặt trên mọi sự kiện được ghi lại từ SDK, bao gồm cả các sự kiện tự động. Với "bộ" của gtag các giá trị được chuyển vẫn tồn tại trên trang hiện tại và được chuyển cùng với tất cả các sự kiện tiếp theo.
hàm(options, ...)
chế độ cài đặt(tuỳ chọn) Định cấu hình Firebase Analytics để sử dụng tên gtag hoặc dataLayer tuỳ chỉnh. Đối với những tập lệnh gtag.js đã được cài đặt trên trang này một cách độc lập với Firebase Analytics, và đang sử dụng các tên không phải tên mặc định cho hàm gtag hoặc cho dataLayer. Bạn phải gọi trước khi gọi getAnalytics(), nếu không lệnh thoại sẽ không có hiệu lực.

Giao diện

Giao diện Mô tả
Số liệu phân tích Một bản sao của Firebase Analytics.
AnalyticsCallOptions Các tuỳ chọn bổ sung có thể được chuyển đến lệnh gọi phương thức Analytics, chẳng hạn như logEvent, v.v.
Cài đặt Analytics Tuỳ chọn khởi tạo thực thể Analytics.
Chế độ đồng ý Chế độ cài đặt trạng thái đồng ý cho từng loại đồng ý. Để biết thêm thông tin, hãy xem tài liệu tham khảo về trạng thái đồng ý và loại đồng ý trong GA4.
ControlParams Tham số kiểm soát gtag.js chuẩn. Để biết thêm thông tin, hãy xem tài liệu tham khảo về GA4.
CustomParams (Tham số tuỳ chỉnh) Mọi thông số tuỳ chỉnh mà người dùng có thể truyền đến gtag.
EventParams (Thông số sự kiện) Thông số sự kiện gtag.js chuẩn. Để biết thêm thông tin, hãy xem tài liệu tham khảo về GA4.
GtagConfigParams Tập hợp các chế độ cài đặt cấu hình phổ biến của Google Analytics mà gtag.js nhận dạng được.
Mặt hàng Loại Item Google Analytics chuẩn.
Khuyến mãi Trường mà trước đây được một số sự kiện Google Analytics sử dụng.
Tuỳ chọn cài đặt Chỉ định các tùy chọn tùy chỉnh cho phiên bản Firebase Analytics của bạn. Bạn phải đặt các mã này trước khi khởi tạo firebase.analytics().

Nhập bí danh

Nhập bí danh Mô tả
ConsentStatusString Liệu một loại đồng ý cụ thể đã đồng ý hay bị từ chối.
Đơn vị tiền tệ Loại đơn vị tiền tệ Google Analytics chuẩn.
Tên sự kiện tuỳ chỉnh Bất kỳ chuỗi tên sự kiện tuỳ chỉnh nào không có trong danh sách chuẩn gồm các tên sự kiện được đề xuất.
EventNameString Nhập tên sự kiện Google Analytics chuẩn. logEvent cũng chấp nhận mọi chuỗi tuỳ chỉnh và diễn giải chuỗi đó dưới dạng tên sự kiện tuỳ chỉnh.

function(app, ...)

getAnalytics(ứng dụng)

Trả về một bản sao Analytics cho ứng dụng cụ thể.

Chữ ký:

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

Thông số

Thông số Loại Mô tả
ứng dụng Ứng dụng Firebase FirebaseApp để sử dụng.

Trường hợp trả lại hàng:

Số liệu phân tích

segmentationAnalytics(ứng dụng, tuỳ chọn)

Trả về một phiên bản Analytics cho ứng dụng cụ thể.

Chữ ký:

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

Thông số

Thông số Loại Mô tả
ứng dụng Ứng dụng Firebase FirebaseApp để sử dụng.
tuỳ chọn Cài đặt Analytics

Trường hợp trả lại hàng:

Số liệu phân tích

function(analyticsInstance, ...)

getGoogleAnalyticsClientId(analyticsInstance)

Truy xuất giá trị nhận dạng Google Analytics duy nhất cho ứng dụng web. Hãy xem client_id.

Chữ ký:

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

Thông số

Thông số Loại Mô tả
phiên bản analytics Số liệu phân tích

Trường hợp trả lại hàng:

Cam kết<string>

logEvent(analyticsInstance, eventName, eventParams, tuỳ chọn)

Gửi một sự kiện Google Analytics có eventParams nhất định. Phương thức này tự động liên kết sự kiện đã ghi lại này với phiên bản ứng dụng web Firebase này trên thiết bị này.

Bạn có thể xem danh sách các thông số sự kiện được đề xuất trong tài liệu tham khảo về GA4.

Chữ ký:

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;

Thông số

Thông số Loại Mô tả
phiên bản analytics Số liệu phân tích
tên sự kiện "add_payment_info"
eventParams (Thông số sự kiện) { phiếu giảm giá?: EventParams['coupon']; đơn vị tiền tệ?: EventParams['currency']; mục?: EventParams['items']; payment_type?: EventParams['payment_type']; giá trị?: EventParams['value']; [khoá: string]: bất kỳ; }
tuỳ chọn AnalyticsCallOptions

Trường hợp trả lại hàng:

trống

logEvent(analyticsInstance, eventName, eventParams, tuỳ chọn)

Gửi một sự kiện Google Analytics có eventParams nhất định. Phương thức này tự động liên kết sự kiện đã ghi lại này với phiên bản ứng dụng web Firebase này trên thiết bị này.

Bạn có thể xem danh sách các thông số sự kiện được đề xuất trong tài liệu tham khảo về GA4.

Chữ ký:

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;

Thông số

Thông số Loại Mô tả
phiên bản analytics Số liệu phân tích
tên sự kiện "purchase" | "refund"
eventParams (Thông số sự kiện) { giá trị?: EventParams['value']; đơn vị tiền tệ?: EventParams['currency']; transaction_id: EventParams['transaction_id']; thuế?: EventParams['tax']; giao hàng?: EventParams['shipping']; mục?: EventParams['items']; phiếu giảm giá?: EventParams['coupon']; đơn vị liên kết?: EventParams['affiliation']; [khoá: chuỗi]: bất kỳ; }
tuỳ chọn AnalyticsCallOptions

Trường hợp trả lại hàng:

trống

logEvent(analyticsInstance, eventName, eventParams, tuỳ chọn)

Gửi một sự kiện Google Analytics có eventParams nhất định. Phương thức này tự động liên kết sự kiện đã ghi lại này với phiên bản ứng dụng web Firebase này trên thiết bị này.

Xem Theo dõi lượt xem màn hình.

Chữ ký:

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;

Thông số

Thông số Loại Mô tả
phiên bản analytics Số liệu phân tích
tên sự kiện "screen_view"
eventParams (Thông số sự kiện) { firebase_screen: EventParams['firebase_screen']; firebase_screen_class: EventParams['firebase_screen_class']; [khoá: chuỗi]: bất kỳ; }
tuỳ chọn AnalyticsCallOptions

Trường hợp trả lại hàng:

trống

logEvent(analyticsInstance, eventName, eventParams, tuỳ chọn)

Gửi một sự kiện Google Analytics có eventParams nhất định. Phương thức này tự động liên kết sự kiện đã ghi lại này với phiên bản ứng dụng web Firebase này trên thiết bị này.

Bạn có thể xem danh sách các thông số sự kiện được đề xuất trong tài liệu tham khảo về GA4.

Chữ ký:

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

Thông số

Thông số Loại Mô tả
phiên bản analytics Số liệu phân tích
tên sự kiện "tìm kiếm" | "view_search_results"
eventParams (Thông số sự kiện) { search_term?: EventParams['search_term']; [khoá: chuỗi]: bất kỳ; }
tuỳ chọn AnalyticsCallOptions

Trường hợp trả lại hàng:

trống

logEvent(analyticsInstance, eventName, eventParams, tuỳ chọn)

Gửi một sự kiện Google Analytics có eventParams nhất định. Phương thức này tự động liên kết sự kiện đã ghi lại này với phiên bản ứng dụng web Firebase này trên thiết bị này.

Bạn có thể xem danh sách các thông số sự kiện được đề xuất trong tài liệu tham khảo về GA4.

Chữ ký:

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;

Thông số

Thông số Loại Mô tả
phiên bản analytics Số liệu phân tích
tên sự kiện "select_content"
eventParams (Thông số sự kiện) { content_type?: EventParams['content_type']; item_id?: EventParams['item_id']; [khoá: chuỗi]: bất kỳ; }
tuỳ chọn AnalyticsCallOptions

Trường hợp trả lại hàng:

trống

logEvent(analyticsInstance, eventName, eventParams, tuỳ chọn)

Gửi một sự kiện Google Analytics có eventParams nhất định. Phương thức này tự động liên kết sự kiện đã ghi lại này với phiên bản ứng dụng web Firebase này trên thiết bị này.

Bạn có thể xem danh sách các thông số sự kiện được đề xuất trong tài liệu tham khảo về GA4.

Chữ ký:

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;

Thông số

Thông số Loại Mô tả
phiên bản analytics Số liệu phân tích
tên sự kiện "select_item"
eventParams (Thông số sự kiện) { mục?: EventParams['items']; item_list_name?: EventParams['item_list_name']; item_list_id?: EventParams['item_list_id']; [khoá: chuỗi]: bất kỳ; }
tuỳ chọn AnalyticsCallOptions

Trường hợp trả lại hàng:

trống

logEvent(analyticsInstance, eventName, eventParams, tuỳ chọn)

Gửi một sự kiện Google Analytics có eventParams nhất định. Phương thức này tự động liên kết sự kiện đã ghi lại này với phiên bản ứng dụng web Firebase này trên thiết bị này.

Bạn có thể xem danh sách các thông số sự kiện được đề xuất trong tài liệu tham khảo về GA4.

Chữ ký:

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;

Thông số

Thông số Loại Mô tả
phiên bản analytics Số liệu phân tích
tên sự kiện "select_promotion" | "view_promotion"
eventParams (Thông số sự kiện) { mục?: EventParams['items']; promotion_id?: EventParams['promotion_id']; promotion_name?: EventParams['promotion_name']; [khoá: chuỗi]: bất kỳ; }
tuỳ chọn AnalyticsCallOptions

Trường hợp trả lại hàng:

trống

logEvent(analyticsInstance, eventName, eventParams, tuỳ chọn)

Gửi một sự kiện Google Analytics có eventParams nhất định. Phương thức này tự động liên kết sự kiện đã ghi lại này với phiên bản ứng dụng web Firebase này trên thiết bị này.

Bạn có thể xem danh sách các thông số sự kiện được đề xuất trong tài liệu tham khảo về GA4.

Chữ ký:

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;

Thông số

Thông số Loại Mô tả
phiên bản analytics Số liệu phân tích
tên sự kiện "set_checkout_option"
eventParams (Thông số sự kiện) { checkout_step?: EventParams['checkout_step']; checkout_option?: EventParams['checkout_option']; [khoá: chuỗi]: bất kỳ; }
tuỳ chọn AnalyticsCallOptions

Trường hợp trả lại hàng:

trống

logEvent(analyticsInstance, eventName, eventParams, tuỳ chọn)

Gửi một sự kiện Google Analytics có eventParams nhất định. Phương thức này tự động liên kết sự kiện đã ghi lại này với phiên bản ứng dụng web Firebase này trên thiết bị này.

Bạn có thể xem danh sách các thông số sự kiện được đề xuất trong tài liệu tham khảo về GA4.

Chữ ký:

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;

Thông số

Thông số Loại Mô tả
phiên bản analytics Số liệu phân tích
tên sự kiện "chia sẻ"
eventParams (Thông số sự kiện) { phương thức?: EventParams['method']; content_type?: EventParams['content_type']; item_id?: EventParams['item_id']; [khoá: chuỗi]: bất kỳ; }
tuỳ chọn AnalyticsCallOptions

Trường hợp trả lại hàng:

trống

logEvent(analyticsInstance, eventName, eventParams, tuỳ chọn)

Gửi một sự kiện Google Analytics có eventParams nhất định. Phương thức này tự động liên kết sự kiện đã ghi lại này với phiên bản ứng dụng web Firebase này trên thiết bị này.

Bạn có thể xem danh sách các thông số sự kiện được đề xuất trong tài liệu tham khảo về GA4.

Chữ ký:

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

Thông số

Thông số Loại Mô tả
phiên bản analytics Số liệu phân tích
tên sự kiện "sign_up"
eventParams (Thông số sự kiện) { phương thức?: EventParams['method']; [khoá: chuỗi]: bất kỳ; }
tuỳ chọn AnalyticsCallOptions

Trường hợp trả lại hàng:

trống

logEvent(analyticsInstance, eventName, eventParams, tuỳ chọn)

Gửi một sự kiện Google Analytics có eventParams nhất định. Phương thức này tự động liên kết sự kiện đã ghi lại này với phiên bản ứng dụng web Firebase này trên thiết bị này.

Bạn có thể xem danh sách các thông số sự kiện được đề xuất trong tài liệu tham khảo về GA4.

Chữ ký:

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;

Thông số

Thông số Loại Mô tả
phiên bản analytics Số liệu phân tích
tên sự kiện "timing_complete"
eventParams (Thông số sự kiện) { tên: chuỗi; giá trị: số; event_category?: string; nhãn_sự_kiện?: chuỗi; [khoá: chuỗi]: bất kỳ; }
tuỳ chọn AnalyticsCallOptions

Trường hợp trả lại hàng:

trống

logEvent(analyticsInstance, eventName, eventParams, tuỳ chọn)

Gửi một sự kiện Google Analytics có eventParams nhất định. Phương thức này tự động liên kết sự kiện đã ghi lại này với phiên bản ứng dụng web Firebase này trên thiết bị này.

Bạn có thể xem danh sách các thông số sự kiện được đề xuất trong tài liệu tham khảo về GA4.

Chữ ký:

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;

Thông số

Thông số Loại Mô tả
phiên bản analytics Số liệu phân tích
tên sự kiện "add_shipping_info"
eventParams (Thông số sự kiện) { phiếu giảm giá?: EventParams['coupon']; đơn vị tiền tệ?: EventParams['currency']; mục?: EventParams['items']; cấp_vận_chuyển?: EventParams['shipping_tier']; giá trị?: EventParams['value']; [khoá: chuỗi]: bất kỳ; }
tuỳ chọn AnalyticsCallOptions

Trường hợp trả lại hàng:

trống

logEvent(analyticsInstance, eventName, eventParams, tuỳ chọn)

Gửi một sự kiện Google Analytics có eventParams nhất định. Phương thức này tự động liên kết sự kiện đã ghi lại này với phiên bản ứng dụng web Firebase này trên thiết bị này.

Bạn có thể xem danh sách các thông số sự kiện được đề xuất trong tài liệu tham khảo về GA4.

Chữ ký:

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;

Thông số

Thông số Loại Mô tả
phiên bản analytics Số liệu phân tích
tên sự kiện "view_cart" | "view_item"
eventParams (Thông số sự kiện) { đơn vị tiền tệ?: EventParams['currency']; mục?: EventParams['items']; giá trị?: EventParams['value']; [khoá: chuỗi]: bất kỳ; }
tuỳ chọn AnalyticsCallOptions

Trường hợp trả lại hàng:

trống

logEvent(analyticsInstance, eventName, eventParams, tuỳ chọn)

Gửi một sự kiện Google Analytics có eventParams nhất định. Phương thức này tự động liên kết sự kiện đã ghi lại này với phiên bản ứng dụng web Firebase này trên thiết bị này.

Bạn có thể xem danh sách các thông số sự kiện được đề xuất trong tài liệu tham khảo về GA4.

Chữ ký:

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;

Thông số

Thông số Loại Mô tả
phiên bản analytics Số liệu phân tích
tên sự kiện "xem_danh_sách_mục_hàng"
eventParams (Thông số sự kiện) { mục?: EventParams['items']; item_list_name?: EventParams['item_list_name']; item_list_id?: EventParams['item_list_id']; [khoá: chuỗi]: bất kỳ; }
tuỳ chọn AnalyticsCallOptions

Trường hợp trả lại hàng:

trống

logEvent(analyticsInstance, eventName, eventParams, tuỳ chọn)

Gửi một sự kiện Google Analytics có eventParams nhất định. Phương thức này tự động liên kết sự kiện đã ghi lại này với phiên bản ứng dụng web Firebase này trên thiết bị này.

Bạn có thể xem danh sách các thông số sự kiện được đề xuất trong tài liệu tham khảo về GA4.

Chữ ký:

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

Thông số

Thông số Loại Mô tả
phiên bản analytics Số liệu phân tích
tên sự kiện CustomEventName<T>
eventParams (Thông số sự kiện) { [key: string]: any; }
tuỳ chọn AnalyticsCallOptions

Trường hợp trả lại hàng:

trống

logEvent(analyticsInstance, eventName, eventParams, tuỳ chọn)

Gửi một sự kiện Google Analytics có eventParams nhất định. Phương thức này tự động liên kết sự kiện đã ghi lại này với phiên bản ứng dụng web Firebase này trên thiết bị này.

Bạn có thể xem danh sách các thông số sự kiện được đề xuất trong tài liệu tham khảo về GA4.

Chữ ký:

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;

Thông số

Thông số Loại Mô tả
phiên bản analytics Số liệu phân tích
tên sự kiện "add_to_cart" | "add_to_wishlist" | "remove_from_cart"
eventParams (Thông số sự kiện) { đơn vị tiền tệ?: EventParams['currency']; giá trị?: EventParams['value']; mục?: EventParams['items']; [khoá: string]: bất kỳ; }
tuỳ chọn AnalyticsCallOptions

Trường hợp trả lại hàng:

trống

logEvent(analyticsInstance, eventName, eventParams, tuỳ chọn)

Gửi một sự kiện Google Analytics có eventParams nhất định. Phương thức này tự động liên kết sự kiện đã ghi lại này với phiên bản ứng dụng web Firebase này trên thiết bị này.

Bạn có thể xem danh sách các thông số sự kiện được đề xuất trong tài liệu tham khảo về GA4.

Chữ ký:

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;

Thông số

Thông số Loại Mô tả
phiên bản analytics Số liệu phân tích
tên sự kiện "begin_checkout"
eventParams (Thông số sự kiện) { đơn vị tiền tệ?: EventParams['currency']; phiếu giảm giá?: EventParams['coupon']; giá trị?: EventParams['value']; mục?: EventParams['items']; [khoá: chuỗi]: bất kỳ; }
tuỳ chọn AnalyticsCallOptions

Trường hợp trả lại hàng:

trống

logEvent(analyticsInstance, eventName, eventParams, tuỳ chọn)

Gửi một sự kiện Google Analytics có eventParams nhất định. Phương thức này tự động liên kết sự kiện đã ghi lại này với phiên bản ứng dụng web Firebase này trên thiết bị này.

Bạn có thể xem danh sách các thông số sự kiện được đề xuất trong tài liệu tham khảo về GA4.

Chữ ký:

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;

Thông số

Thông số Loại Mô tả
phiên bản analytics Số liệu phân tích
tên sự kiện "checkout_progress"
eventParams (Thông số sự kiện) { đơn vị tiền tệ?: EventParams['currency']; phiếu giảm giá?: EventParams['coupon']; giá trị?: EventParams['value']; mục?: EventParams['items']; bước_thanh_toán?: EventParams['checkout_step']; checkout_option?: EventParams['checkout_option']; [khoá: chuỗi]: bất kỳ; }
tuỳ chọn AnalyticsCallOptions

Trường hợp trả lại hàng:

trống

logEvent(analyticsInstance, eventName, eventParams, tuỳ chọn)

Gửi một sự kiện Google Analytics có eventParams nhất định. Phương thức này tự động liên kết sự kiện đã ghi lại này với phiên bản ứng dụng web Firebase này trên thiết bị này.

Hãy xem bài viết Đo lường các trường hợp ngoại lệ.

Chữ ký:

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

Thông số

Thông số Loại Mô tả
phiên bản analytics Số liệu phân tích
tên sự kiện "ngoại lệ"
eventParams (Thông số sự kiện) { mô tả?: EventParams['description']; nghiêm trọng?: EventParams['important']; [khoá: chuỗi]: bất kỳ; }
tuỳ chọn AnalyticsCallOptions

Trường hợp trả lại hàng:

trống

logEvent(analyticsInstance, eventName, eventParams, tuỳ chọn)

Gửi một sự kiện Google Analytics có eventParams nhất định. Phương thức này tự động liên kết sự kiện đã ghi lại này với phiên bản ứng dụng web Firebase này trên thiết bị này.

Bạn có thể xem danh sách các thông số sự kiện được đề xuất trong tài liệu tham khảo về GA4.

Chữ ký:

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

Thông số

Thông số Loại Mô tả
phiên bản analytics Số liệu phân tích
tên sự kiện "generate_lead"
eventParams (Thông số sự kiện) { giá trị?: EventParams['value']; đơn vị tiền tệ?: EventParams['currency']; [khoá: chuỗi]: bất kỳ; }
tuỳ chọn AnalyticsCallOptions

Trường hợp trả lại hàng:

trống

logEvent(analyticsInstance, eventName, eventParams, tuỳ chọn)

Gửi một sự kiện Google Analytics có eventParams nhất định. Phương thức này tự động liên kết sự kiện đã ghi lại này với phiên bản ứng dụng web Firebase này trên thiết bị này.

Bạn có thể xem danh sách các thông số sự kiện được đề xuất trong tài liệu tham khảo về GA4.

Chữ ký:

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

Thông số

Thông số Loại Mô tả
phiên bản analytics Số liệu phân tích
tên sự kiện "đăng nhập"
eventParams (Thông số sự kiện) { phương thức?: EventParams['method']; [khoá: chuỗi]: bất kỳ; }
tuỳ chọn AnalyticsCallOptions

Trường hợp trả lại hàng:

trống

logEvent(analyticsInstance, eventName, eventParams, tuỳ chọn)

Gửi một sự kiện Google Analytics có eventParams nhất định. Phương thức này tự động liên kết sự kiện đã ghi lại này với phiên bản ứng dụng web Firebase này trên thiết bị này.

Xem mục Lượt xem trang.

Chữ ký:

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;

Thông số

Thông số Loại Mô tả
phiên bản analytics Số liệu phân tích
tên sự kiện "page_view"
eventParams (Thông số sự kiện) { page_title?: string; page_location?: string; page_path?: string; [khoá: chuỗi]: bất kỳ; }
tuỳ chọn AnalyticsCallOptions

Trường hợp trả lại hàng:

trống

setAnalyticsCollectionEnabled(analyticsInstance, đã bật)

Đặt xem bộ sưu tập Google Analytics có được bật cho ứng dụng này trên thiết bị này hay không. Đặt window['ga-disable-analyticsId'] = true; chung

Chữ ký:

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

Thông số

Thông số Loại Mô tả
phiên bản analytics Số liệu phân tích Phiên bản Analytics.
đã bật boolean Nếu đúng, bật tính năng thu thập và nếu là sai, sẽ tắt tính năng này.

Trường hợp trả lại hàng:

trống

setCurrentScreen(analyticsInstance, screenName, options)

Sử dụng với eventName làm "screen_view" rồi thêm eventParams có liên quan. Xem Theo dõi lượt xem màn hình.

Sử dụng lệnh config của gtag để đặt screen_name.

Chữ ký:

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

Thông số

Thông số Loại Mô tả
phiên bản analytics Số liệu phân tích Phiên bản Analytics.
tên màn hình chuỗi Tên màn hình để đặt.
tuỳ chọn AnalyticsCallOptions

Trường hợp trả lại hàng:

trống

setUserId(analyticsInstance, id, options)

Sử dụng lệnh config của gtag để đặt user_id.

Chữ ký:

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

Thông số

Thông số Loại Mô tả
phiên bản analytics Số liệu phân tích Phiên bản Analytics.
id chuỗi | rỗng Mã nhận dạng người dùng cần đặt.
tuỳ chọn AnalyticsCallOptions

Trường hợp trả lại hàng:

trống

setUserProperties(analyticsInstance, thuộc tính, tuỳ chọn)

Sử dụng lệnh config của gtag để đặt tất cả các thông số được chỉ định.

Chữ ký:

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

Thông số

Thông số Loại Mô tả
phiên bản analytics Số liệu phân tích
thuộc tính CustomParams (Tham số tuỳ chỉnh)
tuỳ chọn AnalyticsCallOptions

Trường hợp trả lại hàng:

trống

Hàm()

được hỗ trợ()

Đây là một phương thức tĩnh công khai được cung cấp cho người dùng gói 4 bước kiểm tra khác nhau:

  1. Kiểm tra xem đó có phải không phải là môi trường tiện ích của trình duyệt hay không. 2. Kiểm tra xem cookie có được bật trong trình duyệt hiện tại không. 3. Kiểm tra xem IndexedDB có được môi trường trình duyệt hỗ trợ hay không. 4. Kiểm tra xem ngữ cảnh hiện tại của trình duyệt có hợp lệ để sử dụng IndexedDB.open() hay không.

Chữ ký:

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

Trường hợp trả lại hàng:

Promise&lt;boolean&gt;

hàm(consentSettings, ...)

setConsent(consentSettings)

Đặt trạng thái đồng ý hiện hành của người dùng cuối cho ứng dụng web này trên tất cả các tệp tham chiếu gtag sau khi khởi chạy Firebase Analytics.

Sử dụng ConsentSettings để chỉ định từng giá trị loại đồng ý. Theo mặc định, các loại đồng ý được đặt thành "đã đồng ý".

Chữ ký:

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

Thông số

Thông số Loại Mô tả
chế độ cài đặt lấy sự đồng ý Chế độ đồng ý Liên kết trạng thái đồng ý của người dùng cuối hiện hành cho gtag.js.

Trường hợp trả lại hàng:

trống

function(customParams, ...)

setDefaultEventParameters(customParams)

Thêm dữ liệu sẽ được đặt trên mọi sự kiện được ghi lại từ SDK, bao gồm cả các sự kiện tự động. Với "bộ" của gtag các giá trị được chuyển vẫn tồn tại trên trang hiện tại và được chuyển cùng với tất cả các sự kiện tiếp theo.

Chữ ký:

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

Thông số

Thông số Loại Mô tả
customParams (Thông số tuỳ chỉnh) CustomParams (Tham số tuỳ chỉnh) Bất kỳ thông số tùy chỉnh nào mà người dùng có thể chuyển đến gtag.js.

Trường hợp trả lại hàng:

trống

hàm(options, ...)

cài đặt(tùy chọn)

Định cấu hình Firebase Analytics để sử dụng tên gtag hoặc dataLayer tuỳ chỉnh. Đối tượng này nên được sử dụng nếu tập lệnh gtag.js đã được cài đặt trên trang này một cách độc lập với Firebase Analytics và đang sử dụng các tên không phải tên mặc định cho hàm gtag hoặc cho dataLayer. Bạn phải gọi trước khi gọi getAnalytics(), nếu không lệnh thoại sẽ không có hiệu lực.

Chữ ký:

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

Thông số

Thông số Loại Mô tả
tuỳ chọn Tuỳ chọn cài đặt Tên gtag và dataLayer tuỳ chỉnh.

Trường hợp trả lại hàng:

trống

Chuỗi trạng thái đồng ý

Liệu một loại đồng ý cụ thể đã đồng ý hay bị từ chối.

Chữ ký:

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

Đơn vị tiền tệ

Loại đơn vị tiền tệ Google Analytics chuẩn.

Chữ ký:

export declare type Currency = string | number;

Tên sự kiện tuỳ chỉnh

Bất kỳ chuỗi tên sự kiện tuỳ chỉnh nào không có trong danh sách chuẩn gồm các tên sự kiện được đề xuất.

Chữ ký:

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

Chuỗi tên sự kiện

Nhập tên sự kiện Google Analytics chuẩn. logEvent cũng chấp nhận mọi chuỗi tuỳ chỉnh và diễn giải chuỗi đó dưới dạng tên sự kiện tuỳ chỉnh.

Chữ ký:

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