analytics package

O SDK da Web do Firebase Analytics. Este SDK não funciona em um ambiente Node.js.

Funções

Interfaces

Aliases de tipo

função (aplicativo, ...)

obterAnalytics(aplicativo)

Retorna uma instância do Analytics para o aplicativo determinado.

Assinatura:

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

Parâmetros

Retorna:

Análise

inicializarAnalytics(aplicativo, opções)

Retorna uma instância do Analytics para o aplicativo determinado.

Assinatura:

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

Parâmetros

Retorna:

Análise

função(instânciaanalítica, ...)

getGoogleAnalyticsClientId(analyticsInstance)

Recupera um identificador exclusivo do Google Analytics para o cliente web. Veja client_id .

Assinatura:

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

Parâmetros

Retorna:

Promessa<string>

logEvent(analyticsInstance, eventName, eventParams, opções)

Envia um evento do Google Analytics com determinados eventParams . Este método associa automaticamente esse evento registrado a esta instância do aplicativo Web do Firebase neste dispositivo.

A lista de parâmetros de eventos recomendados pode ser encontrada na documentação de referência do GA4 .

Assinatura:

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

Retorna:

vazio

logEvent(analyticsInstance, eventName, eventParams, opções)

Envia um evento do Google Analytics com determinados eventParams . Este método associa automaticamente esse evento registrado a esta instância do aplicativo Web do Firebase neste dispositivo.

A lista de parâmetros de eventos recomendados pode ser encontrada na documentação de referência do GA4 .

Assinatura:

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

Retorna:

vazio

logEvent(analyticsInstance, eventName, eventParams, opções)

Envia um evento do Google Analytics com determinados eventParams . Este método associa automaticamente esse evento registrado a esta instância do aplicativo Web do Firebase neste dispositivo.

Consulte Rastrear visualizações de tela .

Assinatura:

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

Retorna:

vazio

logEvent(analyticsInstance, eventName, eventParams, opções)

Envia um evento do Google Analytics com determinados eventParams . Este método associa automaticamente esse evento registrado a esta instância do aplicativo Web do Firebase neste dispositivo.

A lista de parâmetros de eventos recomendados pode ser encontrada na documentação de referência do GA4 .

Assinatura:

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

Retorna:

vazio

logEvent(analyticsInstance, eventName, eventParams, opções)

Envia um evento do Google Analytics com determinados eventParams . Este método associa automaticamente esse evento registrado a esta instância do aplicativo Web do Firebase neste dispositivo.

A lista de parâmetros de eventos recomendados pode ser encontrada na documentação de referência do GA4 .

Assinatura:

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

Retorna:

vazio

logEvent(analyticsInstance, eventName, eventParams, opções)

Envia um evento do Google Analytics com determinados eventParams . Este método associa automaticamente esse evento registrado a esta instância do aplicativo Web do Firebase neste dispositivo.

A lista de parâmetros de eventos recomendados pode ser encontrada na documentação de referência do GA4 .

Assinatura:

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

Retorna:

vazio

logEvent(analyticsInstance, eventName, eventParams, opções)

Envia um evento do Google Analytics com determinados eventParams . Este método associa automaticamente esse evento registrado a esta instância do aplicativo Web do Firebase neste dispositivo.

A lista de parâmetros de eventos recomendados pode ser encontrada na documentação de referência do GA4 .

Assinatura:

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

Retorna:

vazio

logEvent(analyticsInstance, eventName, eventParams, opções)

Envia um evento do Google Analytics com determinados eventParams . Este método associa automaticamente esse evento registrado a esta instância do aplicativo Web do Firebase neste dispositivo.

A lista de parâmetros de eventos recomendados pode ser encontrada na documentação de referência do GA4 .

Assinatura:

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

Retorna:

vazio

logEvent(analyticsInstance, eventName, eventParams, opções)

Envia um evento do Google Analytics com determinados eventParams . Este método associa automaticamente esse evento registrado a esta instância do aplicativo Web do Firebase neste dispositivo.

A lista de parâmetros de eventos recomendados pode ser encontrada na documentação de referência do GA4 .

