analytics package

El SDK web de Firebase Analytics Este SDK no funciona en un entorno de Node.js.

Funciones

Función Descripción
function(app, ...)
getAnalytics(aplicación) Muestra una instancia de Analytics para la app determinada.
inicializarAnalytics(app, opciones) Muestra una instancia de Analytics para la app determinada.
function(analyticsInstance, ...)
getGoogleAnalyticsClientId(analyticsInstance) Recupera un identificador único de Google Analytics para el cliente web. Consulta client_id.
logEvent(analyticsInstance, eventName, eventParams, options) Envía un evento de Google Analytics con un eventParams determinado. Este método asocia automáticamente este evento registrado con esta instancia de aplicación web de Firebase en este dispositivo.Puedes encontrar la lista de parámetros de eventos recomendados en la documentación de referencia de GA4.
logEvent(analyticsInstance, eventName, eventParams, options) Envía un evento de Google Analytics con un eventParams determinado. Este método asocia automáticamente este evento registrado con esta instancia de aplicación web de Firebase en este dispositivo.Puedes encontrar la lista de parámetros de eventos recomendados en la documentación de referencia de GA4.
logEvent(analyticsInstance, eventName, eventParams, options) Envía un evento de Google Analytics con un eventParams determinado. Este método asocia automáticamente este evento registrado con esta instancia de la aplicación web de Firebase en este dispositivo.Consulta Cómo hacer un seguimiento de las vistas de pantalla.
logEvent(analyticsInstance, eventName, eventParams, options) Envía un evento de Google Analytics con un eventParams determinado. Este método asocia automáticamente este evento registrado con esta instancia de aplicación web de Firebase en este dispositivo.Puedes encontrar la lista de parámetros de eventos recomendados en la documentación de referencia de GA4.
logEvent(analyticsInstance, eventName, eventParams, options) Envía un evento de Google Analytics con un eventParams determinado. Este método asocia automáticamente este evento registrado con esta instancia de aplicación web de Firebase en este dispositivo.Puedes encontrar la lista de parámetros de eventos recomendados en la documentación de referencia de GA4.
logEvent(analyticsInstance, eventName, eventParams, options) Envía un evento de Google Analytics con un eventParams determinado. Este método asocia automáticamente este evento registrado con esta instancia de aplicación web de Firebase en este dispositivo.Puedes encontrar la lista de parámetros de eventos recomendados en la documentación de referencia de GA4.
logEvent(analyticsInstance, eventName, eventParams, options) Envía un evento de Google Analytics con un eventParams determinado. Este método asocia automáticamente este evento registrado con esta instancia de aplicación web de Firebase en este dispositivo.Puedes encontrar la lista de parámetros de eventos recomendados en la documentación de referencia de GA4.
logEvent(analyticsInstance, eventName, eventParams, options) Envía un evento de Google Analytics con un eventParams determinado. Este método asocia automáticamente este evento registrado con esta instancia de aplicación web de Firebase en este dispositivo.Puedes encontrar la lista de parámetros de eventos recomendados en la documentación de referencia de GA4.
logEvent(analyticsInstance, eventName, eventParams, options) Envía un evento de Google Analytics con un eventParams determinado. Este método asocia automáticamente este evento registrado con esta instancia de aplicación web de Firebase en este dispositivo.Puedes encontrar la lista de parámetros de eventos recomendados en la documentación de referencia de GA4.
logEvent(analyticsInstance, eventName, eventParams, options) Envía un evento de Google Analytics con un eventParams determinado. Este método asocia automáticamente este evento registrado con esta instancia de aplicación web de Firebase en este dispositivo.Puedes encontrar la lista de parámetros de eventos recomendados en la documentación de referencia de GA4.
logEvent(analyticsInstance, eventName, eventParams, options) Envía un evento de Google Analytics con un eventParams determinado. Este método asocia automáticamente este evento registrado con esta instancia de aplicación web de Firebase en este dispositivo.Puedes encontrar la lista de parámetros de eventos recomendados en la documentación de referencia de GA4.
logEvent(analyticsInstance, eventName, eventParams, options) Envía un evento de Google Analytics con un eventParams determinado. Este método asocia automáticamente este evento registrado con esta instancia de aplicación web de Firebase en este dispositivo.Puedes encontrar la lista de parámetros de eventos recomendados en la documentación de referencia de GA4.
logEvent(analyticsInstance, eventName, eventParams, options) Envía un evento de Google Analytics con un eventParams determinado. Este método asocia automáticamente este evento registrado con esta instancia de aplicación web de Firebase en este dispositivo.Puedes encontrar la lista de parámetros de eventos recomendados en la documentación de referencia de GA4.
logEvent(analyticsInstance, eventName, eventParams, options) Envía un evento de Google Analytics con un eventParams determinado. Este método asocia automáticamente este evento registrado con esta instancia de aplicación web de Firebase en este dispositivo.Puedes encontrar la lista de parámetros de eventos recomendados en la documentación de referencia de GA4.
logEvent(analyticsInstance, eventName, eventParams, options) Envía un evento de Google Analytics con un eventParams determinado. Este método asocia automáticamente este evento registrado con esta instancia de aplicación web de Firebase en este dispositivo.Puedes encontrar la lista de parámetros de eventos recomendados en la documentación de referencia de GA4.
logEvent(analyticsInstance, eventName, eventParams, options) Envía un evento de Google Analytics con un eventParams determinado. Este método asocia automáticamente este evento registrado con esta instancia de aplicación web de Firebase en este dispositivo.Puedes encontrar la lista de parámetros de eventos recomendados en la documentación de referencia de GA4.
logEvent(analyticsInstance, eventName, eventParams, options) Envía un evento de Google Analytics con un eventParams determinado. Este método asocia automáticamente este evento registrado con esta instancia de aplicación web de Firebase en este dispositivo.Puedes encontrar la lista de parámetros de eventos recomendados en la documentación de referencia de GA4.
logEvent(analyticsInstance, eventName, eventParams, options) Envía un evento de Google Analytics con un eventParams determinado. Este método asocia automáticamente este evento registrado con esta instancia de aplicación web de Firebase en este dispositivo.Puedes encontrar la lista de parámetros de eventos recomendados en la documentación de referencia de GA4.
logEvent(analyticsInstance, eventName, eventParams, options) Envía un evento de Google Analytics con un eventParams determinado. Este método asocia automáticamente este evento registrado con esta instancia de la aplicación web de Firebase en este dispositivo.Consulta Cómo medir excepciones.
logEvent(analyticsInstance, eventName, eventParams, options) Envía un evento de Google Analytics con un eventParams determinado. Este método asocia automáticamente este evento registrado con esta instancia de aplicación web de Firebase en este dispositivo.Puedes encontrar la lista de parámetros de eventos recomendados en la documentación de referencia de GA4.
logEvent(analyticsInstance, eventName, eventParams, options) Envía un evento de Google Analytics con un eventParams determinado. Este método asocia automáticamente este evento registrado con esta instancia de aplicación web de Firebase en este dispositivo.Puedes encontrar la lista de parámetros de eventos recomendados en la documentación de referencia de GA4.
logEvent(analyticsInstance, eventName, eventParams, options) Envía un evento de Google Analytics con un eventParams determinado. Este método asocia automáticamente este evento registrado con esta instancia de la aplicación web de Firebase en este dispositivo.Consulta Páginas vistas.
setAnalyticsCollectionEnabled(analyticsInstance, habilitada) Establece si la recopilación de Google Analytics está habilitada para esta aplicación en este dispositivo. Establece el window['ga-disable-analyticsId'] = true; global.
setCurrentScreen(analyticsInstance, screenName, options) Utilice el comando config de gtag para establecer screen_name.
setUserId(analyticsInstance, id, options) Utilice el comando config de gtag para establecer user_id.
setUserProperties(analyticsInstance, properties, options) Utilice el comando config de gtag para establecer todos los parámetros especificados.
function()
isSupported() Este es un método público estático que se proporciona a los usuarios que une cuatro verificaciones diferentes:1. Comprueba si no es un entorno de extensión del navegador. 2. Comprobar si las cookies están habilitadas en el navegador actual. 3. Comprueba si el entorno del navegador admite IndexedDB. 4. Verifica si el contexto actual del navegador es válido para usar IndexedDB.open().
function(consentSettings, ...)
setConsent(consentSettings) Establece el estado de consentimiento del usuario final aplicable para esta aplicación web en todas las referencias de gtag una vez que se inicializa Firebase Analytics.Utiliza ConsentSettings para especificar valores de tipos de consentimiento individuales. De forma predeterminada, los tipos de consentimiento están configurados como "granted".
function(customParams, ...)
setDefaultEventParameters(customParams) Agrega datos que se configurarán en cada evento registrado desde el SDK, incluidos los eventos automáticos. Con la opción "set" de gtag , los valores pasados persisten en la página actual y se pasan con todos los eventos posteriores.
function(options, ...)
configuración(opciones) Configura Firebase Analytics para usar nombres gtag o dataLayer personalizados. Se diseñó para usarse si la secuencia de comandos gtag.js se instaló en esta página, independientemente de Firebase Analytics, y si utiliza nombres no predeterminados para la función gtag o dataLayer. Se debe llamar antes de llamar a getAnalytics(). De lo contrario, el cambio no tendrá ningún efecto.

