События в приложении

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

Правила

• Событие должно быть минимальным для своей активности.
• Событие должно описывать одну и только одну активность, то есть "Пользователь смотрит видео <N> минут

// [!code class:bad]
Событие: Пользователь нажал на три кнопки, перешел в каталог 
и оставил приложение в афк на 30 секунд

// [!code class:good]
Событие: Пользователь нажал на кнопку А
Событие: Пользователь перешел в каталог
Событие: Пользователь оставил приложение в афк на <N> секунд

Аналитика

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

Не все параметры возможно получить во время возникновения события, это нужно учитывать.

Параметры должны иметь прямое отношение к исследуемой активности.

In-App Messaging

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

Например, пользователь смотрел 5 минут видео и после завершения просмотра ему показывается попап про саммагонку.

Список событий

Далее представлена автоматически сгенерированная документация по событиям реализованным в приложении.

Формат будет со временем улучшаться.

TIP

Правила наследования значений в событиях:

• Если для Target не представлено name или properties, значит они берутся из In-App Messaging
• Если в In-App Messaging не представлено name или properties, значит они берутся из Parent события

В дальнейшем name и properties будут верно пропагироваться в свои Target

• HomeRefreshedEvent In-App Messaging
  

• WidgetEvent
  Событие взаимодействия с виджетом Доступные свойства: - `id: String` — Уникальный идентификатор виджета - `location: String` — Уникальный идентификатор места в приложении, где произошло событие

• WidgetSelectedEvent In-App MessagingGoogleApp Metrica
  Событие взаимодействия с виджетом. Происходит, когда юзер взаимодействует с соответствующим виджетом в приложении.

• WidgetSeenEvent In-App MessagingGoogleApp Metrica
  Событие взаимодействия с виджетом. Происходит, когда юзер взаимодействует с соответствующим виджетом в приложении.

• WidgetCancelledEvent In-App MessagingGoogleApp Metrica
  Событие взаимодействия с виджетом. Происходит, когда юзер закрывает виджет.

• PermissionStatusChangedEvent In-App Messaging
  

• CourseAddedToFavoritesEvent In-App Messaging
  

• ToggleFavoriteCourseEvent In-App Messaging
  

• ToggleFavoriteComboEvent In-App Messaging
  

• FirstFeedbackSentEvent In-App MessagingGoogleApp Metrica
  Пользователь отправил первое мнение к саммари

• FeedbackSentEvent In-App MessagingGoogleApp Metrica
  Пользователь отправил мнение к саммари

• CommentSentEvent In-App MessagingGoogleApp Metrica
  

• QuickActionNavigationEvent In-App Messaging
  

• InAppCallbackEvent
  

• RatingResultsReceivedEvent In-App Messaging
  Если у пользователя есть рейтинг за прошлую неделю

• IntentOpenEvent In-App Messaging
  Событие открытия интента

• HomePageRefreshedEvent In-App Messaging
  

• AppStartedEvent In-App Messaging
  Счетчик запусков приложения Используется для показа баннеров и рекламных материалов

• CourseProgressResettedEvent In-App Messaging
  Отслеживание сброса прогресса по курсу

• DiplomaSentEvent In-App Messaging
  Отслеживание успешной отправки сертификата по курсу

• ProxyDisconnected In-App Messaging
  Отслеживание отключение прокси-соединения Используется тестерами / разработчиками

• NavigationEvent In-App Messaging
  Навигация в приложении

• LocaleChangedEvent In-App Messaging
  

• NotificationPermissionStatusUpdatedEvent In-App Messaging
  

• HomeWidgetRemovedEvent In-App MessagingGoogleApp Metrica
  {@template home_widget_removed_event.class} [HomeWidgetRemovedEvent] is an event triggered when widget with given [id] was removed. {@endtemplate}

• HomeWidgetInstalledEvent In-App MessagingGoogleApp Metrica
  {@template home_widget_installed_event.class} [HomeWidgetInstalledEvent] is an event triggered when widget with given [id] was installed. {@endtemplate}

