analytics package

Firebase Analytics Web SDK. این SDK در محیط Node.js کار نمی کند.

کارکرد

تابع شرح
عملکرد (برنامه، ...)
getAnalytics (برنامه) یک نمونه Analytics را برای برنامه داده شده برمی گرداند.
InitializeAnalytics (برنامه، گزینه ها) یک نمونه Analytics را برای برنامه داده شده برمی گرداند.
تابع (Analytics Instance، ...)
getGoogleAnalyticsClientId (analyticsInstance) یک شناسه منحصر به فرد Google Analytics برای مشتری وب بازیابی می کند. به client_id مراجعه کنید .
logEvent (analyticsInstance، eventName، eventParams، گزینه‌ها) یک رویداد Google Analytics را با eventParams داده شده ارسال می کند. این روش به طور خودکار این رویداد ثبت شده را با این نمونه برنامه وب Firebase در این دستگاه مرتبط می کند. فهرست پارامترهای رویداد توصیه شده را می توان در مستندات مرجع GA4 یافت .
logEvent (analyticsInstance، eventName، eventParams، گزینه‌ها) یک رویداد Google Analytics را با eventParams داده شده ارسال می کند. این روش به طور خودکار این رویداد ثبت شده را با این نمونه برنامه وب Firebase در این دستگاه مرتبط می کند. فهرست پارامترهای رویداد توصیه شده را می توان در مستندات مرجع GA4 یافت .
logEvent (analyticsInstance، eventName، eventParams، گزینه‌ها) یک رویداد Google Analytics را با eventParams داده شده ارسال می کند. این روش به طور خودکار این رویداد ثبت شده را با این نمونه برنامه وب Firebase در این دستگاه مرتبط می کند. مشاهده صفحه نمایش آهنگ را ببینید .
logEvent (analyticsInstance، eventName، eventParams، گزینه‌ها) یک رویداد Google Analytics را با eventParams داده شده ارسال می کند. این روش به طور خودکار این رویداد ثبت شده را با این نمونه برنامه وب Firebase در این دستگاه مرتبط می کند. فهرست پارامترهای رویداد توصیه شده را می توان در مستندات مرجع GA4 یافت .
logEvent (analyticsInstance، eventName، eventParams، گزینه‌ها) یک رویداد Google Analytics را با eventParams داده شده ارسال می کند. این روش به طور خودکار این رویداد ثبت شده را با این نمونه برنامه وب Firebase در این دستگاه مرتبط می کند. فهرست پارامترهای رویداد توصیه شده را می توان در مستندات مرجع GA4 یافت .
logEvent (analyticsInstance، eventName، eventParams، گزینه‌ها) یک رویداد Google Analytics را با eventParams داده شده ارسال می کند. این روش به طور خودکار این رویداد ثبت شده را با این نمونه برنامه وب Firebase در این دستگاه مرتبط می کند. فهرست پارامترهای رویداد توصیه شده را می توان در مستندات مرجع GA4 یافت .
logEvent (analyticsInstance، eventName، eventParams، گزینه‌ها) یک رویداد Google Analytics را با eventParams داده شده ارسال می کند. این روش به طور خودکار این رویداد ثبت شده را با این نمونه برنامه وب Firebase در این دستگاه مرتبط می کند. فهرست پارامترهای رویداد توصیه شده را می توان در مستندات مرجع GA4 یافت .
logEvent (analyticsInstance، eventName، eventParams، گزینه‌ها) یک رویداد Google Analytics را با eventParams داده شده ارسال می کند. این روش به طور خودکار این رویداد ثبت شده را با این نمونه برنامه وب Firebase در این دستگاه مرتبط می کند. فهرست پارامترهای رویداد توصیه شده را می توان در مستندات مرجع GA4 یافت .
logEvent (analyticsInstance، eventName، eventParams، گزینه‌ها) یک رویداد Google Analytics را با eventParams داده شده ارسال می کند. این روش به طور خودکار این رویداد ثبت شده را با این نمونه برنامه وب Firebase در این دستگاه مرتبط می کند. فهرست پارامترهای رویداد توصیه شده را می توان در مستندات مرجع GA4 یافت .
logEvent (analyticsInstance، eventName، eventParams، گزینه‌ها) یک رویداد Google Analytics را با eventParams داده شده ارسال می کند. این روش به طور خودکار این رویداد ثبت شده را با این نمونه برنامه وب Firebase در این دستگاه مرتبط می کند. فهرست پارامترهای رویداد توصیه شده را می توان در مستندات مرجع GA4 یافت .
logEvent (analyticsInstance، eventName، eventParams، گزینه‌ها) یک رویداد Google Analytics را با eventParams داده شده ارسال می کند. این روش به طور خودکار این رویداد ثبت شده را با این نمونه برنامه وب Firebase در این دستگاه مرتبط می کند. فهرست پارامترهای رویداد توصیه شده را می توان در مستندات مرجع GA4 یافت .
logEvent (analyticsInstance، eventName، eventParams، گزینه‌ها) یک رویداد Google Analytics را با eventParams داده شده ارسال می کند. این روش به طور خودکار این رویداد ثبت شده را با این نمونه برنامه وب Firebase در این دستگاه مرتبط می کند. فهرست پارامترهای رویداد توصیه شده را می توان در مستندات مرجع GA4 یافت .
logEvent (analyticsInstance، eventName، eventParams، گزینه‌ها) یک رویداد Google Analytics را با eventParams داده شده ارسال می کند. این روش به طور خودکار این رویداد ثبت شده را با این نمونه برنامه وب Firebase در این دستگاه مرتبط می کند. فهرست پارامترهای رویداد توصیه شده را می توان در مستندات مرجع GA4 یافت .
logEvent (analyticsInstance، eventName، eventParams، گزینه‌ها) یک رویداد Google Analytics را با eventParams داده شده ارسال می کند. این روش به طور خودکار این رویداد ثبت شده را با این نمونه برنامه وب Firebase در این دستگاه مرتبط می کند. فهرست پارامترهای رویداد توصیه شده را می توان در مستندات مرجع GA4 یافت .
logEvent (analyticsInstance، eventName، eventParams، گزینه‌ها) یک رویداد Google Analytics را با eventParams داده شده ارسال می کند. این روش به طور خودکار این رویداد ثبت شده را با این نمونه برنامه وب Firebase در این دستگاه مرتبط می کند. فهرست پارامترهای رویداد توصیه شده را می توان در مستندات مرجع GA4 یافت .
logEvent (analyticsInstance، eventName، eventParams، گزینه‌ها) یک رویداد Google Analytics را با eventParams داده شده ارسال می کند. این روش به طور خودکار این رویداد ثبت شده را با این نمونه برنامه وب Firebase در این دستگاه مرتبط می کند. فهرست پارامترهای رویداد توصیه شده را می توان در مستندات مرجع GA4 یافت .
logEvent (analyticsInstance، eventName، eventParams، گزینه‌ها) یک رویداد Google Analytics را با eventParams داده شده ارسال می کند. این روش به طور خودکار این رویداد ثبت شده را با این نمونه برنامه وب Firebase در این دستگاه مرتبط می کند. فهرست پارامترهای رویداد توصیه شده را می توان در مستندات مرجع GA4 یافت .
logEvent (analyticsInstance، eventName، eventParams، گزینه‌ها) یک رویداد Google Analytics را با eventParams داده شده ارسال می کند. این روش به طور خودکار این رویداد ثبت شده را با این نمونه برنامه وب Firebase در این دستگاه مرتبط می کند. فهرست پارامترهای رویداد توصیه شده را می توان در مستندات مرجع GA4 یافت .
logEvent (analyticsInstance، eventName، eventParams، گزینه‌ها) یک رویداد Google Analytics را با eventParams داده شده ارسال می کند. این روش به طور خودکار این رویداد ثبت شده را با این نمونه برنامه وب Firebase در این دستگاه مرتبط می کند. به اندازه گیری استثناها مراجعه کنید .
logEvent (analyticsInstance، eventName، eventParams، گزینه‌ها) یک رویداد Google Analytics را با eventParams داده شده ارسال می کند. این روش به طور خودکار این رویداد ثبت شده را با این نمونه برنامه وب Firebase در این دستگاه مرتبط می کند. فهرست پارامترهای رویداد توصیه شده را می توان در مستندات مرجع GA4 یافت .
logEvent (analyticsInstance، eventName، eventParams، گزینه‌ها) یک رویداد Google Analytics را با eventParams داده شده ارسال می کند. این روش به طور خودکار این رویداد ثبت شده را با این نمونه برنامه وب Firebase در این دستگاه مرتبط می کند. فهرست پارامترهای رویداد توصیه شده را می توان در مستندات مرجع GA4 یافت .
logEvent (analyticsInstance، eventName، eventParams، گزینه‌ها) یک رویداد Google Analytics را با eventParams داده شده ارسال می کند. این روش به طور خودکار این رویداد ثبت شده را با این نمونه برنامه وب Firebase در این دستگاه مرتبط می کند. بازدیدهای صفحه را ببینید .
setAnalyticsCollectionEnabled(analyticsInstance، فعال) تنظیم می‌کند که مجموعه Google Analytics برای این برنامه در این دستگاه فعال باشد یا خیر. window['ga-disable-analyticsId'] = true;
setCurrentScreen (analyticsInstance، screenName، گزینه‌ها) برای تنظیم screen_name از دستور gtag config استفاده کنید.
setUserId (analyticsInstance, id, option) برای تنظیم user_id از دستور gtag config استفاده کنید.
setUserProperties (analyticsInstance، خواص، گزینه‌ها) برای تنظیم تمام پارامترهای مشخص شده از دستور gtag config استفاده کنید.
تابع()
isSupported() این یک روش استاتیک عمومی است که در اختیار کاربران قرار می‌گیرد و چهار چک مختلف را می‌پیچد: 1. بررسی کنید که آیا یک محیط افزونه مرورگر نیست. 2. بررسی کنید که آیا کوکی ها در مرورگر فعلی فعال هستند یا خیر. 3. بررسی کنید که آیا IndexedDB توسط محیط مرورگر پشتیبانی می شود یا خیر. 4. بررسی کنید که آیا زمینه مرورگر فعلی برای استفاده از IndexedDB.open() معتبر است یا خیر.
تابع (تنظیمات رضایت، ...)
setConsent (تنظیمات رضایت) پس از راه اندازی Firebase Analytics، وضعیت رضایت کاربر نهایی قابل اجرا را برای این برنامه وب در همه مراجع gtag تنظیم می کند. از ConsentSettings برای تعیین مقادیر نوع رضایت فردی استفاده کنید. به‌طور پیش‌فرض، انواع رضایت روی «اعطا شده» تنظیم می‌شوند.
تابع (customParams، ...)
setDefaultEventParameters(customParams) داده‌هایی را اضافه می‌کند که روی هر رویداد ثبت‌شده از SDK، از جمله رویدادهای خودکار، تنظیم می‌شوند. با دستور "set" gtag، مقادیر ارسال شده در صفحه جاری باقی می مانند و با تمام رویدادهای بعدی ارسال می شوند.
تابع (گزینه ها، ...)
تنظیمات (گزینه ها) Firebase Analytics را برای استفاده از نام‌های gtag یا dataLayer سفارشی پیکربندی می‌کند. اگر اسکریپت gtag.js مستقل از Firebase Analytics در این صفحه نصب شده باشد و از نام‌های غیر پیش‌فرض برای تابع gtag یا dataLayer استفاده می‌کند، در نظر گرفته شده است. قبل از فراخوانی getAnalytics() باید فراخوانی شود وگرنه هیچ تاثیری نخواهد داشت.

