analytics package

حزمة تطوير البرامج (SDK) على الويب لخدمة "إحصاءات Firebase" لا تعمل حزمة تطوير البرامج (SDK) هذه في بيئة Node.js.

الدوال

واجهات

كتابة العناوين البديلة للبريد الإلكتروني

function(app, ...)

getAnalytics(app)

عرض مثيل إحصاءات Google للتطبيق المحدّد.

Signature:

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

المَعلمات

المرتجعات:

إحصاءات Google

startizeAnalytics(app, options)

عرض مثيل إحصاءات Google للتطبيق المحدّد.

Signature:

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

المَعلمات

المرتجعات:

إحصاءات Google

function(analyticsInstance, ...)

getGoogleAnalyticsClientId(analyticsInstance)

استرداد معرّف "إحصاءات Google" فريد لعميل الويب. اطّلِع على client_id.

Signature:

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

المَعلمات

المرتجعات:

وعود<string>

LogEvent(analyticsInstance, eventName, eventParams, options)

تُرسِل حدث "إحصاءات Google" مع eventParams المحدّد. تربط هذه الطريقة تلقائيًا هذا الحدث المُسجَّل بمثيل تطبيق الويب Firebase هذا على هذا الجهاز.

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

Signature:

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" مع eventParams المحدّد. تربط هذه الطريقة تلقائيًا هذا الحدث المُسجَّل بمثيل تطبيق الويب Firebase هذا على هذا الجهاز.

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

Signature:

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" مع eventParams المحدّد. تربط هذه الطريقة تلقائيًا هذا الحدث المُسجَّل بمثيل تطبيق الويب Firebase هذا على هذا الجهاز.

راجِع تتبُّع مشاهدات الصفحة في التطبيق.

Signature:

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" مع eventParams المحدّد. تربط هذه الطريقة تلقائيًا هذا الحدث المُسجَّل بمثيل تطبيق الويب Firebase هذا على هذا الجهاز.

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

Signature:

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" مع eventParams المحدّد. تربط هذه الطريقة تلقائيًا هذا الحدث المُسجَّل بمثيل تطبيق الويب Firebase هذا على هذا الجهاز.

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

Signature:

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" مع eventParams المحدّد. تربط هذه الطريقة تلقائيًا هذا الحدث المُسجَّل بمثيل تطبيق الويب Firebase هذا على هذا الجهاز.

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

Signature:

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" مع eventParams المحدّد. تربط هذه الطريقة تلقائيًا هذا الحدث المُسجَّل بمثيل تطبيق الويب Firebase هذا على هذا الجهاز.

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

Signature:

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" مع eventParams المحدّد. تربط هذه الطريقة تلقائيًا هذا الحدث المُسجَّل بمثيل تطبيق الويب Firebase هذا على هذا الجهاز.

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

Signature:

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" مع eventParams المحدّد. تربط هذه الطريقة تلقائيًا هذا الحدث المُسجَّل بمثيل تطبيق الويب Firebase هذا على هذا الجهاز.

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

Signature:

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" مع eventParams المحدّد. تربط هذه الطريقة تلقائيًا هذا الحدث المُسجَّل بمثيل تطبيق الويب Firebase هذا على هذا الجهاز.

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

Signature:

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" مع eventParams المحدّد. تربط هذه الطريقة تلقائيًا هذا الحدث المُسجَّل بمثيل تطبيق الويب Firebase هذا على هذا الجهاز.

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

Signature:

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" مع eventParams المحدّد. تربط هذه الطريقة تلقائيًا هذا الحدث المُسجَّل بمثيل تطبيق الويب Firebase هذا على هذا الجهاز.

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

Signature:

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" مع eventParams المحدّد. تربط هذه الطريقة تلقائيًا هذا الحدث المُسجَّل بمثيل تطبيق الويب Firebase هذا على هذا الجهاز.

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

Signature:

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" مع eventParams المحدّد. تربط هذه الطريقة تلقائيًا هذا الحدث المُسجَّل بمثيل تطبيق الويب Firebase هذا على هذا الجهاز.

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