Interfaces

Interfaz Descripción
Analytics Una instancia de Firebase Analytics.
AnalyticsCallOptions Opciones adicionales que se pueden pasar a llamadas de método de Analytics, como logEvent, etcétera.
Configuración de Analytics Opciones de inicialización de la instancia de Analytics.
ConsentSettings Configuración de estado de consentimiento para cada tipo de consentimiento. Para obtener más información, consulta la documentación de referencia de GA4 sobre el estado y los tipos de consentimiento.
ControlParams Parámetros de control de gtag.js estándar Para obtener más información, consulta la documentación de referencia de GA4.
CustomParams Cualquier parámetro personalizado que el usuario pueda pasar a gtag
EventParams Parámetros del evento gtag.js estándar Para obtener más información, consulta la documentación de referencia de GA4.
GtagConfigParams Un conjunto de parámetros de configuración comunes de Google Analytics reconocidos por gtag.js.
Elemento Tipo Item estándar de Google Analytics.
Promoción Campo utilizado anteriormente por algunos eventos de Google Analytics.
Opciones de configuración Especifica opciones personalizadas para tu instancia de Firebase Analytics. Debes establecerlos antes de inicializar firebase.analytics().

Escribe alias

Alias de tipo Descripción
ConsentStatusString Indica si se otorgó o rechazó un tipo de consentimiento en particular.
Moneda Tipo de moneda estándar de Google Analytics.
NombreDelEventoPersonalizado Cualquier cadena de nombre de evento personalizado que no esté en la lista estándar de nombres de eventos recomendados
EventNameString Escribe para los nombres de eventos estándares de Google Analytics. logEvent también acepta cualquier cadena personalizada y la interpreta como un nombre de evento personalizado.

