analytics package

Internetowy pakiet SDK Firebase Analytics. Ten zestaw SDK nie działa w środowisku Node.js.

Funkcje

Funkcjonować Opis
funkcja (aplikacja, ...)
getAnalytics(aplikacja) Zwraca instancję Analytics dla danej aplikacji.
zainicjujAnalytics(aplikacja, opcje) Zwraca instancję Analytics dla danej aplikacji.
funkcja(analyticsInstance, ...)
getGoogleAnalyticsClientId(analyticsInstance) Pobiera unikalny identyfikator Google Analytics dla klienta internetowego. Zobacz identyfikator_klienta .
logEvent(analyticsInstance, nazwa zdarzenia, parametry zdarzenia, opcje) Wysyła zdarzenie Google Analytics z podanymi eventParams . Ta metoda automatycznie kojarzy zarejestrowane zdarzenie z instancją aplikacji internetowej Firebase na tym urządzeniu. Listę zalecanych parametrów zdarzeń znajdziesz w dokumentacji referencyjnej GA4 .
logEvent(analyticsInstance, nazwa zdarzenia, parametry zdarzenia, opcje) Wysyła zdarzenie Google Analytics z podanymi eventParams . Ta metoda automatycznie kojarzy zarejestrowane zdarzenie z instancją aplikacji internetowej Firebase na tym urządzeniu. Listę zalecanych parametrów zdarzeń znajdziesz w dokumentacji referencyjnej GA4 .
logEvent(analyticsInstance, nazwa zdarzenia, parametry zdarzenia, opcje) Wysyła zdarzenie Google Analytics z podanymi eventParams . Ta metoda automatycznie kojarzy zarejestrowane zdarzenie z instancją aplikacji internetowej Firebase na tym urządzeniu. Zobacz Śledź wyświetlenia ekranu .
logEvent(analyticsInstance, nazwa zdarzenia, parametry zdarzenia, opcje) Wysyła zdarzenie Google Analytics z podanymi eventParams . Ta metoda automatycznie kojarzy zarejestrowane zdarzenie z instancją aplikacji internetowej Firebase na tym urządzeniu. Listę zalecanych parametrów zdarzeń znajdziesz w dokumentacji referencyjnej GA4 .
logEvent(analyticsInstance, nazwa zdarzenia, parametry zdarzenia, opcje) Wysyła zdarzenie Google Analytics z podanymi eventParams . Ta metoda automatycznie kojarzy zarejestrowane zdarzenie z instancją aplikacji internetowej Firebase na tym urządzeniu. Listę zalecanych parametrów zdarzeń znajdziesz w dokumentacji referencyjnej GA4 .
logEvent(analyticsInstance, nazwa zdarzenia, parametry zdarzenia, opcje) Wysyła zdarzenie Google Analytics z podanymi eventParams . Ta metoda automatycznie kojarzy zarejestrowane zdarzenie z instancją aplikacji internetowej Firebase na tym urządzeniu. Listę zalecanych parametrów zdarzeń znajdziesz w dokumentacji referencyjnej GA4 .
logEvent(analyticsInstance, nazwa zdarzenia, parametry zdarzenia, opcje) Wysyła zdarzenie Google Analytics z podanymi eventParams . Ta metoda automatycznie kojarzy zarejestrowane zdarzenie z instancją aplikacji internetowej Firebase na tym urządzeniu. Listę zalecanych parametrów zdarzeń znajdziesz w dokumentacji referencyjnej GA4 .
logEvent(analyticsInstance, nazwa zdarzenia, parametry zdarzenia, opcje) Wysyła zdarzenie Google Analytics z podanymi eventParams . Ta metoda automatycznie kojarzy zarejestrowane zdarzenie z instancją aplikacji internetowej Firebase na tym urządzeniu. Listę zalecanych parametrów zdarzeń znajdziesz w dokumentacji referencyjnej GA4 .
logEvent(analyticsInstance, nazwa zdarzenia, parametry zdarzenia, opcje) Wysyła zdarzenie Google Analytics z podanymi eventParams . Ta metoda automatycznie kojarzy zarejestrowane zdarzenie z instancją aplikacji internetowej Firebase na tym urządzeniu. Listę zalecanych parametrów zdarzeń znajdziesz w dokumentacji referencyjnej GA4 .
logEvent(analyticsInstance, nazwa zdarzenia, parametry zdarzenia, opcje) Wysyła zdarzenie Google Analytics z podanymi eventParams . Ta metoda automatycznie kojarzy zarejestrowane zdarzenie z instancją aplikacji internetowej Firebase na tym urządzeniu. Listę zalecanych parametrów zdarzeń znajdziesz w dokumentacji referencyjnej GA4 .
logEvent(analyticsInstance, nazwa zdarzenia, parametry zdarzenia, opcje) Wysyła zdarzenie Google Analytics z podanymi eventParams . Ta metoda automatycznie kojarzy zarejestrowane zdarzenie z instancją aplikacji internetowej Firebase na tym urządzeniu. Listę zalecanych parametrów zdarzeń znajdziesz w dokumentacji referencyjnej GA4 .
logEvent(analyticsInstance, nazwa zdarzenia, parametry zdarzenia, opcje) Wysyła zdarzenie Google Analytics z podanymi eventParams . Ta metoda automatycznie kojarzy zarejestrowane zdarzenie z instancją aplikacji internetowej Firebase na tym urządzeniu. Listę zalecanych parametrów zdarzeń znajdziesz w dokumentacji referencyjnej GA4 .
logEvent(analyticsInstance, nazwa zdarzenia, parametry zdarzenia, opcje) Wysyła zdarzenie Google Analytics z podanymi eventParams . Ta metoda automatycznie kojarzy zarejestrowane zdarzenie z instancją aplikacji internetowej Firebase na tym urządzeniu. Listę zalecanych parametrów zdarzeń znajdziesz w dokumentacji referencyjnej GA4 .
logEvent(analyticsInstance, nazwa zdarzenia, parametry zdarzenia, opcje) Wysyła zdarzenie Google Analytics z podanymi eventParams . Ta metoda automatycznie kojarzy zarejestrowane zdarzenie z instancją aplikacji internetowej Firebase na tym urządzeniu. Listę zalecanych parametrów zdarzeń znajdziesz w dokumentacji referencyjnej GA4 .
logEvent(analyticsInstance, nazwa zdarzenia, parametry zdarzenia, opcje) Wysyła zdarzenie Google Analytics z podanymi eventParams . Ta metoda automatycznie kojarzy zarejestrowane zdarzenie z instancją aplikacji internetowej Firebase na tym urządzeniu. Listę zalecanych parametrów zdarzeń znajdziesz w dokumentacji referencyjnej GA4 .
logEvent(analyticsInstance, nazwa zdarzenia, parametry zdarzenia, opcje) Wysyła zdarzenie Google Analytics z podanymi eventParams . Ta metoda automatycznie kojarzy zarejestrowane zdarzenie z instancją aplikacji internetowej Firebase na tym urządzeniu. Listę zalecanych parametrów zdarzeń znajdziesz w dokumentacji referencyjnej GA4 .
logEvent(analyticsInstance, nazwa zdarzenia, parametry zdarzenia, opcje) Wysyła zdarzenie Google Analytics z podanymi eventParams . Ta metoda automatycznie kojarzy zarejestrowane zdarzenie z instancją aplikacji internetowej Firebase na tym urządzeniu. Listę zalecanych parametrów zdarzeń znajdziesz w dokumentacji referencyjnej GA4 .
logEvent(analyticsInstance, nazwa zdarzenia, parametry zdarzenia, opcje) Wysyła zdarzenie Google Analytics z podanymi eventParams . Ta metoda automatycznie kojarzy zarejestrowane zdarzenie z instancją aplikacji internetowej Firebase na tym urządzeniu. Listę zalecanych parametrów zdarzeń znajdziesz w dokumentacji referencyjnej GA4 .
logEvent(analyticsInstance, nazwa zdarzenia, parametry zdarzenia, opcje) Wysyła zdarzenie Google Analytics z podanymi eventParams . Ta metoda automatycznie kojarzy zarejestrowane zdarzenie z instancją aplikacji internetowej Firebase na tym urządzeniu. Zobacz Zmierz wyjątki .
logEvent(analyticsInstance, nazwa zdarzenia, parametry zdarzenia, opcje) Wysyła zdarzenie Google Analytics z podanymi eventParams . Ta metoda automatycznie kojarzy zarejestrowane zdarzenie z instancją aplikacji internetowej Firebase na tym urządzeniu. Listę zalecanych parametrów zdarzeń znajdziesz w dokumentacji referencyjnej GA4 .
logEvent(analyticsInstance, nazwa zdarzenia, parametry zdarzenia, opcje) Wysyła zdarzenie Google Analytics z podanymi eventParams . Ta metoda automatycznie kojarzy zarejestrowane zdarzenie z instancją aplikacji internetowej Firebase na tym urządzeniu. Listę zalecanych parametrów zdarzeń znajdziesz w dokumentacji referencyjnej GA4 .
logEvent(analyticsInstance, nazwa zdarzenia, parametry zdarzenia, opcje) Wysyła zdarzenie Google Analytics z podanymi eventParams . Ta metoda automatycznie kojarzy zarejestrowane zdarzenie z instancją aplikacji internetowej Firebase na tym urządzeniu. Zobacz Wyświetlenia strony .
setAnalyticsCollectionEnabled(analyticsInstance, włączone) Określa, czy dla tej aplikacji na tym urządzeniu jest włączone gromadzenie danych Google Analytics. Ustawia globalne window['ga-disable-analyticsId'] = true;
setCurrentScreen(analyticsInstance, nazwa ekranu, opcje) Użyj polecenia gtag config , aby ustawić screen_name .
setUserId(analyticsInstance, identyfikator, opcje) Użyj polecenia gtag config , aby ustawić user_id .
setUserProperties(analyticsInstance, właściwości, opcje) Użyj polecenia gtag config , aby ustawić wszystkie określone parametry.
funkcjonować()
jest wspierany() Jest to publiczna metoda statyczna udostępniana użytkownikom, która obejmuje cztery różne kontrole: 1. Sprawdź, czy nie jest to środowisko rozszerzenia przeglądarki. 2. Sprawdź, czy w aktualnej przeglądarce włączona jest obsługa plików cookies. 3. Sprawdź, czy środowisko przeglądarki obsługuje IndexedDB. 4. Sprawdź, czy bieżący kontekst przeglądarki pozwala na użycie IndexedDB.open() .
funkcja(ustawienia zgody, ...)
setConsent(ustawienia zgody) Ustawia odpowiedni stan zgody użytkownika końcowego dla tej aplikacji internetowej we wszystkich odniesieniach do tagów gtag po zainicjowaniu Firebase Analytics. Użyj ConsentSettings , aby określić indywidualne wartości typu zgody. Domyślnie typy zgód są ustawione na „udzielone”.
funkcja(customParams, ...)
setDefaultEventParameters (customParams) Dodaje dane, które zostaną ustawione na każdym zdarzeniu zarejestrowanym z SDK, także automatycznym. Dzięki poleceniu „set” gtag przekazane wartości zostają zachowane na bieżącej stronie i przekazywane wraz ze wszystkimi kolejnymi zdarzeniami.
funkcja(opcje, ...)
ustawienia(opcje) Konfiguruje Firebase Analytics do używania niestandardowych nazw gtag lub dataLayer . Przeznaczony do użycia, jeśli skrypt gtag.js został zainstalowany na tej stronie niezależnie od Firebase Analytics i używa innych niż domyślne nazw dla funkcji gtag lub dataLayer . Należy wywołać przed wywołaniem getAnalytics() w przeciwnym razie nie będzie to miało żadnego efektu.

