analytics package

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

Hàm

Giao diện

Nhập bí danh

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ố

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ố

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ố

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ố

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ố

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ố

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ố

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ố

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ố

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ố

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ố

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ố

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ố

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ố

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ố

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ố

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ố

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ố

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ố

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ố

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ố

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ố

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ố

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ố

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ố

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ố

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ố

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ố

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ố

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ố

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ố

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ố

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