analytics package

Firebase Analytics Web SDK. SDK זה לא עובד בסביבת Node.js.

פונקציות

ממשקים

הקלד כינויים

פונקציה (אפליקציה,...)

getAnalytics(אפליקציה)

מחזיר מופע Analytics עבור האפליקציה הנתונה.

חֲתִימָה:

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

פרמטרים

החזרות:

ניתוח

initializeAnalytics (אפליקציה, אפשרויות)

מחזיר מופע Analytics עבור האפליקציה הנתונה.

חֲתִימָה:

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

פרמטרים

החזרות:

ניתוח

function(analyticsInstance, ...)

getGoogleAnalyticsClientId(analyticsInstance)

מאחזר מזהה ייחודי של Google Analytics עבור לקוח האינטרנט. ראה client_id .

חֲתִימָה:

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

פרמטרים

החזרות:

הבטחה<string>

logEvent(analyticsInstance, eventName, eventParams, options)

שולח אירוע ב-Google Analytics עם eventParams נתון של event . שיטה זו משייכת באופן אוטומטי את האירוע המתועד הזה למופע אפליקציית האינטרנט של Firebase במכשיר זה.

ניתן למצוא רשימה של פרמטרים מומלצים של אירועים בתיעוד העזר של GA4 .

חֲתִימָה:

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

פרמטרים

החזרות:

בָּטֵל

logEvent(analyticsInstance, eventName, eventParams, options)

שולח אירוע ב-Google Analytics עם eventParams נתון של event . שיטה זו משייכת באופן אוטומטי את האירוע המתועד הזה למופע אפליקציית האינטרנט של Firebase במכשיר זה.

ניתן למצוא רשימה של פרמטרים מומלצים של אירועים בתיעוד העזר של GA4 .

חֲתִימָה:

export declare function logEvent(analyticsInstance: Analytics, eventName: 'purchase' | 'refund', eventParams?: {
    value?: EventParams['value'];
    currency?: EventParams['currency'];
    transaction_id: EventParams['transaction_id'];
    tax?: EventParams['tax'];
    shipping?: EventParams['shipping'];
    items?: EventParams['items'];
    coupon?: EventParams['coupon'];
    affiliation?: EventParams['affiliation'];
    [key: string]: any;
}, options?: AnalyticsCallOptions): void;

פרמטרים

החזרות:

בָּטֵל

logEvent(analyticsInstance, eventName, eventParams, options)

שולח אירוע ב-Google Analytics עם eventParams נתון של event . שיטה זו משייכת באופן אוטומטי את האירוע המתועד הזה למופע אפליקציית האינטרנט של Firebase במכשיר זה.

ראה עקוב אחר תצוגות מסך .

חֲתִימָה:

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

פרמטרים

החזרות:

בָּטֵל

logEvent(analyticsInstance, eventName, eventParams, options)

שולח אירוע ב-Google Analytics עם eventParams נתון של event . שיטה זו משייכת באופן אוטומטי את האירוע המתועד הזה למופע אפליקציית האינטרנט של Firebase במכשיר זה.

ניתן למצוא רשימה של פרמטרים מומלצים של אירועים בתיעוד העזר של GA4 .

חֲתִימָה:

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

פרמטרים

החזרות:

בָּטֵל

logEvent(analyticsInstance, eventName, eventParams, options)

שולח אירוע ב-Google Analytics עם eventParams נתון של event . שיטה זו משייכת באופן אוטומטי את האירוע המתועד הזה למופע אפליקציית האינטרנט של Firebase במכשיר זה.

ניתן למצוא רשימה של פרמטרים מומלצים של אירועים בתיעוד העזר של GA4 .

חֲתִימָה:

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

פרמטרים

החזרות:

בָּטֵל

logEvent(analyticsInstance, eventName, eventParams, options)

שולח אירוע ב-Google Analytics עם eventParams נתון של event . שיטה זו משייכת באופן אוטומטי את האירוע המתועד הזה למופע אפליקציית האינטרנט של Firebase במכשיר זה.

ניתן למצוא רשימה של פרמטרים מומלצים של אירועים בתיעוד העזר של GA4 .

חֲתִימָה:

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

פרמטרים

החזרות:

בָּטֵל

logEvent(analyticsInstance, eventName, eventParams, options)