Interfejsy

Interfejs Opis
Analityka Instancja Firebase Analytics.
Opcje połączeń analitycznych Dodatkowe opcje, które można przekazać do wywołań metod Analytics, takich jak logEvent itp.
Ustawienia Analytics Opcje inicjowania instancji Analytics .
Ustawienia zgody Ustawienia stanu zgody dla każdego typu zgody. Więcej informacji na temat stanu i typów zgody znajdziesz w dokumentacji referencyjnej GA4 .
Parametry kontrolne Standardowe parametry kontrolne gtag.js Więcej informacji znajdziesz w dokumentacji referencyjnej GA4 .
Parametry niestandardowe Wszelkie niestandardowe parametry, które użytkownik może przekazać do gtag .
Parametry zdarzenia Standardowe parametry zdarzenia gtag.js Więcej informacji znajdziesz w dokumentacji referencyjnej GA4 .
Parametry GtagConfig Zestaw typowych ustawień konfiguracyjnych Google Analytics rozpoznawanych przez gtag.js .
Przedmiot Standardowy typ Item Google Analytics.
Awans Pole używane wcześniej przez niektóre zdarzenia Google Analytics.
UstawieniaOpcje Określa opcje niestandardowe dla instancji Firebase Analytics. Musisz je ustawić przed inicjalizacją firebase.analytics() .

