analytics package

Firebase Analytics Web SDK. لا يعمل SDK هذا في بيئة Node.js.

المهام

وظيفة وصف
وظيفة (التطبيق، ...)
الحصول على التحليلات (التطبيق) إرجاع مثيل Analytics للتطبيق المحدد.
تهيئة التحليلات (التطبيق، الخيارات) إرجاع مثيل Analytics للتطبيق المحدد.
وظيفة (analyticsInstance، ...)
getGoogleAnalyticsClientId(analyticsInstance) يسترد معرف Google Analytics الفريد لعميل الويب. راجع معرف العميل .
logEvent(analyticsInstance,eventName,eventParams,options) يرسل حدث Google Analytics مع eventParams معين. تقوم هذه الطريقة تلقائيًا بربط هذا الحدث المسجل بمثيل تطبيق الويب Firebase هذا على هذا الجهاز. يمكن العثور على قائمة بمعلمات الأحداث الموصى بها في الوثائق المرجعية على "إحصاءات Google"‏ 4 .
logEvent(analyticsInstance,eventName,eventParams,options) يرسل حدث Google Analytics مع eventParams معين. تقوم هذه الطريقة تلقائيًا بربط هذا الحدث المسجل بمثيل تطبيق الويب Firebase هذا على هذا الجهاز. يمكن العثور على قائمة بمعلمات الأحداث الموصى بها في الوثائق المرجعية على "إحصاءات Google"‏ 4 .
logEvent(analyticsInstance,eventName,eventParams,options) يرسل حدث Google Analytics مع eventParams معين. تقوم هذه الطريقة تلقائيًا بربط هذا الحدث المسجل بمثيل تطبيق الويب Firebase هذا على هذا الجهاز. راجع تتبع مشاهدات الشاشة .
logEvent(analyticsInstance,eventName,eventParams,options) يرسل حدث Google Analytics مع eventParams معين. تقوم هذه الطريقة تلقائيًا بربط هذا الحدث المسجل بمثيل تطبيق الويب Firebase هذا على هذا الجهاز. يمكن العثور على قائمة بمعلمات الأحداث الموصى بها في الوثائق المرجعية على "إحصاءات Google"‏ 4 .
logEvent(analyticsInstance,eventName,eventParams,options) يرسل حدث Google Analytics مع eventParams معين. تقوم هذه الطريقة تلقائيًا بربط هذا الحدث المسجل بمثيل تطبيق الويب Firebase هذا على هذا الجهاز. يمكن العثور على قائمة بمعلمات الأحداث الموصى بها في الوثائق المرجعية على "إحصاءات Google"‏ 4 .
logEvent(analyticsInstance,eventName,eventParams,options) يرسل حدث Google Analytics مع eventParams معين. تقوم هذه الطريقة تلقائيًا بربط هذا الحدث المسجل بمثيل تطبيق الويب Firebase هذا على هذا الجهاز. يمكن العثور على قائمة بمعلمات الأحداث الموصى بها في الوثائق المرجعية على "إحصاءات Google"‏ 4 .
logEvent(analyticsInstance,eventName,eventParams,options) يرسل حدث Google Analytics مع eventParams معين. تقوم هذه الطريقة تلقائيًا بربط هذا الحدث المسجل بمثيل تطبيق الويب Firebase هذا على هذا الجهاز. يمكن العثور على قائمة بمعلمات الأحداث الموصى بها في الوثائق المرجعية على "إحصاءات Google"‏ 4 .
logEvent(analyticsInstance,eventName,eventParams,options) يرسل حدث Google Analytics مع eventParams معين. تقوم هذه الطريقة تلقائيًا بربط هذا الحدث المسجل بمثيل تطبيق الويب Firebase هذا على هذا الجهاز. يمكن العثور على قائمة بمعلمات الأحداث الموصى بها في الوثائق المرجعية على "إحصاءات Google"‏ 4 .
logEvent(analyticsInstance,eventName,eventParams,options) يرسل حدث Google Analytics مع eventParams معين. تقوم هذه الطريقة تلقائيًا بربط هذا الحدث المسجل بمثيل تطبيق الويب Firebase هذا على هذا الجهاز. يمكن العثور على قائمة بمعلمات الأحداث الموصى بها في الوثائق المرجعية على "إحصاءات Google"‏ 4 .
logEvent(analyticsInstance,eventName,eventParams,options) يرسل حدث Google Analytics مع eventParams معين. تقوم هذه الطريقة تلقائيًا بربط هذا الحدث المسجل بمثيل تطبيق الويب Firebase هذا على هذا الجهاز. يمكن العثور على قائمة بمعلمات الأحداث الموصى بها في الوثائق المرجعية على "إحصاءات Google"‏ 4 .
logEvent(analyticsInstance,eventName,eventParams,options) يرسل حدث Google Analytics مع eventParams معين. تقوم هذه الطريقة تلقائيًا بربط هذا الحدث المسجل بمثيل تطبيق الويب Firebase هذا على هذا الجهاز. يمكن العثور على قائمة بمعلمات الأحداث الموصى بها في الوثائق المرجعية على "إحصاءات Google"‏ 4 .
logEvent(analyticsInstance,eventName,eventParams,options) يرسل حدث Google Analytics مع eventParams معين. تقوم هذه الطريقة تلقائيًا بربط هذا الحدث المسجل بمثيل تطبيق الويب Firebase هذا على هذا الجهاز. يمكن العثور على قائمة بمعلمات الأحداث الموصى بها في الوثائق المرجعية على "إحصاءات Google"‏ 4 .
logEvent(analyticsInstance,eventName,eventParams,options) يرسل حدث Google Analytics مع eventParams معين. تقوم هذه الطريقة تلقائيًا بربط هذا الحدث المسجل بمثيل تطبيق الويب Firebase هذا على هذا الجهاز. يمكن العثور على قائمة بمعلمات الأحداث الموصى بها في الوثائق المرجعية على "إحصاءات Google"‏ 4 .
logEvent(analyticsInstance,eventName,eventParams,options) يرسل حدث Google Analytics مع eventParams معين. تقوم هذه الطريقة تلقائيًا بربط هذا الحدث المسجل بمثيل تطبيق الويب Firebase هذا على هذا الجهاز. يمكن العثور على قائمة بمعلمات الأحداث الموصى بها في الوثائق المرجعية على "إحصاءات Google"‏ 4 .
logEvent(analyticsInstance,eventName,eventParams,options) يرسل حدث Google Analytics مع eventParams معين. تقوم هذه الطريقة تلقائيًا بربط هذا الحدث المسجل بمثيل تطبيق الويب Firebase هذا على هذا الجهاز. يمكن العثور على قائمة بمعلمات الأحداث الموصى بها في الوثائق المرجعية على "إحصاءات Google"‏ 4 .
logEvent(analyticsInstance,eventName,eventParams,options) يرسل حدث Google Analytics مع eventParams معين. تقوم هذه الطريقة تلقائيًا بربط هذا الحدث المسجل بمثيل تطبيق الويب Firebase هذا على هذا الجهاز. يمكن العثور على قائمة بمعلمات الأحداث الموصى بها في الوثائق المرجعية على "إحصاءات Google"‏ 4 .
logEvent(analyticsInstance,eventName,eventParams,options) يرسل حدث Google Analytics مع eventParams معين. تقوم هذه الطريقة تلقائيًا بربط هذا الحدث المسجل بمثيل تطبيق الويب Firebase هذا على هذا الجهاز. يمكن العثور على قائمة بمعلمات الأحداث الموصى بها في الوثائق المرجعية على "إحصاءات Google"‏ 4 .
logEvent(analyticsInstance,eventName,eventParams,options) يرسل حدث Google Analytics مع eventParams معين. تقوم هذه الطريقة تلقائيًا بربط هذا الحدث المسجل بمثيل تطبيق الويب Firebase هذا على هذا الجهاز. يمكن العثور على قائمة بمعلمات الأحداث الموصى بها في الوثائق المرجعية على "إحصاءات Google"‏ 4 .
logEvent(analyticsInstance,eventName,eventParams,options) يرسل حدث Google Analytics مع eventParams معين. تقوم هذه الطريقة تلقائيًا بربط هذا الحدث المسجل بمثيل تطبيق الويب Firebase هذا على هذا الجهاز. راجع استثناءات القياس .
logEvent(analyticsInstance,eventName,eventParams,options) يرسل حدث Google Analytics مع eventParams معين. تقوم هذه الطريقة تلقائيًا بربط هذا الحدث المسجل بمثيل تطبيق الويب Firebase هذا على هذا الجهاز. يمكن العثور على قائمة بمعلمات الأحداث الموصى بها في الوثائق المرجعية على "إحصاءات Google"‏ 4 .
logEvent(analyticsInstance,eventName,eventParams,options) يرسل حدث Google Analytics مع eventParams معين. تقوم هذه الطريقة تلقائيًا بربط هذا الحدث المسجل بمثيل تطبيق الويب Firebase هذا على هذا الجهاز. يمكن العثور على قائمة بمعلمات الأحداث الموصى بها في الوثائق المرجعية على "إحصاءات Google"‏ 4 .
logEvent(analyticsInstance,eventName,eventParams,options) يرسل حدث Google Analytics مع eventParams معين. تقوم هذه الطريقة تلقائيًا بربط هذا الحدث المسجل بمثيل تطبيق الويب Firebase هذا على هذا الجهاز. راجع مشاهدات الصفحة .
setAnalyticsCollectionEnabled(analyticsInstance، ممكّن) يضبط ما إذا كان سيتم تمكين مجموعة Google Analytics لهذا التطبيق على هذا الجهاز. يضبط window['ga-disable-analyticsId'] = true;
setCurrentScreen(analyticsInstance، screenName، options) استخدم أمر gtag config لتعيين screen_name .
setUserId(analyticsInstance، id، options) استخدم أمر gtag config لتعيين user_id .
setUserProperties(analyticsInstance, Properties, options) استخدم أمر gtag config لتعيين جميع المعلمات المحددة.
وظيفة()
مدعوم() هذه طريقة ثابتة عامة مقدمة للمستخدمين والتي تتضمن أربعة اختبارات مختلفة: 1. تحقق مما إذا كانت بيئة امتداد المتصفح ليست كذلك. 2. تحقق من تمكين ملفات تعريف الارتباط في المتصفح الحالي. 3. تحقق مما إذا كانت IndexedDB مدعومة من بيئة المتصفح. 4. تحقق مما إذا كان سياق المتصفح الحالي صالحًا لاستخدام IndexedDB.open() .
وظيفة (إعدادات الموافقة، ...)
setConsent(consentSettings) لتعيين حالة موافقة المستخدم النهائي السارية لتطبيق الويب هذا عبر جميع مراجع gtag بمجرد تهيئة Firebase Analytics. استخدم إعدادات الموافقة لتحديد قيم نوع الموافقة الفردية. افتراضيًا، يتم تعيين أنواع الموافقة على "منحة".
وظيفة (customParams، ...)
setDefaultEventParameters(customParams) إضافة البيانات التي سيتم تعيينها في كل حدث يتم تسجيله من SDK، بما في ذلك الأحداث التلقائية. باستخدام أمر "set" الخاص بـ gtag، تظل القيم التي تم تمريرها موجودة في الصفحة الحالية ويتم تمريرها مع جميع الأحداث اللاحقة.
الوظيفة (الخيارات، ...)
الإعدادات (الخيارات) يقوم بتكوين Firebase Analytics لاستخدام أسماء gtag أو dataLayer المخصصة. يُقصد استخدامه في حالة تثبيت البرنامج النصي gtag.js على هذه الصفحة بشكل مستقل عن Firebase Analytics، ويستخدم أسماء غير افتراضية إما لوظيفة gtag أو لـ dataLayer . يجب استدعاؤه قبل استدعاء getAnalytics() وإلا فلن يكون له أي تأثير.