رابط ها

رابط شرح
تجزیه و تحلیل نمونه ای از Firebase Analytics.
AnalyticsCallOptions گزینه های اضافی که می توانند به فراخوانی روش Analytics ارسال شوند مانند logEvent و غیره.
تنظیمات تجزیه و تحلیل گزینه های اولیه سازی نمونه تجزیه و تحلیل
تنظیمات رضایت تنظیمات وضعیت رضایت برای هر نوع رضایت. برای اطلاعات بیشتر، به اسناد مرجع GA4 برای وضعیت رضایت و انواع رضایت مراجعه کنید .
ControlParams پارامترهای کنترل استاندارد gtag.js برای اطلاعات بیشتر، به مستندات مرجع GA4 مراجعه کنید .
پارام های سفارشی هر پارامتر سفارشی که کاربر ممکن است به gtag ارسال کند.
EventParams پارامترهای رویداد استاندارد gtag.js برای اطلاعات بیشتر، به مستندات مرجع GA4 مراجعه کنید .
GtagConfigParams مجموعه ای از تنظیمات پیکربندی رایج Google Analytics که توسط gtag.js شناسایی شده است.
مورد نوع Item استاندارد Google Analytics.
ترویج فیلدی که قبلاً توسط برخی رویدادهای Google Analytics استفاده شده است.
تنظیمات تنظیمات گزینه های سفارشی را برای نمونه Firebase Analytics شما مشخص می کند. قبل از مقداردهی اولیه firebase.analytics() باید اینها را تنظیم کنید.