Wpisz aliasy

Wpisz Alias Opis
Ciąg stanu zgody Czy dany rodzaj zgody został udzielony, czy odrzucony.
Waluta Standardowy typ waluty Google Analytics.
Nazwa zdarzenia niestandardowego Dowolny ciąg nazw zdarzeń niestandardowych, którego nie ma na standardowej liście zalecanych nazw zdarzeń.
NazwaZdarzeniaCiąg Wpisz standardowe nazwy zdarzeń Google Analytics. logEvent akceptuje również dowolny niestandardowy ciąg znaków i interpretuje go jako niestandardową nazwę zdarzenia.

funkcja (aplikacja, ...)

getAnalytics (aplikacja)

Zwraca instancję Analytics dla danej aplikacji.

Podpis:

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

Parametry

Parametr Typ Opis
aplikacja Aplikacja Firebase Aplikacja Firebase do użycia.

Zwroty:

Analityka

zainicjujAnalytics(aplikacja, opcje)

Zwraca instancję Analytics dla danej aplikacji.

Podpis:

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

Parametry

Parametr Typ Opis
aplikacja Aplikacja Firebase Aplikacja Firebase do użycia.
opcje Ustawienia Analytics

Zwroty:

Analityka

funkcja(analyticsInstance, ...)

getGoogleAnalyticsClientId(analyticsInstance)

