analytics package

SDK web phân tích Firebase. SDK này không hoạt động trong môi trường Node.js.

Chức năng

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

Giao diện

Giao diện Sự miêu tả
phân tích Một phiên bản của Firebase Analytics.
Tùy chọn cuộc gọi Analytics Các tùy 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 phân tích Tùy chọn khởi tạo phiên bản Analytics .
Đồng ýCài đặt 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 GA4 để biết trạng thái đồng ý và các loại đồng ý .
Thông số điều khiển Thông số kiểm soát gtag.js tiêu chuẩn. Để biết thêm thông tin, hãy xem tài liệu tham khảo GA4 .
Thông số tùy chỉnh Mọi thông số tùy chỉnh mà người dùng có thể chuyển tới gtag .
Thông số sự kiện Thông số sự kiện gtag.js tiêu chuẩn. Để biết thêm thông tin, hãy xem tài liệu tham khảo GA4 .
Thông số GtagConfig Một tập hợp các cài đặt cấu hình Google Analytics phổ biến được gtag.js công nhận.
Mục Item mục Google Analytics tiêu chuẩn.
Khuyến mãi Trường trước đây được một số sự kiện Google Analytics sử dụng.
Cài đặtTùy chọn 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 những thứ này trước khi khởi tạo firebase.analytics() .

Nhập bí danh

Nhập bí danh Sự miêu tả
Chuỗi trạng thái đồng ý Liệu một loại chấp thuận cụ thể đã được cấp hay bị từ chối.
Tiền tệ Loại tiền tệ tiêu chuẩn của Google Analytics.
Tên sự kiện tùy chỉnh Bất kỳ chuỗi tên sự kiện tùy chỉnh nào không có trong danh sách tên sự kiện được đề xuất tiêu chuẩn.
Tên sự kiệnChuỗi Nhập tên sự kiện Google Analytics tiêu chuẩn. logEvent cũng chấp nhận bất kỳ chuỗi tùy chỉnh nào và diễn giải nó dưới dạng tên sự kiện tùy chỉnh.

chức năng (ứng dụng, ...)

getAnalytics(ứng dụng)

Trả về một phiên bản Analytics cho ứng dụng nhất định.

Chữ ký:

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

Thông số

Tham số Kiểu Sự miêu tả
ứng dụng Ứng dụng Firebase Ứng dụng Firebase để sử dụng.

Trả về:

phân tích

khởi tạoAnalytics(ứng dụng, tùy chọn)

Trả về một phiên bản Analytics cho ứng dụng nhất định.

Chữ ký:

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

Thông số

Tham số Kiểu Sự miêu tả
ứng dụng Ứng dụng Firebase Ứng dụng Firebase để sử dụng.
tùy chọn Cài đặt phân tích

Trả về:

phân tích

hàm(analyticsInstance, ...)

getGoogleAnalyticsClientId(analyticsInstance)

Truy xuất mã định danh Google Analytics duy nhất cho ứng dụng khách web. Xem client_id .

Chữ ký:

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

Thông số

Tham số Kiểu Sự miêu tả
phân tích sơ thẩm phân tích

Trả về:

Hứa<string>

logEvent(analyticsInstance, tên sự kiện, sự kiệnParams, tùy chọn)

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

Bạn có thể tìm thấy danh sách các thông số sự kiện đề xuất trong tài liệu tham khảo 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ố

Tham số Kiểu Sự miêu tả
phân tích sơ thẩm phân tích
tên sự kiện 'add_Payment_info'
sự kiệnParams { phiếu giảm giá?: EventParams ['phiếu mua hàng']; tiền tệ?: EventParams ['tiền tệ']; các mục?: EventParams ['mặt hàng']; Payment_type?: Thông số sự kiện ['hình thức thanh toán']; giá trị?: EventParams ['giá trị']; [khóa: chuỗi]: bất kỳ; }
tùy chọn Tùy chọn cuộc gọi Analytics

Trả về:

trống rỗng

logEvent(analyticsInstance, tên sự kiện, sự kiệnParams, tùy chọn)

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

Bạn có thể tìm thấy danh sách các thông số sự kiện đề xuất trong tài liệu tham khảo 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ố