نام مستعار را تایپ کنید

نام مستعار را تایپ کنید شرح
ConsentStatusString اینکه آیا یک نوع رضایت خاص داده شده یا رد شده است.
واحد پول نوع ارز استاندارد Google Analytics.
CustomEventName هر رشته نام رویداد سفارشی که در لیست استاندارد نام‌های رویداد توصیه‌شده نیست.
EventNameString نام رویدادهای استاندارد Google Analytics را تایپ کنید. logEvent همچنین هر رشته سفارشی را می پذیرد و آن را به عنوان یک نام رویداد سفارشی تفسیر می کند.

عملکرد (برنامه، ...)

getAnalytics (برنامه)

یک نمونه Analytics را برای برنامه داده شده برمی گرداند.

امضا:

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

مولفه های

پارامتر تایپ کنید شرح
برنامه Firebase App برنامه Firebase برای استفاده.

برمی گرداند:

تجزیه و تحلیل

InitializeAnalytics (برنامه، گزینه ها)

یک نمونه Analytics را برای برنامه داده شده برمی گرداند.

امضا:

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

مولفه های

پارامتر تایپ کنید شرح
برنامه Firebase App برنامه Firebase برای استفاده.
گزینه ها تنظیمات تجزیه و تحلیل

برمی گرداند:

تجزیه و تحلیل

تابع (Analytics Instance، ...)

getGoogleAnalyticsClientId(analyticsInstance)

یک شناسه منحصر به فرد Google Analytics برای مشتری وب بازیابی می کند. به client_id مراجعه کنید .

امضا:

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

مولفه های

پارامتر تایپ کنید شرح
Analytics Instance تجزیه و تحلیل

برمی گرداند:

قول<رشته>

logEvent (analyticsInstance، eventName، eventParams، گزینه‌ها)

یک رویداد Google Analytics را با eventParams می‌فرستد . این روش به طور خودکار این رویداد ثبت شده را با این نمونه برنامه وب 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;

مولفه های

پارامتر تایپ کنید شرح
Analytics Instance تجزیه و تحلیل
نام رخداد "add_payment_info"
eventParams {کوپن؟: EventParams ['کوپن']؛ ارز؟: EventParams ['واحد پول']؛ موارد؟: EventParams ['موارد']؛ type_pay?: EventParams ['نوع پرداخت']؛ ارزش؟: EventParams ['ارزش']؛ [key: string]: any; }
گزینه ها AnalyticsCallOptions

برمی گرداند:

خالی

logEvent (analyticsInstance، eventName، eventParams، گزینه‌ها)

یک رویداد Google Analytics را با eventParams می‌فرستد . این روش به طور خودکار این رویداد ثبت شده را با این نمونه برنامه وب 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;

مولفه های

پارامتر تایپ کنید شرح
Analytics Instance تجزیه و تحلیل
نام رخداد 'خرید' | "بازپرداخت"
eventParams { value?: EventParams ['ارزش']؛ ارز؟: EventParams ['واحد پول']؛ transaction_id: EventParams ['شناسه تراکنش']؛ مالیات؟: EventParams ['مالیات']؛ حمل و نقل؟: EventParams ['حمل دریایی']؛ موارد؟: EventParams ['موارد']؛ کوپن؟: EventParams ['کوپن']؛ وابستگی؟: EventParams ['وابستگی']؛ [key: string]: any; }
گزینه ها AnalyticsCallOptions

برمی گرداند:

خالی

logEvent (analyticsInstance، eventName، eventParams، گزینه‌ها)

یک رویداد Google Analytics را با eventParams می‌فرستد . این روش به طور خودکار این رویداد ثبت شده را با این نمونه برنامه وب 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;

مولفه های

پارامتر تایپ کنید شرح
Analytics Instance تجزیه و تحلیل
نام رخداد 'screen_view'
eventParams { firebase_screen: EventParams ['firebase_screen']; firebase_screen_class: EventParams ['firebase_screen_class']؛ [key: string]: any; }
گزینه ها AnalyticsCallOptions

برمی گرداند:

خالی

logEvent (analyticsInstance، eventName، eventParams، گزینه‌ها)