Pobiera unikalny identyfikator Google Analytics dla klienta internetowego. Zobacz identyfikator_klienta .

Podpis:

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

Parametry

Parametr Typ Opis
Instancja analityczna Analityka

Zwroty:

Obietnica<string>

logEvent(analyticsInstance, nazwa zdarzenia, parametry zdarzenia, opcje)

Wysyła zdarzenie Google Analytics z podanymi eventParams . Ta metoda automatycznie kojarzy zarejestrowane zdarzenie z instancją aplikacji internetowej Firebase na tym urządzeniu.

Listę zalecanych parametrów zdarzeń znajdziesz w dokumentacji referencyjnej 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 analityczna Analityka
Nazwa wydarzenia „dodaj_informacje o_płatności”
parametry zdarzenia {kupon?: EventParams ['kupon']; waluta?: EventParams ['waluta']; elementy?: EventParams ['rzeczy']; typ_płatności?: Parametry zdarzenia ['typ płatności']; wartość?: Parametry zdarzenia ['wartość']; [klucz: string]: dowolny; }
opcje Opcje połączeń analitycznych

Zwroty:

próżnia

logEvent(analyticsInstance, nazwa zdarzenia, parametry zdarzenia, opcje)

Wysyła zdarzenie Google Analytics z podanymi eventParams . Ta metoda automatycznie kojarzy zarejestrowane zdarzenie z instancją aplikacji internetowej Firebase na tym urządzeniu.

Listę zalecanych parametrów zdarzeń znajdziesz w dokumentacji referencyjnej 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 analityczna Analityka
Nazwa wydarzenia „zakup” | 'refundacja'
parametry zdarzenia {wartość?: Parametry zdarzenia ['wartość']; waluta?: EventParams ['waluta']; identyfikator_transakcji: Parametry zdarzenia ['Identyfikator transakcji']; podatek?: EventParams ['podatek']; wysyłka?: EventParams ['wysyłka']; elementy?: EventParams ['rzeczy']; kupon?: EventParams ['kupon']; przynależność?: EventParams ['przynależność']; [klucz: string]: dowolny; }
opcje Opcje połączeń analitycznych

Zwroty:

próżnia

logEvent(analyticsInstance, nazwa zdarzenia, parametry zdarzenia, opcje)

Wysyła zdarzenie Google Analytics z podanymi eventParams . Ta metoda automatycznie kojarzy zarejestrowane zdarzenie z instancją aplikacji internetowej Firebase na tym urządzeniu.

Zobacz Śledź wyświetlenia 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 analityczna Analityka
Nazwa wydarzenia „widok_ekranu”
parametry zdarzenia {firebase_screen: Parametry zdarzenia ['ekran_firebase']; firebase_screen_class: Parametry zdarzenia ['firebase_screen_class']; [klucz: string]: dowolny; }
opcje Opcje połączeń analitycznych

Zwroty:

próżnia

logEvent(analyticsInstance, nazwa zdarzenia, parametry zdarzenia, opcje)

Wysyła zdarzenie Google Analytics z podanymi eventParams . Ta metoda automatycznie kojarzy zarejestrowane zdarzenie z instancją aplikacji internetowej Firebase na tym urządzeniu.

Listę zalecanych parametrów zdarzeń znajdziesz w dokumentacji referencyjnej 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 analityczna Analityka
Nazwa wydarzenia „szukaj” | „view_search_results”
parametry zdarzenia { search_term?: Parametry zdarzenia ['szukany termin']; [klucz: string]: dowolny; }
opcje Opcje połączeń analitycznych

