analytics package

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

Funções

Função Descrição
função(aplicativo...)
getAnalytics(aplicativo) Retorna uma instância do Analytics para o aplicativo fornecido.
initializeAnalytics(aplicativo, opções) Retorna uma instância do Analytics para o aplicativo fornecido.
function(analyticsInstance...)
getGoogleAnalyticsClientId(analyticsInstance) Recupera um identificador exclusivo do Google Analytics para o cliente da web. Ver client_id .
logEvent(analyticsInstance, eventName, eventParams, opções) Envia um evento do Google Analytics com eventParams especificados. Este método associa automaticamente este evento registrado a esta instância do app da Web do Firebase neste dispositivo. A lista de parâmetros de eventos recomendados pode ser encontrada na documentação de referência do GA4 .
logEvent(analyticsInstance, eventName, eventParams, opções) Envia um evento do Google Analytics com eventParams especificados. Este método associa automaticamente este evento registrado a esta instância do app da Web do Firebase neste dispositivo. A lista de parâmetros de eventos recomendados pode ser encontrada na documentação de referência do GA4 .
logEvent(analyticsInstance, eventName, eventParams, opções) Envia um evento do Google Analytics com eventParams especificados. Este método associa automaticamente este evento registrado a esta instância do app da Web do Firebase neste dispositivo. Veja as visualizações de tela da trilha .
logEvent(analyticsInstance, eventName, eventParams, opções) Envia um evento do Google Analytics com eventParams especificados. Este método associa automaticamente este evento registrado a esta instância do app da Web do Firebase neste dispositivo. A lista de parâmetros de eventos recomendados pode ser encontrada na documentação de referência do GA4 .
logEvent(analyticsInstance, eventName, eventParams, opções) Envia um evento do Google Analytics com eventParams especificados. Este método associa automaticamente este evento registrado a esta instância do app da Web do Firebase neste dispositivo. A lista de parâmetros de eventos recomendados pode ser encontrada na documentação de referência do GA4 .
logEvent(analyticsInstance, eventName, eventParams, opções) Envia um evento do Google Analytics com eventParams especificados. Este método associa automaticamente este evento registrado a esta instância do app da Web do Firebase neste dispositivo. A lista de parâmetros de eventos recomendados pode ser encontrada na documentação de referência do GA4 .
logEvent(analyticsInstance, eventName, eventParams, opções) Envia um evento do Google Analytics com eventParams especificados. Este método associa automaticamente este evento registrado a esta instância do app da Web do Firebase neste dispositivo. A lista de parâmetros de eventos recomendados pode ser encontrada na documentação de referência do GA4 .
logEvent(analyticsInstance, eventName, eventParams, opções) Envia um evento do Google Analytics com eventParams especificados. Este método associa automaticamente este evento registrado a esta instância do app da Web do Firebase neste dispositivo. A lista de parâmetros de eventos recomendados pode ser encontrada na documentação de referência do GA4 .
logEvent(analyticsInstance, eventName, eventParams, opções) Envia um evento do Google Analytics com eventParams especificados. Este método associa automaticamente este evento registrado a esta instância do app da Web do Firebase neste dispositivo. A lista de parâmetros de eventos recomendados pode ser encontrada na documentação de referência do GA4 .
logEvent(analyticsInstance, eventName, eventParams, opções) Envia um evento do Google Analytics com eventParams especificados. Este método associa automaticamente este evento registrado a esta instância do app da Web do Firebase neste dispositivo. A lista de parâmetros de eventos recomendados pode ser encontrada na documentação de referência do GA4 .
logEvent(analyticsInstance, eventName, eventParams, opções) Envia um evento do Google Analytics com eventParams especificados. Este método associa automaticamente este evento registrado a esta instância do app da Web do Firebase neste dispositivo. A lista de parâmetros de eventos recomendados pode ser encontrada na documentação de referência do GA4 .
logEvent(analyticsInstance, eventName, eventParams, opções) Envia um evento do Google Analytics com eventParams especificados. Este método associa automaticamente este evento registrado a esta instância do app da Web do Firebase neste dispositivo. A lista de parâmetros de eventos recomendados pode ser encontrada na documentação de referência do GA4 .
logEvent(analyticsInstance, eventName, eventParams, opções) Envia um evento do Google Analytics com eventParams especificados. Este método associa automaticamente este evento registrado a esta instância do app da Web do Firebase neste dispositivo. A lista de parâmetros de eventos recomendados pode ser encontrada na documentação de referência do GA4 .
logEvent(analyticsInstance, eventName, eventParams, opções) Envia um evento do Google Analytics com eventParams especificados. Este método associa automaticamente este evento registrado a esta instância do app da Web do Firebase neste dispositivo. A lista de parâmetros de eventos recomendados pode ser encontrada na documentação de referência do GA4 .
logEvent(analyticsInstance, eventName, eventParams, opções) Envia um evento do Google Analytics com eventParams especificados. Este método associa automaticamente este evento registrado a esta instância do app da Web do Firebase neste dispositivo. A lista de parâmetros de eventos recomendados pode ser encontrada na documentação de referência do GA4 .
logEvent(analyticsInstance, eventName, eventParams, opções) Envia um evento do Google Analytics com eventParams especificados. Este método associa automaticamente este evento registrado a esta instância do app da Web do Firebase neste dispositivo. A lista de parâmetros de eventos recomendados pode ser encontrada na documentação de referência do GA4 .
logEvent(analyticsInstance, eventName, eventParams, opções) Envia um evento do Google Analytics com eventParams especificados. Este método associa automaticamente este evento registrado a esta instância do app da Web do Firebase neste dispositivo. A lista de parâmetros de eventos recomendados pode ser encontrada na documentação de referência do GA4 .
logEvent(analyticsInstance, eventName, eventParams, opções) Envia um evento do Google Analytics com eventParams especificados. Este método associa automaticamente este evento registrado a esta instância do app da Web do Firebase neste dispositivo. A lista de parâmetros de eventos recomendados pode ser encontrada na documentação de referência do GA4 .
logEvent(analyticsInstance, eventName, eventParams, opções) Envia um evento do Google Analytics com eventParams especificados. Este método associa automaticamente este evento registrado a esta instância do app da Web do Firebase neste dispositivo. Consulte Exceções de medição .
logEvent(analyticsInstance, eventName, eventParams, opções) Envia um evento do Google Analytics com eventParams especificados. Este método associa automaticamente este evento registrado a esta instância do app da Web do Firebase neste dispositivo. A lista de parâmetros de eventos recomendados pode ser encontrada na documentação de referência do GA4 .
logEvent(analyticsInstance, eventName, eventParams, opções) Envia um evento do Google Analytics com eventParams especificados. Este método associa automaticamente este evento registrado a esta instância do app da Web do Firebase neste dispositivo. A lista de parâmetros de eventos recomendados pode ser encontrada na documentação de referência do GA4 .
logEvent(analyticsInstance, eventName, eventParams, opções) Envia um evento do Google Analytics com eventParams especificados. Este método associa automaticamente este evento registrado a esta instância do app da Web do Firebase neste dispositivo. Ver visualizações de página .
setAnalyticsCollectionEnabled(analyticsInstance, ativado) Define se a coleta do Google Analytics está habilitada para este aplicativo neste dispositivo. Define window['ga-disable-analyticsId'] = true;
setCurrentScreen(analyticsInstance, screenName, opções) Use o comando gtag config para definir screen_name .
setUserId(analyticsInstance, id, opções) Use o comando gtag config para definir user_id .
setUserProperties(analyticsInstance, propriedades, opções) Use o comando gtag config para definir todos os parâmetros especificados.
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 do navegador. 2. Verifique se os cookies estão ativados no navegador atual. 3. Verifique se IndexedDB é suportado pelo ambiente do navegador. 4. Verifique se o contexto atual do navegador é válido para usar IndexedDB.open() .
função(configurações de consentimento...)
setConsent(consentSettings) Define o estado de consentimento do usuário final aplicável para este aplicativo da Web em todas as referências gtag depois que o Firebase Analytics é inicializado. Use ConsentSettings para especificar valores de tipo de consentimento individuais. Por padrão, os tipos de consentimento são definidos como "concedido".
function(customParams...)
setDefaultEventParameters(customParams) Adiciona dados que serão definidos em todos os eventos registrados do SDK, incluindo 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 subseqüentes.
função(opções...)
configurações(opções) Configura o Firebase Analytics para usar nomes gtag ou dataLayer personalizados. Destina-se 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.

