analytics package

pakietu SDK internetowego Firebase Analytics. Ten pakiet SDK nie działa w środowisku Node.js.

Funkcje

Funkcja Opis
function(aplikacja, ...)
getAnalytics(aplikacja) Zwraca wystąpienie Analytics dla danej aplikacji.
initializeAnalytics(aplikacja, opcje) Zwraca wystąpienie Analytics dla danej aplikacji.
function(analyticsInstance, ...)
getGoogleAnalyticsClientId(analyticsInstance) Pobiera unikalny identyfikator Google Analytics dla klienta internetowego. Patrz client_id.
logEvent(analyticsInstance, eventName, eventParams, options) Wysyła zdarzenie Google Analytics o podanej wartości eventParams. Ta metoda automatycznie wiąże to zarejestrowane zdarzenie z wystąpieniem aplikacji internetowej Firebase na tym urządzeniu.Listę zalecanych parametrów zdarzeń znajdziesz w dokumentacji GA4.
logEvent(analyticsInstance, eventName, eventParams, options) Wysyła zdarzenie Google Analytics o podanej wartości eventParams. Ta metoda automatycznie wiąże to zarejestrowane zdarzenie z wystąpieniem aplikacji internetowej Firebase na tym urządzeniu.Listę zalecanych parametrów zdarzeń znajdziesz w dokumentacji GA4.
logEvent(analyticsInstance, eventName, eventParams, options) Wysyła zdarzenie Google Analytics o podanej wartości eventParams. Ta metoda automatycznie wiąże to zarejestrowane zdarzenie z wystąpieniem aplikacji internetowej Firebase na tym urządzeniu.Zobacz Śledzenie wyświetleń ekranu.
logEvent(analyticsInstance, eventName, eventParams, options) Wysyła zdarzenie Google Analytics o podanej wartości eventParams. Ta metoda automatycznie wiąże to zarejestrowane zdarzenie z wystąpieniem aplikacji internetowej Firebase na tym urządzeniu.Listę zalecanych parametrów zdarzeń znajdziesz w dokumentacji GA4.
logEvent(analyticsInstance, eventName, eventParams, options) Wysyła zdarzenie Google Analytics o podanej wartości eventParams. Ta metoda automatycznie wiąże to zarejestrowane zdarzenie z wystąpieniem aplikacji internetowej Firebase na tym urządzeniu.Listę zalecanych parametrów zdarzeń znajdziesz w dokumentacji GA4.
logEvent(analyticsInstance, eventName, eventParams, options) Wysyła zdarzenie Google Analytics o podanej wartości eventParams. Ta metoda automatycznie wiąże to zarejestrowane zdarzenie z wystąpieniem aplikacji internetowej Firebase na tym urządzeniu.Listę zalecanych parametrów zdarzeń znajdziesz w dokumentacji GA4.
logEvent(analyticsInstance, eventName, eventParams, options) Wysyła zdarzenie Google Analytics o podanej wartości eventParams. Ta metoda automatycznie wiąże to zarejestrowane zdarzenie z wystąpieniem aplikacji internetowej Firebase na tym urządzeniu.Listę zalecanych parametrów zdarzeń znajdziesz w dokumentacji GA4.
logEvent(analyticsInstance, eventName, eventParams, options) Wysyła zdarzenie Google Analytics o podanej wartości eventParams. Ta metoda automatycznie wiąże to zarejestrowane zdarzenie z wystąpieniem aplikacji internetowej Firebase na tym urządzeniu.Listę zalecanych parametrów zdarzeń znajdziesz w dokumentacji GA4.
logEvent(analyticsInstance, eventName, eventParams, options) Wysyła zdarzenie Google Analytics o podanej wartości eventParams. Ta metoda automatycznie wiąże to zarejestrowane zdarzenie z wystąpieniem aplikacji internetowej Firebase na tym urządzeniu.Listę zalecanych parametrów zdarzeń znajdziesz w dokumentacji GA4.
logEvent(analyticsInstance, eventName, eventParams, options) Wysyła zdarzenie Google Analytics o podanej wartości eventParams. Ta metoda automatycznie wiąże to zarejestrowane zdarzenie z wystąpieniem aplikacji internetowej Firebase na tym urządzeniu.Listę zalecanych parametrów zdarzeń znajdziesz w dokumentacji GA4.
logEvent(analyticsInstance, eventName, eventParams, options) Wysyła zdarzenie Google Analytics o podanej wartości eventParams. Ta metoda automatycznie wiąże to zarejestrowane zdarzenie z wystąpieniem aplikacji internetowej Firebase na tym urządzeniu.Listę zalecanych parametrów zdarzeń znajdziesz w dokumentacji GA4.
logEvent(analyticsInstance, eventName, eventParams, options) Wysyła zdarzenie Google Analytics o podanej wartości eventParams. Ta metoda automatycznie wiąże to zarejestrowane zdarzenie z wystąpieniem aplikacji internetowej Firebase na tym urządzeniu.Listę zalecanych parametrów zdarzeń znajdziesz w dokumentacji GA4.
logEvent(analyticsInstance, eventName, eventParams, options) Wysyła zdarzenie Google Analytics o podanej wartości eventParams. Ta metoda automatycznie wiąże to zarejestrowane zdarzenie z wystąpieniem aplikacji internetowej Firebase na tym urządzeniu.Listę zalecanych parametrów zdarzeń znajdziesz w dokumentacji GA4.
logEvent(analyticsInstance, eventName, eventParams, options) Wysyła zdarzenie Google Analytics o podanej wartości eventParams. Ta metoda automatycznie wiąże to zarejestrowane zdarzenie z wystąpieniem aplikacji internetowej Firebase na tym urządzeniu.Listę zalecanych parametrów zdarzeń znajdziesz w dokumentacji GA4.
logEvent(analyticsInstance, eventName, eventParams, options) Wysyła zdarzenie Google Analytics o podanej wartości eventParams. Ta metoda automatycznie wiąże to zarejestrowane zdarzenie z wystąpieniem aplikacji internetowej Firebase na tym urządzeniu.Listę zalecanych parametrów zdarzeń znajdziesz w dokumentacji GA4.
logEvent(analyticsInstance, eventName, eventParams, options) Wysyła zdarzenie Google Analytics o podanej wartości eventParams. Ta metoda automatycznie wiąże to zarejestrowane zdarzenie z wystąpieniem aplikacji internetowej Firebase na tym urządzeniu.Listę zalecanych parametrów zdarzeń znajdziesz w dokumentacji GA4.
logEvent(analyticsInstance, eventName, eventParams, options) Wysyła zdarzenie Google Analytics o podanej wartości eventParams. Ta metoda automatycznie wiąże to zarejestrowane zdarzenie z wystąpieniem aplikacji internetowej Firebase na tym urządzeniu.Listę zalecanych parametrów zdarzeń znajdziesz w dokumentacji GA4.
logEvent(analyticsInstance, eventName, eventParams, options) Wysyła zdarzenie Google Analytics o podanej wartości eventParams. Ta metoda automatycznie wiąże to zarejestrowane zdarzenie z wystąpieniem aplikacji internetowej Firebase na tym urządzeniu.Listę zalecanych parametrów zdarzeń znajdziesz w dokumentacji GA4.
logEvent(analyticsInstance, eventName, eventParams, options) Wysyła zdarzenie Google Analytics o podanej wartości eventParams. Ta metoda automatycznie wiąże to zarejestrowane zdarzenie z wystąpieniem aplikacji internetowej Firebase na tym urządzeniu.Zobacz Pomiar wyjątków.
logEvent(analyticsInstance, eventName, eventParams, options) Wysyła zdarzenie Google Analytics o podanej wartości eventParams. Ta metoda automatycznie wiąże to zarejestrowane zdarzenie z wystąpieniem aplikacji internetowej Firebase na tym urządzeniu.Listę zalecanych parametrów zdarzeń znajdziesz w dokumentacji GA4.
logEvent(analyticsInstance, eventName, eventParams, options) Wysyła zdarzenie Google Analytics o podanej wartości eventParams. Ta metoda automatycznie wiąże to zarejestrowane zdarzenie z wystąpieniem aplikacji internetowej Firebase na tym urządzeniu.Listę zalecanych parametrów zdarzeń znajdziesz w dokumentacji GA4.
logEvent(analyticsInstance, eventName, eventParams, options) Wysyła zdarzenie Google Analytics o podanej wartości eventParams. Ta metoda automatycznie wiąże to zarejestrowane zdarzenie z instancją aplikacji internetowej Firebase na tym urządzeniu.Zobacz Wyświetlenia strony.
setAnalyticsCollectionEnabled(analyticsInstance, włączone) Określa, czy zbieranie danych przez Google Analytics jest włączone dla tej aplikacji na tym urządzeniu. Ustawia globalny window['ga-disable-analyticsId'] = true;
setCurrentScreen(analyticsInstance, screenName, options) Aby ustawić screen_name, użyj polecenia gtag config.
setUserId(analyticsInstance; identyfikator; opcje) Użyj polecenia gtag config, aby ustawić user_id.
setUserWłaściwości(instancja analytics, właściwości, opcje) Aby skonfigurować wszystkie określone parametry, użyj polecenia gtag config.
function()
isSupported() Jest to publiczna, statyczna metoda, która obejmuje 4 różne testy:1. Sprawdź, czy nie jest to środowisko rozszerzeń przeglądarki. 2. Sprawdź, czy w bieżącej przeglądarce włączona jest obsługa plików cookie. 3. Sprawdź, czy środowisko przeglądarki obsługuje IndexedDB. 4. Sprawdź, czy bieżący kontekst przeglądarki umożliwia użycie funkcji IndexedDB.open().
function(consentSettings, ...)
setConsent(consentSettings), Po zainicjowaniu Firebase Analytics ustawia odpowiedni stan zgody użytkownika dla tej aplikacji internetowej we wszystkich plikach referencyjnych do tagu gtag.Aby określić poszczególne wartości typów zgody, użyj opcji ConsentSettings. Domyślnie typy zgody mają wartość „Przyznano”.
function(customParams, ...)
setDefaultEventParameters(customParams) Dodaje dane, które zostaną ustawione w przypadku każdego zdarzenia rejestrowanego przez pakiet SDK, w tym zdarzeń automatycznych. Z wartością „set” tagu gtag , przekazane wartości zostaną zachowane na bieżącej stronie i przekazywane ze wszystkimi kolejnymi zdarzeniami.
function(opcje, ...)
ustawienia(opcje) Konfiguruje Firebase Analytics tak, aby używał niestandardowych nazw gtag lub dataLayer. Można jej używać, jeśli skrypt gtag.js został zainstalowany na tej stronie niezależnie od Firebase Analytics i korzysta z innych niż domyślne nazwy dla funkcji gtag lub dataLayer. Ta funkcja musi zostać wywołana przed wywołaniem funkcji getAnalytics(). W przeciwnym razie działanie nie przyniesie żadnego efektu.