Zwroty:

próżnia

logEvent(analyticsInstance, nazwa zdarzenia, parametry zdarzenia, opcje)

Wysyła zdarzenie Google Analytics z podanymi eventParams . Ta metoda automatycznie kojarzy zarejestrowane zdarzenie z instancją aplikacji internetowej Firebase na tym urządzeniu.

Listę zalecanych parametrów zdarzeń znajdziesz w dokumentacji referencyjnej 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 analityczna Analityka
Nazwa wydarzenia „wybierz_treść”
parametry zdarzenia { typ_treści?: Parametry zdarzenia ['Typ zawartości']; item_id?: Parametry zdarzenia ['id_przedmiotu']; [klucz: string]: dowolny; }
opcje Opcje połączeń analitycznych

Zwroty:

próżnia

logEvent(analyticsInstance, nazwa zdarzenia, parametry zdarzenia, opcje)

Wysyła zdarzenie Google Analytics z podanymi eventParams . Ta metoda automatycznie kojarzy zarejestrowane zdarzenie z instancją aplikacji internetowej Firebase na tym urządzeniu.

Listę zalecanych parametrów zdarzeń znajdziesz w dokumentacji referencyjnej 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 analityczna Analityka
Nazwa wydarzenia 'Wybierz przedmiot'
parametry zdarzenia { elementy?: Parametry zdarzenia ['rzeczy']; nazwa_listy_przedmiotów?: Parametry zdarzenia ['nazwa_listy_przedmiotów']; item_list_id?: Parametry zdarzenia ['item_list_id']; [klucz: string]: dowolny; }
opcje Opcje połączeń analitycznych

Zwroty:

próżnia

logEvent(analyticsInstance, nazwa zdarzenia, parametry zdarzenia, opcje)

Wysyła zdarzenie Google Analytics z podanymi eventParams . Ta metoda automatycznie kojarzy zarejestrowane zdarzenie z instancją aplikacji internetowej Firebase na tym urządzeniu.

Listę zalecanych parametrów zdarzeń znajdziesz w dokumentacji referencyjnej 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 analityczna Analityka
Nazwa wydarzenia „wybierz_promocję” | „widok_promocja”
parametry zdarzenia { elementy?: Parametry zdarzenia ['rzeczy']; Promotion_id?: Parametry zdarzenia ['id_promocji']; nazwa_promocji?: Parametry zdarzenia ['nazwa_promocji']; [klucz: string]: dowolny; }
opcje Opcje połączeń analitycznych

Zwroty:

próżnia

logEvent(analyticsInstance, nazwa zdarzenia, parametry zdarzenia, opcje)

Wysyła zdarzenie Google Analytics z podanymi eventParams . Ta metoda automatycznie kojarzy zarejestrowane zdarzenie z instancją aplikacji internetowej Firebase na tym urządzeniu.

Listę zalecanych parametrów zdarzeń znajdziesz w dokumentacji referencyjnej 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 analityczna Analityka
Nazwa wydarzenia „opcja_zestawu_checkout”
parametry zdarzenia {krok_kasy?: Parametry zdarzenia ['krok_kasy']; opcja_checkout?: Parametry zdarzenia ['opcja_kasy']; [klucz: string]: dowolny; }
opcje Opcje połączeń analitycznych

Zwroty:

próżnia

logEvent(analyticsInstance, nazwa zdarzenia, parametry zdarzenia, opcje)

Wysyła zdarzenie Google Analytics z podanymi eventParams . Ta metoda automatycznie kojarzy zarejestrowane zdarzenie z instancją aplikacji internetowej Firebase na tym urządzeniu.

Listę zalecanych parametrów zdarzeń znajdziesz w dokumentacji referencyjnej 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 analityczna Analityka
Nazwa wydarzenia 'udział'
parametry zdarzenia { metoda?: EventParams ['metoda']; content_type?: Parametry zdarzenia ['Typ zawartości']; item_id?: Parametry zdarzenia ['id_przedmiotu']; [klucz: string]: dowolny; }
opcje Opcje połączeń analitycznych

Zwroty:

próżnia

logEvent(analyticsInstance, nazwa zdarzenia, parametry zdarzenia, opcje)

Wysyła zdarzenie Google Analytics z podanymi eventParams . Ta metoda automatycznie kojarzy zarejestrowane zdarzenie z instancją aplikacji internetowej Firebase na tym urządzeniu.