واجهات

واجهه المستخدم وصف
التحليلات مثال على Firebase Analytics.
تحليلاتCallOptions الخيارات الإضافية التي يمكن تمريرها إلى استدعاءات أسلوب Analytics مثل logEvent وما إلى ذلك.
إعدادات التحليلات خيارات تهيئة مثيل Analytics .
إعدادات الموافقة إعدادات حالة الموافقة لكل نوع موافقة. لمزيد من المعلومات، راجع وثائق "إحصاءات Google"‏ 4 المرجعية لحالة الموافقة وأنواع الموافقة .
ControlParams معلمات التحكم القياسية gtag.js لمزيد من المعلومات، راجع الوثائق المرجعية لـ "إحصاءات Google"‏ 4 .
CustomParams أي معلمات مخصصة قد يمررها المستخدم إلى gtag .
EventParams معلمات أحداث gtag.js القياسية. لمزيد من المعلومات، راجع الوثائق المرجعية لـ "إحصاءات Google"‏ 4 .
GtagConfigParams مجموعة من إعدادات تكوين Google Analytics الشائعة التي تم التعرف عليها بواسطة gtag.js .
غرض نوع Item Google Analytics القياسي.
ترقية الحقل المستخدم سابقًا بواسطة بعض أحداث Google Analytics.
خيارات الإعدادات يحدد الخيارات المخصصة لمثيل Firebase Analytics الخاص بك. يجب عليك ضبط هذه العناصر قبل تهيئة firebase.analytics() .

