analytics package

Das Firebase Analytics Web SDK. Dieses SDK funktioniert nicht in einer Node.js-Umgebung.

Funktionen

Funktion Beschreibung
Funktion(App, ...)
getAnalytics(App) Gibt eine Analytics- Instanz für die angegebene App zurück.
initializeAnalytics(app, Optionen) Gibt eine Analytics- Instanz für die angegebene App zurück.
Funktion(analyticsInstance, ...)
getGoogleAnalyticsClientId(analyticsInstance) Ruft eine eindeutige Google Analytics-ID für den Webclient ab. Siehe client_id .
logEvent(analyticsInstance, eventName, eventParams, Optionen) Sendet ein Google Analytics-Ereignis mit den angegebenen eventParams . Diese Methode ordnet dieses protokollierte Ereignis automatisch dieser Firebase-Web-App-Instanz auf diesem Gerät zu. Eine Liste der empfohlenen Ereignisparameter finden Sie in der GA4-Referenzdokumentation .
logEvent(analyticsInstance, eventName, eventParams, Optionen) Sendet ein Google Analytics-Ereignis mit den angegebenen eventParams . Diese Methode ordnet dieses protokollierte Ereignis automatisch dieser Firebase-Web-App-Instanz auf diesem Gerät zu. Eine Liste der empfohlenen Ereignisparameter finden Sie in der GA4-Referenzdokumentation .
logEvent(analyticsInstance, eventName, eventParams, Optionen) Sendet ein Google Analytics-Ereignis mit den angegebenen eventParams . Diese Methode ordnet dieses protokollierte Ereignis automatisch dieser Firebase-Web-App-Instanz auf diesem Gerät zu. Siehe Bildschirmaufrufe verfolgen .
logEvent(analyticsInstance, eventName, eventParams, Optionen) Sendet ein Google Analytics-Ereignis mit den angegebenen eventParams . Diese Methode ordnet dieses protokollierte Ereignis automatisch dieser Firebase-Web-App-Instanz auf diesem Gerät zu. Eine Liste der empfohlenen Ereignisparameter finden Sie in der GA4-Referenzdokumentation .
logEvent(analyticsInstance, eventName, eventParams, Optionen) Sendet ein Google Analytics-Ereignis mit den angegebenen eventParams . Diese Methode ordnet dieses protokollierte Ereignis automatisch dieser Firebase-Web-App-Instanz auf diesem Gerät zu. Eine Liste der empfohlenen Ereignisparameter finden Sie in der GA4-Referenzdokumentation .
logEvent(analyticsInstance, eventName, eventParams, Optionen) Sendet ein Google Analytics-Ereignis mit den angegebenen eventParams . Diese Methode ordnet dieses protokollierte Ereignis automatisch dieser Firebase-Web-App-Instanz auf diesem Gerät zu. Eine Liste der empfohlenen Ereignisparameter finden Sie in der GA4-Referenzdokumentation .
logEvent(analyticsInstance, eventName, eventParams, Optionen) Sendet ein Google Analytics-Ereignis mit den angegebenen eventParams . Diese Methode ordnet dieses protokollierte Ereignis automatisch dieser Firebase-Web-App-Instanz auf diesem Gerät zu. Eine Liste der empfohlenen Ereignisparameter finden Sie in der GA4-Referenzdokumentation .
logEvent(analyticsInstance, eventName, eventParams, Optionen) Sendet ein Google Analytics-Ereignis mit den angegebenen eventParams . Diese Methode ordnet dieses protokollierte Ereignis automatisch dieser Firebase-Web-App-Instanz auf diesem Gerät zu. Eine Liste der empfohlenen Ereignisparameter finden Sie in der GA4-Referenzdokumentation .
logEvent(analyticsInstance, eventName, eventParams, Optionen) Sendet ein Google Analytics-Ereignis mit den angegebenen eventParams . Diese Methode ordnet dieses protokollierte Ereignis automatisch dieser Firebase-Web-App-Instanz auf diesem Gerät zu. Eine Liste der empfohlenen Ereignisparameter finden Sie in der GA4-Referenzdokumentation .
logEvent(analyticsInstance, eventName, eventParams, Optionen) Sendet ein Google Analytics-Ereignis mit den angegebenen eventParams . Diese Methode ordnet dieses protokollierte Ereignis automatisch dieser Firebase-Web-App-Instanz auf diesem Gerät zu. Eine Liste der empfohlenen Ereignisparameter finden Sie in der GA4-Referenzdokumentation .
logEvent(analyticsInstance, eventName, eventParams, Optionen) Sendet ein Google Analytics-Ereignis mit den angegebenen eventParams . Diese Methode ordnet dieses protokollierte Ereignis automatisch dieser Firebase-Web-App-Instanz auf diesem Gerät zu. Eine Liste der empfohlenen Ereignisparameter finden Sie in der GA4-Referenzdokumentation .
logEvent(analyticsInstance, eventName, eventParams, Optionen) Sendet ein Google Analytics-Ereignis mit den angegebenen eventParams . Diese Methode ordnet dieses protokollierte Ereignis automatisch dieser Firebase-Web-App-Instanz auf diesem Gerät zu. Eine Liste der empfohlenen Ereignisparameter finden Sie in der GA4-Referenzdokumentation .
logEvent(analyticsInstance, eventName, eventParams, Optionen) Sendet ein Google Analytics-Ereignis mit den angegebenen eventParams . Diese Methode ordnet dieses protokollierte Ereignis automatisch dieser Firebase-Web-App-Instanz auf diesem Gerät zu. Eine Liste der empfohlenen Ereignisparameter finden Sie in der GA4-Referenzdokumentation .
logEvent(analyticsInstance, eventName, eventParams, Optionen) Sendet ein Google Analytics-Ereignis mit den angegebenen eventParams . Diese Methode ordnet dieses protokollierte Ereignis automatisch dieser Firebase-Web-App-Instanz auf diesem Gerät zu. Eine Liste der empfohlenen Ereignisparameter finden Sie in der GA4-Referenzdokumentation .
logEvent(analyticsInstance, eventName, eventParams, Optionen) Sendet ein Google Analytics-Ereignis mit den angegebenen eventParams . Diese Methode ordnet dieses protokollierte Ereignis automatisch dieser Firebase-Web-App-Instanz auf diesem Gerät zu. Eine Liste der empfohlenen Ereignisparameter finden Sie in der GA4-Referenzdokumentation .
logEvent(analyticsInstance, eventName, eventParams, Optionen) Sendet ein Google Analytics-Ereignis mit den angegebenen eventParams . Diese Methode ordnet dieses protokollierte Ereignis automatisch dieser Firebase-Web-App-Instanz auf diesem Gerät zu. Eine Liste der empfohlenen Ereignisparameter finden Sie in der GA4-Referenzdokumentation .
logEvent(analyticsInstance, eventName, eventParams, Optionen) Sendet ein Google Analytics-Ereignis mit den angegebenen eventParams . Diese Methode ordnet dieses protokollierte Ereignis automatisch dieser Firebase-Web-App-Instanz auf diesem Gerät zu. Eine Liste der empfohlenen Ereignisparameter finden Sie in der GA4-Referenzdokumentation .
logEvent(analyticsInstance, eventName, eventParams, Optionen) Sendet ein Google Analytics-Ereignis mit den angegebenen eventParams . Diese Methode ordnet dieses protokollierte Ereignis automatisch dieser Firebase-Web-App-Instanz auf diesem Gerät zu. Eine Liste der empfohlenen Ereignisparameter finden Sie in der GA4-Referenzdokumentation .
logEvent(analyticsInstance, eventName, eventParams, Optionen) Sendet ein Google Analytics-Ereignis mit den angegebenen eventParams . Diese Methode ordnet dieses protokollierte Ereignis automatisch dieser Firebase-Web-App-Instanz auf diesem Gerät zu. Siehe Messausnahmen .
logEvent(analyticsInstance, eventName, eventParams, Optionen) Sendet ein Google Analytics-Ereignis mit den angegebenen eventParams . Diese Methode ordnet dieses protokollierte Ereignis automatisch dieser Firebase-Web-App-Instanz auf diesem Gerät zu. Eine Liste der empfohlenen Ereignisparameter finden Sie in der GA4-Referenzdokumentation .
logEvent(analyticsInstance, eventName, eventParams, Optionen) Sendet ein Google Analytics-Ereignis mit den angegebenen eventParams . Diese Methode ordnet dieses protokollierte Ereignis automatisch dieser Firebase-Web-App-Instanz auf diesem Gerät zu. Eine Liste der empfohlenen Ereignisparameter finden Sie in der GA4-Referenzdokumentation .
logEvent(analyticsInstance, eventName, eventParams, Optionen) Sendet ein Google Analytics-Ereignis mit den angegebenen eventParams . Diese Methode ordnet dieses protokollierte Ereignis automatisch dieser Firebase-Web-App-Instanz auf diesem Gerät zu. Siehe Seitenaufrufe .
setAnalyticsCollectionEnabled(analyticsInstance, aktiviert) Legt fest, ob die Google Analytics-Erfassung für diese App auf diesem Gerät aktiviert ist. Setzt globales window['ga-disable-analyticsId'] = true;
setCurrentScreen(analyticsInstance, screenName, Optionen) Verwenden Sie den Befehl gtag config , um screen_name festzulegen.
setUserId(analyticsInstance, id, Optionen) Verwenden Sie den Befehl gtag config , um user_id festzulegen.
setUserProperties(analyticsInstance, Eigenschaften, Optionen) Verwenden Sie den Befehl gtag config , um alle angegebenen Parameter festzulegen.
Funktion()
wird unterstützt() Dies ist eine öffentliche statische Methode, die Benutzern zur Verfügung gestellt wird und vier verschiedene Prüfungen umfasst: 1. Überprüfen Sie, ob es sich nicht um eine Browser-Erweiterungsumgebung handelt. 2. Überprüfen Sie, ob Cookies im aktuellen Browser aktiviert sind. 3. Überprüfen Sie, ob IndexedDB von der Browserumgebung unterstützt wird. 4. Überprüfen Sie, ob der aktuelle Browserkontext für die Verwendung IndexedDB.open() gültig ist.
Funktion(consentSettings, ...)
setConsent(consentSettings) Legt den anwendbaren Zustimmungsstatus des Endbenutzers für diese Web-App für alle gtag-Referenzen fest, sobald Firebase Analytics initialisiert wird. Verwenden Sie ConsentSettings, um individuelle Werte für den Einwilligungstyp anzugeben. Standardmäßig sind die Einwilligungstypen auf „gewährt“ eingestellt.
Funktion(customParams, ...)
setDefaultEventParameters(customParams) Fügt Daten hinzu, die für jedes vom SDK protokollierte Ereignis festgelegt werden, einschließlich automatischer Ereignisse. Mit dem „set“-Befehl von gtag bleiben die übergebenen Werte auf der aktuellen Seite bestehen und werden bei allen nachfolgenden Ereignissen übergeben.
Funktion(Optionen, ...)
Einstellungen (Optionen) Konfiguriert Firebase Analytics für die Verwendung benutzerdefinierter gtag oder dataLayer -Namen. Soll verwendet werden, wenn gtag.js Skript unabhängig von Firebase Analytics auf dieser Seite installiert wurde und nicht standardmäßige Namen entweder für die gtag Funktion oder für dataLayer verwendet. Muss vor dem Aufruf getAnalytics() aufgerufen werden, sonst hat es keine Auswirkung.

