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

Após configurar a instância do FirebaseApp será possível 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.

Encontre detalhes de implementação na referência de constantes para Swift e Objective-C.

Confira no exemplo a seguir como registrar um evento kFIRSelectContent recomendado

Swift

Analytics.logEvent(AnalyticsEventSelectContent, parameters: [
  AnalyticsParameterItemID: "id-\(title!)",
  AnalyticsParameterItemName: title!,
  AnalyticsParameterContentType: "cont",
])ViewController.swift

Objective-C

[FIRAnalytics logEventWithName:kFIREventSelectContent
                    parameters:@{
                                 kFIRParameterItemID:[NSString stringWithFormat:@"id-%@", self.title],
                                 kFIRParameterItemName:self.title,
                                 kFIRParameterContentType:@"image"
                                 }];ViewController.m

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 kFIRParameterValue: kFIRParameterValue é 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:

Swift

Analytics.logEvent("share_image", parameters: [
  "name": name as NSObject,
  "full_text": text as NSObject,
])PatternTabBarController.swift

Objective-C

[FIRAnalytics logEventWithName:@"share_image"
                    parameters:@{
                                 @"name": name,
                                 @"full_text": text
                                 }];PatternTabBarController.m

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.

Registre os parâmetros de eventos padrão para garantir que os parâmetros personalizados sejam exibidos nos relatórios do Analytics.

Swift

Analytics.setDefaultEventParameters([
  "level_name": "Caverns01",
  "level_difficulty": 4
])

Objective-C

[FIRAnalytics setDefaultEventParameters:
  @{
  @"level_name": "Caverns01",
  @"level_difficulty": @(4)
}];

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 nil.

Confira eventos no console de depuração do Xcode

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

Você pode ativar o registro detalhado da seguinte forma:

No Xcode, selecione Product > Scheme > Edit scheme...
Selecione Run no menu à esquerda.
Selecione a guia Arguments.
Na seção Arguments Passed On Launch, adicione -FIRAnalyticsVerboseLoggingEnabled.

Na próxima vez que você executar seu app, os eventos serão exibidos no console de depuração do Xcode, o que ajuda a verificar imediatamente se os eventos estão sendo enviados.

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.