analytics package

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

Funciones

Función Descripción
función (aplicación, ...)
obtenerAnalytics(aplicación) Devuelve una instancia de Analytics para la aplicación dada.
inicializarAnalytics(aplicación, opciones) Devuelve una instancia de Analytics para la aplicación dada.
función (instancia de análisis, ...)
getGoogleAnalyticsClientId(instancia de análisis) Recupera un identificador único de Google Analytics para el cliente web. Ver client_id .
logEvent(analyticsInstance, eventName, eventParams, opciones) Envía un evento de Google Analytics con eventParams dado. 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 puede encontrar en la documentación de referencia de GA4. .
logEvent(analyticsInstance, eventName, eventParams, opciones) Envía un evento de Google Analytics con eventParams dado. 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 puede encontrar en la documentación de referencia de GA4. .
logEvent(analyticsInstance, eventName, eventParams, opciones) Envía un evento de Google Analytics con eventParams dado. Este método asocia automáticamente este evento registrado con esta instancia de la aplicación web de Firebase en este dispositivo. Ver vistas de pantalla de seguimiento .
logEvent(analyticsInstance, eventName, eventParams, opciones) Envía un evento de Google Analytics con eventParams dado. 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 puede encontrar en la documentación de referencia de GA4. .
logEvent(analyticsInstance, eventName, eventParams, opciones) Envía un evento de Google Analytics con eventParams dado. 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 puede encontrar en la documentación de referencia de GA4. .
logEvent(analyticsInstance, eventName, eventParams, opciones) Envía un evento de Google Analytics con eventParams dado. 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 puede encontrar en la documentación de referencia de GA4. .
logEvent(analyticsInstance, eventName, eventParams, opciones) Envía un evento de Google Analytics con eventParams dado. 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 puede encontrar en la documentación de referencia de GA4. .
logEvent(analyticsInstance, eventName, eventParams, opciones) Envía un evento de Google Analytics con eventParams dado. 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 puede encontrar en la documentación de referencia de GA4. .
logEvent(analyticsInstance, eventName, eventParams, opciones) Envía un evento de Google Analytics con eventParams dado. 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 puede encontrar en la documentación de referencia de GA4. .
logEvent(analyticsInstance, eventName, eventParams, opciones) Envía un evento de Google Analytics con eventParams dado. 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 puede encontrar en la documentación de referencia de GA4. .
logEvent(analyticsInstance, eventName, eventParams, opciones) Envía un evento de Google Analytics con eventParams dado. 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 puede encontrar en la documentación de referencia de GA4. .
logEvent(analyticsInstance, eventName, eventParams, opciones) Envía un evento de Google Analytics con eventParams dado. 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 puede encontrar en la documentación de referencia de GA4. .
logEvent(analyticsInstance, eventName, eventParams, opciones) Envía un evento de Google Analytics con eventParams dado. 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 puede encontrar en la documentación de referencia de GA4. .
logEvent(analyticsInstance, eventName, eventParams, opciones) Envía un evento de Google Analytics con eventParams dado. 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 puede encontrar en la documentación de referencia de GA4. .
logEvent(analyticsInstance, eventName, eventParams, opciones) Envía un evento de Google Analytics con eventParams dado. 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 puede encontrar en la documentación de referencia de GA4. .
logEvent(analyticsInstance, eventName, eventParams, opciones) Envía un evento de Google Analytics con eventParams dado. 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 puede encontrar en la documentación de referencia de GA4. .
logEvent(analyticsInstance, eventName, eventParams, opciones) Envía un evento de Google Analytics con eventParams dado. 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 puede encontrar en la documentación de referencia de GA4. .
logEvent(analyticsInstance, eventName, eventParams, opciones) Envía un evento de Google Analytics con eventParams dado. 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 puede encontrar en la documentación de referencia de GA4. .
logEvent(analyticsInstance, eventName, eventParams, opciones) Envía un evento de Google Analytics con eventParams dado. Este método asocia automáticamente este evento registrado con esta instancia de la aplicación web de Firebase en este dispositivo. Ver excepciones de medidas .
logEvent(analyticsInstance, eventName, eventParams, opciones) Envía un evento de Google Analytics con eventParams dado. 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 puede encontrar en la documentación de referencia de GA4. .
logEvent(analyticsInstance, eventName, eventParams, opciones) Envía un evento de Google Analytics con eventParams dado. 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 puede encontrar en la documentación de referencia de GA4. .
logEvent(analyticsInstance, eventName, eventParams, opciones) Envía un evento de Google Analytics con eventParams dado. Este método asocia automáticamente este evento registrado con esta instancia de la aplicación web de Firebase en este dispositivo. Ver vistas de página .
setAnalyticsCollectionEnabled(analyticsInstance, habilitado) Establece si la recopilación de Google Analytics está habilitada para esta aplicación en este dispositivo. Establece window['ga-disable-analyticsId'] = true;
setCurrentScreen(instancia de análisis, nombre de pantalla, opciones) Utilice el comando gtag config para configurar screen_name .
setUserId(analyticsInstance, id, opciones) Utilice el comando gtag config para configurar user_id .
setUserProperties(analyticsInstance, propiedades, opciones) Utilice el comando gtag config para configurar todos los parámetros especificados.
función()
esta apoyado() Este es un método estático público proporcionado a los usuarios que incluye cuatro comprobaciones diferentes: 1. Compruebe si no es un entorno de extensión del navegador. 2. Compruebe si las cookies están habilitadas en el navegador actual. 3. Compruebe si IndexedDB es compatible con el entorno del navegador. 4. Compruebe si el contexto actual del navegador es válido para usar IndexedDB.open() .
función (configuración de consentimiento, ...)
setConsent(configuración de consentimiento) 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. Utilice ConsentSettings para especificar valores de tipos de consentimiento individuales. De forma predeterminada, los tipos de consentimiento están configurados como "concedidos".
función (parámetros personalizados, ...)
setDefaultEventParameters (parámetros personalizados) Agrega datos que se configurarán en cada evento registrado desde el SDK, incluidos los automáticos. Con el comando "set" de gtag, los valores pasados ​​persisten en la página actual y se pasan con todos los eventos posteriores.
función(opciones,...)
configuración (opciones) Configura Firebase Analytics para usar nombres dataLayer o gtag personalizados. Diseñado para usarse si el script gtag.js se instaló en esta página independientemente de Firebase Analytics y usa nombres no predeterminados para la función gtag o para dataLayer . Debe llamarse antes de llamar getAnalytics() o no tendrá ningún efecto.

