analytics package

L'SDK Web di Firebase Analytics. Questo SDK non funziona in un ambiente Node.js.

Funzioni

Interfacce

Digitare Alias

funzione(app, ...)

getAnalytics(app)

Restituisce un'istanza di Analytics per l'app specificata.

Firma:

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

Parametri

Ritorna:

Analitica

inizializza Analytics (app, opzioni)

Restituisce un'istanza di Analytics per l'app specificata.

Firma:

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

Parametri

Ritorna:

Analitica

funzione(analyticsInstance, ...)

getGoogleAnalyticsClientId(analyticsInstance)

Recupera un identificatore univoco di Google Analytics per il client Web. Vedi client_id .

Firma:

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

Parametri

Ritorna:

Promesso<string>

logEvent(analyticsInstance, eventName, eventParams, opzioni)

Invia un evento di Google Analytics con determinati eventParams . Questo metodo associa automaticamente l'evento registrato a questa istanza dell'app Web Firebase su questo dispositivo.

L'elenco dei parametri evento consigliati è disponibile nella documentazione di riferimento GA4 .

Firma:

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;

Parametri

Ritorna:

vuoto

logEvent(analyticsInstance, eventName, eventParams, opzioni)

Invia un evento di Google Analytics con determinati eventParams . Questo metodo associa automaticamente l'evento registrato a questa istanza dell'app Web Firebase su questo dispositivo.

L'elenco dei parametri evento consigliati è disponibile nella documentazione di riferimento GA4 .

Firma:

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;

Parametri

Ritorna:

vuoto

logEvent(analyticsInstance, eventName, eventParams, opzioni)

Invia un evento di Google Analytics con determinati eventParams . Questo metodo associa automaticamente l'evento registrato a questa istanza dell'app Web Firebase su questo dispositivo.

Vedere Monitorare le schermate .

Firma:

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;

Parametri

Ritorna:

vuoto

logEvent(analyticsInstance, eventName, eventParams, opzioni)

Invia un evento di Google Analytics con determinati eventParams . Questo metodo associa automaticamente l'evento registrato a questa istanza dell'app Web Firebase su questo dispositivo.

L'elenco dei parametri evento consigliati è disponibile nella documentazione di riferimento GA4 .

Firma:

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

Parametri

Ritorna:

vuoto

logEvent(analyticsInstance, eventName, eventParams, opzioni)

Invia un evento di Google Analytics con determinati eventParams . Questo metodo associa automaticamente l'evento registrato a questa istanza dell'app Web Firebase su questo dispositivo.

L'elenco dei parametri evento consigliati è disponibile nella documentazione di riferimento GA4 .

Firma:

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;

Parametri

Ritorna:

vuoto

logEvent(analyticsInstance, eventName, eventParams, opzioni)

Invia un evento di Google Analytics con determinati eventParams . Questo metodo associa automaticamente l'evento registrato a questa istanza dell'app Web Firebase su questo dispositivo.

L'elenco dei parametri evento consigliati è disponibile nella documentazione di riferimento GA4 .

Firma:

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;

Parametri

Ritorna:

vuoto

logEvent(analyticsInstance, eventName, eventParams, opzioni)

Invia un evento di Google Analytics con determinati eventParams . Questo metodo associa automaticamente l'evento registrato a questa istanza dell'app Web Firebase su questo dispositivo.

L'elenco dei parametri evento consigliati è disponibile nella documentazione di riferimento GA4 .

Firma:

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;

Parametri

Ritorna:

vuoto

logEvent(analyticsInstance, eventName, eventParams, opzioni)

Invia un evento di Google Analytics con determinati eventParams . Questo metodo associa automaticamente l'evento registrato a questa istanza dell'app Web Firebase su questo dispositivo.

L'elenco dei parametri evento consigliati è disponibile nella documentazione di riferimento GA4 .

Firma:

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;

Parametri

Ritorna:

vuoto

logEvent(analyticsInstance, eventName, eventParams, opzioni)

Invia un evento di Google Analytics con determinati eventParams . Questo metodo associa automaticamente l'evento registrato a questa istanza dell'app Web Firebase su questo dispositivo.

L'elenco dei parametri evento consigliati è disponibile nella documentazione di riferimento GA4 .

Firma:

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;

