El SDK web de Firebase Analytics. Este SDK no funciona en un entorno Node.js.
Funciones
Función | Descripción |
---|---|
función (aplicación...) | |
getAnalytics (aplicación) | Devuelve una instancia de Analytics para la aplicación dada. |
initializeAnalytics(aplicación, opciones) | Devuelve una instancia de Analytics para la aplicación dada. |
function(analyticsInstance...) | |
getGoogleAnalyticsClientId(analyticsInstance) | Recupera un identificador único de Google Analytics para el cliente web. Ver client_id . |
logEvent(analyticsInstance, eventName, eventParams, options) | 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 . |
logEvent(analyticsInstance, eventName, eventParams, options) | 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 . |
logEvent(analyticsInstance, eventName, eventParams, options) | 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 seguimiento de vistas de pantalla . |
logEvent(analyticsInstance, eventName, eventParams, options) | 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 . |
logEvent(analyticsInstance, eventName, eventParams, options) | 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 . |
logEvent(analyticsInstance, eventName, eventParams, options) | 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 . |
logEvent(analyticsInstance, eventName, eventParams, options) | 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 . |
logEvent(analyticsInstance, eventName, eventParams, options) | 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 . |
logEvent(analyticsInstance, eventName, eventParams, options) | 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 . |
logEvent(analyticsInstance, eventName, eventParams, options) | 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 . |
logEvent(analyticsInstance, eventName, eventParams, options) | 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 . |
logEvent(analyticsInstance, eventName, eventParams, options) | 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 . |
logEvent(analyticsInstance, eventName, eventParams, options) | 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 . |
logEvent(analyticsInstance, eventName, eventParams, options) | 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 . |
logEvent(analyticsInstance, eventName, eventParams, options) | 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 . |
logEvent(analyticsInstance, eventName, eventParams, options) | 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 . |
logEvent(analyticsInstance, eventName, eventParams, options) | 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 . |
logEvent(analyticsInstance, eventName, eventParams, options) | 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 . |
logEvent(analyticsInstance, eventName, eventParams, options) | 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 Medir excepciones . |
logEvent(analyticsInstance, eventName, eventParams, options) | 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 . |
logEvent(analyticsInstance, eventName, eventParams, options) | 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 . |
logEvent(analyticsInstance, eventName, eventParams, options) | 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 páginas vistas . |
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(analyticsInstance, nombre de pantalla, opciones) | Use el comando gtag config para configurar screen_name . |
setUserId(analyticsInstance, id, opciones) | Use el comando gtag config para configurar user_id . |
setUserProperties(analyticsInstance, propiedades, opciones) | Use el comando gtag config para establecer todos los parámetros especificados. |
función() | |
esta apoyado() | Este es un método estático público proporcionado a los usuarios que envuelve cuatro controles 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. Verifique si el contexto actual del navegador es válido para usar IndexedDB.open() . |
función (Configuración de consentimiento...) | |
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. Utilice ConsentSettings para especificar valores de tipo de consentimiento individuales. De forma predeterminada, los tipos de consentimiento están configurados como "concedidos". |
función (parámetros personalizados...) | |
setDefaultEventParameters(customParams) | Agrega datos que se establecerán en cada evento registrado desde el SDK, incluidos los automáticos. Con el comando "establecer" de gtag, los valores pasados persisten en la página actual y se pasan con todos los eventos posteriores. |
función(opciones...) | |
ajustes (opciones) | Configura Firebase Analytics para usar nombres personalizados gtag o dataLayer . Diseñado para usarse si la secuencia de comandos 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. |
AnalyticsCallOptions | Opciones adicionales que se pueden pasar a las llamadas a métodos de Analytics, como logEvent , etc. |
Configuración de análisis | Opciones de inicialización de la instancia de análisis . |
Configuración de consentimiento | Configuraciones de estado de consentimiento para cada tipo de consentimiento. Para obtener más información, consulte la documentación de referencia de GA4 sobre 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 . |
CustomParams | Cualquier parámetro personalizado que el usuario pueda pasar a gtag . |
EventParams | Parámetros de eventos gtag.js estándar. Para obtener más información, consulte la documentación de referencia de GA4 . |
GtagConfigParams | Un conjunto de ajustes de configuración comunes de Google Analytics reconocidos por gtag.js . |
Artículo | Tipo Item estándar de Google Analytics. |
Promoción | Campo utilizado anteriormente por algunos eventos de Google Analytics. |
AjustesOpciones | Especifica opciones personalizadas para su instancia de Firebase Analytics. Debe configurarlos antes de inicializar firebase.analytics() . |
Tipo de alias
Alias de tipo | Descripción |
---|---|
ConsentStatusStringConsentStatusString | Si se ha concedido 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. |
EventNameString | Escriba para los nombres de eventos estándar de Google Analytics. logEvent también acepta cualquier cadena personalizada y la interpreta como un nombre de evento personalizado. |
obtenerAnalytics()
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 | FirebaseApp | La FirebaseApp a usar. |
Devoluciones:
initializeAnalytics()
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 | FirebaseApp | La FirebaseApp a usar. |
opciones | Configuración de análisis |
Devoluciones:
getGoogleAnalyticsClientId()
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>
registroEvento()
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 | 'agregar_pago_info' | |
eventParams | { cupón?: EventParams ['cupón']; moneda?: EventParams ['divisa']; elementos?: EventParams ['elementos']; tipo_pago?: Parámetros de evento ['tipo de pago']; valor?: EventParams ['valor']; [clave: cadena]: cualquiera; } | |
opciones | AnalyticsCallOptions |
Devoluciones:
vacío
registroEvento()
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' | |
eventParams | { 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']; elementos?: EventParams ['elementos']; cupón?: EventParams ['cupón']; afiliación?: EventParams ['afiliación']; [clave: cadena]: cualquiera; } | |
opciones | AnalyticsCallOptions |
Devoluciones:
vacío
registroEvento()
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 seguimiento de 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 de análisis | Analítica | |
nombre del evento | 'pantalla_vista' | |
eventParams | { firebase_screen: parámetros de evento ['firebase_screen']; firebase_screen_class: parámetros de evento ['firebase_screen_class']; [clave: cadena]: cualquiera; } | |
opciones | AnalyticsCallOptions |
Devoluciones:
vacío
registroEvento()
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' | |
eventParams | { término_búsqueda?: Parámetros de evento ['término de búsqueda']; [clave: cadena]: cualquiera; } | |
opciones | AnalyticsCallOptions |
Devoluciones:
vacío
registroEvento()
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 | 'select_content' | |
eventParams | { content_type?: Parámetros de evento ['tipo de contenido']; item_id?: Parámetros de evento ['Identificación del artículo']; [clave: cadena]: cualquiera; } | |
opciones | AnalyticsCallOptions |
Devoluciones:
vacío
registroEvento()
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' | |
eventParams | { 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 | AnalyticsCallOptions |
Devoluciones:
vacío
registroEvento()
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 | 'promocion_seleccionada' | 'ver_promoción' | |
eventParams | { artículos?: EventParams ['elementos']; id_promoción?: Parámetros de evento ['promoción_id']; promoción_nombre?: EventParams ['nombre_promoción']; [clave: cadena]: cualquiera; } | |
opciones | AnalyticsCallOptions |
Devoluciones:
vacío
registroEvento()
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' | |
eventParams | { checkout_step?: parámetros de evento ['paso_pago']; checkout_option?: Parámetros de evento ['opción_de_pago']; [clave: cadena]: cualquiera; } | |
opciones | AnalyticsCallOptions |
Devoluciones:
vacío
registroEvento()
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' | |
eventParams | {método?: EventParams ['método']; tipo_de_contenido?: Parámetros de evento ['tipo de contenido']; item_id?: Parámetros de evento ['Identificación del artículo']; [clave: cadena]: cualquiera; } | |
opciones | AnalyticsCallOptions |
Devoluciones:
vacío
registroEvento()
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' | |
eventParams | {método?: EventParams ['método']; [clave: cadena]: cualquiera; } | |
opciones | AnalyticsCallOptions |
Devoluciones:
vacío
registroEvento()
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 | 'tiempo_completo' | |
eventParams | { nombre: cadena; valor: número; categoría_evento?: cadena; etiqueta_evento?: cadena; [clave: cadena]: cualquiera; } | |
opciones | AnalyticsCallOptions |
Devoluciones:
vacío
registroEvento()
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' | |
eventParams | { cupón?: EventParams ['cupón']; moneda?: EventParams ['divisa']; elementos?: EventParams ['elementos']; shipping_tier?: Parámetros de evento ['nivel_de_envío']; valor?: EventParams ['valor']; [clave: cadena]: cualquiera; } | |
opciones | AnalyticsCallOptions |
Devoluciones:
vacío
registroEvento()
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' | |
eventParams | { moneda?: EventParams ['divisa']; elementos?: EventParams ['elementos']; valor?: EventParams ['valor']; [clave: cadena]: cualquiera; } | |
opciones | AnalyticsCallOptions |
Devoluciones:
vacío
registroEvento()
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' | |
eventParams | { 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 | AnalyticsCallOptions |
Devoluciones:
vacío
registroEvento()
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> | |
eventParams | { [clave: cadena]: cualquiera; } | |
opciones | AnalyticsCallOptions |
Devoluciones:
vacío
registroEvento()
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' | 'añadir_a_la_lista de deseos' | 'remove_from_cart' | |
eventParams | { moneda?: EventParams ['divisa']; valor?: EventParams ['valor']; elementos?: EventParams ['elementos']; [clave: cadena]: cualquiera; } | |
opciones | AnalyticsCallOptions |
Devoluciones:
vacío
registroEvento()
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' | |
eventParams | { moneda?: EventParams ['divisa']; cupón?: EventParams ['cupón']; valor?: EventParams ['valor']; elementos?: EventParams ['elementos']; [clave: cadena]: cualquiera; } | |
opciones | AnalyticsCallOptions |
Devoluciones:
vacío
registroEvento()
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' | |
eventParams | { moneda?: EventParams ['divisa']; cupón?: EventParams ['cupón']; valor?: EventParams ['valor']; elementos?: EventParams ['elementos']; checkout_step?: Parámetros de evento ['paso_pago']; checkout_option?: Parámetros de evento ['opción_de_pago']; [clave: cadena]: cualquiera; } | |
opciones | AnalyticsCallOptions |
Devoluciones:
vacío
registroEvento()
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 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 de análisis | Analítica | |
nombre del evento | 'excepción' | |
eventParams | { descripción?: Parámetros de evento ['descripción']; fatal?: EventParams ['fatal']; [clave: cadena]: cualquiera; } | |
opciones | AnalyticsCallOptions |
Devoluciones:
vacío
registroEvento()
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' | |
eventParams | { valor?: EventParams ['valor']; moneda?: EventParams ['divisa']; [clave: cadena]: cualquiera; } | |
opciones | AnalyticsCallOptions |
Devoluciones:
vacío
registroEvento()
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' | |
eventParams | {método?: EventParams ['método']; [clave: cadena]: cualquiera; } | |
opciones | AnalyticsCallOptions |
Devoluciones:
vacío
registroEvento()
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 páginas vistas .
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' | |
eventParams | { título_página?: cadena; ¿ubicación_página?: cadena; página_ruta?: cadena; [clave: cadena]: cualquiera; } | |
opciones | AnalyticsCallOptions |
Devoluciones:
vacío
setAnalyticsCollectionEnabled()
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
establecerPantallaActual()
Úselo con
eventName
como 'screen_view' y agregueeventParams
relevantes . Ver seguimiento de vistas de pantalla .
Use 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 | AnalyticsCallOptions |
Devoluciones:
vacío
establecerIdUsuario()
Use 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 a configurar. |
opciones | AnalyticsCallOptions |
Devoluciones:
vacío
establecer propiedades de usuario ()
Use el comando gtag config
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 de análisis | Analítica | |
propiedades | CustomParams | |
opciones | AnalyticsCallOptions |
Devoluciones:
vacío
esta apoyado()
Este es un método estático público proporcionado a los usuarios que envuelve cuatro controles diferentes:
- 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 del navegador actual es válido para usar
IndexedDB.open()
.
Firma:
export declare function isSupported(): Promise<boolean>;
Devoluciones:
Promesa<booleano>
establecer 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 tipo 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 |
---|---|---|
configuración de consentimiento | Configuración de consentimiento | Asigna el estado de consentimiento del usuario final aplicable para gtag.js. |
Devoluciones:
vacío
setDefaultEventParameters()
Agrega datos que se establecerán en cada evento registrado desde el SDK, incluidos los automáticos. Con el comando "establecer" 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 |
---|---|---|
customParams | CustomParams | Cualquier parámetro personalizado que el usuario pueda pasar a gtag.js. |
Devoluciones:
vacío
ajustes()
Configura Firebase Analytics para usar nombres personalizados gtag
o dataLayer
. Diseñado para usarse si la secuencia de comandos 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 | AjustesOpciones | Nombres personalizados de gtag y capa de datos. |
Devoluciones:
vacío
ConsentStatusStringConsentStatusString
Si se ha concedido 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;
EventNameString
Escriba para los 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';