שולח אירוע ב-Google Analytics עם eventParams נתון של event . שיטה זו משייכת באופן אוטומטי את האירוע המתועד הזה למופע אפליקציית האינטרנט של Firebase במכשיר זה.

ניתן למצוא רשימה של פרמטרים מומלצים של אירועים בתיעוד העזר של GA4 .

חֲתִימָה:

export declare function logEvent(analyticsInstance: Analytics, eventName: 'select_promotion' | 'view_promotion', eventParams?: {
    items?: EventParams['items'];
    promotion_id?: EventParams['promotion_id'];
    promotion_name?: EventParams['promotion_name'];
    [key: string]: any;
}, options?: AnalyticsCallOptions): void;

פרמטרים

החזרות:

בָּטֵל

logEvent(analyticsInstance, eventName, eventParams, options)

שולח אירוע ב-Google Analytics עם eventParams נתון של event . שיטה זו משייכת באופן אוטומטי את האירוע המתועד הזה למופע אפליקציית האינטרנט של Firebase במכשיר זה.

ניתן למצוא רשימה של פרמטרים מומלצים של אירועים בתיעוד העזר של GA4 .

חֲתִימָה:

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

פרמטרים

החזרות:

בָּטֵל

logEvent(analyticsInstance, eventName, eventParams, options)

שולח אירוע ב-Google Analytics עם eventParams נתון של event . שיטה זו משייכת באופן אוטומטי את האירוע המתועד הזה למופע אפליקציית האינטרנט של Firebase במכשיר זה.

ניתן למצוא רשימה של פרמטרים מומלצים של אירועים בתיעוד העזר של GA4 .

חֲתִימָה:

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

פרמטרים

החזרות:

בָּטֵל

logEvent(analyticsInstance, eventName, eventParams, options)

שולח אירוע ב-Google Analytics עם eventParams נתון של event . שיטה זו משייכת באופן אוטומטי את האירוע המתועד הזה למופע אפליקציית האינטרנט של Firebase במכשיר זה.

ניתן למצוא רשימה של פרמטרים מומלצים של אירועים בתיעוד העזר של GA4 .

חֲתִימָה:

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

פרמטרים

החזרות:

בָּטֵל

logEvent(analyticsInstance, eventName, eventParams, options)

שולח אירוע ב-Google Analytics עם eventParams נתון של event . שיטה זו משייכת באופן אוטומטי את האירוע המתועד הזה למופע אפליקציית האינטרנט של Firebase במכשיר זה.

ניתן למצוא רשימה של פרמטרים מומלצים של אירועים בתיעוד העזר של GA4 .

חֲתִימָה:

export declare function logEvent(analyticsInstance: Analytics, eventName: 'timing_complete', eventParams?: {
    name: string;
    value: number;
    event_category?: string;
    event_label?: string;
    [key: string]: any;
}, options?: AnalyticsCallOptions): void;

פרמטרים

החזרות:

בָּטֵל

logEvent(analyticsInstance, eventName, eventParams, options)

שולח אירוע ב-Google Analytics עם eventParams נתון של event . שיטה זו משייכת באופן אוטומטי את האירוע המתועד הזה למופע אפליקציית האינטרנט של Firebase במכשיר זה.

ניתן למצוא רשימה של פרמטרים מומלצים של אירועים בתיעוד העזר של GA4 .

חֲתִימָה:

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

פרמטרים

החזרות:

בָּטֵל

logEvent(analyticsInstance, eventName, eventParams, options)

שולח אירוע ב-Google Analytics עם eventParams נתון של event . שיטה זו משייכת באופן אוטומטי את האירוע המתועד הזה למופע אפליקציית האינטרנט של Firebase במכשיר זה.

ניתן למצוא רשימה של פרמטרים מומלצים של אירועים בתיעוד העזר של GA4 .

חֲתִימָה:

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

פרמטרים

החזרות:

בָּטֵל

logEvent(analyticsInstance, eventName, eventParams, options)

שולח אירוע ב-Google Analytics עם eventParams נתון של event . שיטה זו משייכת באופן אוטומטי את האירוע המתועד הזה למופע אפליקציית האינטרנט של Firebase במכשיר זה.

ניתן למצוא רשימה של פרמטרים מומלצים של אירועים בתיעוד העזר של GA4 .