اكتب الأسماء المستعارة

اكتب الاسم المستعار وصف
سلسلة حالة الموافقة ما إذا كان قد تم منح نوع موافقة معين أو رفضه.
عملة نوع العملة القياسي في Google Analytics.
اسم الحدث المخصص أي سلسلة اسم حدث مخصصة غير موجودة في القائمة القياسية لأسماء الأحداث الموصى بها.
اسم الحدثسلسلة اكتب أسماء أحداث Google Analytics القياسية. يقبل logEvent أيضًا أي سلسلة مخصصة ويفسرها كاسم حدث مخصص.

وظيفة (التطبيق، ...)

الحصول على التحليلات (التطبيق)

إرجاع مثيل Analytics للتطبيق المحدد.

إمضاء:

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

حدود

معامل يكتب وصف
برنامج FirebaseApp FirebaseApp للاستخدام.

عائدات:

التحليلات

تهيئة التحليلات (التطبيق، الخيارات)

إرجاع مثيل Analytics للتطبيق المحدد.

إمضاء:

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

حدود

معامل يكتب وصف
برنامج FirebaseApp FirebaseApp للاستخدام.
خيارات إعدادات التحليلات

عائدات:

التحليلات

وظيفة (analyticsInstance، ...)

getGoogleAnalyticsClientId(analyticsInstance)