Listę zalecanych parametrów zdarzeń znajdziesz w dokumentacji referencyjnej 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 analityczna Analityka
Nazwa wydarzenia 'zapisać się'
parametry zdarzenia { metoda?: EventParams ['metoda']; [klucz: string]: dowolny; }
opcje Opcje połączeń analitycznych

Zwroty:

próżnia

logEvent(analyticsInstance, nazwa zdarzenia, parametry zdarzenia, opcje)

Wysyła zdarzenie Google Analytics z podanymi eventParams . Ta metoda automatycznie kojarzy zarejestrowane zdarzenie z instancją aplikacji internetowej Firebase na tym urządzeniu.

Listę zalecanych parametrów zdarzeń znajdziesz w dokumentacji referencyjnej 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 analityczna Analityka
Nazwa wydarzenia „kompletny czas”
parametry zdarzenia {nazwa: ciąg; wartość: liczba; kategoria_zdarzenia?: string; etykieta_wydarzenia?: string; [klucz: string]: dowolny; }
opcje Opcje połączeń analitycznych

Zwroty:

próżnia

logEvent(analyticsInstance, nazwa zdarzenia, parametry zdarzenia, opcje)

Wysyła zdarzenie Google Analytics z podanymi eventParams . Ta metoda automatycznie kojarzy zarejestrowane zdarzenie z instancją aplikacji internetowej Firebase na tym urządzeniu.

Listę zalecanych parametrów zdarzeń znajdziesz w dokumentacji referencyjnej 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 analityczna Analityka
Nazwa wydarzenia „dodaj_informacje o_wysyłce”
parametry zdarzenia {kupon?: EventParams ['kupon']; waluta?: EventParams ['waluta']; elementy?: EventParams ['rzeczy']; shipping_tier?: Parametry zdarzenia ['poziom_wysyłki']; wartość?: Parametry zdarzenia ['wartość']; [klucz: string]: dowolny; }
opcje Opcje połączeń analitycznych

Zwroty:

próżnia

logEvent(analyticsInstance, nazwa zdarzenia, parametry zdarzenia, opcje)

Wysyła zdarzenie Google Analytics z podanymi eventParams . Ta metoda automatycznie kojarzy zarejestrowane zdarzenie z instancją aplikacji internetowej Firebase na tym urządzeniu.

Listę zalecanych parametrów zdarzeń znajdziesz w dokumentacji referencyjnej 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 analityczna Analityka
Nazwa wydarzenia 'widok_koszyka' | 'Zobacz obiekt'
parametry zdarzenia {waluta?: EventParams ['waluta']; elementy?: EventParams ['rzeczy']; wartość?: Parametry zdarzenia ['wartość']; [klucz: string]: dowolny; }
opcje Opcje połączeń analitycznych

Zwroty:

próżnia

logEvent(analyticsInstance, nazwa zdarzenia, parametry zdarzenia, opcje)

Wysyła zdarzenie Google Analytics z podanymi eventParams . Ta metoda automatycznie kojarzy zarejestrowane zdarzenie z instancją aplikacji internetowej Firebase na tym urządzeniu.

Listę zalecanych parametrów zdarzeń znajdziesz w dokumentacji referencyjnej 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 analityczna Analityka
Nazwa wydarzenia „lista_przedmiotów_wyświetleń”
parametry zdarzenia { elementy?: Parametry zdarzenia ['rzeczy']; nazwa_listy_przedmiotów?: Parametry zdarzenia ['nazwa_listy_przedmiotów']; item_list_id?: Parametry zdarzenia ['item_list_id']; [klucz: string]: dowolny; }
opcje Opcje połączeń analitycznych

Zwroty:

próżnia

logEvent(analyticsInstance, nazwa zdarzenia, parametry zdarzenia, opcje)

Wysyła zdarzenie Google Analytics z podanymi eventParams . Ta metoda automatycznie kojarzy zarejestrowane zdarzenie z instancją aplikacji internetowej Firebase na tym urządzeniu.

Listę zalecanych parametrów zdarzeń znajdziesz w dokumentacji referencyjnej 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 analityczna Analityka
Nazwa wydarzenia Nazwa zdarzenia niestandardowego <T>
parametry zdarzenia { [klucz: ciąg znaków]: dowolny; }
opcje Opcje połączeń analitycznych

Zwroty:

próżnia

logEvent(analyticsInstance, nazwa zdarzenia, parametry zdarzenia, opcje)

Wysyła zdarzenie Google Analytics z podanymi eventParams . Ta metoda automatycznie kojarzy zarejestrowane zdarzenie z instancją aplikacji internetowej Firebase na tym urządzeniu.