Schnittstellen

Schnittstelle Beschreibung
Analytik Eine Instanz von Firebase Analytics.
AnalyticsCallOptions Zusätzliche Optionen, die an Analytics-Methodenaufrufe wie logEvent usw. übergeben werden können.
AnalyticsSettings Initialisierungsoptionen für Analytics- Instanzen.
Einwilligungseinstellungen Einwilligungsstatuseinstellungen für jeden Einwilligungstyp. Weitere Informationen finden Sie in der GA4-Referenzdokumentation zum Einwilligungsstatus und den Einwilligungstypen .
ControlParams Standard gtag.js Steuerungsparameter. Weitere Informationen finden Sie in der GA4-Referenzdokumentation .
BenutzerdefinierteParams Alle benutzerdefinierten Parameter, die der Benutzer an gtag übergeben kann.
EventParams Standard gtag.js -Ereignisparameter. Weitere Informationen finden Sie in der GA4-Referenzdokumentation .
GtagConfigParams Eine Reihe allgemeiner Google Analytics-Konfigurationseinstellungen, die von gtag.js erkannt werden.
Artikel Standard-Google Analytics- Item .
Förderung Feld, das zuvor von einigen Google Analytics-Ereignissen verwendet wurde.
EinstellungenOptionen Gibt benutzerdefinierte Optionen für Ihre Firebase Analytics-Instanz an. Sie müssen diese festlegen, bevor Sie firebase.analytics() initialisieren.