función(app, ...)

getAnalytics(aplicación)

Muestra una instancia de Analytics para la app determinada.

Firma:

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

Parámetros

Parámetro Tipo Descripción
app App de Firebase La FirebaseApp que se usará.

Muestra:

Analytics

inicializarAnalytics(app, opciones)

Muestra una instancia de Analytics para la app determinada.

Firma:

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

Parámetros

Parámetro Tipo Descripción
app App de Firebase La FirebaseApp que se usará.
opciones Configuración de Analytics

Muestra:

Analytics

function(analyticsInstance, ...)

getGoogleAnalyticsClientId(analyticsInstance)

Recupera un identificador único de Google Analytics para el cliente web. Consulta client_id.

Firma:

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

Parámetros

Parámetro Tipo Descripción
Instancia analítica Analytics

Muestra:

Promesa<string>

logEvent(analyticsInstance, eventName, eventParams, options)

Envía un evento de Google Analytics con un eventParams determinado. Este método asocia automáticamente este evento registrado con esta instancia de la aplicación web de Firebase en este dispositivo.

La lista de parámetros de eventos recomendados se encuentra en la documentación de referencia de 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;

Parámetros

Parámetro Tipo Descripción
Instancia analítica Analytics
nombredelevento "add_payment_info"
eventParams { cupón?: EventParams['coupon']; moneda?: EventParams['currency']; elementos?: EventParams['items']; payment_type?: EventParams['payment_type']; valor?: EventParams['value']; [clave: cadena]: cualquiera; }.
opciones AnalyticsCallOptions