Assinatura:

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

Retorna:

vazio

logEvent(analyticsInstance, eventName, eventParams, opções)

Envia um evento do Google Analytics com determinados eventParams . Este método associa automaticamente esse evento registrado a esta instância do aplicativo Web do Firebase neste dispositivo.

A lista de parâmetros de eventos recomendados pode ser encontrada na documentação de referência do GA4 .

Assinatura:

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

Parâmetros

Retorna:

vazio

logEvent(analyticsInstance, eventName, eventParams, opções)

Envia um evento do Google Analytics com determinados eventParams . Este método associa automaticamente esse evento registrado a esta instância do aplicativo Web do Firebase neste dispositivo.

A lista de parâmetros de eventos recomendados pode ser encontrada na documentação de referência do GA4 .

Assinatura:

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

Retorna:

vazio

logEvent(analyticsInstance, eventName, eventParams, opções)

Envia um evento do Google Analytics com determinados eventParams . Este método associa automaticamente esse evento registrado a esta instância do aplicativo Web do Firebase neste dispositivo.

A lista de parâmetros de eventos recomendados pode ser encontrada na documentação de referência do GA4 .

Assinatura:

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

Retorna:

vazio

logEvent(analyticsInstance, eventName, eventParams, opções)

Envia um evento do Google Analytics com determinados eventParams . Este método associa automaticamente esse evento registrado a esta instância do aplicativo Web do Firebase neste dispositivo.

A lista de parâmetros de eventos recomendados pode ser encontrada na documentação de referência do GA4 .

Assinatura:

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

Retorna:

vazio

logEvent(analyticsInstance, eventName, eventParams, opções)

Envia um evento do Google Analytics com determinados eventParams . Este método associa automaticamente esse evento registrado a esta instância do aplicativo Web do Firebase neste dispositivo.

A lista de parâmetros de eventos recomendados pode ser encontrada na documentação de referência do GA4 .

Assinatura:

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

Retorna:

vazio

logEvent(analyticsInstance, eventName, eventParams, opções)

Envia um evento do Google Analytics com determinados eventParams . Este método associa automaticamente esse evento registrado a esta instância do aplicativo Web do Firebase neste dispositivo.

A lista de parâmetros de eventos recomendados pode ser encontrada na documentação de referência do GA4 .

Assinatura:

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

Parâmetros

Retorna:

vazio

logEvent(analyticsInstance, eventName, eventParams, opções)

Envia um evento do Google Analytics com determinados eventParams . Este método associa automaticamente esse evento registrado a esta instância do aplicativo Web do Firebase neste dispositivo.

A lista de parâmetros de eventos recomendados pode ser encontrada na documentação de referência do GA4 .

Assinatura:

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

Retorna:

vazio

logEvent(analyticsInstance, eventName, eventParams, opções)

Envia um evento do Google Analytics com determinados eventParams . Este método associa automaticamente esse evento registrado a esta instância do aplicativo Web do Firebase neste dispositivo.

A lista de parâmetros de eventos recomendados pode ser encontrada na documentação de referência do GA4 .

Assinatura:

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

Retorna:

vazio

logEvent(analyticsInstance, eventName, eventParams, opções)

Envia um evento do Google Analytics com determinados eventParams . Este método associa automaticamente esse evento registrado a esta instância do aplicativo Web do Firebase neste dispositivo.

A lista de parâmetros de eventos recomendados pode ser encontrada na documentação de referência do GA4 .

Assinatura:

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

Retorna:

vazio

logEvent(analyticsInstance, eventName, eventParams, opções)

Envia um evento do Google Analytics com determinados eventParams . Este método associa automaticamente esse evento registrado a esta instância do aplicativo Web do Firebase neste dispositivo.

Consulte Medir exceções .

Assinatura:

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

Parâmetros

Retorna:

vazio

logEvent(analyticsInstance, eventName, eventParams, opções)

Envia um evento do Google Analytics com determinados eventParams . Este método associa automaticamente esse evento registrado a esta instância do aplicativo Web do Firebase neste dispositivo.