Geben Sie Aliase ein

Geben Sie Alias ​​ein Beschreibung
ConsentStatusString Ob eine bestimmte Einwilligungsart erteilt oder verweigert wurde.
Währung Standardwährungstyp von Google Analytics.
Benutzerdefinierter Ereignisname Jede benutzerdefinierte Ereignisnamenzeichenfolge, die nicht in der Standardliste der empfohlenen Ereignisnamen enthalten ist.
EventNameString Geben Sie Standardnamen für Google Analytics-Ereignisse ein. logEvent akzeptiert auch jede benutzerdefinierte Zeichenfolge und interpretiert sie als benutzerdefinierten Ereignisnamen.

Funktion(App, ...)

getAnalytics(App)

Gibt eine Analytics- Instanz für die angegebene App zurück.

Unterschrift:

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

Parameter

Parameter Typ Beschreibung
App FirebaseApp Die zu verwendende FirebaseApp .

Kehrt zurück:

Analytik

initializeAnalytics(app, Optionen)

Gibt eine Analytics- Instanz für die angegebene App zurück.

Unterschrift:

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

Parameter

Parameter Typ Beschreibung
App FirebaseApp Die zu verwendende FirebaseApp .
Optionen AnalyticsSettings

Kehrt zurück:

Analytik

Funktion(analyticsInstance, ...)

getGoogleAnalyticsClientId(analyticsInstance)