Tham số Kiểu Sự miêu tả
phân tích sơ thẩm phân tích
tên sự kiện 'mua' | 'đền bù'
sự kiệnParams { giá trị?: Thông số sự kiện ['giá trị']; tiền tệ?: EventParams ['tiền tệ']; giao dịch_id: EventParams ['ID giao dịch']; thuế?: EventParams ['Thuế']; Đang chuyển hàng?: EventParams ['Đang chuyển hàng']; các mục?: EventParams ['mặt hàng']; phiếu giảm giá?: EventParams ['phiếu mua hàng']; liên kết?: EventParams ['liên kết']; [khóa: chuỗi]: bất kỳ; }
tùy chọn Tùy chọn cuộc gọi Analytics

Trả về:

trống rỗng

logEvent(analyticsInstance, tên sự kiện, sự kiệnParams, tùy chọn)

Gửi sự kiện Google Analytics với thông eventParams nhất định . Phương pháp này tự động liên kết sự kiện đã ghi này với phiên bản ứng dụng web Firebase 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ố

Tham số Kiểu Sự miêu tả
phân tích sơ thẩm phân tích
tên sự kiện 'screen_view'
sự kiệnParams { firebase_screen: EventParams ['firebase_screen']; firebase_screen_class: Thông số sự kiện ['firebase_screen_class']; [khóa: chuỗi]: bất kỳ; }
tùy chọn Tùy chọn cuộc gọi Analytics

Trả về:

trống rỗng

logEvent(analyticsInstance, tên sự kiện, sự kiệnParams, tùy chọn)

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

Bạn có thể tìm thấy danh sách các thông số sự kiện đề xuất trong tài liệu tham khảo 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ố

Tham số Kiểu Sự miêu tả
phân tích sơ thẩm phân tích
tên sự kiện 'tìm kiếm' | 'view_search_results'
sự kiệnParams { search_term?: Thông số sự kiện ['thuật ngữ tìm kiếm']; [khóa: chuỗi]: bất kỳ; }
tùy chọn Tùy chọn cuộc gọi Analytics

Trả về:

trống rỗng

logEvent(analyticsInstance, tên sự kiện, sự kiệnParams, tùy chọn)

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

Bạn có thể tìm thấy danh sách các thông số sự kiện đề xuất trong tài liệu tham khảo 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ố

Tham số Kiểu Sự miêu tả
phân tích sơ thẩm phân tích
tên sự kiện 'chọn_content'
sự kiệnParams { content_type?: Thông số sự kiện ['loại_nội dung']; item_id?: Thông số sự kiện ['item_id']; [khóa: chuỗi]: bất kỳ; }
tùy chọn Tùy chọn cuộc gọi Analytics

Trả về:

trống rỗng

logEvent(analyticsInstance, tên sự kiện, sự kiệnParams, tùy chọn)

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

Bạn có thể tìm thấy danh sách các thông số sự kiện đề xuất trong tài liệu tham khảo 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ố

Tham số Kiểu Sự miêu tả
phân tích sơ thẩm phân tích
tên sự kiện 'chọn_item'
sự kiệnParams { mục?: EventParams ['mặt hàng']; item_list_name?: Thông số sự kiện ['item_list_name']; item_list_id?: Thông số sự kiện ['item_list_id']; [khóa: chuỗi]: bất kỳ; }
tùy chọn Tùy chọn cuộc gọi Analytics

Trả về:

trống rỗng

logEvent(analyticsInstance, tên sự kiện, sự kiệnParams, tùy chọn)

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

Bạn có thể tìm thấy danh sách các thông số sự kiện đề xuất trong tài liệu tham khảo 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ố

Tham số Kiểu Sự miêu tả
phân tích sơ thẩm phân tích
tên sự kiện 'chọn_promotion' | 'view_promotion'
sự kiệnParams { mục?: EventParams ['mặt hàng']; Promotion_id?: EventParams ['id_khuyến mãi']; Promotion_name?: EventParams ['tên_khuyến mãi']; [khóa: chuỗi]: bất kỳ; }
tùy chọn Tùy chọn cuộc gọi Analytics

Trả về:

trống rỗng

logEvent(analyticsInstance, tên sự kiện, sự kiệnParams, tùy chọn)

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

Bạn có thể tìm thấy danh sách các thông số sự kiện đề xuất trong tài liệu tham khảo 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ố

Tham số Kiểu Sự miêu tả
phân tích sơ thẩm phân tích
tên sự kiện 'set_checkout_option'
sự kiệnParams {check_step?: Thông số sự kiện ['checkout_step']; Check_option?: Thông số sự kiện ['checkout_option']; [khóa: chuỗi]: bất kỳ; }
tùy chọn Tùy chọn cuộc gọi Analytics