Interfaces

Interface Descrição
Análise Uma instância do Firebase Analytics.
AnalyticsCallOptions Opções adicionais que podem ser transmitidas para chamadas de método do Analytics, como logEvent etc.
AnalyticsSettings Opções de inicialização da instância do Analytics .
Configurações de consentimento Configurações de status de consentimento para cada tipo de consentimento. Para obter mais informações, consulte a documentação de referência do GA4 para estado de consentimento e tipos de consentimento .
ControlParams Parâmetros de controle gtag.js padrão. Para obter mais informações, consulte a documentação de referência do GA4 .
Parâmetros personalizados Quaisquer parâmetros personalizados que o usuário possa passar para gtag .
EventParams Parâmetros de evento gtag.js padrão. Para obter mais informações, consulte a documentação de referência do GA4 .
GtagConfigParams Um conjunto de configurações comuns do Google Analytics reconhecidas por gtag.js .
Item Tipo Item padrão do Google Analytics.
Promoção Campo usado anteriormente por alguns eventos do Google Analytics.
ConfiguraçõesOpções Especifica opções personalizadas para sua instância do Firebase Analytics. Você deve defini-los antes de inicializar firebase.analytics() .

Aliases de tipo

Digite Alias Descrição
ConsentimentoStatusString Se um determinado tipo de consentimento foi concedido ou negado.
Moeda Tipo de moeda padrão do Google Analytics.
CustomEventName Qualquer string de nome de evento personalizado que não esteja na lista padrão de nomes de eventos recomendados.
EventNameString Digite para nomes de eventos padrão do Google Analytics. logEvent também aceita qualquer string customizada e a interpreta como um nome de evento customizado.