Signature:

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" مع eventParams المحدّد. تربط هذه الطريقة تلقائيًا هذا الحدث المُسجَّل بمثيل تطبيق الويب Firebase هذا على هذا الجهاز.

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

Signature:

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" مع eventParams المحدّد. تربط هذه الطريقة تلقائيًا هذا الحدث المُسجَّل بمثيل تطبيق الويب Firebase هذا على هذا الجهاز.

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

Signature:

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" مع eventParams المحدّد. تربط هذه الطريقة تلقائيًا هذا الحدث المُسجَّل بمثيل تطبيق الويب Firebase هذا على هذا الجهاز.

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

Signature:

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" مع eventParams المحدّد. تربط هذه الطريقة تلقائيًا هذا الحدث المُسجَّل بمثيل تطبيق الويب Firebase هذا على هذا الجهاز.

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

Signature:

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" مع eventParams المحدّد. تربط هذه الطريقة تلقائيًا هذا الحدث المُسجَّل بمثيل تطبيق الويب Firebase هذا على هذا الجهاز.

راجِع قياس الاستثناءات.

Signature:

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" مع eventParams المحدّد. تربط هذه الطريقة تلقائيًا هذا الحدث المُسجَّل بمثيل تطبيق الويب Firebase هذا على هذا الجهاز.

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

Signature:

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" مع eventParams المحدّد. تربط هذه الطريقة تلقائيًا هذا الحدث المُسجَّل بمثيل تطبيق الويب Firebase هذا على هذا الجهاز.

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

Signature:

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

المَعلمات

المرتجعات:

فراغ

LogEvent(analyticsInstance, eventName, eventParams, options)

تُرسِل حدث "إحصاءات Google" مع eventParams المحدّد. تربط هذه الطريقة تلقائيًا هذا الحدث المُسجَّل بمثيل تطبيق الويب Firebase هذا على هذا الجهاز.

اطّلِع على مشاهدات الصفحة على الويب.

Signature:

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" لهذا التطبيق على هذا الجهاز. تضبط window['ga-disable-analyticsId'] = true; على مستوى العالم

Signature:

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

المَعلمات

المرتجعات:

فراغ

setCurrentscreen(analyticsInstance, screenName, options)

الاستخدام مع "eventName" كـ screen_view وإضافة eventParams ذات صلة راجِع تتبُّع مشاهدات الصفحة في التطبيق.

استخدِم الأمر gtag config لضبط screen_name.

Signature:

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

المَعلمات

المرتجعات:

فراغ

setUserId(analyticsInstance, id, options)

استخدِم الأمر gtag config لضبط user_id.

Signature:

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

المَعلمات

المرتجعات:

فراغ

setUserProperties(analyticsInstance, properties, options)

استخدِم الأمر gtag config لضبط كل المَعلمات المحدَّدة.

Signature:

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

المَعلمات

المرتجعات:

فراغ

الدالة()

issupported()

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

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

Signature:

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

المرتجعات:

Promise&lt;boolean&gt;

function(consentSettings, ...)

setConsent(consentSettings)

تضبط حالة موافقة المستخدِم النهائي السارية لتطبيق الويب هذا في جميع مراجع gtag بعد إعداد "إحصاءات Firebase".

استخدِم ConsentSettings لتحديد قيم أنواع الموافقة الفردية. يتم ضبط أنواع الموافقة تلقائيًا على "ممنوحة".

Signature:

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

المَعلمات

المرتجعات:

فراغ

function(customParams, ...)

setDefaultEventparams(customParams)

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

Signature:

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

المَعلمات

المرتجعات:

فراغ

الدالة(options, ...)

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

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

Signature:

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

المَعلمات

المرتجعات:

فراغ

ConsentStatusString

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

Signature:

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

العملة

نوع العملة العادي في "إحصاءات Google".

Signature:

export declare type Currency = string | number;

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

أيّ سلسلة اسم حدث مخصّص غير مدرَجة في القائمة العادية لأسماء الأحداث المقترَحة.

Signature:

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

سلسلة EventNameString

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

Signature:

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