Ruft eine eindeutige Google Analytics-ID für den Webclient ab. Siehe client_id .

Unterschrift:

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

Parameter

Parameter Typ Beschreibung
AnalyticsInstanz Analytik

Kehrt zurück:

Versprechen<string>

logEvent(analyticsInstance, eventName, eventParams, Optionen)

Sendet ein Google Analytics-Ereignis mit angegebenen eventParams . Diese Methode ordnet dieses protokollierte Ereignis automatisch dieser Firebase-Web-App-Instanz auf diesem Gerät zu.

Eine Liste der empfohlenen Ereignisparameter finden Sie in der GA4-Referenzdokumentation .

Unterschrift:

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;

Parameter

Parameter Typ Beschreibung
AnalyticsInstanz Analytik
Veranstaltungsname 'add_paid_info'
eventParams { Gutschein?: EventParams ['Coupon']; Währung?: EventParams ['Währung']; Elemente?: EventParams ['Artikel']; payment_type?: EventParams ['Zahlungsart']; Wert?: EventParams ['Wert']; [Schlüssel: Zeichenfolge]: beliebig; }
Optionen AnalyticsCallOptions

Kehrt zurück:

Leere

logEvent(analyticsInstance, eventName, eventParams, Optionen)

Sendet ein Google Analytics-Ereignis mit angegebenen eventParams . Diese Methode ordnet dieses protokollierte Ereignis automatisch dieser Firebase-Web-App-Instanz auf diesem Gerät zu.

Eine Liste der empfohlenen Ereignisparameter finden Sie in der GA4-Referenzdokumentation .

Unterschrift:

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;

Parameter

Parameter Typ Beschreibung
AnalyticsInstanz Analytik
Veranstaltungsname 'Kauf' | 'Erstattung'
eventParams { Wert?: EventParams ['Wert']; Währung?: EventParams ['Währung']; Transaktions-ID: EventParams ['Transaktions-ID']; Steuer?: EventParams ['Steuer']; Versand?: EventParams ['Versand']; Elemente?: EventParams ['Artikel']; Gutschein?: EventParams ['Coupon']; Zugehörigkeit?: EventParams ['Zugehörigkeit']; [Schlüssel: Zeichenfolge]: beliebig; }
Optionen AnalyticsCallOptions

Kehrt zurück:

Leere

logEvent(analyticsInstance, eventName, eventParams, Optionen)

Sendet ein Google Analytics-Ereignis mit angegebenen eventParams . Diese Methode ordnet dieses protokollierte Ereignis automatisch dieser Firebase-Web-App-Instanz auf diesem Gerät zu.

Siehe Bildschirmaufrufe verfolgen .

Unterschrift:

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;

Parameter

Parameter Typ Beschreibung
AnalyticsInstanz Analytik
Veranstaltungsname 'screen_view'
eventParams { firebase_screen: EventParams ['firebase_screen']; firebase_screen_class: EventParams ['firebase_screen_class']; [Schlüssel: Zeichenfolge]: beliebig; }
Optionen AnalyticsCallOptions

Kehrt zurück:

Leere

logEvent(analyticsInstance, eventName, eventParams, Optionen)

Sendet ein Google Analytics-Ereignis mit angegebenen eventParams . Diese Methode ordnet dieses protokollierte Ereignis automatisch dieser Firebase-Web-App-Instanz auf diesem Gerät zu.

Eine Liste der empfohlenen Ereignisparameter finden Sie in der GA4-Referenzdokumentation .

Unterschrift:

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

Parameter

Parameter Typ Beschreibung
AnalyticsInstanz Analytik
Veranstaltungsname 'suchen' | 'view_search_results'
eventParams { search_term?: EventParams ['Suchbegriff']; [Schlüssel: Zeichenfolge]: beliebig; }
Optionen AnalyticsCallOptions

Kehrt zurück:

Leere

logEvent(analyticsInstance, eventName, eventParams, Optionen)

Sendet ein Google Analytics-Ereignis mit angegebenen eventParams . Diese Methode ordnet dieses protokollierte Ereignis automatisch dieser Firebase-Web-App-Instanz auf diesem Gerät zu.

Eine Liste der empfohlenen Ereignisparameter finden Sie in der GA4-Referenzdokumentation .

Unterschrift:

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;

Parameter

Parameter Typ Beschreibung
AnalyticsInstanz Analytik
Veranstaltungsname 'select_content'
eventParams { content_type?: EventParams ['Inhaltstyp']; item_id?: EventParams ['Artikel Identifikationsnummer']; [Schlüssel: Zeichenfolge]: beliebig; }
Optionen AnalyticsCallOptions

Kehrt zurück:

Leere

logEvent(analyticsInstance, eventName, eventParams, Optionen)