Interfejsy

Interfejs Opis
Analytics Instancja Firebase Analytics.
AnalyticsCallOptions Dodatkowe opcje, które można przekazać do wywołań metod Analytics, np. logEvent.
Ustawienia Analytics Analytics.
ConsentSettings (Ustawienia uzyskiwania zgody) Ustawienia stanu zgody w przypadku poszczególnych rodzajów zgody. Więcej informacji znajdziesz w dokumentacji GA4 dotyczącej stanu i rodzajów zgody.
ControlParams Standardowe parametry sterujące gtag.js. Więcej informacji znajdziesz w dokumentacji referencyjnej GA4.
Parametry niestandardowe Wszelkie parametry niestandardowe, które użytkownik może przekazywać do usługi gtag.
EventParams Standardowe parametry zdarzenia gtag.js. Więcej informacji znajdziesz w dokumentacji referencyjnej GA4.
GtagConfigParams Zestaw typowych ustawień konfiguracji Google Analytics rozpoznawanych przez gtag.js.
Element Standardowy typ Item Google Analytics.
Promocja Pole używane wcześniej przez niektóre zdarzenia Google Analytics.
SettingsOptions (Opcje ustawień). Określa opcje niestandardowe instancji Firebase Analytics. Należy je ustawić przed zainicjowaniem programu firebase.analytics().