חֲתִימָה:

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

פרמטרים

החזרות:

בָּטֵל

logEvent(analyticsInstance, eventName, eventParams, options)

שולח אירוע ב-Google Analytics עם eventParams נתון של event . שיטה זו משייכת באופן אוטומטי את האירוע המתועד הזה למופע אפליקציית האינטרנט של Firebase במכשיר זה.

ניתן למצוא רשימה של פרמטרים מומלצים של אירועים בתיעוד העזר של GA4 .

חֲתִימָה:

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

פרמטרים

החזרות:

בָּטֵל

logEvent(analyticsInstance, eventName, eventParams, options)

שולח אירוע ב-Google Analytics עם eventParams נתון של event . שיטה זו משייכת באופן אוטומטי את האירוע המתועד הזה למופע אפליקציית האינטרנט של Firebase במכשיר זה.

ניתן למצוא רשימה של פרמטרים מומלצים של אירועים בתיעוד העזר של GA4 .

חֲתִימָה:

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

פרמטרים

החזרות:

בָּטֵל

logEvent(analyticsInstance, eventName, eventParams, options)

שולח אירוע ב-Google Analytics עם eventParams נתון של event . שיטה זו משייכת באופן אוטומטי את האירוע המתועד הזה למופע אפליקציית האינטרנט של Firebase במכשיר זה.

ניתן למצוא רשימה של פרמטרים מומלצים של אירועים בתיעוד העזר של GA4 .

חֲתִימָה:

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

פרמטרים

החזרות:

בָּטֵל

logEvent(analyticsInstance, eventName, eventParams, options)

שולח אירוע ב-Google Analytics עם eventParams נתון של event . שיטה זו משייכת באופן אוטומטי את האירוע המתועד הזה למופע אפליקציית האינטרנט של Firebase במכשיר זה.

ניתן למצוא רשימה של פרמטרים מומלצים של אירועים בתיעוד העזר של GA4 .

חֲתִימָה:

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

פרמטרים

החזרות:

בָּטֵל

logEvent(analyticsInstance, eventName, eventParams, options)

שולח אירוע ב-Google Analytics עם eventParams נתון של event . שיטה זו משייכת באופן אוטומטי את האירוע המתועד הזה למופע אפליקציית האינטרנט של Firebase במכשיר זה.

ראה מדידת חריגים .

חֲתִימָה:

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

פרמטרים

החזרות:

בָּטֵל

logEvent(analyticsInstance, eventName, eventParams, options)

שולח אירוע ב-Google Analytics עם eventParams נתון של event . שיטה זו משייכת באופן אוטומטי את האירוע המתועד הזה למופע אפליקציית האינטרנט של Firebase במכשיר זה.

ניתן למצוא רשימה של פרמטרים מומלצים של אירועים בתיעוד העזר של GA4 .

חֲתִימָה:

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

פרמטרים

החזרות:

בָּטֵל

logEvent(analyticsInstance, eventName, eventParams, options)

שולח אירוע ב-Google Analytics עם eventParams נתון של event . שיטה זו משייכת באופן אוטומטי את האירוע המתועד הזה למופע אפליקציית האינטרנט של Firebase במכשיר זה.

ניתן למצוא רשימה של פרמטרים מומלצים של אירועים בתיעוד העזר של GA4 .

חֲתִימָה:

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

פרמטרים

החזרות:

בָּטֵל

logEvent(analyticsInstance, eventName, eventParams, options)

שולח אירוע ב-Google Analytics עם eventParams נתון של event . שיטה זו משייכת באופן אוטומטי את האירוע המתועד הזה למופע אפליקציית האינטרנט של Firebase במכשיר זה.

ראה תצוגות עמוד .

חֲתִימָה:

export declare function logEvent(analyticsInstance: Analytics, eventName: 'page_view', eventParams?: {
    page_title?: string;
    page_location?: string;
    page_path?: string;
    [key: string]: any;
}, options?: AnalyticsCallOptions): void;

פרמטרים

החזרות:

בָּטֵל

setAnalyticsCollectionEnabled(analyticsInstance, enabled)

מגדיר אם איסוף Google Analytics מופעל עבור אפליקציה זו במכשיר זה. מגדיר את window['ga-disable-analyticsId'] = true;

