Документация
Интеграция SDK

Справочник методов и свойств

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

Внимание! Не передавайте личную или конфиденциальную информацию о пользователях в пользовательском событии.

Таблица 1. Методы статического класса Yandex.Metrica.YandexMetrica

НазначениеМетодОписание
Запуск процесса сбора статистики static void Activate(string apiKey)

Если в файле App.xaml описан ресурс metrica:YandexMetricaActivator статистика начнет собираться сразу после запуска приложения.

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

Запуск процесса сбора статистики static void Activate(Guid apiKey)

Если в файле App.xaml описан ресурс metrica:YandexMetricaActivator статистика начнет собираться сразу после запуска приложения.

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

Сохранение рабочего состояния AppMetrica

static void Snapshot() Данный метод предназначен для кэширования неотправленных событий в памяти устройства. В классических приложениях его вызывать не нужно, поскольку он вызывается автоматически в ответ на системные события жизненного цикла приложения, однако его нужно вызывать в фоновых задачах и из C++ кода перед завершением работы процесса, где системные уведомления недоступны
Установка местоположения вручную static void SetCustomLocation(YandexMetrica.Location location)

Используйте данный метод, если вы хотите передавать собственные данные о местоположении устройства. После вызова этого метода значение метода YandexMetrica.Config.LocationTracking игнорируется.

В качестве входных параметров передаются долгота (longitude) и широта (latitude)

Отправка необработанного исключения

static void ReportUnhandledException(Exception ex) Необходимо установить значение свойства YandexMetrica.Config.CrashTracking в false, чтобы избежать дублирования событий об исключениях
Отправка собственного события

static void ReportEvent(string eventName)

Отправляет произвольное сообщение о событии. Параметр eventName содержит краткое имя или описание события. Этот параметр может быть составным, части имени разделяются символом «/»
Отправка собственного события с дополнительной информацией в виде JSON строки

static void ReportEvent(string eventName, string jsonInfoString)

Отправляет произвольное сообщение о событии. Параметр eventName содержит краткое имя или описание события. Этот параметр может быть составным, части имени разделяются символом «/».

jsonInfoString — валидная JSON-строка с произвольным содержимым. Доступно 5 уровней вложенности JSON-объекта

Отправка собственного события с дополнительной информацией в виде словаря

static void ReportEvent(string eventName, IDictionary infoDictionary)

Отправляет произвольное сообщение о событии. Параметр eventName содержит краткое имя или описание события. Этот параметр может быть составным, части имени разделяются символом «/».

infoDictionary — произвольный словарь, который конвертируется в JSON-строку посредством системного класса DataContractJsonSerializer и отправляется на сервер. Доступно 5 уровней вложенности JSON-объекта

Отправка собственного события об открытии приложения с помощью deeplink

static void ReportLaunchUri(Uri uri)

Отправляет сообщение об открытии приложения с помощью deeplink. Параметр uri содержит deeplink

Отправка собственного события об ошибке

static void ReportError(string message, Exception ex)

Отправляет произвольное сообщение об ошибке и (или) обработанном исключении. Параметр message содержит краткое имя или описание ошибки. Параметр ex — обработанное исключение

Таблица 2. Методы статического класса Yandex.Metrica.YandexMetricaFolder

НазначениеМетодОписание

Установка текущей рабочей папки для служебных файлов AppMetrica

static void SetCurrent(string path)

Доступно только для ПК. Устанавливает папку, в которой будут размещаться служебные файлы AppMetrica. Приложение должно обладать необходимыми правами для чтения данной папки и записи в нее файлов. В противном случае библиотека будет работать некорректно

Таблица 3. Свойства статического класса Yandex.Metrica.YandexMetrica

ОперацияСвойствоОписание
Получение версии библиотеки Version Config.LibraryVersion { get; }

Позволяет определить версию библиотеки непосредственно из кода приложения

Задание/получение идентификатора приложения Version Config.CustomAppId { get; set; }

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

Задание/получение версии приложения Version Config.CustomAppVersion { get; set; }

По умолчанию используется версия приложения, указанная в файле AssemblyInfo.cs основной сборки приложения.

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

Задание длительности тайм-аута сессии TimeSpan Config.SessionTimeout { get; set; }

По умолчанию сессия заканчивается, если активность приложения отсутствует в течение 10 секунд. Минимально допустимое значение данного параметра составляет 10 секунд. При задании значения меньше 10, значение автоматически будет соответствовать 10 секундам

Отключение сетевых взаимодействий

static bool Config.OfflineMode { get; set; }

Библиотека прекращает отправку сообщений при выставлении значения true. По умолчанию установлено значение false (взаимодействие с сервером включено)
Включение/отключение отслеживания необработанных исключений bool Config.CrashTracking { get; set; }

По умолчанию библиотека отслеживает необработанные исключения.

Чтобы отключить отслеживание необработанных исключений, укажите значение false

Включение/отключение отслеживания местоположения устройства bool Config.LocationTracking { get; set; }

Признак отслеживания местоположения устройства задается в WMAppManifest с помощью ID_CAP_LOCATION.

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

По умолчанию отслеживание включено

Учет новых пользователей static bool Config.HandleFirstActivationAsUpdate { get; set; }

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