A lista de parâmetros de eventos recomendados pode ser encontrada na documentação de referência do GA4 .

Assinatura:

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

Parâmetros

Retorna:

vazio

logEvent(analyticsInstance, eventName, eventParams, opções)

Envia um evento do Google Analytics com determinados eventParams . Este método associa automaticamente esse evento registrado a esta instância do aplicativo Web do Firebase neste dispositivo.

A lista de parâmetros de eventos recomendados pode ser encontrada na documentação de referência do GA4 .

Assinatura:

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

Parâmetros

Retorna:

vazio

logEvent(analyticsInstance, eventName, eventParams, opções)

Envia um evento do Google Analytics com determinados eventParams . Este método associa automaticamente esse evento registrado a esta instância do aplicativo Web do Firebase neste dispositivo.

Ver visualizações de página .

Assinatura:

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

Retorna:

vazio

setAnalyticsCollectionEnabled(analyticsInstance, ativado)

Define se a coleta do Google Analytics está ativada para este aplicativo neste dispositivo. Define global window['ga-disable-analyticsId'] = true;

Assinatura:

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

Parâmetros

Retorna:

vazio

setCurrentScreen(analyticsInstance, screenName, opções)

Use com eventName como 'screen_view' e adicione eventParams relevantes . Consulte Rastrear visualizações de tela .

Use o comando gtag config para definir screen_name .

Assinatura:

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

Parâmetros

Retorna:

vazio

setUserId(analyticsInstance, id, opções)

Use o comando gtag config para definir user_id .

Assinatura:

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

Parâmetros

Retorna:

vazio

setUserProperties(analyticsInstance, propriedades, opções)

Use o comando gtag config para definir todos os parâmetros especificados.

Assinatura:

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

Parâmetros

Retorna:

vazio

função()

é suportado()

Este é um método estático público fornecido aos usuários que envolve quatro verificações diferentes:

1. Verifique se não é um ambiente de extensão de navegador. 2. Verifique se os cookies estão habilitados no navegador atual. 3. Verifique se IndexedDB é compatível com o ambiente do navegador. 4. Verifique se o contexto atual do navegador é válido para usar IndexedDB.open() .

Assinatura:

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

Retorna:

Promessa<booleano>

função(consentSettings, ...)

setConsent(consentSettings)

Define o estado de consentimento do usuário final aplicável para este aplicativo da Web em todas as referências de gtag assim que o Firebase Analytics for inicializado.

Use ConsentSettings para especificar valores de tipo de consentimento individuais. Por padrão, os tipos de consentimento são definidos como "concedido".

Assinatura:

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

Parâmetros

Retorna:

vazio

função(customParams, ...)

setDefaultEventParameters(customParams)

Adiciona dados que serão definidos em cada evento registrado no SDK, inclusive os automáticos. Com o comando “set” da gtag, os valores passados ​​persistem na página atual e são passados ​​com todos os eventos subsequentes.

Assinatura:

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

Parâmetros

Retorna:

vazio

função(opções, ...)

configurações (opções)

Configura o Firebase Analytics para usar nomes personalizados gtag ou dataLayer . Destinado a ser usado se o script gtag.js tiver sido instalado nesta página independentemente do Firebase Analytics e estiver usando nomes não padrão para a função gtag ou para dataLayer . Deve ser chamado antes de chamar getAnalytics() ou não terá nenhum efeito.

Assinatura:

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

Parâmetros

Retorna:

vazio

ConsentStatusString

Se um determinado tipo de consentimento foi concedido ou negado.

Assinatura:

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

Moeda

Tipo de moeda padrão do Google Analytics.

Assinatura:

export declare type Currency = string | number;

Nome do Evento Personalizado

Qualquer sequência de nomes de eventos personalizados que não esteja na lista padrão de nomes de eventos recomendados.

Assinatura:

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

EventNameString

Digite nomes de eventos padrão do Google Analytics. logEvent também aceita qualquer string personalizada e a interpreta como um nome de evento personalizado.

Assinatura:

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