Muestra:

void

logEvent(analyticsInstance, eventName, eventParams, options)

Envía un evento de Google Analytics con un eventParams determinado. Este método asocia automáticamente este evento registrado con esta instancia de la aplicación web de Firebase en este dispositivo.

La lista de parámetros de eventos recomendados se encuentra en la documentación de referencia de 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;

Parámetros

Parámetro Tipo Descripción
Instancia analítica Analytics
nombredelevento 'compra' | "refund"
eventParams { value?: EventParams['value']; moneda?: EventParams['currency']; transaction_id: EventParams['transaction_id']; impuestos?: EventParams['tax']; envío?: EventParams['shipping']; elementos?: EventParams['items']; cupón?: EventParams['coupon']; afiliación?: EventParams['affiliation']; [clave: cadena]: cualquiera; }.
opciones AnalyticsCallOptions

Muestra:

void

logEvent(analyticsInstance, eventName, eventParams, options)

Envía un evento de Google Analytics con un eventParams determinado. Este método asocia automáticamente este evento registrado con esta instancia de la aplicación web de Firebase en este dispositivo.

Consulta Realiza un seguimiento de las vistas de pantalla.

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;

Parámetros

Parámetro Tipo Descripción
Instancia analítica Analytics
nombredelevento 'screen_view'
eventParams { firebase_screen: EventParams['firebase_screen']; firebase_screen_class: EventParams['firebase_screen_class']; [clave: cadena]: cualquiera; }.
opciones AnalyticsCallOptions

Muestra:

void

logEvent(analyticsInstance, eventName, eventParams, options)

Envía un evento de Google Analytics con un eventParams determinado. Este método asocia automáticamente este evento registrado con esta instancia de la aplicación web de Firebase en este dispositivo.

La lista de parámetros de eventos recomendados se encuentra en la documentación de referencia de 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;

Parámetros

Parámetro Tipo Descripción
Instancia analítica Analytics
nombredelevento "buscar" | 'view_search_results'
eventParams { search_term?: EventParams['search_term']; [clave: cadena]: cualquiera; }.
opciones AnalyticsCallOptions

Muestra:

void

logEvent(analyticsInstance, eventName, eventParams, options)

Envía un evento de Google Analytics con un eventParams determinado. Este método asocia automáticamente este evento registrado con esta instancia de la aplicación web de Firebase en este dispositivo.

La lista de parámetros de eventos recomendados se encuentra en la documentación de referencia de 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;

Parámetros

Parámetro Tipo Descripción
Instancia analítica Analytics
nombredelevento "select_content"
eventParams { content_type?: EventParams['content_type']; item_id?: EventParams['item_id']; [clave: cadena]: cualquiera; }.
opciones AnalyticsCallOptions

Muestra:

void

logEvent(analyticsInstance, eventName, eventParams, options)

Envía un evento de Google Analytics con un eventParams determinado. Este método asocia automáticamente este evento registrado con esta instancia de la aplicación web de Firebase en este dispositivo.

La lista de parámetros de eventos recomendados se encuentra en la documentación de referencia de 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;

Parámetros

Parámetro Tipo Descripción
Instancia analítica Analytics
nombredelevento "select_item"
eventParams { items?: EventParams['items']; item_list_name?: EventParams['item_list_name']; item_list_id?: EventParams['item_list_id']; [clave: cadena]: cualquiera; }.
opciones AnalyticsCallOptions

Muestra:

void

logEvent(analyticsInstance, eventName, eventParams, options)

Envía un evento de Google Analytics con un eventParams determinado. Este método asocia automáticamente este evento registrado con esta instancia de la aplicación web de Firebase en este dispositivo.

La lista de parámetros de eventos recomendados se encuentra en la documentación de referencia de 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;

Parámetros

Parámetro Tipo Descripción
Instancia analítica Analytics
nombredelevento 'select_promotion' | 'view_promotion'
eventParams { items?: EventParams['items']; promotion_id?: EventParams['promotion_id']; promotion_name?: EventParams['promotion_name']; [clave: cadena]: cualquiera; }.
opciones AnalyticsCallOptions

Muestra:

void

logEvent(analyticsInstance, eventName, eventParams, options)

Envía un evento de Google Analytics con un eventParams determinado. Este método asocia automáticamente este evento registrado con esta instancia de la aplicación web de Firebase en este dispositivo.

La lista de parámetros de eventos recomendados se encuentra en la documentación de referencia de 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;

Parámetros

Parámetro Tipo Descripción
Instancia analítica Analytics
nombredelevento 'set_checkout_option'
eventParams { checkout_step?: EventParams['checkout_step']; Checkout_option? EventParams['checkout_option']; [clave: cadena]: cualquiera; }.
opciones AnalyticsCallOptions

Muestra:

void

logEvent(analyticsInstance, eventName, eventParams, options)

Envía un evento de Google Analytics con un eventParams determinado. Este método asocia automáticamente este evento registrado con esta instancia de la aplicación web de Firebase en este dispositivo.

La lista de parámetros de eventos recomendados se encuentra en la documentación de referencia de 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;

Parámetros

Parámetro Tipo Descripción
Instancia analítica Analytics
nombredelevento "compartir"
eventParams { método?: EventParams['method']; ¿content_type?: EventParams['content_type']; item_id?: EventParams['item_id']; [clave: cadena]: cualquiera; }.
opciones AnalyticsCallOptions

Muestra:

void

logEvent(analyticsInstance, eventName, eventParams, options)

Envía un evento de Google Analytics con un eventParams determinado. Este método asocia automáticamente este evento registrado con esta instancia de la aplicación web de Firebase en este dispositivo.

La lista de parámetros de eventos recomendados se encuentra en la documentación de referencia de GA4.

Firma:

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

Parámetros

Parámetro Tipo Descripción
Instancia analítica Analytics
nombredelevento “sign_up”
eventParams { método?: EventParams['method']; [clave: cadena]: cualquiera; }.
opciones AnalyticsCallOptions

Muestra:

void

logEvent(analyticsInstance, eventName, eventParams, options)

Envía un evento de Google Analytics con un eventParams determinado. Este método asocia automáticamente este evento registrado con esta instancia de la aplicación web de Firebase en este dispositivo.

La lista de parámetros de eventos recomendados se encuentra en la documentación de referencia de 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;

Parámetros

Parámetro Tipo Descripción
Instancia analítica Analytics
nombredelevento "timing_complete"
eventParams { nombre: cadena; valor: número; event_category?: string; event_label?: cadena; [clave: cadena]: cualquiera; }.
opciones AnalyticsCallOptions