يسترد معرف Google Analytics الفريد لعميل الويب. راجع معرف العميل .

إمضاء:

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

حدود

معامل يكتب وصف
analyticsInstance التحليلات

عائدات:

وعد <سلسلة>

logEvent(analyticsInstance,eventName,eventParams,options)

يرسل حدث Google Analytics مع eventParams معين . تقوم هذه الطريقة تلقائيًا بربط هذا الحدث المسجل بمثيل تطبيق الويب Firebase هذا على هذا الجهاز.

يمكن العثور على قائمة بمعلمات الأحداث الموصى بها في الوثائق المرجعية على "إحصاءات Google"‏ 4 .

إمضاء:

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;

حدود

معامل يكتب وصف
analyticsInstance التحليلات
اسم الحدث "add_ Payment_info"
this.eventParams { قسيمة؟: EventParams ['قسيمة']; العملة؟: EventParams ['عملة']؛ العناصر؟: EventParams ['أغراض']؛ Payment_type ؟: EventParams ['نوع الدفع']؛ القيمة؟: EventParams ['قيمة']؛ [مفتاح: سلسلة]: أي؛ }
خيارات تحليلاتCallOptions

عائدات:

فارغ

logEvent(analyticsInstance,eventName,eventParams,options)

يرسل حدث Google Analytics مع eventParams معين . تقوم هذه الطريقة تلقائيًا بربط هذا الحدث المسجل بمثيل تطبيق الويب Firebase هذا على هذا الجهاز.

يمكن العثور على قائمة بمعلمات الأحداث الموصى بها في الوثائق المرجعية على "إحصاءات Google"‏ 4 .

إمضاء:

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;

حدود

معامل يكتب وصف
analyticsInstance التحليلات
اسم الحدث 'شراء' | 'استرداد'
this.eventParams { القيمة؟: EventParams ['قيمة']؛ العملة؟: EventParams ['عملة']؛ معرف_المعاملة: EventParams ['رقم المعاملة']؛ الضريبة ؟: EventParams ['ضريبة']؛ الشحن؟: EventParams ['شحن']؛ العناصر؟: EventParams ['أغراض']؛ قسيمة؟: EventParams ['قسيمة']; الانتماء؟: EventParams ['انتساب']؛ [مفتاح: سلسلة]: أي؛ }
خيارات تحليلاتCallOptions

عائدات:

فارغ

logEvent(analyticsInstance,eventName,eventParams,options)

يرسل حدث 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;

حدود

معامل يكتب وصف
analyticsInstance التحليلات
اسم الحدث "عرض_الشاشة"
this.eventParams {firebase_screen: EventParams ["firebase_screen"]؛ firebase_screen_class: EventParams ['firebase_screen_class']؛ [مفتاح: سلسلة]: أي؛ }
خيارات تحليلاتCallOptions

عائدات:

فارغ

logEvent(analyticsInstance,eventName,eventParams,options)

يرسل حدث Google Analytics مع eventParams معين . تقوم هذه الطريقة تلقائيًا بربط هذا الحدث المسجل بمثيل تطبيق الويب Firebase هذا على هذا الجهاز.

يمكن العثور على قائمة بمعلمات الأحداث الموصى بها في الوثائق المرجعية على "إحصاءات Google"‏ 4 .

إمضاء:

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

حدود

معامل يكتب وصف
analyticsInstance التحليلات
اسم الحدث 'بحث' | "view_search_results"
this.eventParams { search_term ؟: EventParams ['مصطلح البحث']؛ [مفتاح: سلسلة]: أي؛ }
خيارات تحليلاتCallOptions

عائدات:

فارغ

logEvent(analyticsInstance,eventName,eventParams,options)

يرسل حدث Google Analytics مع eventParams معين . تقوم هذه الطريقة تلقائيًا بربط هذا الحدث المسجل بمثيل تطبيق الويب Firebase هذا على هذا الجهاز.

يمكن العثور على قائمة بمعلمات الأحداث الموصى بها في الوثائق المرجعية على "إحصاءات Google"‏ 4 .

إمضاء:

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;

