Este guia mostra como registrar eventos em seu aplicativo.
O Analytics registra automaticamente alguns eventos para você; você não precisa adicionar nenhum código para recebê-los. Se seu aplicativo precisar coletar dados adicionais, você poderá registrar até 500 tipos diferentes de eventos do Analytics em seu aplicativo. Não há limite para o volume total de eventos registrados pelo seu aplicativo. Observe que os nomes dos eventos diferenciam maiúsculas de minúsculas e que registrar dois eventos cujos nomes diferem apenas em maiúsculas e minúsculas resultará em dois eventos distintos.
Antes de você começar
Certifique-se de ter configurado seu projeto e de poder acessar o Analytics conforme descrito em Primeiros passos com o Analytics .
Registrar eventos
Depois de criar uma instância FirebaseAnalytics , você poderá usá-la para registrar eventos com os métodos log da biblioteca.
Eventos predefinidos
Para ajudar você a começar, o SDK do Analytics define vários eventos recomendados que são comuns entre diferentes tipos de aplicativos, incluindo aplicativos de varejo e comércio eletrônico, viagens e jogos. Para saber mais sobre esses eventos e quando usá-los, consulte Eventos recomendados .
Você pode encontrar os métodos de log para os tipos de eventos recomendados na referência da API .
O exemplo a seguir demonstra como registrar um evento select_content :
await FirebaseAnalytics.instance.logSelectContent(
contentType: "image",
itemId: itemId,
);
Alternativamente, você pode registrar o mesmo evento usando logEvent() :
await FirebaseAnalytics.instance.logEvent(
name: "select_content",
parameters: {
"content_type": "image",
"item_id": itemId,
},
);
Isto pode ser útil se você quiser especificar parâmetros adicionais além dos parâmetros prescritos (obrigatórios). Você pode adicionar os seguintes parâmetros a qualquer evento:
Parâmetros personalizados: os parâmetros personalizados podem ser usados como dimensões ou métricas em relatórios do Google Analytics . Você pode usar dimensões personalizadas para dados de parâmetros de eventos não numéricos e métricas personalizadas para quaisquer dados de parâmetros melhor representados numericamente. Depois de registrar um parâmetro personalizado usando o SDK, registre a dimensão ou métrica para garantir que esses parâmetros personalizados apareçam nos relatórios do Analytics. Faça isso usando Analytics > Eventos > Gerenciar definições personalizadas > Criar dimensões personalizadas .
Parâmetros personalizados podem ser usados em definições de público que podem ser aplicadas a todos os relatórios. Os parâmetros personalizados também serão incluídos nos dados exportados para o BigQuery se o seu aplicativo estiver vinculado a um projeto do BigQuery. Encontre exemplos de consultas e muito mais no Google Analytics 4 BigQuery Export .
parâmetro
value: um parâmetro de propósito geral que é útil para acumular uma métrica chave que pertence a um evento. Os exemplos incluem receita, distância, tempo e pontos.Os nomes dos parâmetros podem ter até 40 caracteres e devem começar com um caractere alfabético e conter apenas caracteres alfanuméricos e sublinhados. Os tipos string e num são suportados. Os valores dos parâmetros de string podem ter até 100 caracteres. Os prefixos "firebase ", "google " e "ga_" são reservados e não devem ser usados para nomes de parâmetros.
Eventos personalizados
Se o seu aplicativo tiver necessidades específicas não cobertas por um tipo de evento recomendado, você poderá registrar seus próprios eventos personalizados, conforme mostrado neste exemplo:
await FirebaseAnalytics.instance.logEvent(
name: "share_image",
parameters: {
"image_name": name,
"full_text": text,
},
);
Definir parâmetros de evento padrão
Você pode registrar parâmetros em eventos usando setDefaultEventParameters() . Os parâmetros padrão estão associados a todos os eventos futuros registrados.
Assim como acontece com os parâmetros personalizados, registre os parâmetros de evento padrão para garantir que eles apareçam nos relatórios do Analytics.
Os valores de parâmetro válidos são String e num. Definir o valor de uma chave como null limpa esse parâmetro. Passar um valor nulo limpa todos os parâmetros.
// Not supported on web
await FirebaseAnalytics.instance
.setDefaultEventParameters({
version: '1.2.3'
});
Se um parâmetro for especificado no método logEvent() ou log -, esse valor será usado em vez do padrão.
Para limpar um parâmetro padrão, chame o método setDefaultEventParameters() com o parâmetro definido como null .
Ver eventos no painel
Você pode visualizar estatísticas agregadas sobre seus eventos nos painéis do Console do Firebase. Esses painéis são atualizados periodicamente ao longo do dia. Para testes imediatos, use a saída do logcat conforme descrito na seção anterior.
Você pode acessar esses dados no painel de eventos no console do Firebase. Este painel mostra os relatórios de eventos criados automaticamente para cada tipo distinto de evento registrado pelo seu aplicativo.