Registrar eventos

Neste guia, vamos mostrar como registrar eventos no seu app.

Eventos apresentam insights sobre o que está acontecendo no app, como ações do usuário, eventos do sistema ou erros.

O Analytics registra automaticamente alguns eventos para você. Não é necessário adicionar códigos para recebê-los. Caso o aplicativo precise coletar outros dados, é possível registrar até 500 tipos diferentes de eventos do Analytics no app. Não há limite para o volume total de eventos registrados pelo app. Como os nomes de eventos diferenciam letras maiúsculas de minúsculas, registrar dois eventos com nomes que diferem apenas no uso de caixa baixa/alta resultará na criação de dois eventos distintos.

Antes de começar

Verifique se você configurou seu projeto e pode acessar o Analytics, como descrito em Primeiras etapas com o Analytics.

Registrar eventos

Depois de criar uma instância FirebaseAnalytics, use-a para registrar eventos com o método logEvent().

Para ajudar você a começar, o SDK do Analytics define vários eventos recomendados, comuns entre diferentes tipos de apps, como os de varejo, e-commerce, viagem e jogos. Para saber mais sobre esses eventos e quando usar cada um, consulte Eventos recomendados.

O detalhes de implementação dos tipos de eventos recomendados são encontrados nos seguintes locais:

Confira no exemplo a seguir como registrar um evento SELECT_CONTENT:

Kotlin+KTX 

firebaseAnalytics.logEvent(FirebaseAnalytics.Event.SELECT_ITEM) {
    param(FirebaseAnalytics.Param.ITEM_ID, id)
    param(FirebaseAnalytics.Param.ITEM_NAME, name)
    param(FirebaseAnalytics.Param.CONTENT_TYPE, "image")
}
MainActivity.kt

Java 

Bundle bundle = new Bundle();
bundle.putString(FirebaseAnalytics.Param.ITEM_ID, id);
bundle.putString(FirebaseAnalytics.Param.ITEM_NAME, name);
bundle.putString(FirebaseAnalytics.Param.CONTENT_TYPE, "image");
mFirebaseAnalytics.logEvent(FirebaseAnalytics.Event.SELECT_CONTENT, bundle);
MainActivity.java

Além dos prescritos, é possível adicionar os parâmetros a seguir a qualquer evento:

  • Parâmetros personalizados: podem ser usados como dimensões ou métricas em relatórios do Analytics. Use 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 apareçam nos relatórios do Analytics. Para isso, acesse Analytics > Eventos > Gerenciar definições personalizadas > Criar dimensões personalizadas.

    Os parâmetros personalizados podem ser usados em definições de segmentos que podem ser aplicadas a todos os relatórios. Eles também estão incluídos nos dados exportados ao BigQuery caso seu app seja vinculado a um projeto do BigQuery. Encontre exemplos de consultas e muito mais no Google Analytics 4 BigQuery Export.

  • Parâmetro VALUE: VALUE é um parâmetro de uso geral útil para coletar uma métrica principal pertencente a um evento. Exemplos incluem receita, distância, tempo e pontos.

Caso seu aplicativo tenha necessidades específicas não atendidas por um tipo de evento recomendado, registre seus próprios eventos personalizados, conforme mostrado neste exemplo:

Kotlin+KTX 

firebaseAnalytics.logEvent("share_image") {
    param("image_name", name)
    param("full_text", text)
}
MainActivity.kt

Java 

Bundle params = new Bundle();
params.putString("image_name", name);
params.putString("full_text", text);
mFirebaseAnalytics.logEvent("share_image", params);
MainActivity.java

Definir parâmetros padrão de eventos

É possível registrar parâmetros em eventos usando setDefaultEventParameters. Os parâmetros padrão são associados a todos os eventos futuros registrados.

Assim como nos parâmetros personalizados, registre os parâmetros padrão de eventos para garantir que eles apareçam nos relatórios do Analytics.

Kotlin+KTX 

val parameters = Bundle().apply {
    this.putString("level_name", "Caverns01")
    this.putInt("level_difficulty", 4)
}

firebaseAnalytics.setDefaultEventParameters(parameters)

Java 

Bundle parameters = new Bundle();
params.putString("level_name", "Caverns01");
params.putInt("level_difficulty", 4);
mFirebaseAnalytics.setDefaultEventParameters(parameters);

Se um parâmetro for especificado no método logEvent(), esse valor será usado no lugar do padrão.

Para limpar um parâmetro padrão, chame o método setDefaultEventParameters com o parâmetro definido como null.

Visualizar eventos no registro de depuração do Android Studio

É possível ativar o registro detalhado para conferir se o SDK está registrando adequadamente os eventos. Isso inclui os eventos registrados manual e automaticamente.

Ative o registro detalhado com uma série de comandos adb:

adb shell setprop log.tag.FA VERBOSE
adb shell setprop log.tag.FA-SVC VERBOSE
adb logcat -v time -s FA FA-SVC

Esse comando exibe seus eventos no logcat do Android Studio, permitindo a verificação imediata do envio dos eventos.

Conferir eventos no painel

Você pode encontrar estatísticas agregadas sobre os eventos nos painéis de controle do Console do Firebase. Eles são atualizados periodicamente ao longo do dia. Para fazer testes imediatos, use a saída do logcat conforme descrito na seção anterior.

Acesse esses dados no painel Eventos do Console do Firebase. Esse painel mostra os relatórios de eventos criados automaticamente para cada tipo diferente de evento registrado pelo seu app.