یک رویداد Google Analytics را با eventParams می‌فرستد . این روش به طور خودکار این رویداد ثبت شده را با این نمونه برنامه وب 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;

مولفه های

پارامتر تایپ کنید شرح
Analytics Instance تجزیه و تحلیل
نام رخداد 'جستجو' | 'view_search_results'
eventParams { search_term?: EventParams ['search_term']; [key: string]: any; }
گزینه ها AnalyticsCallOptions

برمی گرداند:

خالی

logEvent (analyticsInstance، eventName، eventParams، گزینه‌ها)

یک رویداد Google Analytics را با eventParams می‌فرستد . این روش به طور خودکار این رویداد ثبت شده را با این نمونه برنامه وب 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;

مولفه های

پارامتر تایپ کنید شرح
Analytics Instance تجزیه و تحلیل
نام رخداد "انتخاب_محتوا"
eventParams {content_type?: EventParams ['نوع محتوا']؛ item_id؟: EventParams ['item_id']; [key: string]: any; }
گزینه ها AnalyticsCallOptions

برمی گرداند:

خالی

logEvent (analyticsInstance، eventName، eventParams، گزینه‌ها)

یک رویداد Google Analytics را با eventParams می‌فرستد . این روش به طور خودکار این رویداد ثبت شده را با این نمونه برنامه وب 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;

مولفه های

پارامتر تایپ کنید شرح
Analytics Instance تجزیه و تحلیل
نام رخداد "انتخاب_آیتم"
eventParams { آیتم ها؟: EventParams ['موارد']؛ item_list_name؟: EventParams ['item_list_name']; item_list_id؟: EventParams ['item_list_id']; [key: string]: any; }
گزینه ها AnalyticsCallOptions

برمی گرداند:

خالی

logEvent (analyticsInstance، eventName، eventParams، گزینه‌ها)

یک رویداد Google Analytics را با eventParams می‌فرستد . این روش به طور خودکار این رویداد ثبت شده را با این نمونه برنامه وب 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;

مولفه های

پارامتر تایپ کنید شرح
Analytics Instance تجزیه و تحلیل
نام رخداد 'انتخاب_ترفیع' | "view_promotion"
eventParams { آیتم ها؟: EventParams ['موارد']؛ promotion_id؟: EventParams ['promotion_id']; promotion_name?: EventParams ['promotion_name']; [key: string]: any; }
گزینه ها AnalyticsCallOptions

برمی گرداند:

خالی

logEvent (analyticsInstance، eventName، eventParams، گزینه‌ها)

یک رویداد Google Analytics را با eventParams می‌فرستد . این روش به طور خودکار این رویداد ثبت شده را با این نمونه برنامه وب 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;

مولفه های

پارامتر تایپ کنید شرح
Analytics Instance تجزیه و تحلیل
نام رخداد 'set_checkout_option'
eventParams {checkout_step?: EventParams ['checkout_step']; checkout_option؟: EventParams ['checkout_option']; [key: string]: any; }
گزینه ها AnalyticsCallOptions

برمی گرداند:

خالی

logEvent (analyticsInstance، eventName، eventParams، گزینه‌ها)

یک رویداد Google Analytics را با eventParams می‌فرستد . این روش به طور خودکار این رویداد ثبت شده را با این نمونه برنامه وب 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;

مولفه های

پارامتر تایپ کنید شرح
Analytics Instance تجزیه و تحلیل
نام رخداد 'اشتراک گذاری'
eventParams { روش؟: EventParams ['روش']؛ content_type؟: EventParams ['نوع محتوا']؛ item_id؟: EventParams ['item_id']; [key: string]: any; }
گزینه ها AnalyticsCallOptions

برمی گرداند:

خالی

logEvent (analyticsInstance، eventName، eventParams، گزینه‌ها)

یک رویداد Google Analytics را با eventParams می‌فرستد . این روش به طور خودکار این رویداد ثبت شده را با این نمونه برنامه وب Firebase در این دستگاه مرتبط می کند.

فهرست پارامترهای رویداد توصیه شده را می توان در مستندات مرجع GA4 یافت .

امضا:

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

مولفه های

پارامتر تایپ کنید شرح
Analytics Instance تجزیه و تحلیل
نام رخداد 'ثبت نام'
eventParams { روش؟: EventParams ['روش']؛ [key: string]: any; }
گزینه ها AnalyticsCallOptions