Parametri

Ritorna:

vuoto

logEvent(analyticsInstance, eventName, eventParams, opzioni)

Invia un evento di Google Analytics con determinati eventParams . Questo metodo associa automaticamente l'evento registrato a questa istanza dell'app Web Firebase su questo dispositivo.

L'elenco dei parametri evento consigliati è disponibile nella documentazione di riferimento GA4 .

Firma:

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

Parametri

Ritorna:

vuoto

logEvent(analyticsInstance, eventName, eventParams, opzioni)

Invia un evento di Google Analytics con determinati eventParams . Questo metodo associa automaticamente l'evento registrato a questa istanza dell'app Web Firebase su questo dispositivo.

L'elenco dei parametri evento consigliati è disponibile nella documentazione di riferimento GA4 .

Firma:

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;

Parametri

Ritorna:

vuoto

logEvent(analyticsInstance, eventName, eventParams, opzioni)

Invia un evento di Google Analytics con determinati eventParams . Questo metodo associa automaticamente l'evento registrato a questa istanza dell'app Web Firebase su questo dispositivo.

L'elenco dei parametri evento consigliati è disponibile nella documentazione di riferimento GA4 .

Firma:

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;

Parametri

Ritorna:

vuoto

logEvent(analyticsInstance, eventName, eventParams, opzioni)

Invia un evento di Google Analytics con determinati eventParams . Questo metodo associa automaticamente l'evento registrato a questa istanza dell'app Web Firebase su questo dispositivo.

L'elenco dei parametri evento consigliati è disponibile nella documentazione di riferimento GA4 .

Firma:

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;

Parametri

Ritorna:

vuoto

logEvent(analyticsInstance, eventName, eventParams, opzioni)

Invia un evento di Google Analytics con determinati eventParams . Questo metodo associa automaticamente l'evento registrato a questa istanza dell'app Web Firebase su questo dispositivo.

L'elenco dei parametri evento consigliati è disponibile nella documentazione di riferimento GA4 .

Firma:

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;

Parametri

Ritorna:

vuoto

logEvent(analyticsInstance, eventName, eventParams, opzioni)

Invia un evento di Google Analytics con determinati eventParams . Questo metodo associa automaticamente l'evento registrato a questa istanza dell'app Web Firebase su questo dispositivo.

L'elenco dei parametri evento consigliati è disponibile nella documentazione di riferimento GA4 .

Firma:

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

Parametri

Ritorna:

vuoto

logEvent(analyticsInstance, eventName, eventParams, opzioni)

Invia un evento di Google Analytics con determinati eventParams . Questo metodo associa automaticamente l'evento registrato a questa istanza dell'app Web Firebase su questo dispositivo.

L'elenco dei parametri evento consigliati è disponibile nella documentazione di riferimento GA4 .

Firma:

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;

Parametri

Ritorna:

vuoto

logEvent(analyticsInstance, eventName, eventParams, opzioni)

Invia un evento di Google Analytics con determinati eventParams . Questo metodo associa automaticamente l'evento registrato a questa istanza dell'app Web Firebase su questo dispositivo.

L'elenco dei parametri evento consigliati è disponibile nella documentazione di riferimento GA4 .

Firma:

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;

Parametri

Ritorna:

vuoto

logEvent(analyticsInstance, eventName, eventParams, opzioni)

Invia un evento di Google Analytics con determinati eventParams . Questo metodo associa automaticamente l'evento registrato a questa istanza dell'app Web Firebase su questo dispositivo.

L'elenco dei parametri evento consigliati è disponibile nella documentazione di riferimento GA4 .

Firma:

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;

Parametri

Ritorna:

vuoto

logEvent(analyticsInstance, eventName, eventParams, opzioni)

Invia un evento di Google Analytics con determinati eventParams . Questo metodo associa automaticamente l'evento registrato a questa istanza dell'app Web Firebase su questo dispositivo.

Consulta Eccezioni di misurazione .

Firma:

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

Parametri

Ritorna:

vuoto

logEvent(analyticsInstance, eventName, eventParams, opzioni)

Invia un evento di Google Analytics con determinati eventParams . Questo metodo associa automaticamente l'evento registrato a questa istanza dell'app Web Firebase su questo dispositivo.

