O SDK da Web do Firebase Analytics Este SDK não funciona em um ambiente Node.js.
Funções
Função | Descrição |
---|---|
function(app, ...) (link em inglês) | |
getAnalytics(app) (em inglês) | Retorna uma instância do Analytics para o app especificado. |
InitializeAnalytics(app, options) | Retorna uma instância do Analytics para o app especificado. |
function(analyticsInstance, ...) | |
getGoogleAnalyticsClientId(analyticsInstance) | Recupera um identificador exclusivo do Google Analytics para o cliente da Web. Consulte client_id. |
logEvent(analyticsInstance, eventName, eventParams, options) | Envia um evento do Google Analytics com o eventParams especificado. Esse método associa automaticamente o evento registrado a esta instância do app da Web do Firebase neste dispositivo.A lista de parâmetros de evento recomendados está disponível na documentação de referência do GA4. |
logEvent(analyticsInstance, eventName, eventParams, options) | Envia um evento do Google Analytics com o eventParams especificado. Esse método associa automaticamente o evento registrado a esta instância do app da Web do Firebase neste dispositivo.A lista de parâmetros de evento recomendados está disponível na documentação de referência do GA4. |
logEvent(analyticsInstance, eventName, eventParams, options) | Envia um evento do Google Analytics com o eventParams especificado. Este método associa automaticamente o evento registrado a essa instância do app da Web do Firebase neste dispositivo.Consulte Acompanhar exibições de tela. |
logEvent(analyticsInstance, eventName, eventParams, options) | Envia um evento do Google Analytics com o eventParams especificado. Esse método associa automaticamente o evento registrado a esta instância do app da Web do Firebase neste dispositivo.A lista de parâmetros de evento recomendados está disponível na documentação de referência do GA4. |
logEvent(analyticsInstance, eventName, eventParams, options) | Envia um evento do Google Analytics com o eventParams especificado. Esse método associa automaticamente o evento registrado a esta instância do app da Web do Firebase neste dispositivo.A lista de parâmetros de evento recomendados está disponível na documentação de referência do GA4. |
logEvent(analyticsInstance, eventName, eventParams, options) | Envia um evento do Google Analytics com o eventParams especificado. Esse método associa automaticamente o evento registrado a esta instância do app da Web do Firebase neste dispositivo.A lista de parâmetros de evento recomendados está disponível na documentação de referência do GA4. |
logEvent(analyticsInstance, eventName, eventParams, options) | Envia um evento do Google Analytics com o eventParams especificado. Esse método associa automaticamente o evento registrado a esta instância do app da Web do Firebase neste dispositivo.A lista de parâmetros de evento recomendados está disponível na documentação de referência do GA4. |
logEvent(analyticsInstance, eventName, eventParams, options) | Envia um evento do Google Analytics com o eventParams especificado. Esse método associa automaticamente o evento registrado a esta instância do app da Web do Firebase neste dispositivo.A lista de parâmetros de evento recomendados está disponível na documentação de referência do GA4. |
logEvent(analyticsInstance, eventName, eventParams, options) | Envia um evento do Google Analytics com o eventParams especificado. Esse método associa automaticamente o evento registrado a esta instância do app da Web do Firebase neste dispositivo.A lista de parâmetros de evento recomendados está disponível na documentação de referência do GA4. |
logEvent(analyticsInstance, eventName, eventParams, options) | Envia um evento do Google Analytics com o eventParams especificado. Esse método associa automaticamente o evento registrado a esta instância do app da Web do Firebase neste dispositivo.A lista de parâmetros de evento recomendados está disponível na documentação de referência do GA4. |
logEvent(analyticsInstance, eventName, eventParams, options) | Envia um evento do Google Analytics com o eventParams especificado. Esse método associa automaticamente o evento registrado a esta instância do app da Web do Firebase neste dispositivo.A lista de parâmetros de evento recomendados está disponível na documentação de referência do GA4. |
logEvent(analyticsInstance, eventName, eventParams, options) | Envia um evento do Google Analytics com o eventParams especificado. Esse método associa automaticamente o evento registrado a esta instância do app da Web do Firebase neste dispositivo.A lista de parâmetros de evento recomendados está disponível na documentação de referência do GA4. |
logEvent(analyticsInstance, eventName, eventParams, options) | Envia um evento do Google Analytics com o eventParams especificado. Esse método associa automaticamente o evento registrado a esta instância do app da Web do Firebase neste dispositivo.A lista de parâmetros de evento recomendados está disponível na documentação de referência do GA4. |
logEvent(analyticsInstance, eventName, eventParams, options) | Envia um evento do Google Analytics com o eventParams especificado. Esse método associa automaticamente o evento registrado a esta instância do app da Web do Firebase neste dispositivo.A lista de parâmetros de evento recomendados está disponível na documentação de referência do GA4. |
logEvent(analyticsInstance, eventName, eventParams, options) | Envia um evento do Google Analytics com o eventParams especificado. Esse método associa automaticamente o evento registrado a esta instância do app da Web do Firebase neste dispositivo.A lista de parâmetros de evento recomendados está disponível na documentação de referência do GA4. |
logEvent(analyticsInstance, eventName, eventParams, options) | Envia um evento do Google Analytics com o eventParams especificado. Esse método associa automaticamente o evento registrado a esta instância do app da Web do Firebase neste dispositivo.A lista de parâmetros de evento recomendados está disponível na documentação de referência do GA4. |
logEvent(analyticsInstance, eventName, eventParams, options) | Envia um evento do Google Analytics com o eventParams especificado. Esse método associa automaticamente o evento registrado a esta instância do app da Web do Firebase neste dispositivo.A lista de parâmetros de evento recomendados está disponível na documentação de referência do GA4. |
logEvent(analyticsInstance, eventName, eventParams, options) | Envia um evento do Google Analytics com o eventParams especificado. Esse método associa automaticamente o evento registrado a esta instância do app da Web do Firebase neste dispositivo.A lista de parâmetros de evento recomendados está disponível na documentação de referência do GA4. |
logEvent(analyticsInstance, eventName, eventParams, options) | Envia um evento do Google Analytics com o eventParams especificado. Este método associa automaticamente o evento registrado a essa instância do app da Web do Firebase neste dispositivo.Consulte Medir as exceções. |
logEvent(analyticsInstance, eventName, eventParams, options) | Envia um evento do Google Analytics com o eventParams especificado. Esse método associa automaticamente o evento registrado a esta instância do app da Web do Firebase neste dispositivo.A lista de parâmetros de evento recomendados está disponível na documentação de referência do GA4. |
logEvent(analyticsInstance, eventName, eventParams, options) | Envia um evento do Google Analytics com o eventParams especificado. Esse método associa automaticamente o evento registrado a esta instância do app da Web do Firebase neste dispositivo.A lista de parâmetros de evento recomendados está disponível na documentação de referência do GA4. |
logEvent(analyticsInstance, eventName, eventParams, options) | Envia um evento do Google Analytics com o eventParams especificado. Este método associa automaticamente o evento registrado a esta instância do app da Web do Firebase neste dispositivo.Consulte Visualizações de página. |
setAnalyticsCollectionEnabled(analyticsInstance, enabled) | Define se a coleta do Google Analytics está ativada para o app neste dispositivo. Define o window['ga-disable-analyticsId'] = true; global |
setCurrentScreen(analyticsInstance, screenName, options) | Use o comando config da gtag para definir screen_name . |
setUserId(analyticsInstance, id, options) | Use o comando config da gtag para definir user_id . |
setUserProperties(analyticsInstance, propriedades, opções) | Use o comando config da gtag para definir todos os parâmetros especificados. |
function(). | |
issupported(); | Esse é 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 o ambiente do navegador oferece suporte ao IndexedDB. 4. Verifique se o contexto atual do navegador é válido para usar IndexedDB.open() . |
function(consentSettings, ...) | |
setConsent(consentSettings) | Define o estado de consentimento do usuário final aplicável a este app da Web em todas as referências da gtag depois 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 "concedidos". |
function(customParams, ...) | |
setDefaultEventParameters(customParams) | Adiciona dados que serão definidos em todos os eventos registrados pelo SDK, incluindo os automáticos. Com o parâmetro "set" da gtag , os valores transmitidos persistem na página atual e são transmitidos para todos os eventos subsequentes. |
function(options, ...) | |
settings(options) (em inglês) | Configura o Firebase Analytics para usar nomes personalizados gtag ou dataLayer . Destina-se a ser usado se o script gtag.js tiver sido instalado nesta página, independentemente do Firebase Analytics, e usar nomes não padrão para a função gtag ou para dataLayer . Precisa ser chamado antes de chamar getAnalytics() ou não terá nenhum efeito. |
Interfaces
Interface | Descrição |
---|---|
Analytics | Uma instância do Firebase Analytics. |
AnalyticsCallOptions | Outras opções que podem ser transmitidas para chamadas de método do Google Analytics, como logEvent etc. |
AnalyticsSettings | Opções de inicialização de instâncias do Analytics. |
ConsentSettings (em inglês) | Configurações de status de consentimento para cada tipo de consentimento. Para mais informações, consulte a documentação de referência do GA4 sobre estado e tipos de consentimento. |
ControlParams | Parâmetros de controle gtag.js padrão. Para mais informações, consulte a documentação de referência do GA4. |
CustomParams | Todos os parâmetros personalizados que o usuário pode transmitir para gtag . |
EventParams | Parâmetros de evento gtag.js padrão. Para mais informações, consulte a documentação de referência do GA4. |
GtagConfigParams (em inglês) | Um conjunto de configurações comuns do Google Analytics reconhecidas por gtag.js . |
Item | Tipo de Item padrão do Google Analytics. |
Promoção | Campo usado anteriormente por alguns eventos do Google Analytics. |
SettingsOptions (em inglês) | Especifica opções personalizadas para sua instância do Firebase Analytics. Elas precisam ser definidas antes de inicializar o firebase.analytics() . |
Aliases de tipos
Alias de tipo | Descrição |
---|---|
ConsentStatusString (link em inglês) | Se um tipo de consentimento específico foi dado ou negado. |
Moeda | Tipo de moeda padrão do Google Analytics. |
CustomEventName (em inglês) | Qualquer string de nome de evento personalizado que não esteja na lista padrão de nomes de eventos recomendados. |
EventNameString | Tipo para nomes de eventos padrão do Google Analytics. logEvent também aceita qualquer string personalizada e a interpreta como um nome de evento personalizado. |
função(app, ...)
getAnalytics(app)
Retorna uma instância do Analytics para o app especificado.
Assinatura:
export declare function getAnalytics(app?: FirebaseApp): Analytics;
Parâmetros
Parâmetro | Tipo | Descrição |
---|---|---|
app | FirebaseApp | O FirebaseApp a ser usado. |
Retorna:
inicializeAnalytics(app, options)
Retorna uma instância do Analytics para o app especificado.
Assinatura:
export declare function initializeAnalytics(app: FirebaseApp, options?: AnalyticsSettings): Analytics;
Parâmetros
Parâmetro | Tipo | Descrição |
---|---|---|
app | FirebaseApp | O FirebaseApp a ser usado. |
options | AnalyticsSettings |
Retorna:
function(analyticsInstance, ...)
getGoogleAnalyticsClientId(analyticsInstance)
Recupera um identificador exclusivo do Google Analytics para o cliente da Web. Consulte client_id.
Assinatura:
export declare function getGoogleAnalyticsClientId(analyticsInstance: Analytics): Promise<string>;
Parâmetros
Parâmetro | Tipo | Descrição |
---|---|---|
analyticsInstance | Analytics |
Retorna:
Promessa<string>
logEvent(analyticsInstance, eventName, eventParams, options)
Envia um evento do Google Analytics com eventParams
. Esse método associa automaticamente o evento registrado a essa instância do app da Web do Firebase neste dispositivo.
A lista de parâmetros de evento recomendados está disponível 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 | Analytics | |
eventName | "add_payment_info" | |
eventParams | { cupom?: EventParams['coupon']; moeda? EventParams['currency']; itens? EventParams['items']; payment_type? EventParams['payment_type']; ?: EventParams['value']; [chave: string]: qualquer; } | |
options | AnalyticsCallOptions |
Retorna:
void
logEvent(analyticsInstance, eventName, eventParams, options)
Envia um evento do Google Analytics com eventParams
. Esse método associa automaticamente o evento registrado a essa instância do app da Web do Firebase neste dispositivo.
A lista de parâmetros de evento recomendados está disponível 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 | Analytics | |
eventName | "purchase" | "reembolso" | |
eventParams | { valor?: EventParams['value']; moeda? EventParams['currency']; transaction_id: EventParams['transaction_id']; tributos? EventParams['tax']; envio? EventParams['shipping']; itens? EventParams['items']; cupom? EventParams['coupon']; afiliação? EventParams['affiliation']; [chave: string]: qualquer; } | |
options | AnalyticsCallOptions |
Retorna:
void
logEvent(analyticsInstance, eventName, eventParams, options)
Envia um evento do Google Analytics com eventParams
. Esse método associa automaticamente o evento registrado a essa instância do app da Web do Firebase neste dispositivo.
Consulte Acompanhar exibiçõ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
Parâmetro | Tipo | Descrição |
---|---|---|
analyticsInstance | Analytics | |
eventName | "screen_view" | |
eventParams | { firebase_screen: EventParams['firebase_screen']; firebase_screen_class: EventParams['firebase_screen_class']; [chave: string]: qualquer; } | |
options | AnalyticsCallOptions |
Retorna:
void
logEvent(analyticsInstance, eventName, eventParams, options)
Envia um evento do Google Analytics com eventParams
. Esse método associa automaticamente o evento registrado a essa instância do app da Web do Firebase neste dispositivo.
A lista de parâmetros de evento recomendados está disponível 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 | Analytics | |
eventName | "pesquisa" | "view_search_results" | |
eventParams | { search_term?: EventParams['search_term']; [chave: string]: qualquer; } | |
options | AnalyticsCallOptions |
Retorna:
void
logEvent(analyticsInstance, eventName, eventParams, options)
Envia um evento do Google Analytics com eventParams
. Esse método associa automaticamente o evento registrado a essa instância do app da Web do Firebase neste dispositivo.
A lista de parâmetros de evento recomendados está disponível 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 | Analytics | |
eventName | "select_content" | |
eventParams | { content_type? EventParams['content_type']; item_id? EventParams['item_id']; [chave: string]: qualquer; } | |
options | AnalyticsCallOptions |
Retorna:
void
logEvent(analyticsInstance, eventName, eventParams, options)
Envia um evento do Google Analytics com eventParams
. Esse método associa automaticamente o evento registrado a essa instância do app da Web do Firebase neste dispositivo.
A lista de parâmetros de evento recomendados está disponível 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 | Analytics | |
eventName | "select_item" | |
eventParams | { itens?: EventParams['items']; item_list_name? EventParams['item_list_name']; item_list_id? EventParams['item_list_id']; [chave: string]: qualquer; } | |
options | AnalyticsCallOptions |
Retorna:
void
logEvent(analyticsInstance, eventName, eventParams, options)
Envia um evento do Google Analytics com eventParams
. Esse método associa automaticamente o evento registrado a essa instância do app da Web do Firebase neste dispositivo.
A lista de parâmetros de evento recomendados está disponível 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 | Analytics | |
eventName | "select_promotion" | "view_promotion" | |
eventParams | { itens?: EventParams['items']; promotion_id [código_da_promoção]: EventParams['promotion_id']; promotion_name [nome_da_promoção]?: EventParams['promotion_name']; [chave: string]: qualquer; } | |
options | AnalyticsCallOptions |
Retorna:
void
logEvent(analyticsInstance, eventName, eventParams, options)
Envia um evento do Google Analytics com eventParams
. Esse método associa automaticamente o evento registrado a essa instância do app da Web do Firebase neste dispositivo.
A lista de parâmetros de evento recomendados está disponível 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 | Analytics | |
eventName | "set_checkout_option" | |
eventParams | { checkout_step?: EventParams['checkout_step']; checkout_option?: EventParams['checkout_option']; [chave: string]: qualquer; } | |
options | AnalyticsCallOptions |
Retorna:
void
logEvent(analyticsInstance, eventName, eventParams, options)
Envia um evento do Google Analytics com eventParams
. Esse método associa automaticamente o evento registrado a essa instância do app da Web do Firebase neste dispositivo.
A lista de parâmetros de evento recomendados está disponível 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 | Analytics | |
eventName | "compartilhar" | |
eventParams | { method?: EventParams['method']; content_type? EventParams['content_type']; item_id? EventParams['item_id']; [chave: string]: qualquer; } | |
options | AnalyticsCallOptions |
Retorna:
void
logEvent(analyticsInstance, eventName, eventParams, options)
Envia um evento do Google Analytics com eventParams
. Esse método associa automaticamente o evento registrado a essa instância do app da Web do Firebase neste dispositivo.
A lista de parâmetros de evento recomendados está disponível 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 | Analytics | |
eventName | "sign_up" | |
eventParams | { method?: EventParams['method']; [chave: string]: qualquer; } | |
options | AnalyticsCallOptions |
Retorna:
void
logEvent(analyticsInstance, eventName, eventParams, options)
Envia um evento do Google Analytics com eventParams
. Esse método associa automaticamente o evento registrado a essa instância do app da Web do Firebase neste dispositivo.
A lista de parâmetros de evento recomendados está disponível 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 | Analytics | |
eventName | "timing_complete" | |
eventParams | { name: string; value: number; event_category?: string; event_label?: string; [chave: string]: qualquer; } | |
options | AnalyticsCallOptions |
Retorna:
void
logEvent(analyticsInstance, eventName, eventParams, options)
Envia um evento do Google Analytics com eventParams
. Esse método associa automaticamente o evento registrado a essa instância do app da Web do Firebase neste dispositivo.
A lista de parâmetros de evento recomendados está disponível 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 | Analytics | |
eventName | "add_shipping_info" | |
eventParams | { cupom?: EventParams['coupon']; moeda? EventParams['currency']; itens? EventParams['items']; frete_nível? EventParams['shipping_tier']; ?: EventParams['value']; [chave: string]: qualquer; } | |
options | AnalyticsCallOptions |
Retorna:
void
logEvent(analyticsInstance, eventName, eventParams, options)
Envia um evento do Google Analytics com eventParams
. Esse método associa automaticamente o evento registrado a essa instância do app da Web do Firebase neste dispositivo.
A lista de parâmetros de evento recomendados está disponível 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 | Analytics | |
eventName | "view_cart" | "view_item" | |
eventParams | { moeda?: EventParams['currency']; itens? EventParams['items']; ?: EventParams['value']; [chave: string]: qualquer; } | |
options | AnalyticsCallOptions |
Retorna:
void
logEvent(analyticsInstance, eventName, eventParams, options)
Envia um evento do Google Analytics com eventParams
. Esse método associa automaticamente o evento registrado a essa instância do app da Web do Firebase neste dispositivo.
A lista de parâmetros de evento recomendados está disponível 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 | Analytics | |
eventName | "view_item_list" | |
eventParams | { itens?: EventParams['items']; item_list_name? EventParams['item_list_name']; item_list_id? EventParams['item_list_id']; [chave: string]: qualquer; } | |
options | AnalyticsCallOptions |
Retorna:
void
logEvent(analyticsInstance, eventName, eventParams, options)
Envia um evento do Google Analytics com eventParams
. Esse método associa automaticamente o evento registrado a essa instância do app da Web do Firebase neste dispositivo.
A lista de parâmetros de evento recomendados está disponível 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 | Analytics | |
eventName | CustomEventName<T> | |
eventParams | { [chave: string]: qualquer; } | |
options | AnalyticsCallOptions |
Retorna:
void
logEvent(analyticsInstance, eventName, eventParams, options)
Envia um evento do Google Analytics com eventParams
. Esse método associa automaticamente o evento registrado a essa instância do app da Web do Firebase neste dispositivo.
A lista de parâmetros de evento recomendados está disponível 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 | Analytics | |
eventName | "add_to_cart" | "add_to_wishlist" | "remove_from_cart" | |
eventParams | { moeda?: EventParams['currency']; ?: EventParams['value']; itens? EventParams['items']; [chave: string]: qualquer; } | |
options | AnalyticsCallOptions |
Retorna:
void
logEvent(analyticsInstance, eventName, eventParams, options)
Envia um evento do Google Analytics com eventParams
. Esse método associa automaticamente o evento registrado a essa instância do app da Web do Firebase neste dispositivo.
A lista de parâmetros de evento recomendados está disponível 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 | Analytics | |
eventName | "begin_checkout" | |
eventParams | { moeda?: EventParams['currency']; cupom? EventParams['coupon']; ?: EventParams['value']; itens? EventParams['items']; [chave: string]: qualquer; } | |
options | AnalyticsCallOptions |
Retorna:
void
logEvent(analyticsInstance, eventName, eventParams, options)
Envia um evento do Google Analytics com eventParams
. Esse método associa automaticamente o evento registrado a essa instância do app da Web do Firebase neste dispositivo.
A lista de parâmetros de evento recomendados está disponível 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 | Analytics | |
eventName | "checkout_progress" | |
eventParams | { moeda?: EventParams['currency']; cupom? EventParams['coupon']; ?: EventParams['value']; itens? EventParams['items']; checkout_step?: EventParams['checkout_step']; checkout_option?: EventParams['checkout_option']; [chave: string]: qualquer; } | |
options | AnalyticsCallOptions |
Retorna:
void
logEvent(analyticsInstance, eventName, eventParams, options)
Envia um evento do Google Analytics com eventParams
. Esse método associa automaticamente o evento registrado a essa instância do app da Web do Firebase neste dispositivo.
Consulte Medir as 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
Parâmetro | Tipo | Descrição |
---|---|---|
analyticsInstance | Analytics | |
eventName | "exceção" | |
eventParams | { descrição?: EventParams['description']; fatal?: EventParams['fatal']; [chave: string]: qualquer; } | |
options | AnalyticsCallOptions |
Retorna:
void
logEvent(analyticsInstance, eventName, eventParams, options)
Envia um evento do Google Analytics com eventParams
. Esse método associa automaticamente o evento registrado a essa instância do app da Web do Firebase neste dispositivo.
A lista de parâmetros de evento recomendados está disponível 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 | Analytics | |
eventName | "generate_lead" | |
eventParams | { valor?: EventParams['value']; moeda? EventParams['currency']; [chave: string]: qualquer; } | |
options | AnalyticsCallOptions |
Retorna:
void
logEvent(analyticsInstance, eventName, eventParams, options)
Envia um evento do Google Analytics com eventParams
. Esse método associa automaticamente o evento registrado a essa instância do app da Web do Firebase neste dispositivo.
A lista de parâmetros de evento recomendados está disponível 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 | Analytics | |
eventName | "login" | |
eventParams | { method?: EventParams['method']; [chave: string]: qualquer; } | |
options | AnalyticsCallOptions |
Retorna:
void
logEvent(analyticsInstance, eventName, eventParams, options)
Envia um evento do Google Analytics com eventParams
. Esse método associa automaticamente o evento registrado a essa instância do app da Web do Firebase neste dispositivo.
Consulte 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 | Analytics | |
eventName | "page_view" | |
eventParams | { page_title?: string; page_location?: string; page_path?: string; [chave: string]: qualquer; } | |
options | AnalyticsCallOptions |
Retorna:
void
setAnalyticsCollectionEnabled(analyticsInstance, enabled)
Define se a coleta do Google Analytics está ativada para o app neste dispositivo. Define o window['ga-disable-analyticsId'] = true;
global
Assinatura:
export declare function setAnalyticsCollectionEnabled(analyticsInstance: Analytics, enabled: boolean): void;
Parâmetros
Parâmetro | Tipo | Descrição |
---|---|---|
analyticsInstance | Analytics | A instância Analytics. |
ativado | booleano | Se definida como verdadeira, ativa a coleta. Se definida como falsa, a desativa. |
Retorna:
void
setCurrentScreen(analyticsInstance, screenName, options)
Usar com
eventName
como "screen_view" e adicionareventParams
relevantes. Consulte Rastrear exibições de tela.
Use o comando config
da gtag para definir screen_name
.
Assinatura:
export declare function setCurrentScreen(analyticsInstance: Analytics, screenName: string, options?: AnalyticsCallOptions): void;
Parâmetros
Parâmetro | Tipo | Descrição |
---|---|---|
analyticsInstance | Analytics | A instância Analytics. |
screenName | string | Nome da tela a ser definido. |
options | AnalyticsCallOptions |
Retorna:
void
setUserId(analyticsInstance, id, options)
Use o comando config
da gtag 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 | Analytics | A instância Analytics. |
id | string | nulo | ID do usuário a ser definido. |
options | AnalyticsCallOptions |
Retorna:
void
setUserProperties(analyticsInstance, propriedades, opções)
Use o comando config
da gtag 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 | Analytics | |
do bucket | CustomParams | |
options | AnalyticsCallOptions |
Retorna:
void
função()
issupported();
Esse é um método estático público fornecido aos usuários que envolve quatro verificações diferentes:
- 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 o ambiente do navegador oferece suporte ao IndexedDB. 4. Verifique se o contexto atual do navegador é válido para usar
IndexedDB.open()
.
Assinatura:
export declare function isSupported(): Promise<boolean>;
Retorna:
Promise<boolean>
function(consentSettings, ...)
setConsent(consentSettings)
Define o estado de consentimento do usuário final aplicável para este app da Web em todas as referências da gtag depois 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 "concedidos".
Assinatura:
export declare function setConsent(consentSettings: ConsentSettings): void;
Parâmetros
Parâmetro | Tipo | Descrição |
---|---|---|
consentSettings | ConsentSettings (em inglês) | Mapeia o estado de consentimento do usuário final aplicável para gtag.js. |
Retorna:
void
function(customParams, ...)
setDefaultEventParameters(customParams)
Adiciona dados que serão definidos em todos os eventos registrados pelo SDK, incluindo os automáticos. Com o parâmetro "set" da gtag , os valores transmitidos persistem na página atual e são transmitidos para todos os eventos subsequentes.
Assinatura:
export declare function setDefaultEventParameters(customParams: CustomParams): void;
Parâmetros
Parâmetro | Tipo | Descrição |
---|---|---|
customParams | CustomParams | Todos os parâmetros personalizados que o usuário pode transmitir para a gtag.js. |
Retorna:
void
função(options, ...)
configurações(opções)
Configura o Firebase Analytics para usar nomes personalizados gtag
ou dataLayer
. Destina-se a ser usado se o script gtag.js
tiver sido instalado nesta página, independentemente do Firebase Analytics, e usar nomes não padrão para a função gtag
ou para dataLayer
. Precisa 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 |
---|---|---|
options | SettingsOptions (em inglês) | Nomes personalizados de gtag e dataLayer. |
Retorna:
void
ConsentStatusString
Se um tipo de consentimento específico foi dado 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 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;
StringNomedoEvento
Tipo para 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';