Trả về:

trống rỗng

logEvent(analyticsInstance, tên sự kiện, sự kiệnParams, tùy chọn)

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

Bạn có thể tìm thấy danh sách các thông số sự kiện đề xuất trong tài liệu tham khảo 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ố

Tham số Kiểu Sự miêu tả
phân tích sơ thẩm phân tích
tên sự kiện 'chia sẻ'
sự kiệnParams { phương thức?: EventParams ['phương pháp']; content_type?: Thông số sự kiện ['loại_nội dung']; item_id?: Thông số sự kiện ['item_id']; [khóa: chuỗi]: bất kỳ; }
tùy chọn Tùy chọn cuộc gọi Analytics

Trả về:

trống rỗng

logEvent(analyticsInstance, tên sự kiện, sự kiệnParams, tùy chọn)

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

Bạn có thể tìm thấy danh sách các thông số sự kiện đề xuất trong tài liệu tham khảo 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ố

Tham số Kiểu Sự miêu tả
phân tích sơ thẩm phân tích
tên sự kiện 'đăng ký'
sự kiệnParams { phương thức?: EventParams ['phương pháp']; [khóa: chuỗi]: bất kỳ; }
tùy chọn Tùy chọn cuộc gọi Analytics

Trả về:

trống rỗng

logEvent(analyticsInstance, tên sự kiện, sự kiệnParams, tùy chọn)

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

Bạn có thể tìm thấy danh sách các thông số sự kiện đề xuất trong tài liệu tham khảo 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ố

Tham số Kiểu Sự miêu tả
phân tích sơ thẩm phân tích
tên sự kiện 'thời gian_hoàn thành'
sự kiệnParams { tên: chuỗi; giá trị: số; sự kiện_category?: chuỗi; sự kiện_label?: chuỗi; [khóa: chuỗi]: bất kỳ; }
tùy chọn Tùy chọn cuộc gọi Analytics

Trả về:

trống rỗng

logEvent(analyticsInstance, tên sự kiện, sự kiệnParams, tùy chọn)

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

Bạn có thể tìm thấy danh sách các thông số sự kiện đề xuất trong tài liệu tham khảo 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ố

Tham số Kiểu Sự miêu tả
phân tích sơ thẩm phân tích
tên sự kiện 'add_shipping_info'
sự kiệnParams { phiếu giảm giá?: EventParams ['phiếu mua hàng']; tiền tệ?: EventParams ['tiền tệ']; các mục?: EventParams ['mặt hàng']; Shipping_tier?: Thông số sự kiện ['bậc vận chuyển']; giá trị?: EventParams ['giá trị']; [khóa: chuỗi]: bất kỳ; }
tùy chọn Tùy chọn cuộc gọi Analytics

Trả về:

trống rỗng

logEvent(analyticsInstance, tên sự kiện, sự kiệnParams, tùy chọn)

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

Bạn có thể tìm thấy danh sách các thông số sự kiện đề xuất trong tài liệu tham khảo 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ố

Tham số Kiểu Sự miêu tả
phân tích sơ thẩm phân tích
tên sự kiện 'view_cart' | 'xem_item'
sự kiệnParams { tiền tệ?: EventParams ['tiền tệ']; các mục?: EventParams ['mặt hàng']; giá trị?: EventParams ['giá trị']; [khóa: chuỗi]: bất kỳ; }
tùy chọn Tùy chọn cuộc gọi Analytics

Trả về:

trống rỗng

logEvent(analyticsInstance, tên sự kiện, sự kiệnParams, tùy chọn)

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

Bạn có thể tìm thấy danh sách các thông số sự kiện đề xuất trong tài liệu tham khảo 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ố

Tham số Kiểu Sự miêu tả
phân tích sơ thẩm phân tích
tên sự kiện 'view_item_list'
sự kiệnParams { mục?: EventParams ['mặt hàng']; item_list_name?: Thông số sự kiện ['item_list_name']; item_list_id?: Thông số sự kiện ['item_list_id']; [khóa: chuỗi]: bất kỳ; }
tùy chọn Tùy chọn cuộc gọi Analytics

Trả về:

trống rỗng

logEvent(analyticsInstance, tên sự kiện, sự kiệnParams, tùy chọn)

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

Bạn có thể tìm thấy danh sách các thông số sự kiện đề xuất trong tài liệu tham khảo 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ố