حدود

معامل يكتب وصف
analyticsInstance التحليلات
اسم الحدث "select_content"
this.eventParams { content_type؟: EventParams ['نوع المحتوى']؛ item_id?: EventParams ['item_id']; [مفتاح: سلسلة]: أي؛ }
خيارات تحليلاتCallOptions

عائدات:

فارغ

logEvent(analyticsInstance,eventName,eventParams,options)

يرسل حدث Google Analytics مع eventParams معين . تقوم هذه الطريقة تلقائيًا بربط هذا الحدث المسجل بمثيل تطبيق الويب Firebase هذا على هذا الجهاز.

يمكن العثور على قائمة بمعلمات الأحداث الموصى بها في الوثائق المرجعية على "إحصاءات Google"‏ 4 .

إمضاء:

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;

حدود

معامل يكتب وصف
analyticsInstance التحليلات
اسم الحدث "اختر_العنصر"
this.eventParams { العناصر ؟: EventParams ['أغراض']؛ item_list_name?: EventParams ['item_list_name']; item_list_id?: EventParams ['item_list_id']; [مفتاح: سلسلة]: أي؛ }
خيارات تحليلاتCallOptions

عائدات:

فارغ

logEvent(analyticsInstance,eventName,eventParams,options)

يرسل حدث Google Analytics مع eventParams معين . تقوم هذه الطريقة تلقائيًا بربط هذا الحدث المسجل بمثيل تطبيق الويب Firebase هذا على هذا الجهاز.

يمكن العثور على قائمة بمعلمات الأحداث الموصى بها في الوثائق المرجعية على "إحصاءات Google"‏ 4 .

إمضاء:

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;

حدود

معامل يكتب وصف
analyticsInstance التحليلات
اسم الحدث 'select_promotion' | "عرض_الترويج"
this.eventParams { العناصر ؟: EventParams ['أغراض']؛ Promotion_id?: EventParams ['promotion_id']; اسم الترويج؟: EventParams ["اسم_الترويج"]; [مفتاح: سلسلة]: أي؛ }
خيارات تحليلاتCallOptions

عائدات:

فارغ

logEvent(analyticsInstance,eventName,eventParams,options)

يرسل حدث Google Analytics مع eventParams معين . تقوم هذه الطريقة تلقائيًا بربط هذا الحدث المسجل بمثيل تطبيق الويب Firebase هذا على هذا الجهاز.

يمكن العثور على قائمة بمعلمات الأحداث الموصى بها في الوثائق المرجعية على "إحصاءات Google"‏ 4 .

إمضاء:

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;

حدود

معامل يكتب وصف
analyticsInstance التحليلات
اسم الحدث "set_checkout_option"
this.eventParams { checkout_step?: EventParams ['checkout_step']; checkout_option?: EventParams ['checkout_option']; [مفتاح: سلسلة]: أي؛ }
خيارات تحليلاتCallOptions

عائدات:

فارغ

logEvent(analyticsInstance,eventName,eventParams,options)

يرسل حدث Google Analytics مع eventParams معين . تقوم هذه الطريقة تلقائيًا بربط هذا الحدث المسجل بمثيل تطبيق الويب Firebase هذا على هذا الجهاز.

يمكن العثور على قائمة بمعلمات الأحداث الموصى بها في الوثائق المرجعية على "إحصاءات Google"‏ 4 .

إمضاء:

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;

حدود

معامل يكتب وصف
analyticsInstance التحليلات
اسم الحدث 'يشارك'
this.eventParams { الطريقة ؟: EventParams ['طريقة']؛ content_type ؟: EventParams ['نوع المحتوى']؛ item_id?: EventParams ['item_id']; [مفتاح: سلسلة]: أي؛ }
خيارات تحليلاتCallOptions

عائدات:

فارغ

logEvent(analyticsInstance,eventName,eventParams,options)

يرسل حدث Google Analytics مع eventParams معين . تقوم هذه الطريقة تلقائيًا بربط هذا الحدث المسجل بمثيل تطبيق الويب Firebase هذا على هذا الجهاز.

يمكن العثور على قائمة بمعلمات الأحداث الموصى بها في الوثائق المرجعية على "إحصاءات Google"‏ 4 .

إمضاء:

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

حدود

معامل يكتب وصف
analyticsInstance التحليلات
اسم الحدث 'اشتراك'
this.eventParams { الطريقة ؟: EventParams ['طريقة']؛ [مفتاح: سلسلة]: أي؛ }
خيارات تحليلاتCallOptions

عائدات:

فارغ

logEvent(analyticsInstance,eventName,eventParams,options)

يرسل حدث Google Analytics مع eventParams معين . تقوم هذه الطريقة تلقائيًا بربط هذا الحدث المسجل بمثيل تطبيق الويب Firebase هذا على هذا الجهاز.