برمی گرداند:

خالی

logEvent (analyticsInstance، eventName، eventParams، گزینه‌ها)

یک رویداد Google Analytics را با eventParams می‌فرستد . این روش به طور خودکار این رویداد ثبت شده را با این نمونه برنامه وب 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;

مولفه های

پارامتر تایپ کنید شرح
Analytics Instance تجزیه و تحلیل
نام رخداد "زمان_کامل"
eventParams {name: string; مقدار: عدد; event_category؟: string; event_label؟: string; [key: string]: any; }
گزینه ها AnalyticsCallOptions

برمی گرداند:

خالی

logEvent (analyticsInstance، eventName، eventParams، گزینه‌ها)

یک رویداد Google Analytics را با eventParams می‌فرستد . این روش به طور خودکار این رویداد ثبت شده را با این نمونه برنامه وب 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;

مولفه های

پارامتر تایپ کنید شرح
Analytics Instance تجزیه و تحلیل
نام رخداد "add_shipping_info"
eventParams {کوپن؟: EventParams ['کوپن']؛ ارز؟: EventParams ['واحد پول']؛ موارد؟: EventParams ['موارد']؛ shipping_tier?: EventParams ['shipping_tier']; ارزش؟: EventParams ['ارزش']؛ [key: string]: any; }
گزینه ها AnalyticsCallOptions

برمی گرداند:

خالی

logEvent (analyticsInstance، eventName، eventParams، گزینه‌ها)

یک رویداد Google Analytics را با eventParams می‌فرستد . این روش به طور خودکار این رویداد ثبت شده را با این نمونه برنامه وب 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;

مولفه های

پارامتر تایپ کنید شرح
Analytics Instance تجزیه و تحلیل
نام رخداد "نمایش_سبد" | "view_item"
eventParams { ارز؟: EventParams ['واحد پول']؛ موارد؟: EventParams ['موارد']؛ ارزش؟: EventParams ['ارزش']؛ [key: string]: any; }
گزینه ها AnalyticsCallOptions

برمی گرداند:

خالی

logEvent (analyticsInstance، eventName، eventParams، گزینه‌ها)

یک رویداد Google Analytics را با eventParams می‌فرستد . این روش به طور خودکار این رویداد ثبت شده را با این نمونه برنامه وب 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;

مولفه های

پارامتر تایپ کنید شرح
Analytics Instance تجزیه و تحلیل
نام رخداد "view_item_list"
eventParams { آیتم ها؟: EventParams ['موارد']؛ item_list_name؟: EventParams ['item_list_name']; item_list_id؟: EventParams ['item_list_id']; [key: string]: any; }
گزینه ها AnalyticsCallOptions

برمی گرداند:

خالی

logEvent (analyticsInstance، eventName، eventParams، گزینه‌ها)

یک رویداد Google Analytics را با eventParams می‌فرستد . این روش به طور خودکار این رویداد ثبت شده را با این نمونه برنامه وب Firebase در این دستگاه مرتبط می کند.

فهرست پارامترهای رویداد توصیه شده را می توان در مستندات مرجع GA4 یافت .

امضا:

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

مولفه های

پارامتر تایپ کنید شرح
Analytics Instance تجزیه و تحلیل
نام رخداد CustomEventName <T>
eventParams { [key: string]: any; }
گزینه ها AnalyticsCallOptions

برمی گرداند:

خالی

logEvent (analyticsInstance، eventName، eventParams، گزینه‌ها)

یک رویداد Google Analytics را با eventParams می‌فرستد . این روش به طور خودکار این رویداد ثبت شده را با این نمونه برنامه وب 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;

مولفه های

پارامتر تایپ کنید شرح
Analytics Instance تجزیه و تحلیل
نام رخداد "افزودن_به_سبد" | "افزودن به_لیست" | "حذف_از_سبد"
eventParams { ارز؟: EventParams ['واحد پول']؛ ارزش؟: EventParams ['ارزش']؛ موارد؟: EventParams ['موارد']؛ [key: string]: any; }
گزینه ها AnalyticsCallOptions

برمی گرداند:

خالی

logEvent (analyticsInstance، eventName، eventParams، گزینه‌ها)

یک رویداد Google Analytics را با eventParams می‌فرستد . این روش به طور خودکار این رویداد ثبت شده را با این نمونه برنامه وب 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;

مولفه های