Sendet ein Google Analytics-Ereignis mit angegebenen eventParams . Diese Methode ordnet dieses protokollierte Ereignis automatisch dieser Firebase-Web-App-Instanz auf diesem Gerät zu.

Eine Liste der empfohlenen Ereignisparameter finden Sie in der GA4-Referenzdokumentation .

Unterschrift:

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;

Parameter

Parameter Typ Beschreibung
AnalyticsInstanz Analytik
Veranstaltungsname 'Menüpunkt wählen'
eventParams { Artikel?: EventParams ['Artikel']; item_list_name?: EventParams ['item_list_name']; item_list_id?: EventParams ['item_list_id']; [Schlüssel: Zeichenfolge]: beliebig; }
Optionen AnalyticsCallOptions

Kehrt zurück:

Leere

logEvent(analyticsInstance, eventName, eventParams, Optionen)

Sendet ein Google Analytics-Ereignis mit angegebenen eventParams . Diese Methode ordnet dieses protokollierte Ereignis automatisch dieser Firebase-Web-App-Instanz auf diesem Gerät zu.

Eine Liste der empfohlenen Ereignisparameter finden Sie in der GA4-Referenzdokumentation .

Unterschrift:

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;

Parameter

Parameter Typ Beschreibung
AnalyticsInstanz Analytik
Veranstaltungsname 'select_promotion' | 'view_promotion'
eventParams { Artikel?: EventParams ['Artikel']; Promotion_id?: EventParams ['promotion_id']; Aktionsname?: EventParams ['Aktionsname']; [Schlüssel: Zeichenfolge]: beliebig; }
Optionen AnalyticsCallOptions

Kehrt zurück:

Leere

logEvent(analyticsInstance, eventName, eventParams, Optionen)

Sendet ein Google Analytics-Ereignis mit angegebenen eventParams . Diese Methode ordnet dieses protokollierte Ereignis automatisch dieser Firebase-Web-App-Instanz auf diesem Gerät zu.

Eine Liste der empfohlenen Ereignisparameter finden Sie in der GA4-Referenzdokumentation .

Unterschrift:

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;

Parameter

Parameter Typ Beschreibung
AnalyticsInstanz Analytik
Veranstaltungsname 'set_checkout_option'
eventParams { checkout_step?: EventParams ['checkout_step']; checkout_option?: EventParams ['checkout_option']; [Schlüssel: Zeichenfolge]: beliebig; }
Optionen AnalyticsCallOptions

Kehrt zurück:

Leere

logEvent(analyticsInstance, eventName, eventParams, Optionen)

Sendet ein Google Analytics-Ereignis mit angegebenen eventParams . Diese Methode ordnet dieses protokollierte Ereignis automatisch dieser Firebase-Web-App-Instanz auf diesem Gerät zu.

Eine Liste der empfohlenen Ereignisparameter finden Sie in der GA4-Referenzdokumentation .

Unterschrift:

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;

Parameter

Parameter Typ Beschreibung
AnalyticsInstanz Analytik
Veranstaltungsname 'Aktie'
eventParams { Methode?: EventParams ['Methode']; content_type?: EventParams ['Inhaltstyp']; item_id?: EventParams ['Artikel Identifikationsnummer']; [Schlüssel: Zeichenfolge]: beliebig; }
Optionen AnalyticsCallOptions

Kehrt zurück:

Leere

logEvent(analyticsInstance, eventName, eventParams, Optionen)

Sendet ein Google Analytics-Ereignis mit angegebenen eventParams . Diese Methode ordnet dieses protokollierte Ereignis automatisch dieser Firebase-Web-App-Instanz auf diesem Gerät zu.

Eine Liste der empfohlenen Ereignisparameter finden Sie in der GA4-Referenzdokumentation .

Unterschrift:

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

Parameter

Parameter Typ Beschreibung
AnalyticsInstanz Analytik
Veranstaltungsname 'Melden Sie sich an'
eventParams { Methode?: EventParams ['Methode']; [Schlüssel: Zeichenfolge]: beliebig; }
Optionen AnalyticsCallOptions

Kehrt zurück:

Leere

logEvent(analyticsInstance, eventName, eventParams, Optionen)

Sendet ein Google Analytics-Ereignis mit angegebenen eventParams . Diese Methode ordnet dieses protokollierte Ereignis automatisch dieser Firebase-Web-App-Instanz auf diesem Gerät zu.

Eine Liste der empfohlenen Ereignisparameter finden Sie in der GA4-Referenzdokumentation .

Unterschrift:

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;

Parameter

Parameter Typ Beschreibung
AnalyticsInstanz Analytik
Veranstaltungsname 'timing_complete'
eventParams { Name: Zeichenfolge; Wert: Zahl; event_category?: string; event_label?: string; [Schlüssel: Zeichenfolge]: beliebig; }
Optionen AnalyticsCallOptions

Kehrt zurück:

Leere