يمكن العثور على قائمة بمعلمات الأحداث الموصى بها في الوثائق المرجعية على "إحصاءات Google"‏ 4 .

إمضاء:

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;

حدود

معامل يكتب وصف
analyticsInstance التحليلات
اسم الحدث "التوقيت_مكتمل"
this.eventParams { الاسم: سلسلة؛ القيمة: رقم؛ فئة_الحدث؟: سلسلة؛ Event_label ؟: سلسلة؛ [مفتاح: سلسلة]: أي؛ }
خيارات تحليلاتCallOptions

عائدات:

فارغ

logEvent(analyticsInstance,eventName,eventParams,options)

يرسل حدث Google Analytics مع eventParams معين . تقوم هذه الطريقة تلقائيًا بربط هذا الحدث المسجل بمثيل تطبيق الويب Firebase هذا على هذا الجهاز.

يمكن العثور على قائمة بمعلمات الأحداث الموصى بها في الوثائق المرجعية على "إحصاءات Google"‏ 4 .

إمضاء:

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;

حدود

معامل يكتب وصف
analyticsInstance التحليلات
اسم الحدث "add_shipping_info"
this.eventParams { قسيمة؟: EventParams ['قسيمة']; العملة؟: EventParams ['عملة']؛ العناصر؟: EventParams ['أغراض']؛ Shipping_tier ؟: EventParams ['مستوى_الشحن']; القيمة؟: EventParams ['قيمة']؛ [مفتاح: سلسلة]: أي؛ }
خيارات تحليلاتCallOptions

عائدات:

فارغ

logEvent(analyticsInstance,eventName,eventParams,options)

يرسل حدث Google Analytics مع eventParams معين . تقوم هذه الطريقة تلقائيًا بربط هذا الحدث المسجل بمثيل تطبيق الويب Firebase هذا على هذا الجهاز.

يمكن العثور على قائمة بمعلمات الأحداث الموصى بها في الوثائق المرجعية على "إحصاءات Google"‏ 4 .

إمضاء:

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;

حدود

معامل يكتب وصف
analyticsInstance التحليلات
اسم الحدث 'view_cart' | "عرض_العنصر"
this.eventParams { العملة ؟: EventParams ['عملة']؛ العناصر؟: EventParams ['أغراض']؛ القيمة؟: EventParams ['قيمة']؛ [مفتاح: سلسلة]: أي؛ }
خيارات تحليلاتCallOptions

عائدات:

فارغ

logEvent(analyticsInstance,eventName,eventParams,options)

يرسل حدث Google Analytics مع eventParams معين . تقوم هذه الطريقة تلقائيًا بربط هذا الحدث المسجل بمثيل تطبيق الويب Firebase هذا على هذا الجهاز.

يمكن العثور على قائمة بمعلمات الأحداث الموصى بها في الوثائق المرجعية على "إحصاءات Google"‏ 4 .

إمضاء:

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;

حدود

معامل يكتب وصف
analyticsInstance التحليلات
اسم الحدث "view_item_list"
this.eventParams { العناصر ؟: EventParams ['أغراض']؛ item_list_name?: EventParams ['item_list_name']; item_list_id?: EventParams ['item_list_id']; [مفتاح: سلسلة]: أي؛ }
خيارات تحليلاتCallOptions

عائدات:

فارغ

logEvent(analyticsInstance,eventName,eventParams,options)

يرسل حدث Google Analytics مع eventParams معين . تقوم هذه الطريقة تلقائيًا بربط هذا الحدث المسجل بمثيل تطبيق الويب Firebase هذا على هذا الجهاز.

يمكن العثور على قائمة بمعلمات الأحداث الموصى بها في الوثائق المرجعية على "إحصاءات Google"‏ 4 .

إمضاء:

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

حدود

معامل يكتب وصف
analyticsInstance التحليلات
اسم الحدث اسم الحدث المخصص <ت>
this.eventParams { [مفتاح: سلسلة]: أي؛ }
خيارات تحليلاتCallOptions

عائدات:

فارغ

logEvent(analyticsInstance,eventName,eventParams,options)

يرسل حدث Google Analytics مع eventParams معين . تقوم هذه الطريقة تلقائيًا بربط هذا الحدث المسجل بمثيل تطبيق الويب Firebase هذا على هذا الجهاز.

يمكن العثور على قائمة بمعلمات الأحداث الموصى بها في الوثائق المرجعية على "إحصاءات Google"‏ 4 .

إمضاء:

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;

حدود