Aliasy typu

Wpisz alias Opis
ConsentStatusString – Określa, czy dany rodzaj zgody został udzielony.
Waluta Standardowy typ waluty Google Analytics.
NazwaZdarzenia niestandardowego Dowolny ciąg niestandardowych nazw zdarzeń, których nie ma na standardowej liście zalecanych nazw zdarzeń.
EventNameString Wpisz standardowe nazwy zdarzeń Google Analytics. logEvent akceptuje też dowolny ciąg niestandardowy i interpretuje go jako niestandardową nazwę zdarzenia.

funkcja(aplikacja, ...)

getAnalytics(aplikacja)

Zwraca wystąpienie Analytics dla danej aplikacji.

Podpis:

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

Parametry

Parametr Typ Opis
aplikacja Aplikacja Firebase FirebaseApp, która ma być używana.

Zwroty:

Analytics

zainicjujAnalytics(aplikacja; opcje)

Zwraca wystąpienie Analytics dla danej aplikacji.

Podpis:

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

Parametry

Parametr Typ Opis
aplikacja Aplikacja Firebase FirebaseApp, która ma być używana.
opcje Ustawienia Analytics

Zwroty:

Analytics

funkcja(instancja analytics, ...)

getGoogleAnalyticsClientId(instancja analytics)