پارامتر تایپ کنید شرح
Analytics Instance تجزیه و تحلیل
نام رخداد 'begin_checkout'
eventParams { ارز؟: EventParams ['واحد پول']؛ کوپن؟: EventParams ['کوپن']؛ ارزش؟: EventParams ['ارزش']؛ موارد؟: EventParams ['موارد']؛ [key: string]: any; }
گزینه ها AnalyticsCallOptions

برمی گرداند:

خالی

logEvent (analyticsInstance، eventName، eventParams، گزینه‌ها)

یک رویداد Google Analytics را با eventParams می‌فرستد . این روش به طور خودکار این رویداد ثبت شده را با این نمونه برنامه وب 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;

مولفه های

پارامتر تایپ کنید شرح
Analytics Instance تجزیه و تحلیل
نام رخداد "خروج_پیشرفت"
eventParams { ارز؟: EventParams ['واحد پول']؛ کوپن؟: EventParams ['کوپن']؛ ارزش؟: EventParams ['ارزش']؛ موارد؟: EventParams ['موارد']؛ checkout_step؟: EventParams ['checkout_step']; checkout_option؟: EventParams ['checkout_option']; [key: string]: any; }
گزینه ها AnalyticsCallOptions

برمی گرداند:

خالی

logEvent (analyticsInstance، eventName، eventParams، گزینه‌ها)

یک رویداد Google Analytics را با eventParams می‌فرستد . این روش به طور خودکار این رویداد ثبت شده را با این نمونه برنامه وب Firebase در این دستگاه مرتبط می کند.

به اندازه گیری استثناها مراجعه کنید .

امضا:

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

مولفه های

پارامتر تایپ کنید شرح
Analytics Instance تجزیه و تحلیل
نام رخداد 'استثنا'
eventParams { توضیحات؟: EventParams ['شرح']؛ کشنده؟: EventParams ['کشنده']؛ [key: string]: any; }
گزینه ها AnalyticsCallOptions

برمی گرداند:

خالی

logEvent (analyticsInstance، eventName، eventParams، گزینه‌ها)

یک رویداد Google Analytics را با eventParams می‌فرستد . این روش به طور خودکار این رویداد ثبت شده را با این نمونه برنامه وب Firebase در این دستگاه مرتبط می کند.

فهرست پارامترهای رویداد توصیه شده را می توان در مستندات مرجع GA4 یافت .

امضا:

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

مولفه های

پارامتر تایپ کنید شرح
Analytics Instance تجزیه و تحلیل
نام رخداد "تولید_سرنخ"
eventParams { value?: EventParams ['ارزش']؛ ارز؟: EventParams ['واحد پول']؛ [key: string]: any; }
گزینه ها AnalyticsCallOptions

برمی گرداند:

خالی

logEvent (analyticsInstance، eventName، eventParams، گزینه‌ها)

یک رویداد Google Analytics را با eventParams می‌فرستد . این روش به طور خودکار این رویداد ثبت شده را با این نمونه برنامه وب Firebase در این دستگاه مرتبط می کند.

فهرست پارامترهای رویداد توصیه شده را می توان در مستندات مرجع GA4 یافت .

امضا:

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

مولفه های

پارامتر تایپ کنید شرح
Analytics Instance تجزیه و تحلیل
نام رخداد 'وارد شدن'
eventParams { روش؟: EventParams ['روش']؛ [key: string]: any; }
گزینه ها AnalyticsCallOptions

برمی گرداند:

خالی

logEvent (analyticsInstance، eventName، eventParams، گزینه‌ها)

یک رویداد Google Analytics را با eventParams می‌فرستد . این روش به طور خودکار این رویداد ثبت شده را با این نمونه برنامه وب 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;

مولفه های

پارامتر تایپ کنید شرح
Analytics Instance تجزیه و تحلیل
نام رخداد "page_view"
eventParams {page_title?: string; page_location?: string; page_path?: string; [key: string]: any; }
گزینه ها AnalyticsCallOptions

برمی گرداند:

خالی

setAnalyticsCollectionEnabled(analyticsInstance، فعال)

تنظیم می‌کند که مجموعه Google Analytics برای این برنامه در این دستگاه فعال باشد یا خیر. window['ga-disable-analyticsId'] = true;

امضا:

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

مولفه های