Interfaces

Interfaz Descripción
Analítica Una instancia de Firebase Analytics.
Opciones de llamada de análisis Opciones adicionales que se pueden pasar a las llamadas a métodos de Analytics, como logEvent , etc.
AnálisisConfiguración Opciones de inicialización de instancias de Analytics .
Configuración de consentimiento Configuración del estado de consentimiento para cada tipo de consentimiento. Para obtener más información, consulte la documentación de referencia de GA4 para conocer el estado de consentimiento y los tipos de consentimiento. .
Parámetros de control Parámetros de control estándar gtag.js Para obtener más información, consulte la documentación de referencia de GA4. .
Parámetros personalizados Cualquier parámetro personalizado que el usuario pueda pasar a gtag .
Parámetros de evento Parámetros de eventos estándar gtag.js Para obtener más información, consulte la documentación de referencia de GA4. .
GtagConfigParams Un conjunto de configuraciones comunes de Google Analytics reconocidas por gtag.js
Artículo Tipo Item estándar de Google Analytics.
Promoción Campo utilizado anteriormente por algunos eventos de Google Analytics.
ConfiguraciónOpciones Especifica opciones personalizadas para su instancia de Firebase Analytics. Debes configurarlos antes de inicializar firebase.analytics() .

Tipo de alias

Tipo Alias Descripción
Cadena de estado de consentimiento Si se ha otorgado o denegado un tipo de consentimiento en particular.
Divisa Tipo de moneda estándar de Google Analytics.
Nombre de evento personalizado Cualquier cadena de nombre de evento personalizado que no esté en la lista estándar de nombres de eventos recomendados.
Cadena de nombre de evento Escriba nombres de eventos estándar de Google Analytics. logEvent también acepta cualquier cadena personalizada y la interpreta como un nombre de evento personalizado.

función (aplicación, ...)

obtenerAnalytics(aplicación)

Devuelve una instancia de Analytics para la aplicación dada.

Firma:

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

Parámetros

Parámetro Tipo Descripción
aplicación Aplicación Firebase La FirebaseApp que se utilizará.

Devoluciones:

Analítica

inicializarAnalytics(aplicación, opciones)

Devuelve una instancia de Analytics para la aplicación dada.

Firma:

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

Parámetros

Parámetro Tipo Descripción
aplicación Aplicación Firebase La FirebaseApp que se utilizará.
opciones AnálisisConfiguración

Devoluciones:

Analítica

función (instancia de análisis, ...)

getGoogleAnalyticsClientId(instancia de análisis)

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

Firma:

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

Parámetros

Parámetro Tipo Descripción
instancia de análisis Analítica