معامل يكتب وصف
analyticsInstance التحليلات
اسم الحدث 'add_to_cart' | 'add_to_wishlist' | "إزالة_من_العربة"
this.eventParams { العملة ؟: EventParams ['عملة']؛ القيمة؟: EventParams ['قيمة']؛ العناصر؟: EventParams ['أغراض']؛ [مفتاح: سلسلة]: أي؛ }
خيارات تحليلاتCallOptions

عائدات:

فارغ

logEvent(analyticsInstance,eventName,eventParams,options)

يرسل حدث Google Analytics مع eventParams معين . تقوم هذه الطريقة تلقائيًا بربط هذا الحدث المسجل بمثيل تطبيق الويب Firebase هذا على هذا الجهاز.

يمكن العثور على قائمة بمعلمات الأحداث الموصى بها في الوثائق المرجعية على "إحصاءات Google"‏ 4 .

إمضاء:

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;

حدود

معامل يكتب وصف
analyticsInstance التحليلات
اسم الحدث 'بدء الخروج'
this.eventParams { العملة ؟: EventParams ['عملة']؛ قسيمة؟: EventParams ['قسيمة']; القيمة؟: EventParams ['قيمة']؛ العناصر؟: EventParams ['أغراض']؛ [مفتاح: سلسلة]: أي؛ }
خيارات تحليلاتCallOptions

عائدات:

فارغ

logEvent(analyticsInstance,eventName,eventParams,options)

يرسل حدث Google Analytics مع eventParams معين . تقوم هذه الطريقة تلقائيًا بربط هذا الحدث المسجل بمثيل تطبيق الويب Firebase هذا على هذا الجهاز.

يمكن العثور على قائمة بمعلمات الأحداث الموصى بها في الوثائق المرجعية على "إحصاءات Google"‏ 4 .

إمضاء:

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;

حدود

معامل يكتب وصف
analyticsInstance التحليلات
اسم الحدث "الخروج_التقدم"
this.eventParams { العملة ؟: EventParams ['عملة']؛ قسيمة؟: EventParams ['قسيمة']; القيمة؟: EventParams ['قيمة']؛ العناصر؟: EventParams ['أغراض']؛ checkout_step?: EventParams ['checkout_step']; checkout_option?: EventParams ['checkout_option']; [مفتاح: سلسلة]: أي؛ }
خيارات تحليلاتCallOptions

عائدات:

فارغ

logEvent(analyticsInstance,eventName,eventParams,options)

يرسل حدث 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;

حدود

معامل يكتب وصف
analyticsInstance التحليلات
اسم الحدث 'استثناء'
this.eventParams { الوصف؟: EventParams ['وصف']؛ قاتلة؟: EventParams ['مميت']؛ [مفتاح: سلسلة]: أي؛ }
خيارات تحليلاتCallOptions

عائدات:

فارغ

logEvent(analyticsInstance,eventName,eventParams,options)

يرسل حدث Google Analytics مع eventParams معين . تقوم هذه الطريقة تلقائيًا بربط هذا الحدث المسجل بمثيل تطبيق الويب Firebase هذا على هذا الجهاز.

يمكن العثور على قائمة بمعلمات الأحداث الموصى بها في الوثائق المرجعية على "إحصاءات Google"‏ 4 .

إمضاء:

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

حدود

معامل يكتب وصف
analyticsInstance التحليلات
اسم الحدث "إنشاء_الرصاص"
this.eventParams { القيمة؟: EventParams ['قيمة']؛ العملة؟: EventParams ['عملة']؛ [مفتاح: سلسلة]: أي؛ }
خيارات تحليلاتCallOptions

عائدات:

فارغ

logEvent(analyticsInstance,eventName,eventParams,options)

يرسل حدث Google Analytics مع eventParams معين . تقوم هذه الطريقة تلقائيًا بربط هذا الحدث المسجل بمثيل تطبيق الويب Firebase هذا على هذا الجهاز.

يمكن العثور على قائمة بمعلمات الأحداث الموصى بها في الوثائق المرجعية على "إحصاءات Google"‏ 4 .

إمضاء:

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

حدود

معامل يكتب وصف
analyticsInstance التحليلات
اسم الحدث 'تسجيل الدخول'
this.eventParams { الطريقة ؟: EventParams ['طريقة']؛ [مفتاح: سلسلة]: أي؛ }
خيارات تحليلاتCallOptions

عائدات:

فارغ

logEvent(analyticsInstance,eventName,eventParams,options)

يرسل حدث 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;

حدود

معامل يكتب وصف
analyticsInstance التحليلات
اسم الحدث "page_view"
this.eventParams {page_title؟: سلسلة؛ page_location؟: سلسلة؛ page_path ؟: سلسلة؛ [مفتاح: سلسلة]: أي؛ }
خيارات تحليلاتCallOptions

عائدات:

فارغ

setAnalyticsCollectionEnabled(analyticsInstance، ممكّن)