Muestra:

void

logEvent(analyticsInstance, eventName, eventParams, options)

Envía un evento de Google Analytics con un eventParams determinado. Este método asocia automáticamente este evento registrado con esta instancia de la aplicación web de Firebase en este dispositivo.

La lista de parámetros de eventos recomendados se encuentra en la documentación de referencia de 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;

Parámetros

Parámetro Tipo Descripción
Instancia analítica Analytics
nombredelevento 'add_shipping_info'
eventParams { cupón?: EventParams['coupon']; moneda?: EventParams['currency']; elementos?: EventParams['items']; shipping_tier?: EventParams['shipping_tier']; valor?: EventParams['value']; [clave: cadena]: cualquiera; }.
opciones AnalyticsCallOptions

Muestra:

void

logEvent(analyticsInstance, eventName, eventParams, options)

Envía un evento de Google Analytics con un eventParams determinado. Este método asocia automáticamente este evento registrado con esta instancia de la aplicación web de Firebase en este dispositivo.

La lista de parámetros de eventos recomendados se encuentra en la documentación de referencia de 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;

Parámetros

Parámetro Tipo Descripción
Instancia analítica Analytics
nombredelevento 'view_cart' | 'view_item'
eventParams { currency?: EventParams['currency']; elementos?: EventParams['items']; valor?: EventParams['value']; [clave: cadena]: cualquiera; }.
opciones AnalyticsCallOptions

Muestra:

void

logEvent(analyticsInstance, eventName, eventParams, options)

Envía un evento de Google Analytics con un eventParams determinado. Este método asocia automáticamente este evento registrado con esta instancia de la aplicación web de Firebase en este dispositivo.

La lista de parámetros de eventos recomendados se encuentra en la documentación de referencia de 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;

Parámetros

Parámetro Tipo Descripción
Instancia analítica Analytics
nombredelevento 'view_item_list'
eventParams { items?: EventParams['items']; item_list_name?: EventParams['item_list_name']; item_list_id?: EventParams['item_list_id']; [clave: cadena]: cualquiera; }.
opciones AnalyticsCallOptions

Muestra:

void

logEvent(analyticsInstance, eventName, eventParams, options)

Envía un evento de Google Analytics con un eventParams determinado. Este método asocia automáticamente este evento registrado con esta instancia de la aplicación web de Firebase en este dispositivo.

La lista de parámetros de eventos recomendados se encuentra en la documentación de referencia de GA4.

Firma:

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

Parámetros

Parámetro Tipo Descripción
Instancia analítica Analytics
nombredelevento NombreDelEventoPersonalizado<T>
eventParams { [clave: cadena]: cualquiera; }.
opciones AnalyticsCallOptions

Muestra:

void

logEvent(analyticsInstance, eventName, eventParams, options)

Envía un evento de Google Analytics con un eventParams determinado. Este método asocia automáticamente este evento registrado con esta instancia de la aplicación web de Firebase en este dispositivo.

La lista de parámetros de eventos recomendados se encuentra en la documentación de referencia de 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;

Parámetros

Parámetro Tipo Descripción
Instancia analítica Analytics
nombredelevento 'agregar_al_carrito' | "add_to_wishlist" | “remove_from_cart”
eventParams { currency?: EventParams['currency']; valor?: EventParams['value']; elementos?: EventParams['items']; [clave: cadena]: cualquiera; }.
opciones AnalyticsCallOptions

Muestra:

void

logEvent(analyticsInstance, eventName, eventParams, options)

Envía un evento de Google Analytics con un eventParams determinado. Este método asocia automáticamente este evento registrado con esta instancia de la aplicación web de Firebase en este dispositivo.

La lista de parámetros de eventos recomendados se encuentra en la documentación de referencia de 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;

Parámetros