پارامتر تایپ کنید شرح
Analytics Instance تجزیه و تحلیل نمونه Analytics .
فعال شد بولی اگر درست باشد، مجموعه را فعال می کند، اگر نادرست است، آن را غیرفعال می کند.

برمی گرداند:

خالی

setCurrentScreen (analyticsInstance، screenName، گزینه‌ها)

با eventName به عنوان «screen_view» استفاده کنید و eventParams مربوطه را اضافه کنید . مشاهده صفحه نمایش آهنگ را ببینید .

برای تنظیم screen_name از دستور gtag config استفاده کنید .

امضا:

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

مولفه های

پارامتر تایپ کنید شرح
Analytics Instance تجزیه و تحلیل نمونه Analytics .
نام صفحه نمایش رشته نام صفحه نمایش برای تنظیم.
گزینه ها AnalyticsCallOptions

برمی گرداند:

خالی

setUserId (analyticsInstance, id, option)

برای تنظیم user_id از دستور gtag config استفاده کنید .

امضا:

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

مولفه های

پارامتر تایپ کنید شرح
Analytics Instance تجزیه و تحلیل نمونه Analytics .
شناسه رشته | خالی شناسه کاربری برای تنظیم.
گزینه ها AnalyticsCallOptions

برمی گرداند:

خالی

setUserProperties (analyticsInstance، خواص، گزینه‌ها)

برای تنظیم تمام پارامترهای مشخص شده از دستور gtag config استفاده کنید.

امضا:

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

مولفه های

پارامتر تایپ کنید شرح
Analytics Instance تجزیه و تحلیل
خواص پارام های سفارشی
گزینه ها AnalyticsCallOptions

برمی گرداند:

خالی

تابع()

isSupported()

این یک روش استاتیک عمومی است که در اختیار کاربران قرار می‌گیرد و چهار چک مختلف را می‌پیچد:

  1. بررسی کنید که آیا یک محیط افزونه مرورگر نیست. 2. بررسی کنید که آیا کوکی ها در مرورگر فعلی فعال هستند یا خیر. 3. بررسی کنید که آیا IndexedDB توسط محیط مرورگر پشتیبانی می شود یا خیر. 4. بررسی کنید که آیا زمینه مرورگر فعلی برای استفاده از IndexedDB.open() .

امضا:

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

برمی گرداند:

وعده<boolean>

تابع (تنظیمات رضایت، ...)

setConsent (تنظیمات رضایت)

پس از راه اندازی Firebase Analytics، وضعیت رضایت کاربر نهایی قابل اجرا را برای این برنامه وب در همه مراجع gtag تنظیم می کند.

از ConsentSettings برای تعیین مقادیر نوع رضایت فردی استفاده کنید. به‌طور پیش‌فرض، انواع رضایت روی «اعطا شده» تنظیم می‌شوند.

امضا:

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

مولفه های

پارامتر تایپ کنید شرح
تنظیمات رضایت تنظیمات رضایت وضعیت رضایت کاربر نهایی قابل اجرا را برای gtag.js ترسیم می کند.

برمی گرداند:

خالی

تابع (customParams، ...)

setDefaultEventParameters(customParams)

داده‌هایی را اضافه می‌کند که روی هر رویداد ثبت‌شده از SDK، از جمله رویدادهای خودکار، تنظیم می‌شوند. با دستور "set" gtag، مقادیر ارسال شده در صفحه جاری باقی می مانند و با تمام رویدادهای بعدی ارسال می شوند.

امضا:

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

مولفه های

پارامتر تایپ کنید شرح
پارام های سفارشی پارام های سفارشی هر پارامتر سفارشی که کاربر ممکن است به gtag.js ارسال کند.

برمی گرداند:

خالی

تابع (گزینه ها، ...)

تنظیمات (گزینه ها)

Firebase Analytics را برای استفاده از نام‌های gtag یا dataLayer سفارشی پیکربندی می‌کند. اگر اسکریپت gtag.js مستقل از Firebase Analytics در این صفحه نصب شده باشد و از نام‌های غیر پیش‌فرض هم برای تابع gtag یا هم برای dataLayer استفاده می‌کند، استفاده می‌شود. . قبل از فراخوانی getAnalytics() باید فراخوانی شود وگرنه هیچ تاثیری نخواهد داشت.

امضا:

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

مولفه های

پارامتر تایپ کنید شرح
گزینه ها تنظیمات تنظیمات نام های gtag و dataLayer سفارشی.

برمی گرداند:

خالی

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