Tham số Kiểu Sự miêu tả
phân tích sơ thẩm phân tích
tên sự kiện Tên sự kiện tùy chỉnh <T>
sự kiệnParams { [khóa: chuỗi]: bất kỳ; }
tùy chọn Tùy chọn cuộc gọi Analytics

Trả về:

trống rỗng

logEvent(analyticsInstance, tên sự kiện, sự kiệnParams, tùy chọn)

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

Bạn có thể tìm thấy danh sách các thông số sự kiện đề xuất trong tài liệu tham khảo 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ố

Tham số Kiểu Sự miêu tả
phân tích sơ thẩm phân tích
tên sự kiện 'thêm_vào_cart' | 'add_to_wishlist' | 'xóa_khỏi_cart'
sự kiệnParams { tiền tệ?: EventParams ['tiền tệ']; giá trị?: EventParams ['giá trị']; các mục?: EventParams ['mặt hàng']; [khóa: chuỗi]: bất kỳ; }
tùy chọn Tùy chọn cuộc gọi Analytics

Trả về:

trống rỗng

logEvent(analyticsInstance, tên sự kiện, sự kiệnParams, tùy chọn)

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

Bạn có thể tìm thấy danh sách các thông số sự kiện đề xuất trong tài liệu tham khảo 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ố

Tham số Kiểu Sự miêu tả
phân tích sơ thẩm phân tích
tên sự kiện 'bắt đầu kiểm tra'
sự kiệnParams { tiền tệ?: EventParams ['tiền tệ']; phiếu giảm giá?: EventParams ['phiếu mua hàng']; giá trị?: EventParams ['giá trị']; các mục?: EventParams ['mặt hàng']; [khóa: chuỗi]: bất kỳ; }
tùy chọn Tùy chọn cuộc gọi Analytics

Trả về:

trống rỗng

logEvent(analyticsInstance, tên sự kiện, sự kiệnParams, tùy chọn)

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

Bạn có thể tìm thấy danh sách các thông số sự kiện đề xuất trong tài liệu tham khảo 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ố

Tham số Kiểu Sự miêu tả
phân tích sơ thẩm phân tích
tên sự kiện 'checkout_progress'
sự kiệnParams { tiền tệ?: EventParams ['tiền tệ']; phiếu giảm giá?: EventParams ['phiếu mua hàng']; giá trị?: EventParams ['giá trị']; các mục?: EventParams ['mặt hàng']; Check_step?: Thông số sự kiện ['checkout_step']; Check_option?: Thông số sự kiện ['checkout_option']; [khóa: chuỗi]: bất kỳ; }
tùy chọn Tùy chọn cuộc gọi Analytics

Trả về:

trống rỗng

logEvent(analyticsInstance, tên sự kiện, sự kiệnParams, tùy chọn)

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

Xem Đo lường 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ố

Tham số Kiểu Sự miêu tả
phân tích sơ thẩm phân tích
tên sự kiện 'ngoại lệ'
sự kiệnParams { mô tả?: EventParams ['Sự miêu tả']; gây tử vong?: EventParams ['gây tử vong']; [khóa: chuỗi]: bất kỳ; }
tùy chọn Tùy chọn cuộc gọi Analytics

Trả về:

trống rỗng

logEvent(analyticsInstance, tên sự kiện, sự kiệnParams, tùy chọn)

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

Bạn có thể tìm thấy danh sách các thông số sự kiện đề xuất trong tài liệu tham khảo 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ố

Tham số Kiểu Sự miêu tả
phân tích sơ thẩm phân tích
tên sự kiện 'tạo_khách hàng tiềm năng'
sự kiệnParams { giá trị?: Thông số sự kiện ['giá trị']; tiền tệ?: EventParams ['tiền tệ']; [khóa: chuỗi]: bất kỳ; }
tùy chọn Tùy chọn cuộc gọi Analytics

Trả về:

trống rỗng

logEvent(analyticsInstance, tên sự kiện, sự kiệnParams, tùy chọn)

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

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

Chữ ký:

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

Thông số

Tham số Kiểu Sự miêu tả
phân tích sơ thẩm phân tích
tên sự kiện 'đăng nhập'
sự kiệnParams { phương thức?: EventParams ['phương pháp']; [khóa: chuỗi]: bất kỳ; }
tùy chọn Tùy chọn cuộc gọi Analytics

Trả về:

trống rỗng