Parámetro Tipo Descripción
Instancia analítica Analytics
nombredelevento "begin_checkout"
eventParams { currency?: EventParams['currency']; cupón?: EventParams['coupon']; valor?: EventParams['value']; elementos?: EventParams['items']; [clave: cadena]: cualquiera; }.
opciones AnalyticsCallOptions

Muestra:

void

logEvent(analyticsInstance, eventName, eventParams, options)

Envía un evento de Google Analytics con un eventParams determinado. Este método asocia automáticamente este evento registrado con esta instancia de la aplicación web de Firebase en este dispositivo.

La lista de parámetros de eventos recomendados se encuentra en la documentación de referencia de 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;

Parámetros

Parámetro Tipo Descripción
Instancia analítica Analytics
nombredelevento "checkout_progress"
eventParams { currency?: EventParams['currency']; cupón?: EventParams['coupon']; valor?: EventParams['value']; elementos?: EventParams['items']; Checkout_step?: EventParams['checkout_step']; Checkout_option? EventParams['checkout_option']; [clave: cadena]: cualquiera; }.
opciones AnalyticsCallOptions

Muestra:

void

logEvent(analyticsInstance, eventName, eventParams, options)

Envía un evento de Google Analytics con un eventParams determinado. Este método asocia automáticamente este evento registrado con esta instancia de la aplicación web de Firebase en este dispositivo.

Consulta Cómo medir excepciones.

Firma:

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

Parámetros

Parámetro Tipo Descripción
Instancia analítica Analytics
nombredelevento "excepción"
eventParams { description?: EventParams['description']; fatal?: EventParams['fatal']; [clave: cadena]: cualquiera; }.
opciones AnalyticsCallOptions

Muestra:

void

logEvent(analyticsInstance, eventName, eventParams, options)

Envía un evento de Google Analytics con un eventParams determinado. Este método asocia automáticamente este evento registrado con esta instancia de la aplicación web de Firebase en este dispositivo.

La lista de parámetros de eventos recomendados se encuentra en la documentación de referencia de GA4.

Firma:

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

Parámetros

Parámetro Tipo Descripción
Instancia analítica Analytics
nombredelevento "generate_lead"
eventParams { value?: EventParams['value']; moneda?: EventParams['currency']; [clave: cadena]: cualquiera; }.
opciones AnalyticsCallOptions

Muestra:

void

logEvent(analyticsInstance, eventName, eventParams, options)

Envía un evento de Google Analytics con un eventParams determinado. Este método asocia automáticamente este evento registrado con esta instancia de la aplicación web de Firebase en este dispositivo.

La lista de parámetros de eventos recomendados se encuentra en la documentación de referencia de GA4.

Firma:

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

Parámetros

Parámetro Tipo Descripción
Instancia analítica Analytics
nombredelevento "login"
eventParams { método?: EventParams['method']; [clave: cadena]: cualquiera; }.
opciones AnalyticsCallOptions

Muestra:

void

logEvent(analyticsInstance, eventName, eventParams, options)

Envía un evento de Google Analytics con un eventParams determinado. Este método asocia automáticamente este evento registrado con esta instancia de la aplicación web de Firebase en este dispositivo.

Consulta Vistas de página.

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;

Parámetros

Parámetro Tipo Descripción
Instancia analítica Analytics
nombredelevento 'page_view' [vista_de_página]
eventParams { page_title?: cadena; page_location?: cadena; page_path?: cadena; [clave: cadena]: cualquiera; }.
opciones AnalyticsCallOptions

Muestra:

void

setAnalyticsCollectionEnabled(analyticsInstance, habilitada)

Establece si la recopilación de Google Analytics está habilitada para esta aplicación en este dispositivo. Establece el window['ga-disable-analyticsId'] = true; global.

Firma:

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

Parámetros

Parámetro Tipo Descripción
Instancia analítica Analytics La instancia Analytics.
habilitado booleano Si es verdadero, habilita la recopilación; si es falso, la inhabilita.