logEvent(analyticsInstance, eventName, eventParams, Optionen)

Sendet ein Google Analytics-Ereignis mit angegebenen eventParams . Diese Methode ordnet dieses protokollierte Ereignis automatisch dieser Firebase-Web-App-Instanz auf diesem Gerät zu.

Eine Liste der empfohlenen Ereignisparameter finden Sie in der GA4-Referenzdokumentation .

Unterschrift:

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;

Parameter

Parameter Typ Beschreibung
AnalyticsInstanz Analytik
Veranstaltungsname 'add_shipping_info'
eventParams { Gutschein?: EventParams ['Coupon']; Währung?: EventParams ['Währung']; Elemente?: EventParams ['Artikel']; Shipping_tier?: EventParams ['shipping_tier']; Wert?: EventParams ['Wert']; [Schlüssel: Zeichenfolge]: beliebig; }
Optionen AnalyticsCallOptions

Kehrt zurück:

Leere

logEvent(analyticsInstance, eventName, eventParams, Optionen)

Sendet ein Google Analytics-Ereignis mit angegebenen eventParams . Diese Methode ordnet dieses protokollierte Ereignis automatisch dieser Firebase-Web-App-Instanz auf diesem Gerät zu.

Eine Liste der empfohlenen Ereignisparameter finden Sie in der GA4-Referenzdokumentation .

Unterschrift:

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;

Parameter

Parameter Typ Beschreibung
AnalyticsInstanz Analytik
Veranstaltungsname 'view_cart' | 'view_item'
eventParams { Währung?: EventParams ['Währung']; Elemente?: EventParams ['Artikel']; Wert?: EventParams ['Wert']; [Schlüssel: Zeichenfolge]: beliebig; }
Optionen AnalyticsCallOptions

Kehrt zurück:

Leere

logEvent(analyticsInstance, eventName, eventParams, Optionen)

Sendet ein Google Analytics-Ereignis mit angegebenen eventParams . Diese Methode ordnet dieses protokollierte Ereignis automatisch dieser Firebase-Web-App-Instanz auf diesem Gerät zu.

Eine Liste der empfohlenen Ereignisparameter finden Sie in der GA4-Referenzdokumentation .

Unterschrift:

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;

Parameter

Parameter Typ Beschreibung
AnalyticsInstanz Analytik
Veranstaltungsname 'view_item_list'
eventParams { Artikel?: EventParams ['Artikel']; item_list_name?: EventParams ['item_list_name']; item_list_id?: EventParams ['item_list_id']; [Schlüssel: Zeichenfolge]: beliebig; }
Optionen AnalyticsCallOptions

Kehrt zurück:

Leere

logEvent(analyticsInstance, eventName, eventParams, Optionen)

Sendet ein Google Analytics-Ereignis mit angegebenen eventParams . Diese Methode ordnet dieses protokollierte Ereignis automatisch dieser Firebase-Web-App-Instanz auf diesem Gerät zu.

Eine Liste der empfohlenen Ereignisparameter finden Sie in der GA4-Referenzdokumentation .

Unterschrift:

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

Parameter

Parameter Typ Beschreibung
AnalyticsInstanz Analytik
Veranstaltungsname Benutzerdefinierter Ereignisname <T>
eventParams { [key: string]: any; }
Optionen AnalyticsCallOptions

Kehrt zurück:

Leere

logEvent(analyticsInstance, eventName, eventParams, Optionen)

Sendet ein Google Analytics-Ereignis mit angegebenen eventParams . Diese Methode ordnet dieses protokollierte Ereignis automatisch dieser Firebase-Web-App-Instanz auf diesem Gerät zu.

Eine Liste der empfohlenen Ereignisparameter finden Sie in der GA4-Referenzdokumentation .

Unterschrift:

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;

Parameter

Parameter Typ Beschreibung
AnalyticsInstanz Analytik
Veranstaltungsname 'add_to_cart' | 'add_to_wishlist' | 'remove_from_cart'
eventParams { Währung?: EventParams ['Währung']; Wert?: EventParams ['Wert']; Elemente?: EventParams ['Artikel']; [Schlüssel: Zeichenfolge]: beliebig; }
Optionen AnalyticsCallOptions

Kehrt zurück:

Leere

logEvent(analyticsInstance, eventName, eventParams, Optionen)

Sendet ein Google Analytics-Ereignis mit angegebenen eventParams . Diese Methode ordnet dieses protokollierte Ereignis automatisch dieser Firebase-Web-App-Instanz auf diesem Gerät zu.

Eine Liste der empfohlenen Ereignisparameter finden Sie in der GA4-Referenzdokumentation .

Unterschrift:

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;

Parameter