logEvent(analyticsInstance, tên sự kiện, sự kiệnParams, tùy chọn)

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

Xem 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ố

Tham số Kiểu Sự miêu tả
phân tích sơ thẩm phân tích
tên sự kiện 'trang_view'
sự kiệnParams { page_title?: chuỗi; page_location?: chuỗi; page_path?: chuỗi; [khóa: chuỗi]: bất kỳ; }
tùy chọn Tùy chọn cuộc gọi Analytics

Trả về:

trống rỗng

setAnalyticsCollectionEnabled(analyticsInstance, đã bật)

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

Chữ ký:

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

Thông số

Tham số Kiểu Sự miêu tả
phân tích sơ thẩm phân tích Phiên bản Analytics .
đã bật boolean Nếu đúng thì cho phép thu thập, nếu sai thì tắt nó.

Trả về:

trống rỗng

setCurrentScreen(analyticsInstance, screenName, options)

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

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

Chữ ký:

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

Thông số

Tham số Kiểu Sự miêu tả
phân tích sơ thẩm phân tích Phiên bản Analytics .
Tên hiển thị sợi dây Tên màn hình để đặt.
tùy chọn Tùy chọn cuộc gọi Analytics

Trả về:

trống rỗng

setUserId(analyticsInstance, id, options)

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

Chữ ký:

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

Thông số

Tham số Kiểu Sự miêu tả
phân tích sơ thẩm phân tích Phiên bản Analytics .
nhận dạng chuỗi | vô giá trị ID người dùng để thiết lập.
tùy chọn Tùy chọn cuộc gọi Analytics

Trả về:

trống rỗng

setUserProperties(analyticsInstance, thuộc tính, tùy chọn)

Sử dụng lệnh gtag config để đặ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ố

Tham số Kiểu Sự miêu tả
phân tích sơ thẩm phân tích
của cải Thông số tùy chỉnh
tùy chọn Tùy chọn cuộc gọi Analytics

Trả về:

trống rỗng

chức năng()

đượ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 bao gồm bốn bước kiểm tra khác nhau:

  1. Kiểm tra xem đó có phải là môi trường mở rộng 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 hay không. 3. Kiểm tra xem môi trường trình duyệt có hỗ trợ IndexedDB hay không. 4. Kiểm tra xem bối cảnh trình duyệt hiện tại có hợp lệ để sử dụng IndexedDB.open() .

Chữ ký:

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

Trả về:

Lời hứa<boolean>

chức năng (sự đồng ýCài đặt, ...)

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 tham chiếu gtag sau khi khởi chạy Firebase Analytics.

Sử dụng ConsentSettings để chỉ định các giá trị loại sự đồng ý riêng lẻ. Theo mặc định, loại đồng ý được đặt thành "đã cấp".

Chữ ký:

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

Thông số

Tham số Kiểu Sự miêu tả
đồng ýCài đặt Đồng ýCài đặt Ánh xạ trạng thái đồng ý của người dùng cuối hiện hành cho gtag.js.

Trả về:

trống rỗng

hàm (customParams, ...)

setDefaultEventParameters(customParams)

Thêm dữ liệu sẽ được đặt cho mọi sự kiện được ghi từ SDK, bao gồm cả những sự kiện tự động. Với lệnh "set" của gtag, các giá trị được chuyển sẽ 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ố

Tham số Kiểu Sự miêu tả
thông số tùy chỉnh Thông số tùy chỉnh Mọi thông số tùy chỉnh mà người dùng có thể chuyển tới gtag.js.

Trả về:

trống rỗng

chức năng (tùy chọn, ...)

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

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

Chữ ký:

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

Thông số

Tham số Kiểu Sự miêu tả
tùy chọn Cài đặtTùy chọn Tên gtag và dataLayer tùy chỉnh.

Trả về:

trống rỗng

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

Liệu một loại chấp thuận cụ thể đã được cấp hay bị từ chối.

Chữ ký:

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

Tiền tệ

Loại tiền tệ tiêu chuẩn của Google Analytics.

Chữ ký:

export declare type Currency = string | number;

Tên sự kiện tùy chỉnh

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

Chữ ký:

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

Tên sự kiệnChuỗi

Nhập tên sự kiện Google Analytics tiêu chuẩn. logEvent cũng chấp nhận bất kỳ chuỗi tùy chỉnh nào và diễn giải nó dưới dạng tên sự kiện tùy 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';