• ActiveOlympiadExistsEvent In-App Messaging
  Отслеживание доступности олимпиады Содержит id олимпиады и ее статус

• OlympiadClosedEvent In-App Messaging
  

• OlympiadTestCompletedEvent In-App MessagingGoogleApp Metrica
  Exam completed when client receives exam results.

• IconChangedEvent In-App MessagingGoogle
  Отслеживанение изменения иконки приложения

• UserPageRefreshBusEvent In-App Messaging
  Событие для обновления страницы пользователя сейчас используется для обновления списка достижений

• UserPageFollowersEvent
  Отслеживание подписки и отписки от пользователя

• UserPageFollowEvent In-App Messaging
  

• UserPageUnfollowEvent In-App Messaging
  

• BuyYearSubscriptionStartEvent In-App MessagingGoogleApp Metrica
  Occurs when buy year subscription flow started.

• SubscriptionPurchaseEvent In-App MessagingGoogleApp Metrica
  Occurs when subscription purchase successfully completed and money earned. Source can be `iap` or `site`: - `iap` for in app purchase - `site` for our own web purchase flow

• SelectBuySubscriptionEvent In-App MessagingGoogleApp Metrica
  Occurs when subscription button was clicked by user. Each button has unique `id`

• WebSubscriptionCancelledEvent In-App MessagingGoogleApp Metrica
  

• BuySubscriptionStartedEvent In-App MessagingGoogleApp Metrica
  Occurs when subscription flow started. Source can be `iap` or `site`: - `iap` for in app purchase - `site` for our own web purchase flow

• SkillPointReceivedEvent In-App Messaging
  Пользователь получил баллы в скиллы

• ExamClosedEvent In-App Messaging
  Завершение пользователем экзамена

• PromotionSeenEvent In-App Messaging
  Событие просмотра рекламной кампании. Происходит, когда юзер видит соответствующий виджет в приложении. Доступные свойства: - `promotion_id: String` — Уникальный идентификатор рекламной кампании - `promotion_name: String` — Название рекламной кампании - `location_id: String` — Уникальный идентификатор места в приложении, где произошло событие - `creative_slot: String` — Определенное место, где произошло событие - `creative_name: String` — Описание визуала, который вызвал событие

• PromotionEvent In-App Messaging
  Рекламное событие Доступные свойства: - `promotion_id: String` — Уникальный идентификатор рекламной кампании - `promotion_name: String` — Название рекламной кампании - `location_id: String` — Уникальный идентификатор места в приложении, где произошло событие - `creative_slot: String` — Определенное место, где произошло событие - `creative_name: String` — Описание визуала, который вызвал событие

• AnalyticsEvent In-App Messaging
  Динамическое рекламное событие. Доступные свойства могут быть любые.

• PromotionSelectedEvent In-App Messaging
  Событие взаимодействия с рекламной кампанией. Происходит, когда юзер взаимодействует с соответствующим виджетом в приложении. Доступные свойства: - `promotion_id: String` — Уникальный идентификатор рекламной кампании - `promotion_name: String` — Название рекламной кампании - `location_id: String` — Уникальный идентификатор места в приложении, где произошло событие - `creative_slot: String` — Определенное место, где произошло событие - `creative_name: String` — Описание визуала, который вызвал событие

• UserProfileBusEvent
  Отслеживание изменений профиля пользователя Включает в себя подписку / отписку / удаление из списка подписчиков

• UserProfileFollowEvent In-App Messaging
  

• UserProfileUnfollowEvent In-App Messaging
  

• UserProfileDeleteFollowersEvent In-App Messaging
  

• UserItemSwitchFollowBusEvent In-App Messaging
  Отслеживание отписки от пользователя

• RecommendationsUpdatedEvent In-App Messaging
  

• TestCompletedEvent In-App Messaging
  Отслеживание прохождения теста Тест считается пройденным, когда клиент получает данные от бэка

