Журнал событий


В этом руководстве показано, как регистрировать события в вашем приложении.

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

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

Прежде чем начать

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

Журнал событий

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

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

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

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

Быстрый 

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

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

  • Пользовательские параметры: пользовательские параметры можно использовать в качестве измерений или метрик в отчётах Analytics . Вы можете использовать пользовательские измерения для нечисловых данных параметров событий, а пользовательские метрики — для любых данных параметров, которые лучше представить в числовом виде. После регистрации пользовательского параметра с помощью SDK зарегистрируйте измерение или метрику, чтобы эти пользовательские параметры отображались в отчётах Analytics. Для этого выберите: Аналитика > События > Управление пользовательскими определениями > Создать пользовательские измерения.

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

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

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

Быстрый 

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

Установить параметры события по умолчанию

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

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

Быстрый 

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

Objective-C 

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

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

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

Просмотр событий в консоли отладки Xcode

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

Подробное ведение журнала можно включить следующим образом:

  1. В Xcode выберите Продукт > Схема > Редактировать схему...
  2. Выберите пункт Выполнить в левом меню.
  3. Выберите вкладку «Аргументы» .
  4. В разделе «Аргументы, передаваемые при запуске» добавьте -FIRAnalyticsVerboseLoggingEnabled .

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

Просмотр событий на панели управления

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

Доступ к этим данным можно получить на панели «События» в консоли Firebase . Эта панель отображает отчёты о событиях, которые автоматически создаются для каждого типа событий, регистрируемых вашим приложением.