getAnalytics()

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

Assinatura:

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

Parâmetros

Parâmetro Tipo Descrição
aplicativo FirebaseApp O FirebaseApp a ser usado.

Retorna:

Análise

inicializarAnalytics()

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

Assinatura:

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

Parâmetros

Parâmetro Tipo Descrição
aplicativo FirebaseApp O FirebaseApp a ser usado.
opções AnalyticsSettings

Retorna:

Análise

getGoogleAnalyticsClientId()

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

Assinatura:

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

Parâmetros

Parâmetro Tipo Descrição
analyticsInstance Análise

Retorna:

Promessa<string>

logEvent()

Envia um evento do Google Analytics com eventParams fornecidos . Este método associa automaticamente este evento registrado a esta instância do app da 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

Parâmetro Tipo Descrição
analyticsInstance Análise
nome do evento 'adicionar_pagamento_info'
eventParams { cupom?: EventParams ['cupom']; moeda?: EventParams ['moeda']; itens?: EventParams ['Unid']; tipo_pagamento?: EventParams ['tipo de pagamento']; valor?: EventParams ['valor']; [chave: string]: qualquer; }
opções AnalyticsCallOptions

Retorna:

vazio

logEvent()

Envia um evento do Google Analytics com eventParams fornecidos . Este método associa automaticamente este evento registrado a esta instância do app da 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

Parâmetro Tipo Descrição
analyticsInstance Análise
nome do evento 'comprar' | 'reembolso'
eventParams { valor?: EventParams ['valor']; moeda?: EventParams ['moeda']; transaction_id: EventParams ['transação_id']; imposto?: EventParams ['imposto']; envio?: EventParams ['envio']; itens?: EventParams ['Unid']; cupom?: EventParams ['cupom']; afiliação?: EventParams ['afiliação']; [chave: string]: qualquer; }
opções AnalyticsCallOptions