• ExamCompletedEvent In-App MessagingGoogleApp Metrica
  Отслеживание прохождения экзамена Экзамен считается пройденным, когда клиент получает данные от бэка

• OnboardingStartedEvent In-App MessagingGoogleApp Metrica
  Represents an event triggered when the onboarding process is started. This event is used to track the initiation of the onboarding flow and can be used for analytics and tracking user engagement.

• OnboardingSurveyChoiceSelectedEvent In-App MessagingApp Metrica
  

• OnboardingGoalSelectedEvent In-App MessagingApp Metrica
  

• OnboardingCompletedEvent In-App MessagingGoogleApp Metrica
  Событие завершения онбординга. Онбординг может быть завершен успешно и неуспешно. Успешным завершением онбординга считается переход пользователя к тиндеру или пейволлу. Неуспешным завершением онбординга считается выход пользователся из онбординга по крестику.

• OnboardingCancelledEvent In-App MessagingGoogleApp Metrica
  

• OnboardingBrainSizeSelectedEvent In-App MessagingApp Metrica
  

• ComboExamFinishedEvent In-App Messaging
  

• FormSentEvent In-App MessagingGoogle
  Отслеживание закрытия формы заявки через телеграм После успешного создания заявки

• VideoPlayerEngagementEvent In-App Messaging
  Событие происходит во время просмотра саммари, каждые **5 секунд**. Доступные свойства: - `media_item: String` — Название видео - `duration: int` — Общее время просмотра, в секундах - `is_last: bool` — Это последнее событие для текущего видео. Событие считается последним, если пользователь: закрывает плеер, переключается на следующее видео

• VideoPlayerEngagementCompletedEvent In-App Messaging
  Событие происходит после закрытия плеера. Отслеживает время просмотра в рамках одной сессии просмотра. Время просмотра сбрасывается при закрытии плеера. Доступные свойства: - `total_duration: int` — Общее время просмотра всех видео в рамках одной сессии, в секундах - `maximum_duration: int` — Максимальное время просмотра одного видео, в секундах - `today_duration: int` — Время просмотра на текущие сутки в рамках одной сессии просмотра, в секундах

• VideoPlayerSummaryWatchThresholdEvent In-App MessagingGoogleApp Metrica
  Event is triggered when watch progress becomes larger than some `threshold` value

• CoursePlayerEvent
  

• CoursePlayerStartedEvent In-App Messaging
  @nodoc

• CoursePlayerCompletedEvent In-App Messaging
  @nodoc

• CoursePlayerSwitchVideoEvent In-App Messaging
  @nodoc

• CoursePlayerClosedEvent In-App Messaging
  @nodoc

• QuizCardsOpenedEvent In-App MessagingGoogleApp Metrica
  

• QuizCardsCompletedEvent In-App Messaging
  Событие происходит после закрытия экрана с квиз-карточками

• QuizCardsFinishedEvent In-App MessagingGoogleApp Metrica
  

• QuizCardsActionEvent In-App MessagingGoogleApp Metrica
  

• SprintDayCompletedNotificationClosedEvent In-App Messaging
  

• UserInfoReceivedEvent In-App Messaging
  Отслеживание состояния пользователя

• RegisterEvent In-App MessagingApp Metrica
  Отслеживание регистрации пользователя

• AuthenticationEvent
  Отслеживание событий аутентификации Содержит вход и выход из аккаунта

• LoginEvent In-App MessagingGoogleApp Metrica
  Dispatched when user successfully authenticated

• LogoutEvent In-App Messaging
  Dispatched when user successfully logged out

• ProfileEditBusEvent In-App Messaging
  Отслеживание изменения данных профиля юзером

• ProfileRefreshBusEvent In-App Messaging
  should be removed: TODO(@melvspace): 06/20/24 remove this event. It can be replaced with refreshing in-place Будет удалено в дальнейшем

Авторы

melvspace

История

Последнее редактирование: 8 месяцев назад

Показать историю

2a0d74b-docs(events): rewrite events documentation

e82c36d-docs: add automated events documentation