Listę zalecanych parametrów zdarzeń znajdziesz w dokumentacji referencyjnej 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 analityczna Analityka
Nazwa wydarzenia „dodaj_do_koszyka” | „dodaj_do_listy życzeń” | „usuń_z_koszyka”
parametry zdarzenia {waluta?: EventParams ['waluta']; wartość?: Parametry zdarzenia ['wartość']; elementy?: EventParams ['rzeczy']; [klucz: string]: dowolny; }
opcje Opcje połączeń analitycznych

Zwroty:

próżnia

logEvent(analyticsInstance, nazwa zdarzenia, parametry zdarzenia, opcje)

Wysyła zdarzenie Google Analytics z podanymi eventParams . Ta metoda automatycznie kojarzy zarejestrowane zdarzenie z instancją aplikacji internetowej Firebase na tym urządzeniu.

Listę zalecanych parametrów zdarzeń znajdziesz w dokumentacji referencyjnej 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 analityczna Analityka
Nazwa wydarzenia „rozpoczęcie_kasy”
parametry zdarzenia {waluta?: EventParams ['waluta']; kupon?: EventParams ['kupon']; wartość?: Parametry zdarzenia ['wartość']; elementy?: EventParams ['rzeczy']; [klucz: string]: dowolny; }
opcje Opcje połączeń analitycznych

Zwroty:

próżnia

logEvent(analyticsInstance, nazwa zdarzenia, parametry zdarzenia, opcje)

Wysyła zdarzenie Google Analytics z podanymi eventParams . Ta metoda automatycznie kojarzy zarejestrowane zdarzenie z instancją aplikacji internetowej Firebase na tym urządzeniu.

Listę zalecanych parametrów zdarzeń znajdziesz w dokumentacji referencyjnej 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 analityczna Analityka
Nazwa wydarzenia „postęp_kasy”
parametry zdarzenia {waluta?: EventParams ['waluta']; kupon?: EventParams ['kupon']; wartość?: Parametry zdarzenia ['wartość']; elementy?: EventParams ['rzeczy']; checkout_step?: Parametry zdarzenia ['krok_kasy']; opcja_checkout?: Parametry zdarzenia ['opcja_kasy']; [klucz: string]: dowolny; }
opcje Opcje połączeń analitycznych

Zwroty:

próżnia

logEvent(analyticsInstance, nazwa zdarzenia, parametry zdarzenia, opcje)

Wysyła zdarzenie Google Analytics z podanymi eventParams . Ta metoda automatycznie kojarzy zarejestrowane zdarzenie z instancją aplikacji internetowej Firebase na tym urządzeniu.

Zobacz Zmierz wyjątki .

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 analityczna Analityka
Nazwa wydarzenia 'wyjątek'
parametry zdarzenia { opis?: Parametry zdarzenia ['opis']; fatal?: EventParams ['fatalny']; [klucz: string]: dowolny; }
opcje Opcje połączeń analitycznych

Zwroty:

próżnia

logEvent(analyticsInstance, nazwa zdarzenia, parametry zdarzenia, opcje)

Wysyła zdarzenie Google Analytics z podanymi eventParams . Ta metoda automatycznie kojarzy zarejestrowane zdarzenie z instancją aplikacji internetowej Firebase na tym urządzeniu.

Listę zalecanych parametrów zdarzeń znajdziesz w dokumentacji referencyjnej 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 analityczna Analityka
Nazwa wydarzenia „generuj_potencjał”
parametry zdarzenia {wartość?: Parametry zdarzenia ['wartość']; waluta?: EventParams ['waluta']; [klucz: string]: dowolny; }
opcje Opcje połączeń analitycznych

Zwroty:

próżnia

logEvent(analyticsInstance, nazwa zdarzenia, parametry zdarzenia, opcje)

Wysyła zdarzenie Google Analytics z podanymi eventParams . Ta metoda automatycznie kojarzy zarejestrowane zdarzenie z instancją aplikacji internetowej Firebase na tym urządzeniu.

Listę zalecanych parametrów zdarzeń znajdziesz w dokumentacji referencyjnej 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 analityczna Analityka
Nazwa wydarzenia 'Zaloguj sie'
parametry zdarzenia { metoda?: EventParams ['metoda']; [klucz: string]: dowolny; }
opcje Opcje połączeń analitycznych

Zwroty:

próżnia

logEvent(analyticsInstance, nazwa zdarzenia, parametry zdarzenia, opcje)