Muestra:

void

setCurrentScreen(analyticsInstance, screenName, opciones)

Usar con eventName como "screen_view" y agrega eventParams relevantes. Consulta Realiza un seguimiento de las vistas de pantalla.

Utilice el comando config de gtag para establecer screen_name.

Firma:

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

Parámetros

Parámetro Tipo Descripción
Instancia analítica Analytics La instancia de Analytics
Nombre de la pantalla string Nombre de pantalla para establecer.
opciones AnalyticsCallOptions

Muestra:

void

setUserId(analyticsInstance, id, options)

Utilice el comando config de gtag para establecer user_id.

Firma:

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

Parámetros

Parámetro Tipo Descripción
Instancia analítica Analytics La instancia de Analytics
id cadena | nulo Es el ID de usuario que se configurará.
opciones AnalyticsCallOptions

Muestra:

void

setUserProperties(analyticsInstance, properties, options)

Utilice el comando config de gtag para establecer todos los parámetros especificados.

Firma:

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

Parámetros

Parámetro Tipo Descripción
Instancia analítica Analytics
del bucket CustomParams
opciones AnalyticsCallOptions

Muestra:

void

función()

isSupported()

Este es un método público estático que se proporciona a los usuarios que une cuatro verificaciones diferentes:

  1. Comprueba si no es un entorno de extensión del navegador. 2. Comprobar si las cookies están habilitadas en el navegador actual. 3. Comprueba si el entorno del navegador admite IndexedDB. 4. Verifica si el contexto actual del navegador es válido para usar IndexedDB.open().

Firma:

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

Muestra:

Promise&lt;boolean&gt;

function(consentSettings, ...)

setConsent(consentSettings)

Establece el estado de consentimiento del usuario final aplicable a esta aplicación web en todas las referencias de gtag una vez que se inicializa Firebase Analytics.

Utiliza ConsentSettings para especificar valores de tipos de consentimiento individuales. De forma predeterminada, los tipos de consentimiento están configurados como "granted".

Firma:

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

Parámetros

Parámetro Tipo Descripción
configuración de consentimiento ConsentSettings Asigna el estado de consentimiento del usuario final aplicable para gtag.js.

Muestra:

void

función(customParams, ...)

setDefaultEventParameters(paramspersonalizados)

Agrega datos que se configurarán en cada evento registrado desde el SDK, incluidos los eventos automáticos. Con la opción "set" de gtag , los valores pasados persisten en la página actual y se pasan con todos los eventos posteriores.

Firma:

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

Parámetros

Parámetro Tipo Descripción
Parámetros personalizados CustomParams Cualquier parámetro personalizado que el usuario pueda pasar a gtag.js

Muestra:

void

función(opciones, ...)

configuración(opciones)

Configura Firebase Analytics para usar nombres gtag o dataLayer personalizados. Se diseñó para usarse si la secuencia de comandos gtag.js se instaló en esta página, independientemente de Firebase Analytics, y si utiliza nombres no predeterminados para la función gtag o dataLayer. Se debe llamar antes de llamar a getAnalytics(). De lo contrario, el cambio no tendrá ningún efecto.

Firma:

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

Parámetros

Parámetro Tipo Descripción
opciones Opciones de configuración Nombres personalizados de gtag y dataLayer.

Muestra:

void

ConsentStatusString

Indica si se otorgó o rechazó un tipo de consentimiento en particular.

Firma:

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

Moneda

Tipo de moneda estándar de Google Analytics.

Firma:

export declare type Currency = string | number;

Nombre delEvento personalizado

Cualquier cadena de nombre de evento personalizado que no esté en la lista estándar de nombres de eventos recomendados

Firma:

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

NombreDelEvento

Escribe para los nombres de eventos estándares de Google Analytics. logEvent también acepta cualquier cadena personalizada y la interpreta como un nombre de evento personalizado.

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