Devoluciones:

Promesa<cadena>

logEvent(analyticsInstance, eventName, eventParams, opciones)

Envía un evento de Google Analytics con eventParams dados . 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 puede encontrar 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 de análisis Analítica
nombre del evento 'añadir_info_pago'
parámetros de evento {¿cupón?: EventParams ['cupón']; ¿moneda?: EventParams ['divisa']; ¿Artículos?: EventParams ['elementos']; tipo_pago?: EventParams ['tipo de pago']; valor?: EventParams ['valor']; [clave: cadena]: cualquiera; }
opciones Opciones de llamada de análisis

Devoluciones:

vacío

logEvent(analyticsInstance, eventName, eventParams, opciones)

Envía un evento de Google Analytics con eventParams dados . 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 puede encontrar 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 de análisis Analítica
nombre del evento 'compra' | 'reembolso'
parámetros de evento {valor?: EventParams ['valor']; ¿moneda?: EventParams ['divisa']; id_transacción: parámetros de evento ['ID de transacción']; ¿impuestos?: EventParams ['impuesto']; ¿Envío?: EventParams ['envío']; ¿Artículos?: EventParams ['elementos']; ¿cupón?: EventParams ['cupón']; ¿Afiliación?: EventParams ['afiliación']; [clave: cadena]: cualquiera; }
opciones Opciones de llamada de análisis

Devoluciones:

vacío

logEvent(analyticsInstance, eventName, eventParams, opciones)

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

Ver vistas de pantalla de seguimiento .

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 de análisis Analítica
nombre del evento 'vista_pantalla'
parámetros de evento {firebase_screen: parámetros de evento ['firebase_screen']; firebase_screen_class: parámetros de evento ['firebase_screen_class']; [clave: cadena]: cualquiera; }
opciones Opciones de llamada de análisis

Devoluciones:

vacío

logEvent(analyticsInstance, eventName, eventParams, opciones)

Envía un evento de Google Analytics con eventParams dados . 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 puede encontrar 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 de análisis Analítica
nombre del evento 'buscar' | 'ver_resultados_de_búsqueda'
parámetros de evento { término_búsqueda?: EventParams ['término de búsqueda']; [clave: cadena]: cualquiera; }
opciones Opciones de llamada de análisis

Devoluciones:

vacío

logEvent(analyticsInstance, eventName, eventParams, opciones)

Envía un evento de Google Analytics con eventParams dados . 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 puede encontrar 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 de análisis Analítica
nombre del evento 'seleccionar_contenido'
parámetros de evento { tipo_contenido?: EventParams ['tipo de contenido']; item_id?: Parámetros de evento ['Identificación del artículo']; [clave: cadena]: cualquiera; }
opciones Opciones de llamada de análisis

Devoluciones:

vacío

logEvent(analyticsInstance, eventName, eventParams, opciones)

Envía un evento de Google Analytics con eventParams dados . 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 puede encontrar 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 de análisis Analítica
nombre del evento 'seleccione un artículo'
parámetros de evento {artículos?: EventParams ['elementos']; item_list_name?: Parámetros de evento ['item_list_name']; item_list_id?: Parámetros de evento ['item_list_id']; [clave: cadena]: cualquiera; }
opciones Opciones de llamada de análisis

Devoluciones:

vacío

logEvent(analyticsInstance, eventName, eventParams, opciones)

Envía un evento de Google Analytics con eventParams dados . 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 puede encontrar 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 de análisis Analítica
nombre del evento 'select_promoción' | 'ver_promoción'
parámetros de evento {artículos?: EventParams ['elementos']; ¿promoción_id?: EventParams ['promoción_id']; ¿nombre_promoción?: EventParams ['nombre_promoción']; [clave: cadena]: cualquiera; }
opciones Opciones de llamada de análisis

Devoluciones:

vacío

logEvent(analyticsInstance, eventName, eventParams, opciones)

Envía un evento de Google Analytics con eventParams dados . 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 puede encontrar 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 de análisis Analítica
nombre del evento 'set_checkout_option'
parámetros de evento { checkout_step?: EventParams ['paso_pago']; checkout_option?: Parámetros de evento ['opción_compra']; [clave: cadena]: cualquiera; }
opciones Opciones de llamada de análisis

Devoluciones:

vacío

logEvent(analyticsInstance, eventName, eventParams, opciones)

Envía un evento de Google Analytics con eventParams dados . 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 puede encontrar 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 de análisis Analítica
nombre del evento 'compartir'
parámetros de evento {método?: EventParams ['método']; ¿tipo_contenido?: parámetros de evento ['tipo de contenido']; item_id?: Parámetros de evento ['Identificación del artículo']; [clave: cadena]: cualquiera; }
opciones Opciones de llamada de análisis

