Как регистрировать события

События позволяют отслеживать действия пользователей, системные события и ошибки в приложении.

Analytics автоматически регистрирует некоторые события, поэтому вам не нужно добавлять код, чтобы получать данные о них. Если вам нужно собирать дополнительные данные, вы можете регистрировать в приложении до 500 различных Analyticsтипов событий. Общее количество регистрируемых событий не ограничено. Обратите внимание, что в названиях событий учитывается регистр. Два события, названия которых отличаются только регистром, считаются разными.

Подготовка

Убедитесь, что у вас настроен проект и есть доступ к Analytics, как описано в статье Начало работы с Analytics.

Если вы хотите собирать данные атрибуции в кампаниях, добавьте в проект фреймворк AdSupport.

Как регистрировать события

Настроив экземпляр FirebaseApp, вы можете начать регистрировать события с помощью метода logEvent().

Чтобы вам было проще начать работу, в SDK Analytics определен ряд рекомендуемых событий, которые часто используются в приложениях разных типов, в том числе в приложениях для розничной и электронной торговли, путешествий и мобильных играх. Подробнее об этих событиях и о том, когда их использовать, читайте в статье Рекомендуемые события.

Подробную информацию о реализации можно найти в справочнике по константам для Swift и Objective-C.

В примере ниже показано, как регистрировать рекомендуемое событие kFIRSelectContent:

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

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

Помимо предписанных параметров, вы можете добавить к любому событию следующие:

• Специальные параметры, которые могут использоваться в качестве параметров и показателей в отчетах Analytics. Вы можете использовать специальные параметры для нечисловых данных по параметрам событий, а специальные показатели – для данных по параметрам, которые удобнее представлять в числовом виде. После того как вы зарегистрируете специальный параметр с помощью SDK, чтобы он отображался в отчетах Аналитики, вам нужно зарегистрировать соответствующий ему параметр или показатель. Для этого в консоли Firebase выберите Analytics (Аналитика) > Custom Definitions (Специальные определения).

  Специальные параметры можно использовать в определениях аудиторий, которые можно применять к любому отчету. Если ваше приложение связано с проектом BigQuery, специальные параметры также включаются в данные, экспортируемые в BigQuery. Примеры запросов и другую информацию можно найти в статье BigQuery Export в Google Аналитике 4.

• Параметр общего назначения kFIRParameterValuekFIRParameterValue , удобный для сбора данных по ключевому показателю , относящемуся к событию. Примеры: доход, расстояние, время и баллы.

Если предлагаемые типы событий не подходят для вашего приложения, вы можете регистрировать собственные специальные события, как показано в примере ниже:

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

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

Как настроить параметры по умолчанию для событий

Вы можете регистрировать параметры различных событий с помощью setDefaultEventParameters. Параметры по умолчанию связаны со всеми событиями, которые будут регистрироваться в будущем.

Как и в случае со специальными параметрами, зарегистрируйте параметры событий по умолчанию, чтобы эти специальные параметры отображались в отчетах Аналитики.

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

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

Если в методе logEvent() указан параметр, вместо значения по умолчанию используется его значение.

Чтобы удалить значение параметра по умолчанию, вызовите метод setDefaultEventParameters, задав для параметра значение nil.

Как просматривать события в консоли отладки Xcode

Вы можете включить ведение подробных журналов, чтобы убедиться, что события правильно регистрируются с помощью SDK. Это относится к событиям, регистрируемым как автоматически, так и вручную.

Чтобы включить ведение подробных журналов:

1. В Xcode выберите Product (Продукт) > Scheme (Схема) > Edit scheme (Изменить схему).
2. В меню слева нажмите Run (Выполнить).
3. Перейдите на вкладку Arguments (Аргументы).
4. В разделе Arguments Passed On Launch (Аргументы, передаваемые при запуске) добавьте -FIRAnalyticsVerboseLoggingEnabled.

При следующем запуске приложения ваши события отобразятся в консоли отладки Xcode. Так вы сразу сможете проверить, отправляются ли события.

Как просматривать события на панели управления

В консоли Firebase можно посмотреть сводную статистику по событиям. Для этого перейдите в раздел Аналитика > События.

Обратите внимание на следующее:

• На ней отображаются отчеты, которые создаются автоматически для каждого типа событий, зарегистрированных вашим приложением.

• Она периодически обновляется в течение дня. Для оперативного тестирования используйте выходные данные консоли отладки Xcode, как описано в предыдущем разделе этого руководства.