يضبط ما إذا كان سيتم تمكين مجموعة Google Analytics لهذا التطبيق على هذا الجهاز. يضبط window['ga-disable-analyticsId'] = true;

إمضاء:

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

حدود

معامل يكتب وصف
analyticsInstance التحليلات مثيل التحليلات .
ممكّن منطقية إذا كان صحيحًا، فسيتم تمكين التجميع، وإذا كان خطأ، فسيتم تعطيله.

عائدات:

فارغ

setCurrentScreen(analyticsInstance، screenName، options)

استخدمه مع eventName كـ "screen_view" وأضف eventParams ذات الصلة . راجع تتبع مشاهدات الشاشة .

استخدم أمر gtag config لتعيين screen_name .

إمضاء:

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

حدود

معامل يكتب وصف
analyticsInstance التحليلات مثيل التحليلات .
الاسم الذي سيظهر خيط اسم الشاشة المراد ضبطه.
خيارات تحليلاتCallOptions

عائدات:

فارغ

setUserId(analyticsInstance، id، options)

استخدم أمر gtag config لتعيين user_id .

إمضاء:

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

حدود

معامل يكتب وصف
analyticsInstance التحليلات مثيل التحليلات .
بطاقة تعريف سلسلة | باطل معرف المستخدم لتعيين.
خيارات تحليلاتCallOptions

عائدات:

فارغ

setUserProperties(analyticsInstance, Properties, options)

استخدم أمر gtag config لتعيين جميع المعلمات المحددة.

إمضاء:

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

حدود

معامل يكتب وصف
analyticsInstance التحليلات
ملكيات CustomParams
خيارات تحليلاتCallOptions

عائدات:

فارغ

وظيفة()

مدعوم()

هذه طريقة ثابتة عامة مقدمة للمستخدمين والتي تتضمن أربعة اختبارات مختلفة:

  1. تحقق مما إذا كانت ليست بيئة امتداد للمتصفح. 2. تحقق من تمكين ملفات تعريف الارتباط في المتصفح الحالي. 3. تحقق مما إذا كانت IndexedDB مدعومة من بيئة المتصفح. 4. تحقق مما إذا كان سياق المتصفح الحالي صالحًا لاستخدام IndexedDB.open() .

إمضاء:

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

عائدات:

وعد <منطقي>

وظيفة (إعدادات الموافقة، ...)

setConsent(consentSettings)

لتعيين حالة موافقة المستخدم النهائي السارية لتطبيق الويب هذا عبر جميع مراجع gtag بمجرد تهيئة Firebase Analytics.

استخدم إعدادات الموافقة لتحديد قيم نوع الموافقة الفردية. افتراضيًا، يتم تعيين أنواع الموافقة على "منحة".

إمضاء:

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

حدود

معامل يكتب وصف
إعدادات الموافقة إعدادات الموافقة يحدّد حالة موافقة المستخدم السارية على gtag.js.

عائدات:

فارغ

وظيفة (customParams، ...)

setDefaultEventParameters(customParams)

إضافة البيانات التي سيتم تعيينها في كل حدث يتم تسجيله من SDK، بما في ذلك الأحداث التلقائية. باستخدام أمر "set" الخاص بـ gtag، تظل القيم التي تم تمريرها موجودة في الصفحة الحالية ويتم تمريرها مع جميع الأحداث اللاحقة.

إمضاء:

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

حدود

معامل يكتب وصف
customParams CustomParams أي معلمات مخصصة قد يمررها المستخدم إلى gtag.js.

عائدات:

فارغ

الوظيفة (الخيارات، ...)

الإعدادات (الخيارات)

يقوم بتكوين Firebase Analytics لاستخدام أسماء gtag أو dataLayer المخصصة. مخصص للاستخدام في حالة تثبيت البرنامج النصي gtag.js على هذه الصفحة بشكل مستقل عن Firebase Analytics، ويستخدم أسماء غير افتراضية إما لوظيفة gtag أو dataLayer . يجب استدعاؤه قبل استدعاء getAnalytics() وإلا فلن يكون له أي تأثير.

إمضاء:

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

حدود

معامل يكتب وصف
خيارات خيارات الإعدادات أسماء gtag وdataLayer المخصصة.

عائدات:

فارغ

سلسلة حالة الموافقة

ما إذا كان قد تم منح نوع موافقة معين أو رفضه.

إمضاء:

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

عملة

نوع العملة القياسي في Google Analytics.

إمضاء:

export declare type Currency = string | number;

اسم الحدث المخصص

أي سلسلة اسم حدث مخصصة غير موجودة في القائمة القياسية لأسماء الأحداث الموصى بها.

إمضاء:

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

اسم الحدثسلسلة

اكتب أسماء أحداث 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';