Devoluciones:

vacío

logEvent(analyticsInstance, eventName, eventParams, opciones)

Envía un evento de Google Analytics con eventParams dados . 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 puede encontrar 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 de análisis Analítica
nombre del evento 'inscribirse'
parámetros de evento {método?: EventParams ['método']; [clave: cadena]: cualquiera; }
opciones Opciones de llamada de análisis

Devoluciones:

vacío

logEvent(analyticsInstance, eventName, eventParams, opciones)

Envía un evento de Google Analytics con eventParams dados . 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 puede encontrar 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 de análisis Analítica
nombre del evento 'timing_complete'
parámetros de evento { nombre: cadena; valor: número; categoría_evento?: cadena; etiqueta_evento?: cadena; [clave: cadena]: cualquiera; }
opciones Opciones de llamada de análisis

Devoluciones:

vacío

logEvent(analyticsInstance, eventName, eventParams, opciones)

Envía un evento de Google Analytics con eventParams dados . 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 puede encontrar 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 de análisis Analítica
nombre del evento 'add_shipping_info'
parámetros de evento {¿cupón?: EventParams ['cupón']; ¿moneda?: EventParams ['divisa']; ¿Artículos?: EventParams ['elementos']; ¿nivel_envío?: EventParams ['nivel_envío']; valor?: EventParams ['valor']; [clave: cadena]: cualquiera; }
opciones Opciones de llamada de análisis

Devoluciones:

vacío

logEvent(analyticsInstance, eventName, eventParams, opciones)

Envía un evento de Google Analytics con eventParams dados . 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 puede encontrar 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 de análisis Analítica
nombre del evento 'ver_carrito' | 'ver ítem'
parámetros de evento {moneda?: EventParams ['divisa']; ¿Artículos?: EventParams ['elementos']; valor?: EventParams ['valor']; [clave: cadena]: cualquiera; }
opciones Opciones de llamada de análisis

Devoluciones:

vacío

logEvent(analyticsInstance, eventName, eventParams, opciones)

Envía un evento de Google Analytics con eventParams dados . 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 puede encontrar 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 de análisis Analítica
nombre del evento 'ver_lista_de_elementos'
parámetros de evento {artículos?: EventParams ['elementos']; item_list_name?: Parámetros de evento ['item_list_name']; item_list_id?: Parámetros de evento ['item_list_id']; [clave: cadena]: cualquiera; }
opciones Opciones de llamada de análisis

Devoluciones:

vacío

logEvent(analyticsInstance, eventName, eventParams, opciones)

Envía un evento de Google Analytics con eventParams dados . 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 puede encontrar 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 de análisis Analítica
nombre del evento Nombre de evento personalizado <T>
parámetros de evento { [clave: cadena]: cualquiera; }
opciones Opciones de llamada de análisis

Devoluciones:

vacío

logEvent(analyticsInstance, eventName, eventParams, opciones)

Envía un evento de Google Analytics con eventParams dados . 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 puede encontrar 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 de análisis Analítica
nombre del evento 'añadir_al_carrito' | 'add_to_wishlist' | 'eliminar_del_carrito'
parámetros de evento {moneda?: EventParams ['divisa']; valor?: EventParams ['valor']; ¿Artículos?: EventParams ['elementos']; [clave: cadena]: cualquiera; }
opciones Opciones de llamada de análisis

Devoluciones:

vacío

logEvent(analyticsInstance, eventName, eventParams, opciones)

Envía un evento de Google Analytics con eventParams dados . 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 puede encontrar 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 de análisis Analítica
nombre del evento 'comenzar registro de salida'
parámetros de evento {moneda?: EventParams ['divisa']; ¿cupón?: EventParams ['cupón']; valor?: EventParams ['valor']; ¿Artículos?: EventParams ['elementos']; [clave: cadena]: cualquiera; }
opciones Opciones de llamada de análisis

Devoluciones:

vacío

logEvent(analyticsInstance, eventName, eventParams, opciones)

Envía un evento de Google Analytics con eventParams dados . 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 puede encontrar 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 de análisis Analítica
nombre del evento 'checkout_progress'
parámetros de evento {moneda?: EventParams ['divisa']; ¿cupón?: EventParams ['cupón']; valor?: EventParams ['valor']; ¿Artículos?: EventParams ['elementos']; checkout_step?: Parámetros de evento ['paso_pago']; checkout_option?: Parámetros de evento ['opción_compra']; [clave: cadena]: cualquiera; }
opciones Opciones de llamada de análisis