Pobiera unikalny identyfikator Google Analytics dla klienta internetowego. Patrz client_id.

Podpis:

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

Parametry

Parametr Typ Opis
Instancja Analytics Analytics

Zwroty:

Obietnica<ciąg>

logEvent(instancja analytics; nazwazdarzenia; parametr eventParams; opcje)

Wysyła zdarzenie Google Analytics o podanej wartości eventParams. Ta metoda automatycznie wiąże to zarejestrowane zdarzenie z tą instancją aplikacji internetowej Firebase na tym urządzeniu.

Listę zalecanych parametrów zdarzeń znajdziesz w dokumentacji GA4.

Podpis:

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;

Parametry

Parametr Typ Opis
Instancja Analytics Analytics
nazwaZdarzenia „add_payment_info”
parametr eventParams { kupon?: EventParams['kupon']; currency?: EventParams['currency']; elementów?: EventParams['items']; payment_type?: EventParams['payment_type']; ?: EventParams['value']; [klucz: ciąg znaków]: any;
opcje AnalyticsCallOptions

Zwroty:

nieważne

logEvent(instancja analytics; nazwazdarzenia; parametr eventParams; opcje)

Wysyła zdarzenie Google Analytics o podanej wartości eventParams. Ta metoda automatycznie wiąże to zarejestrowane zdarzenie z tą instancją aplikacji internetowej Firebase na tym urządzeniu.

Listę zalecanych parametrów zdarzeń znajdziesz w dokumentacji GA4.

Podpis:

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;

Parametry

Parametr Typ Opis
Instancja Analytics Analytics
nazwaZdarzenia „zakup” | „zwrot środków”
parametr eventParams { value?: EventParams['value']; currency?: EventParams['currency']; transakcja_id: EventParams['transaction_id']; podatek: EventParams['tax']; dostawa?: EventParams['shipping']; elementów?: EventParams['items']; Kupon?: EventParams['kupon']; przynależność?: EventParams['affiliation']; [klucz: ciąg znaków]: any;
opcje AnalyticsCallOptions

Zwroty:

nieważne

logEvent(instancja analytics; nazwazdarzenia; parametr eventParams; opcje)

Wysyła zdarzenie Google Analytics o podanej wartości eventParams. Ta metoda automatycznie wiąże to zarejestrowane zdarzenie z tą instancją aplikacji internetowej Firebase na tym urządzeniu.

Zobacz Śledzenie wyświetleń ekranu.

Podpis:

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;

Parametry

Parametr Typ Opis
Instancja Analytics Analytics
nazwaZdarzenia „screen_view”
parametr eventParams { firebase_screen: EventParams['firebase_screen']; firebase_screen_class: EventParams['firebase_screen_class']; [klucz: ciąg znaków]: any;
opcje AnalyticsCallOptions

Zwroty:

nieważne

logEvent(instancja analytics; nazwazdarzenia; parametr eventParams; opcje)

Wysyła zdarzenie Google Analytics o podanej wartości eventParams. Ta metoda automatycznie wiąże to zarejestrowane zdarzenie z tą instancją aplikacji internetowej Firebase na tym urządzeniu.

Listę zalecanych parametrów zdarzeń znajdziesz w dokumentacji GA4.

Podpis:

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

Parametry

Parametr Typ Opis
Instancja Analytics Analytics
nazwaZdarzenia „szukaj” | „view_search_results”
parametr eventParams { search_term?: EventParams['search_term']; [klucz: ciąg znaków]: any;
opcje AnalyticsCallOptions

Zwroty:

nieważne

logEvent(instancja analytics; nazwazdarzenia; parametr eventParams; opcje)

Wysyła zdarzenie Google Analytics o podanej wartości eventParams. Ta metoda automatycznie wiąże to zarejestrowane zdarzenie z tą instancją aplikacji internetowej Firebase na tym urządzeniu.

Listę zalecanych parametrów zdarzeń znajdziesz w dokumentacji GA4.

Podpis:

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;

Parametry

Parametr Typ Opis
Instancja Analytics Analytics
nazwaZdarzenia „select_content”
parametr eventParams { content_type?: EventParams['content_type']; item_id?: EventParams['item_id']; [klucz: ciąg znaków]: any;
opcje AnalyticsCallOptions

Zwroty:

nieważne

logEvent(instancja analytics; nazwazdarzenia; parametr eventParams; opcje)

Wysyła zdarzenie Google Analytics o podanej wartości eventParams. Ta metoda automatycznie wiąże to zarejestrowane zdarzenie z tą instancją aplikacji internetowej Firebase na tym urządzeniu.

Listę zalecanych parametrów zdarzeń znajdziesz w dokumentacji GA4.

Podpis:

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;

Parametry

Parametr Typ Opis
Instancja Analytics Analytics
nazwaZdarzenia „select_item”
parametr eventParams { items?: EventParams['items']; item_list_name? EventParams['item_list_name']; item_list_id?: EventParams['item_list_id']; [klucz: ciąg znaków]: any;
opcje AnalyticsCallOptions

Zwroty:

nieważne

logEvent(instancja analytics; nazwazdarzenia; parametr eventParams; opcje)

Wysyła zdarzenie Google Analytics o podanej wartości eventParams. Ta metoda automatycznie wiąże to zarejestrowane zdarzenie z tą instancją aplikacji internetowej Firebase na tym urządzeniu.

Listę zalecanych parametrów zdarzeń znajdziesz w dokumentacji GA4.

Podpis:

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;

Parametry

Parametr Typ Opis
Instancja Analytics Analytics
nazwaZdarzenia „select_promotion” | „view_promotion”
parametr eventParams { items?: EventParams['items']; „promotion_id” [identyfikator_promocji]?: EventParams['promotion_id']; promotion_name? EventParams['promotion_name']; [klucz: ciąg znaków]: any;
opcje AnalyticsCallOptions

Zwroty:

nieważne

logEvent(instancja analytics; nazwazdarzenia; parametr eventParams; opcje)

Wysyła zdarzenie Google Analytics o podanej wartości eventParams. Ta metoda automatycznie wiąże to zarejestrowane zdarzenie z tą instancją aplikacji internetowej Firebase na tym urządzeniu.

Listę zalecanych parametrów zdarzeń znajdziesz w dokumentacji GA4.

Podpis:

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;

Parametry

Parametr Typ Opis
Instancja Analytics Analytics
nazwaZdarzenia „set_checkout_option”
parametr eventParams { checkout_step?: EventParams['checkout_step']; Checkout_option?: EventParams['checkout_option']; [klucz: ciąg znaków]: any;
opcje AnalyticsCallOptions

Zwroty:

nieważne

logEvent(instancja analytics; nazwazdarzenia; parametr eventParams; opcje)

Wysyła zdarzenie Google Analytics o podanej wartości eventParams. Ta metoda automatycznie wiąże to zarejestrowane zdarzenie z tą instancją aplikacji internetowej Firebase na tym urządzeniu.

Listę zalecanych parametrów zdarzeń znajdziesz w dokumentacji GA4.

Podpis:

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;

Parametry

Parametr Typ Opis
Instancja Analytics Analytics
nazwaZdarzenia „udostępnij”
parametr eventParams { metoda?: EventParams['metoda']; content_type?: EventParams['content_type']; item_id?: EventParams['item_id']; [klucz: ciąg znaków]: any;
opcje AnalyticsCallOptions

Zwroty:

nieważne

logEvent(instancja analytics; nazwazdarzenia; parametr eventParams; opcje)

Wysyła zdarzenie Google Analytics o podanej wartości eventParams. Ta metoda automatycznie wiąże to zarejestrowane zdarzenie z tą instancją aplikacji internetowej Firebase na tym urządzeniu.

Listę zalecanych parametrów zdarzeń znajdziesz w dokumentacji GA4.

Podpis:

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

Parametry

Parametr Typ Opis
Instancja Analytics Analytics
nazwaZdarzenia „sign_up”
parametr eventParams { metoda?: EventParams['metoda']; [klucz: ciąg znaków]: any;
opcje AnalyticsCallOptions

Zwroty:

nieważne

logEvent(instancja analytics; nazwazdarzenia; parametr eventParams; opcje)

Wysyła zdarzenie Google Analytics o podanej wartości eventParams. Ta metoda automatycznie wiąże to zarejestrowane zdarzenie z tą instancją aplikacji internetowej Firebase na tym urządzeniu.

Listę zalecanych parametrów zdarzeń znajdziesz w dokumentacji GA4.

Podpis:

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;

Parametry

Parametr Typ Opis
Instancja Analytics Analytics
nazwaZdarzenia „timing_complete”
parametr eventParams { name: string; value: liczba; event_category?: string; event_label?: string; [klucz: ciąg znaków]: any;
opcje AnalyticsCallOptions

Zwroty:

nieważne

logEvent(instancja analytics; nazwazdarzenia; parametr eventParams; opcje)

Wysyła zdarzenie Google Analytics o podanej wartości eventParams. Ta metoda automatycznie wiąże to zarejestrowane zdarzenie z tą instancją aplikacji internetowej Firebase na tym urządzeniu.

Listę zalecanych parametrów zdarzeń znajdziesz w dokumentacji GA4.

Podpis:

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;

Parametry

Parametr Typ Opis
Instancja Analytics Analytics
nazwaZdarzenia „add_shipping_info”
parametr eventParams { kupon?: EventParams['kupon']; currency?: EventParams['currency']; elementów?: EventParams['items']; shipping_tier?: EventParams['shipping_tier']; ?: EventParams['value']; [klucz: ciąg znaków]: any;
opcje AnalyticsCallOptions

Zwroty:

nieważne

logEvent(instancja analytics; nazwazdarzenia; parametr eventParams; opcje)

Wysyła zdarzenie Google Analytics o podanej wartości eventParams. Ta metoda automatycznie wiąże to zarejestrowane zdarzenie z tą instancją aplikacji internetowej Firebase na tym urządzeniu.

Listę zalecanych parametrów zdarzeń znajdziesz w dokumentacji GA4.

Podpis:

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;

Parametry

Parametr Typ Opis
Instancja Analytics Analytics
nazwaZdarzenia „view_cart” | „view_item”
parametr eventParams { currency?: EventParams['currency']; elementów?: EventParams['items']; ?: EventParams['value']; [klucz: ciąg znaków]: any;
opcje AnalyticsCallOptions

Zwroty:

nieważne

logEvent(instancja analytics; nazwazdarzenia; parametr eventParams; opcje)

Wysyła zdarzenie Google Analytics o podanej wartości eventParams. Ta metoda automatycznie wiąże to zarejestrowane zdarzenie z tą instancją aplikacji internetowej Firebase na tym urządzeniu.

Listę zalecanych parametrów zdarzeń znajdziesz w dokumentacji GA4.

Podpis:

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;

Parametry

Parametr Typ Opis
Instancja Analytics Analytics
nazwaZdarzenia „view_item_list”
parametr eventParams { items?: EventParams['items']; item_list_name? EventParams['item_list_name']; item_list_id?: EventParams['item_list_id']; [klucz: ciąg znaków]: any;
opcje AnalyticsCallOptions

Zwroty:

nieważne

logEvent(instancja analytics; nazwazdarzenia; parametr eventParams; opcje)

Wysyła zdarzenie Google Analytics o podanej wartości eventParams. Ta metoda automatycznie wiąże to zarejestrowane zdarzenie z tą instancją aplikacji internetowej Firebase na tym urządzeniu.

Listę zalecanych parametrów zdarzeń znajdziesz w dokumentacji GA4.

Podpis:

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

Parametry

Parametr Typ Opis
Instancja Analytics Analytics
nazwaZdarzenia CustomEventName<T>
parametr eventParams { [klucz: ciąg znaków]: any;
opcje AnalyticsCallOptions

Zwroty:

nieważne

logEvent(instancja analytics; nazwazdarzenia; parametr eventParams; opcje)

Wysyła zdarzenie Google Analytics o podanej wartości eventParams. Ta metoda automatycznie wiąże to zarejestrowane zdarzenie z tą instancją aplikacji internetowej Firebase na tym urządzeniu.

Listę zalecanych parametrów zdarzeń znajdziesz w dokumentacji GA4.

Podpis:

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;

Parametry

Parametr Typ Opis
Instancja Analytics Analytics
nazwaZdarzenia „add_to_cart” | „add_to_wishlist” | „remove_from_cart”
parametr eventParams { currency?: EventParams['currency']; ?: EventParams['value']; elementów?: EventParams['items']; [klucz: ciąg znaków]: any;
opcje AnalyticsCallOptions

Zwroty:

nieważne

logEvent(instancja analytics; nazwazdarzenia; parametr eventParams; opcje)

Wysyła zdarzenie Google Analytics o podanej wartości eventParams. Ta metoda automatycznie wiąże to zarejestrowane zdarzenie z tą instancją aplikacji internetowej Firebase na tym urządzeniu.

Listę zalecanych parametrów zdarzeń znajdziesz w dokumentacji GA4.

Podpis:

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;

Parametry

Parametr Typ Opis
Instancja Analytics Analytics
nazwaZdarzenia „begin_checkout”
parametr eventParams { currency?: EventParams['currency']; Kupon?: EventParams['kupon']; ?: EventParams['value']; elementów?: EventParams['items']; [klucz: ciąg znaków]: any;
opcje AnalyticsCallOptions

Zwroty:

nieważne

logEvent(instancja analytics; nazwazdarzenia; parametr eventParams; opcje)

Wysyła zdarzenie Google Analytics o podanej wartości eventParams. Ta metoda automatycznie wiąże to zarejestrowane zdarzenie z tą instancją aplikacji internetowej Firebase na tym urządzeniu.

Listę zalecanych parametrów zdarzeń znajdziesz w dokumentacji GA4.

Podpis:

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;

Parametry

Parametr Typ Opis
Instancja Analytics Analytics
nazwaZdarzenia „checkout_progress”
parametr eventParams { currency?: EventParams['currency']; Kupon?: EventParams['kupon']; ?: EventParams['value']; elementów?: EventParams['items']; Checkout_step?: EventParams['checkout_step']; Checkout_option?: EventParams['checkout_option']; [klucz: ciąg znaków]: any;
opcje AnalyticsCallOptions

Zwroty:

nieważne

logEvent(instancja analytics; nazwazdarzenia; parametr eventParams; opcje)

Wysyła zdarzenie Google Analytics o podanej wartości eventParams. Ta metoda automatycznie wiąże to zarejestrowane zdarzenie z tą instancją aplikacji internetowej Firebase na tym urządzeniu.

Zobacz Pomiar wyjątków.

Podpis:

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

Parametry

Parametr Typ Opis
Instancja Analytics Analytics
nazwaZdarzenia „wyjątek”
parametr eventParams { description?: EventParams['description']; kryminalne?: EventParams['fatal']; [klucz: ciąg znaków]: any;
opcje AnalyticsCallOptions

Zwroty:

nieważne

logEvent(instancja analytics; nazwazdarzenia; parametr eventParams; opcje)

Wysyła zdarzenie Google Analytics o podanej wartości eventParams. Ta metoda automatycznie wiąże to zarejestrowane zdarzenie z tą instancją aplikacji internetowej Firebase na tym urządzeniu.

Listę zalecanych parametrów zdarzeń znajdziesz w dokumentacji GA4.

Podpis:

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

Parametry

Parametr Typ Opis
Instancja Analytics Analytics
nazwaZdarzenia „generate_lead”
parametr eventParams { value?: EventParams['value']; currency?: EventParams['currency']; [klucz: ciąg znaków]: any;
opcje AnalyticsCallOptions

Zwroty:

nieważne

logEvent(instancja analytics; nazwazdarzenia; parametr eventParams; opcje)

Wysyła zdarzenie Google Analytics o podanej wartości eventParams. Ta metoda automatycznie wiąże to zarejestrowane zdarzenie z tą instancją aplikacji internetowej Firebase na tym urządzeniu.

Listę zalecanych parametrów zdarzeń znajdziesz w dokumentacji GA4.

Podpis:

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

Parametry

Parametr Typ Opis
Instancja Analytics Analytics
nazwaZdarzenia „login”
parametr eventParams { metoda?: EventParams['metoda']; [klucz: ciąg znaków]: any;
opcje AnalyticsCallOptions

Zwroty:

nieważne

logEvent(instancja analytics; nazwazdarzenia; parametr eventParams; opcje)

Wysyła zdarzenie Google Analytics o podanej wartości eventParams. Ta metoda automatycznie wiąże to zarejestrowane zdarzenie z tą instancją aplikacji internetowej Firebase na tym urządzeniu.

Zobacz Wyświetlenia strony.

Podpis:

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;

Parametry

Parametr Typ Opis
Instancja Analytics Analytics
nazwaZdarzenia „page_view”
parametr eventParams { page_title?: string; page_location?: string; page_path?: string; [klucz: ciąg znaków]: any;
opcje AnalyticsCallOptions

Zwroty:

nieważne

setAnalyticsCollectionEnabled(instancjaanalytics, włączona)

Określa, czy zbieranie danych przez Google Analytics jest włączone dla tej aplikacji na tym urządzeniu. Ustawia globalny window['ga-disable-analyticsId'] = true;

Podpis:

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

Parametry

Parametr Typ Opis
Instancja Analytics Analytics instancję Analytics.
włączona wartość logiczna Jeśli ma wartość true (prawda), gromadzenie danych jest włączone, a jeśli ma wartość false (fałsz), wyłącza tę funkcję.

Zwroty:

nieważne

setCurrentScreen(instancja analytics; nazwa ekranu; opcje)

Użyj razem z reklamą eventName jako elementu „screen_view” i dodaj odpowiednią wartość eventParams. Zobacz Śledzenie wyświetleń ekranu.

Użyj polecenia gtag config, aby ustawić screen_name.

Podpis:

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

Parametry

Parametr Typ Opis
Instancja Analytics Analytics instancję Analytics.
Nazwaekranu ciąg znaków Nazwa ekranu do ustawienia.
opcje AnalyticsCallOptions

Zwroty:

nieważne

setUserId(instancja analytics; identyfikator; opcje)

Użyj polecenia gtag config, aby ustawić user_id.

Podpis:

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

Parametry

Parametr Typ Opis
Instancja Analytics Analytics instancję Analytics.
id ciąg znaków | wartość null Identyfikator użytkownika do ustawienia.
opcje AnalyticsCallOptions

Zwroty:

nieważne

setUserWłaściwości(instancja analytics, właściwości, opcje)

Aby skonfigurować wszystkie określone parametry, użyj polecenia gtag config.

Podpis:

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

Parametry

Parametr Typ Opis
Instancja Analytics Analytics
właściwości Parametry niestandardowe
opcje AnalyticsCallOptions

Zwroty:

nieważne

funkcja()

issupported()

Jest to publiczna, statyczna metoda udostępniania użytkownikom, która obejmuje 4 różne testy:

  1. Sprawdź, czy nie jest to środowisko rozszerzeń przeglądarki. 2. Sprawdź, czy w bieżącej przeglądarce włączona jest obsługa plików cookie. 3. Sprawdź, czy środowisko przeglądarki obsługuje IndexedDB. 4. Sprawdź, czy bieżący kontekst przeglądarki umożliwia użycie tagu IndexedDB.open().

Podpis:

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

Zwroty:

Promise&lt;boolean&gt;

function(consentSettings, ...)

setConsent(consentSettings)

Ustawia odpowiedni stan zgody użytkownika dla tej aplikacji internetowej we wszystkich odniesieniach do tagu gtag po zainicjowaniu Firebase Analytics.

Użyj opcji ConsentSettings, aby określić wartości poszczególnych typów zgody. Domyślnie typy zgody mają wartość „Przyznano”.

Podpis:

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

Parametry

Parametr Typ Opis
ustawienia zgody ConsentSettings (Ustawienia uzyskiwania zgody) Mapuje odpowiedni stan zgody użytkownika na potrzeby tagu gtag.js.

Zwroty:

nieważne

function(customParams, ...)

setDefaultEventParameters(customParams)

Dodaje dane, które zostaną ustawione w przypadku każdego zdarzenia rejestrowanego przez pakiet SDK, w tym zdarzeń automatycznych. Z wartością „set” tagu gtag , przekazane wartości zostaną zachowane na bieżącej stronie i przekazywane ze wszystkimi kolejnymi zdarzeniami.

Podpis:

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

Parametry

Parametr Typ Opis
parametry customParams Parametry niestandardowe Wszystkie parametry niestandardowe, które użytkownik może przekazywać do tagu gtag.js.

Zwroty:

nieważne

funkcja(opcje, ...)

ustawienia(opcje)

Konfiguruje Firebase Analytics tak, aby używał niestandardowych nazw gtag lub dataLayer. Można jej używać, jeśli skrypt gtag.js został zainstalowany na tej stronie niezależnie od Firebase Analytics i używa innych nazw niż domyślne dla funkcji gtag lub dataLayer. Ta funkcja musi zostać wywołana przed wywołaniem funkcji getAnalytics(). W przeciwnym razie działanie nie przyniesie żadnego efektu.

Podpis:

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

Parametry

Parametr Typ Opis
opcje SettingsOptions (Opcje ustawień). Niestandardowe nazwy tagów gtag i dataLayer.

Zwroty:

nieważne

Ciąg zgody

Określa, czy dany rodzaj zgody został udzielony.

Podpis:

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

Waluta

Standardowy typ waluty Google Analytics.

Podpis:

export declare type Currency = string | number;

Nazwa zdarzenia niestandardowego

Dowolny ciąg niestandardowych nazw zdarzeń, których nie ma na standardowej liście zalecanych nazw zdarzeń.

Podpis:

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

Ciąg nazwy zdarzenia

Wpisz standardowe nazwy zdarzeń Google Analytics. logEvent akceptuje też dowolny ciąg niestandardowy i interpretuje go jako niestandardową nazwę zdarzenia.

Podpis:

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