Retorna:

vazio

logEvent()

Envia um evento do Google Analytics com eventParams fornecidos . Este método associa automaticamente este evento registrado a esta instância do app da Web do Firebase neste dispositivo.

Veja as visualizações de tela da trilha .

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

Parâmetro Tipo Descrição
analyticsInstance Análise
nome do evento 'screen_view'
eventParams { firebase_screen: EventParams ['firebase_screen']; firebase_screen_class: EventParams ['firebase_screen_class']; [chave: string]: qualquer; }
opções AnalyticsCallOptions

Retorna:

vazio

logEvent()

Envia um evento do Google Analytics com eventParams fornecidos . Este método associa automaticamente este evento registrado a esta instância do app da 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

Parâmetro Tipo Descrição
analyticsInstance Análise
nome do evento 'pesquisar' | 'view_search_results'
eventParams { search_term?: EventParams ['termo de pesquisa']; [chave: string]: qualquer; }
opções AnalyticsCallOptions

Retorna:

vazio

logEvent()

Envia um evento do Google Analytics com eventParams fornecidos . Este método associa automaticamente este evento registrado a esta instância do app da 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

Parâmetro Tipo Descrição
analyticsInstance Análise
nome do evento 'select_content'
eventParams { content_type?: EventParams ['tipo de conteúdo']; item_id?: EventParams ['item_id']; [chave: string]: qualquer; }
opções AnalyticsCallOptions

Retorna:

vazio

logEvent()

Envia um evento do Google Analytics com eventParams fornecidos . Este método associa automaticamente este evento registrado a esta instância do app da 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

Parâmetro Tipo Descrição
analyticsInstance Análise
nome do evento 'Selecionar item'
eventParams { items?: EventParams ['Unid']; item_list_name?: EventParams ['item_list_name']; item_list_id?: EventParams ['item_list_id']; [chave: string]: qualquer; }
opções AnalyticsCallOptions

Retorna:

vazio

logEvent()

Envia um evento do Google Analytics com eventParams fornecidos . Este método associa automaticamente este evento registrado a esta instância do app da 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

Parâmetro Tipo Descrição
analyticsInstance Análise
nome do evento 'select_promotion' | 'visualizar_promoção'
eventParams { items?: EventParams ['Unid']; promotion_id?: EventParams ['promoção_id']; nome_da_promoção?: EventParams ['promoção_nome']; [chave: string]: qualquer; }
opções AnalyticsCallOptions

Retorna:

vazio

logEvent()

Envia um evento do Google Analytics com eventParams fornecidos . Este método associa automaticamente este evento registrado a esta instância do app da 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

Parâmetro Tipo Descrição
analyticsInstance Análise
nome do evento 'set_checkout_option'
eventParams { checkout_step?: EventParams ['passo_checkout']; checkout_option?: EventParams ['opção_checkout']; [chave: string]: qualquer; }
opções AnalyticsCallOptions

Retorna:

vazio

logEvent()

Envia um evento do Google Analytics com eventParams fornecidos . Este método associa automaticamente este evento registrado a esta instância do app da 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

Parâmetro Tipo Descrição
analyticsInstance Análise
nome do evento 'compartilhar'
eventParams { método?: EventParams ['método']; content_type?: EventParams ['tipo de conteúdo']; item_id?: EventParams ['item_id']; [chave: string]: qualquer; }
opções AnalyticsCallOptions

Retorna:

vazio

logEvent()

Envia um evento do Google Analytics com eventParams fornecidos . Este método associa automaticamente este evento registrado a esta instância do app da 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

Parâmetro Tipo Descrição
analyticsInstance Análise
nome do evento 'inscrever-se'
eventParams { método?: EventParams ['método']; [chave: string]: qualquer; }
opções AnalyticsCallOptions

Retorna:

vazio

logEvent()

Envia um evento do Google Analytics com eventParams fornecidos . Este método associa automaticamente este evento registrado a esta instância do app da 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