Wysyła zdarzenie Google Analytics z podanymi eventParams . Ta metoda automatycznie kojarzy zarejestrowane zdarzenie z 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 analityczna Analityka
Nazwa wydarzenia 'widok strony'
parametry zdarzenia {tytuł_strony?: ciąg; lokalizacja_strony?: string; ścieżka_strony?: ciąg; [klucz: string]: dowolny; }
opcje Opcje połączeń analitycznych

Zwroty:

próżnia

setAnalyticsCollectionEnabled(analyticsInstance, włączone)

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

Podpis:

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

Parametry

Parametr Typ Opis
Instancja analityczna Analityka Instancja Analytics .
włączony wartość logiczna Jeśli true, włącza zbieranie, jeśli false, wyłącza je.

Zwroty:

próżnia

setCurrentScreen(analyticsInstance, nazwa ekranu, opcje)

Użyj z eventName jako „screen_view” i dodaj odpowiednie eventParams . Zobacz Śledź wyświetlenia 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 analityczna Analityka Instancja Analytics .
Nick strunowy Nazwa ekranu do ustawienia.
opcje Opcje połączeń analitycznych

Zwroty:

próżnia

setUserId(analyticsInstance, 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 analityczna Analityka Instancja Analytics .
ID ciąg | zero Identyfikator użytkownika do ustawienia.
opcje Opcje połączeń analitycznych

Zwroty:

próżnia

setUserProperties(analyticsInstance, właściwości, opcje)

Użyj polecenia gtag config , aby ustawić wszystkie określone parametry.

Podpis:

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

Parametry

Parametr Typ Opis
Instancja analityczna Analityka
nieruchomości Parametry niestandardowe
opcje Opcje połączeń analitycznych

Zwroty:

próżnia

funkcjonować()

jest wspierany()

Jest to publiczna metoda statyczna udostępniana użytkownikom, która obejmuje cztery różne kontrole:

  1. Sprawdź, czy nie jest to środowisko rozszerzenia przeglądarki. 2. Sprawdź, czy w aktualnej przeglądarce włączona jest obsługa plików cookies. 3. Sprawdź, czy środowisko przeglądarki obsługuje IndexedDB. 4. Sprawdź, czy bieżący kontekst przeglądarki pozwala na użycie IndexedDB.open() .

Podpis:

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

Zwroty:

Obietnica<boolean>

funkcja(ustawienia zgody, ...)

setConsent(ustawienia zgody)

Ustawia odpowiedni stan zgody użytkownika końcowego dla tej aplikacji internetowej we wszystkich odniesieniach do tagów gtag po zainicjowaniu Firebase Analytics.

Użyj ConsentSettings , aby określić indywidualne wartości typu zgody. Domyślnie typy zgód są ustawione na „udzielone”.

Podpis:

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

Parametry

Parametr Typ Opis
ustawienia zgody Ustawienia zgody Mapuje odpowiedni stan zgody użytkownika końcowego na plik gtag.js.

Zwroty:

próżnia

funkcja(customParams, ...)

setDefaultEventParameters (customParams)

Dodaje dane, które zostaną ustawione na każdym zdarzeniu zarejestrowanym z SDK, także automatycznym. Dzięki poleceniu „set” gtag przekazane wartości zostają zachowane na bieżącej stronie i przekazywane wraz ze wszystkimi kolejnymi zdarzeniami.

Podpis:

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

Parametry

Parametr Typ Opis
niestandardoweParamy Parametry niestandardowe Wszelkie niestandardowe parametry, które użytkownik może przekazać do gtag.js.

Zwroty:

próżnia

funkcja(opcje, ...)

ustawienia(opcje)

Konfiguruje Firebase Analytics do używania niestandardowych nazw gtag lub dataLayer . Przeznaczony do użycia, jeśli skrypt gtag.js został zainstalowany na tej stronie niezależnie od Firebase Analytics i używa nazw innych niż domyślne dla funkcji gtag lub dataLayer . Należy wywołać przed wywołaniem getAnalytics() w przeciwnym razie nie będzie to miało żadnego efektu.

Podpis:

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

Parametry

Parametr Typ Opis
opcje UstawieniaOpcje Niestandardowe nazwy tagów gtag i dataLayer.

Zwroty:

próżnia

Ciąg stanu zgody

Czy dany rodzaj zgody został udzielony, czy odrzucony.

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 znaków niestandardowej nazwy zdarzenia, którego nie ma na standardowej liście zalecanych nazw zdarzeń.

Podpis:

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

NazwaZdarzeniaCiąg

Wpisz standardowe nazwy zdarzeń Google Analytics. logEvent akceptuje również dowolny niestandardowy ciąg znaków 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';