חֲתִימָה:

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

פרמטרים

החזרות:

בָּטֵל

setCurrentScreen(analyticsInstance, screenName, options)

השתמש עם eventName בתור 'screen_view' והוסף eventParams רלוונטיים . ראה עקוב אחר תצוגות מסך .

השתמש בפקודה gtag config כדי להגדיר screen_name .

חֲתִימָה:

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

פרמטרים

החזרות:

בָּטֵל

setUserId(analyticsInstance, id, options)

השתמש בפקודה gtag config כדי להגדיר user_id .

חֲתִימָה:

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

פרמטרים

החזרות:

בָּטֵל

setUserProperties(analyticsInstance, מאפיינים, אפשרויות)

השתמש בפקודה gtag config כדי להגדיר את כל הפרמטרים שצוינו.

חֲתִימָה:

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

פרמטרים

החזרות:

בָּטֵל

פוּנקצִיָה()

נתמך()

זוהי שיטה סטטית ציבורית המסופקת למשתמשים הכוללת ארבעה בדיקות שונות:

1. בדוק אם זו לא סביבת תוסף דפדפן. 2. בדוק אם קובצי Cookie מופעלים בדפדפן הנוכחי. 3. בדוק אם IndexedDB נתמך על ידי סביבת הדפדפן. 4. בדוק אם הקשר הדפדפן הנוכחי חוקי לשימוש IndexedDB.open() .

חֲתִימָה:

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

החזרות:

הבטחה<בוליאנית>

פונקציה (הגדרות הסכמה, ...)

setConsent(consentSettings)

מגדיר את מצב הסכמת משתמש הקצה הרלוונטי עבור אפליקציית האינטרנט הזו בכל ההפניות ל-gtag לאחר אתחול Firebase Analytics.

השתמש ב- ConsentSettings כדי לציין ערכי סוג הסכמה בודדים. כברירת מחדל, סוגי הסכמה מוגדרים ל"ניתן".

חֲתִימָה:

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

פרמטרים

החזרות:

בָּטֵל

function (customParams, ...)

setDefaultEventParameters(customParams)

מוסיף נתונים שיוגדרו בכל אירוע שנרשם מה-SDK, כולל אלה אוטומטיים. עם הפקודה "set" של gtag, הערכים שהועברו נשארים בעמוד הנוכחי ומועברים עם כל האירועים הבאים.

חֲתִימָה:

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

פרמטרים

החזרות:

בָּטֵל

פונקציה (אפשרויות,...)

הגדרות (אפשרויות)

מגדיר את Firebase Analytics לשימוש בשמות gtag או dataLayer מותאמים אישית. מיועד לשימוש אם סקריפט gtag.js הותקן בדף זה ללא תלות ב-Firebase Analytics, והוא משתמש בשמות שאינם ברירת מחדל עבור הפונקציה gtag או עבור dataLayer . יש לקרוא לפני קריאה getAnalytics() אחרת זה לא ישפיע.

חֲתִימָה:

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

פרמטרים

החזרות:

בָּטֵל

ConsentStatusString

האם סוג הסכמה מסוים ניתן או נדחה.

חֲתִימָה:

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

מַטְבֵּעַ

סוג מטבע רגיל של Google Analytics.

חֲתִימָה:

export declare type Currency = string | number;

CustomEventName

כל מחרוזת שמות אירועים מותאמת אישית שאינה ברשימה הסטנדרטית של שמות אירועים מומלצים.

חֲתִימָה:

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

EventNameString

הקלד עבור שמות אירועים רגילים של Google Analytics. logEvent גם מקבל כל מחרוזת מותאמת אישית ומפרש אותה כשם אירוע מותאם אישית.

חֲתִימָה:

export declare type EventNameString = 'add_payment_info' | 'add_shipping_info' | 'add_to_cart' | 'add_to_wishlist' | 'begin_checkout' | 'checkout_progress' | 'exception' | 'generate_lead' | 'login' | 'page_view' | 'purchase' | 'refund' | 'remove_from_cart' | 'screen_view' | 'search' | 'select_content' | 'select_item' | 'select_promotion' | 'set_checkout_option' | 'share' | 'sign_up' | 'timing_complete' | 'view_cart' | 'view_item' | 'view_item_list' | 'view_promotion' | 'view_search_results';