Devoluciones:

vacío

logEvent(analyticsInstance, eventName, eventParams, opciones)

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

Ver excepciones de medidas .

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 de análisis Analítica
nombre del evento 'excepción'
parámetros de evento { descripción?: EventParams ['descripción']; fatal?: EventParams ['fatal']; [clave: cadena]: cualquiera; }
opciones Opciones de llamada de análisis

Devoluciones:

vacío

logEvent(analyticsInstance, eventName, eventParams, opciones)

Envía un evento de Google Analytics con eventParams dados . 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 puede encontrar 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 de análisis Analítica
nombre del evento 'generar_lead'
parámetros de evento {valor?: EventParams ['valor']; ¿moneda?: EventParams ['divisa']; [clave: cadena]: cualquiera; }
opciones Opciones de llamada de análisis

Devoluciones:

vacío

logEvent(analyticsInstance, eventName, eventParams, opciones)

Envía un evento de Google Analytics con eventParams dados . 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 puede encontrar 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 de análisis Analítica
nombre del evento 'acceso'
parámetros de evento {método?: EventParams ['método']; [clave: cadena]: cualquiera; }
opciones Opciones de llamada de análisis

Devoluciones:

vacío

logEvent(analyticsInstance, eventName, eventParams, opciones)

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

Ver 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 de análisis Analítica
nombre del evento 'vista de pagina'
parámetros de evento { título_página?: cadena; ubicación_página?: cadena; ruta_página?: cadena; [clave: cadena]: cualquiera; }
opciones Opciones de llamada de análisis

Devoluciones:

vacío

setAnalyticsCollectionEnabled(analyticsInstance, habilitado)

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

Firma:

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

Parámetros

Parámetro Tipo Descripción
instancia de análisis Analítica La instancia de Analytics .
activado booleano Si es verdadero, habilita la recopilación; si es falso, la deshabilita.

Devoluciones:

vacío

setCurrentScreen(instancia de análisis, nombre de pantalla, opciones)

Úselo con eventName como 'screen_view' y agregue eventParams relevantes . Ver vistas de pantalla de seguimiento .

Utilice el comando gtag config para configurar screen_name .

Firma:

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

Parámetros

Parámetro Tipo Descripción
instancia de análisis Analítica La instancia de Analytics .
Nombre de pantalla cadena Nombre de pantalla a configurar.
opciones Opciones de llamada de análisis

Devoluciones:

vacío

setUserId(analyticsInstance, id, opciones)

Utilice el comando gtag config para configurar user_id .

Firma:

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

Parámetros

Parámetro Tipo Descripción
instancia de análisis Analítica La instancia de Analytics .
identificación cadena | nulo ID de usuario para configurar.
opciones Opciones de llamada de análisis

Devoluciones:

vacío

setUserProperties(analyticsInstance, propiedades, opciones)

Utilice el comando gtag config para configurar 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 de análisis Analítica
propiedades Parámetros personalizados
opciones Opciones de llamada de análisis

Devoluciones:

vacío

función()

esta apoyado()

Este es un método estático público proporcionado a los usuarios que incluye cuatro comprobaciones diferentes:

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

Firma:

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

Devoluciones:

Promesa<booleana>

función (configuración de consentimiento, ...)

setConsent(configuración de consentimiento)

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.

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

Firma:

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

Parámetros

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

Devoluciones:

vacío

función (parámetros personalizados, ...)

setDefaultEventParameters (parámetros personalizados)

Agrega datos que se configurarán en cada evento registrado desde el SDK, incluidos los automáticos. Con el comando "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 Parámetros personalizados Cualquier parámetro personalizado que el usuario pueda pasar a gtag.js.

Devoluciones:

vacío

función(opciones,...)

configuración (opciones)

Configura Firebase Analytics para usar nombres dataLayer o gtag personalizados. Diseñado para usarse si el script gtag.js se instaló en esta página independientemente de Firebase Analytics y usa nombres no predeterminados para la función gtag o para dataLayer . Debe llamarse antes de llamar getAnalytics() o no tendrá ningún efecto.

Firma:

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

Parámetros

Parámetro Tipo Descripción
opciones ConfiguraciónOpciones Nombres personalizados de gtag y dataLayer.

Devoluciones:

vacío

Cadena de estado de consentimiento

Si se ha otorgado o denegado un tipo de consentimiento en particular.

Firma:

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

Divisa

Tipo de moneda estándar de Google Analytics.

Firma:

export declare type Currency = string | number;

Nombre de evento 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;

Cadena de nombre de evento

Escriba nombres de eventos estándar 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';