L'elenco dei parametri evento consigliati è disponibile nella documentazione di riferimento GA4 .

Firma:

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

Parametri

Ritorna:

vuoto

logEvent(analyticsInstance, eventName, eventParams, opzioni)

Invia un evento di Google Analytics con determinati eventParams . Questo metodo associa automaticamente l'evento registrato a questa istanza dell'app Web Firebase su questo dispositivo.

L'elenco dei parametri evento consigliati è disponibile nella documentazione di riferimento GA4 .

Firma:

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

Parametri

Ritorna:

vuoto

logEvent(analyticsInstance, eventName, eventParams, opzioni)

Invia un evento di Google Analytics con determinati eventParams . Questo metodo associa automaticamente l'evento registrato a questa istanza dell'app Web Firebase su questo dispositivo.

Consulta Visualizzazioni di pagina .

Firma:

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;

Parametri

Ritorna:

vuoto

setAnalyticsCollectionEnabled(analyticsInstance, abilitato)

Imposta se la raccolta di Google Analytics è abilitata per questa app su questo dispositivo. Imposta window['ga-disable-analyticsId'] = true;

Firma:

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

Parametri

Ritorna:

vuoto

setCurrentScreen(analyticsInstance, screenName, opzioni)

Utilizzare con eventName come 'screen_view' e aggiungere eventParams pertinenti . Vedere Monitorare le schermate .

Utilizza il comando gtag config per impostare screen_name .

Firma:

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

Parametri

Ritorna:

vuoto

setUserId(analyticsInstance, id, opzioni)

Utilizza il comando gtag config per impostare user_id .

Firma:

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

Parametri

Ritorna:

vuoto

setUserProperties(analyticsInstance, proprietà, opzioni)

Utilizza il comando gtag config per impostare tutti i parametri specificati.

Firma:

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

Parametri

Ritorna:

vuoto

funzione()

è supportato()

Si tratta di un metodo statico pubblico fornito agli utenti che racchiude quattro diversi controlli:

1. Controlla se non è un ambiente di estensione del browser. 2. Controlla se i cookie sono abilitati nel browser corrente. 3. Controlla se IndexedDB è supportato dall'ambiente del browser. 4. Controlla se il contesto del browser corrente è valido per l'utilizzo IndexedDB.open() .

Firma:

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

Ritorna:

Promesso<booleano>

funzione(Impostazioniconsenso, ...)

setConsent(Impostazioni consenso)

Imposta lo stato di consenso dell'utente finale applicabile per questa app web su tutti i riferimenti gtag una volta inizializzato Firebase Analytics.

Utilizza ConsentSettings per specificare i singoli valori del tipo di consenso. Per impostazione predefinita, i tipi di consenso sono impostati su "concesso".

Firma:

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

Parametri

Ritorna:

vuoto

funzione(parametripersonalizzati, ...)

setDefaultEventParameters(customParams)

Aggiunge i dati che verranno impostati su ogni evento registrato dall'SDK, compresi quelli automatici. Con il comando "set" di gtag, i valori passati persistono nella pagina corrente e vengono passati con tutti gli eventi successivi.

Firma:

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

Parametri

Ritorna:

vuoto

funzione(opzioni, ...)

impostazioni (opzioni)

Configura Firebase Analytics per utilizzare nomi gtag o dataLayer personalizzati. Destinato a essere utilizzato se lo script gtag.js è stato installato su questa pagina indipendentemente da Firebase Analytics e utilizza nomi non predefiniti per la funzione gtag o per dataLayer . Deve essere chiamato prima di chiamare getAnalytics() altrimenti non avrà alcun effetto.

Firma:

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

Parametri

Ritorna:

vuoto

StringStatusConsenso

Se un particolare tipo di consenso è stato concesso o negato.

Firma:

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

Valuta

Tipo di valuta standard di Google Analytics.

Firma:

export declare type Currency = string | number;

Nomeeventopersonalizzato

Qualsiasi stringa del nome dell'evento personalizzato non presente nell'elenco standard dei nomi degli eventi consigliati.

Firma:

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

StringaNomeEvento

Digita per i nomi degli eventi standard di Google Analytics. logEvent accetta anche qualsiasi stringa personalizzata e la interpreta come un nome di evento personalizzato.

Firma:

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