Parameter Typ Beschreibung
AnalyticsInstanz Analytik
Veranstaltungsname 'begin_checkout'
eventParams { Währung?: EventParams ['Währung']; Gutschein?: EventParams ['Coupon']; Wert?: EventParams ['Wert']; Elemente?: EventParams ['Artikel']; [Schlüssel: Zeichenfolge]: beliebig; }
Optionen AnalyticsCallOptions

Kehrt zurück:

Leere

logEvent(analyticsInstance, eventName, eventParams, Optionen)

Sendet ein Google Analytics-Ereignis mit angegebenen eventParams . Diese Methode ordnet dieses protokollierte Ereignis automatisch dieser Firebase-Web-App-Instanz auf diesem Gerät zu.

Eine Liste der empfohlenen Ereignisparameter finden Sie in der GA4-Referenzdokumentation .

Unterschrift:

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;

Parameter

Parameter Typ Beschreibung
AnalyticsInstanz Analytik
Veranstaltungsname 'checkout_progress'
eventParams { Währung?: EventParams ['Währung']; Gutschein?: EventParams ['Coupon']; Wert?: EventParams ['Wert']; Elemente?: EventParams ['Artikel']; checkout_step?: EventParams ['checkout_step']; checkout_option?: EventParams ['checkout_option']; [Schlüssel: Zeichenfolge]: beliebig; }
Optionen AnalyticsCallOptions

Kehrt zurück:

Leere

logEvent(analyticsInstance, eventName, eventParams, Optionen)

Sendet ein Google Analytics-Ereignis mit angegebenen eventParams . Diese Methode ordnet dieses protokollierte Ereignis automatisch dieser Firebase-Web-App-Instanz auf diesem Gerät zu.

Siehe Messausnahmen .

Unterschrift:

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

Parameter

Parameter Typ Beschreibung
AnalyticsInstanz Analytik
Veranstaltungsname 'Ausnahme'
eventParams { Beschreibung?: EventParams ['Beschreibung']; fatal?: EventParams ['tödlich']; [Schlüssel: Zeichenfolge]: beliebig; }
Optionen AnalyticsCallOptions

Kehrt zurück:

Leere

logEvent(analyticsInstance, eventName, eventParams, Optionen)

Sendet ein Google Analytics-Ereignis mit angegebenen eventParams . Diese Methode ordnet dieses protokollierte Ereignis automatisch dieser Firebase-Web-App-Instanz auf diesem Gerät zu.

Eine Liste der empfohlenen Ereignisparameter finden Sie in der GA4-Referenzdokumentation .

Unterschrift:

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

Parameter

Parameter Typ Beschreibung
AnalyticsInstanz Analytik
Veranstaltungsname 'generate_lead'
eventParams { Wert?: EventParams ['Wert']; Währung?: EventParams ['Währung']; [Schlüssel: Zeichenfolge]: beliebig; }
Optionen AnalyticsCallOptions

Kehrt zurück:

Leere

logEvent(analyticsInstance, eventName, eventParams, Optionen)

Sendet ein Google Analytics-Ereignis mit angegebenen eventParams . Diese Methode ordnet dieses protokollierte Ereignis automatisch dieser Firebase-Web-App-Instanz auf diesem Gerät zu.

Eine Liste der empfohlenen Ereignisparameter finden Sie in der GA4-Referenzdokumentation .

Unterschrift:

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

Parameter

Parameter Typ Beschreibung
AnalyticsInstanz Analytik
Veranstaltungsname 'Anmeldung'
eventParams { Methode?: EventParams ['Methode']; [Schlüssel: Zeichenfolge]: beliebig; }
Optionen AnalyticsCallOptions

Kehrt zurück:

Leere

logEvent(analyticsInstance, eventName, eventParams, Optionen)

Sendet ein Google Analytics-Ereignis mit angegebenen eventParams . Diese Methode ordnet dieses protokollierte Ereignis automatisch dieser Firebase-Web-App-Instanz auf diesem Gerät zu.

Siehe Seitenaufrufe .

Unterschrift:

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;

Parameter

Parameter Typ Beschreibung
AnalyticsInstanz Analytik
Veranstaltungsname 'Seitenansicht'
eventParams { page_title?: string; page_location?: string; page_path?: string; [Schlüssel: Zeichenfolge]: beliebig; }
Optionen AnalyticsCallOptions

Kehrt zurück:

Leere

setAnalyticsCollectionEnabled(analyticsInstance, aktiviert)

Legt fest, ob die Google Analytics-Erfassung für diese App auf diesem Gerät aktiviert ist. Setzt globales window['ga-disable-analyticsId'] = true;

Unterschrift:

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

Parameter

Parameter Typ Beschreibung
AnalyticsInstanz Analytik Die Analytics- Instanz.
ermöglicht Boolescher Wert Bei „true“ wird die Erfassung aktiviert, bei „false“ wird sie deaktiviert.

Kehrt zurück:

Leere

setCurrentScreen(analyticsInstance, screenName, Optionen)