Parâmetro Tipo Descrição
analyticsInstance Análise
nome do evento 'timing_complete'
eventParams { nome: string; valor: número; categoria_evento?: string; rótulo_do_evento?: string; [chave: string]: qualquer; }
opções AnalyticsCallOptions

Retorna:

vazio

logEvent()

Envia um evento do Google Analytics com eventParams fornecidos . Este método associa automaticamente este evento registrado a esta instância do app da 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

Parâmetro Tipo Descrição
analyticsInstance Análise
nome do evento 'add_shipping_info'
eventParams { cupom?: EventParams ['cupom']; moeda?: EventParams ['moeda']; itens?: EventParams ['Unid']; shipping_tier?: EventParams ['shipping_tier']; valor?: EventParams ['valor']; [chave: string]: qualquer; }
opções AnalyticsCallOptions

Retorna:

vazio

logEvent()

Envia um evento do Google Analytics com eventParams fornecidos . Este método associa automaticamente este evento registrado a esta instância do app da 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

Parâmetro Tipo Descrição
analyticsInstance Análise
nome do evento 'view_cart' | 'ver item'
eventParams { moeda?: EventParams ['moeda']; itens?: EventParams ['Unid']; valor?: EventParams ['valor']; [chave: string]: qualquer; }
opções AnalyticsCallOptions

Retorna:

vazio

logEvent()

Envia um evento do Google Analytics com eventParams fornecidos . Este método associa automaticamente este evento registrado a esta instância do app da 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

Parâmetro Tipo Descrição
analyticsInstance Análise
nome do evento 'view_item_list'
eventParams { items?: EventParams ['Unid']; item_list_name?: EventParams ['item_list_name']; item_list_id?: EventParams ['item_list_id']; [chave: string]: qualquer; }
opções AnalyticsCallOptions

Retorna:

vazio

logEvent()

Envia um evento do Google Analytics com eventParams fornecidos . Este método associa automaticamente este evento registrado a esta instância do app da 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

Parâmetro Tipo Descrição
analyticsInstance Análise
nome do evento CustomEventName <T>
eventParams { [chave: string]: qualquer; }
opções AnalyticsCallOptions

Retorna:

vazio

logEvent()

Envia um evento do Google Analytics com eventParams fornecidos . Este método associa automaticamente este evento registrado a esta instância do app da 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

Parâmetro Tipo Descrição
analyticsInstance Análise
nome do evento 'adicionar_ao_carrinho' | 'adicionar_à_lista de desejos' | 'remover_do_carrinho'
eventParams { moeda?: EventParams ['moeda']; valor?: EventParams ['valor']; itens?: EventParams ['Unid']; [chave: string]: qualquer; }
opções AnalyticsCallOptions

Retorna:

vazio

logEvent()

Envia um evento do Google Analytics com eventParams fornecidos . Este método associa automaticamente este evento registrado a esta instância do app da 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

Parâmetro Tipo Descrição
analyticsInstance Análise
nome do evento 'begin_checkout'
eventParams { moeda?: EventParams ['moeda']; cupom?: EventParams ['cupom']; valor?: EventParams ['valor']; itens?: EventParams ['Unid']; [chave: string]: qualquer; }
opções AnalyticsCallOptions

Retorna:

vazio

logEvent()

Envia um evento do Google Analytics com eventParams fornecidos . Este método associa automaticamente este evento registrado a esta instância do app da 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

Parâmetro Tipo Descrição
analyticsInstance Análise
nome do evento 'checkout_progress'
eventParams { moeda?: EventParams ['moeda']; cupom?: EventParams ['cupom']; valor?: EventParams ['valor']; itens?: EventParams ['Unid']; checkout_step?: EventParams ['passo_checkout']; checkout_option?: EventParams ['opção_checkout']; [chave: string]: qualquer; }
opções AnalyticsCallOptions

Retorna:

vazio

logEvent()

Envia um evento do Google Analytics com eventParams fornecidos . Este método associa automaticamente este evento registrado a esta instância do app da Web do Firebase neste dispositivo.

Consulte Exceções de medida .