Verwenden Sie eventName als „screen_view“ und fügen Sie relevante eventParams hinzu . Siehe Bildschirmaufrufe verfolgen .

Verwenden Sie den Befehl gtag config , um screen_name festzulegen .

Unterschrift:

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

Parameter

Parameter Typ Beschreibung
AnalyticsInstanz Analytik Die Analytics- Instanz.
Künstlername Zeichenfolge Festzulegender Bildschirmname.
Optionen AnalyticsCallOptions

Kehrt zurück:

Leere

setUserId(analyticsInstance, id, Optionen)

Verwenden Sie den Befehl gtag config , um user_id festzulegen .

Unterschrift:

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

Parameter

Parameter Typ Beschreibung
AnalyticsInstanz Analytik Die Analytics- Instanz.
Ausweis Zeichenfolge | Null Benutzer-ID, die festgelegt werden soll.
Optionen AnalyticsCallOptions

Kehrt zurück:

Leere

setUserProperties(analyticsInstance, Eigenschaften, Optionen)

Verwenden Sie den Befehl gtag config , um alle angegebenen Parameter festzulegen.

Unterschrift:

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

Parameter

Parameter Typ Beschreibung
AnalyticsInstanz Analytik
Eigenschaften BenutzerdefinierteParams
Optionen AnalyticsCallOptions

Kehrt zurück:

Leere

Funktion()

wird unterstützt()

Dies ist eine öffentliche statische Methode, die Benutzern zur Verfügung gestellt wird und vier verschiedene Prüfungen umfasst:

  1. Überprüfen Sie, ob es sich nicht um eine Browser-Erweiterungsumgebung handelt. 2. Überprüfen Sie, ob Cookies im aktuellen Browser aktiviert sind. 3. Überprüfen Sie, ob IndexedDB von der Browserumgebung unterstützt wird. 4. Überprüfen Sie, ob der aktuelle Browserkontext für die Verwendung IndexedDB.open() gültig ist. .

Unterschrift:

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

Kehrt zurück:

Versprechen<boolean>

Funktion(consentSettings, ...)

setConsent(consentSettings)

Legt den anwendbaren Zustimmungsstatus des Endbenutzers für diese Web-App für alle gtag-Referenzen fest, sobald Firebase Analytics initialisiert wird.

Verwenden Sie ConsentSettings, um individuelle Werte für den Einwilligungstyp anzugeben. Standardmäßig sind die Einwilligungstypen auf „gewährt“ eingestellt.

Unterschrift:

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

Parameter

Parameter Typ Beschreibung
Einwilligungseinstellungen Einwilligungseinstellungen Ordnet den anwendbaren Zustimmungsstatus des Endbenutzers für gtag.js zu.

Kehrt zurück:

Leere

Funktion(customParams, ...)

setDefaultEventParameters(customParams)

Fügt Daten hinzu, die für jedes vom SDK protokollierte Ereignis festgelegt werden, einschließlich automatischer Ereignisse. Mit dem „set“-Befehl von gtag bleiben die übergebenen Werte auf der aktuellen Seite bestehen und werden bei allen nachfolgenden Ereignissen übergeben.

Unterschrift:

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

Parameter

Parameter Typ Beschreibung
benutzerdefinierteParams BenutzerdefinierteParams Alle benutzerdefinierten Parameter, die der Benutzer an gtag.js übergeben kann.

Kehrt zurück:

Leere

Funktion(Optionen, ...)

Einstellungen (Optionen)

Konfiguriert Firebase Analytics für die Verwendung benutzerdefinierter gtag oder dataLayer -Namen. Soll verwendet werden, wenn gtag.js Skript unabhängig von Firebase Analytics auf dieser Seite installiert wurde und nicht standardmäßige Namen entweder für die gtag Funktion oder für dataLayer verwendet . Muss vor dem Aufruf getAnalytics() aufgerufen werden, sonst hat es keine Auswirkung.

Unterschrift:

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

Parameter

Parameter Typ Beschreibung
Optionen EinstellungenOptionen Benutzerdefinierte gtag- und dataLayer-Namen.

Kehrt zurück:

Leere

ConsentStatusString

Ob eine bestimmte Einwilligungsart erteilt oder verweigert wurde.

Unterschrift:

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

Währung

Standardwährungstyp von Google Analytics.

Unterschrift:

export declare type Currency = string | number;

Benutzerdefinierter Ereignisname

Jede benutzerdefinierte Ereignisnamenzeichenfolge, die nicht in der Standardliste der empfohlenen Ereignisnamen enthalten ist.

Unterschrift:

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

EventNameString

Geben Sie Standardnamen für Google Analytics-Ereignisse ein. logEvent akzeptiert auch jede benutzerdefinierte Zeichenfolge und interpretiert sie als benutzerdefinierten Ereignisnamen.

Unterschrift:

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