Assinatura:

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 Descrição
analyticsInstance Análise
nome do evento 'exceção'
eventParams { descrição?: EventParams ['descrição']; fatal?: EventParams ['fatal']; [chave: string]: qualquer; }
opções AnalyticsCallOptions

Retorna:

vazio

logEvent()

Envia um evento do Google Analytics com eventParams fornecidos . Este método associa automaticamente este evento registrado a esta instância do app da 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

Parâmetro Tipo Descrição
analyticsInstance Análise
nome do evento 'generate_lead'
eventParams { valor?: EventParams ['valor']; moeda?: EventParams ['moeda']; [chave: string]: qualquer; }
opções AnalyticsCallOptions

Retorna:

vazio

logEvent()

Envia um evento do Google Analytics com eventParams fornecidos . Este método associa automaticamente este evento registrado a esta instância do app da 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

Parâmetro Tipo Descrição
analyticsInstance Análise
nome do evento 'Conecte-se'
eventParams { método?: EventParams ['método']; [chave: string]: qualquer; }
opções AnalyticsCallOptions

Retorna:

vazio

logEvent()

Envia um evento do Google Analytics com eventParams fornecidos . Este método associa automaticamente este evento registrado a esta instância do app da 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

Parâmetro Tipo Descrição
analyticsInstance Análise
nome do evento 'page_view'
eventParams { page_title?: string; local_da_página?: string; page_path?: string; [chave: string]: qualquer; }
opções AnalyticsCallOptions

Retorna:

vazio

setAnalyticsCollectionEnabled()

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

Assinatura:

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

Parâmetros

Parâmetro Tipo Descrição
analyticsInstance Análise A instância do Analytics .
habilitado boleano Se verdadeiro, habilita a coleta, se falso, desabilita.

Retorna:

vazio

setCurrentScreen()

Use com eventName como 'screen_view' e adicione eventParams relevantes . Veja as visualizações de tela da trilha .

Use o comando gtag config para definir screen_name .

Assinatura:

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

Parâmetros

Parâmetro Tipo Descrição
analyticsInstance Análise A instância do Analytics .
Nome de Tela corda Nome da tela para definir.
opções AnalyticsCallOptions

Retorna:

vazio

setUserId()

Use o comando gtag config para definir user_id .

Assinatura:

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

Parâmetros

Parâmetro Tipo Descrição
analyticsInstance Análise A instância do Analytics .
eu ia seqüência de caracteres | nulo ID do usuário a ser definido.
opções AnalyticsCallOptions

Retorna:

vazio

setUserProperties()

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

Parâmetro Tipo Descrição
analyticsInstance Análise
propriedades Parâmetros personalizados
opções AnalyticsCallOptions

Retorna:

vazio

é 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 do navegador. 2. Verifique se os cookies estão ativados no navegador atual. 3. Verifique se IndexedDB é suportado pelo 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<booleana>

setConsent()

Define o estado de consentimento do usuário final aplicável para este aplicativo da Web em todas as referências gtag depois que o Firebase Analytics é 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

Parâmetro Tipo Descrição
configurações de consentimento Configurações de consentimento Mapeia o estado de consentimento do usuário final aplicável para gtag.js.

Retorna:

vazio

setDefaultEventParameters()

Adiciona dados que serão definidos em todos os eventos registrados do SDK, incluindo 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 subseqüentes.

Assinatura:

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

Parâmetros

Parâmetro Tipo Descrição
customParams Parâmetros personalizados Quaisquer parâmetros personalizados que o usuário pode passar para gtag.js.

Retorna:

vazio

configurações()

Configura o Firebase Analytics para usar nomes gtag ou dataLayer personalizados. Destina-se 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

Parâmetro Tipo Descrição
opções ConfiguraçõesOpções Nomes personalizados de gtag e dataLayer.

Retorna:

vazio

ConsentimentoStatusString

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;

CustomEventName

Qualquer string de nome de evento personalizado 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 para nomes de eventos padrão do Google Analytics. logEvent também aceita qualquer string customizada e a interpreta como um nome de evento customizado.

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