Класс YandexMetrica

yandex.metrica

public  class  YandexMetrica

Методы класса используются для настройки работы библиотеки.

Вложенные классы

Методы

voidActivate(string apiKey)

Инициализирует библиотеку в приложении с указанным API key.

voidActivate(Guid apiKey)

Инициализирует библиотеку в приложении с указанным API key.

YandexMetrica.YandexMetricaConfigConfig

Метод для доступа к вложенному классу YandexMetrica.YandexMetricaConfig.

voidReportError(string message, Exception )

Отправляет сообщение об ошибке.

voidReportEvent(string eventName)

Отправляет сообщение о событии.

voidReportEvent(string eventName, string jsonData)

Отправляет сообщение о событии в формате JSON в виде строки.

voidReportEvent<TItem>(string eventName, TItem serializableItem)

Отправляет сообщение о событии c дополнительными параметрами.

voidReportLaunchUri(Uri uri)

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

voidReportUnhandledException(Exception exception)

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

voidSnapshot()

Кэширует неотправленные события в памяти устройства.

Описание методов

Activate

public static void Activate(string apiKey)

Инициализирует библиотеку в приложении с указанным API key.

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

Если библиотека инициализируется в файле App.xaml, то инициализировать библиотеку из кода не нужно.

Параметры:
apiKey

API key приложения.

Activate

public static void Activate(Guid apiKey)

Инициализирует библиотеку в приложении с указанным API key.

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

Если библиотека инициализируется в файле App.xaml, то инициализировать библиотеку из кода не нужно.

Параметры:
apiKey

API key приложения.

Config

public static readonly YandexMetrica.YandexMetricaConfig Config

Метод для доступа к вложенному классу YandexMetrica.YandexMetricaConfig.

Возвращает:

Объект класса YandexMetrica.YandexMetricaConfig.

ReportError

public static void ReportError(string message, Exception exception)

Отправляет сообщение об ошибке.

Параметры:
message

Короткое название или описание ошибки.

exception

Объект системного класса Exception.

ReportEvent

public static void ReportEvent(string eventName)

Отправляет сообщение о событии.

Параметры:
eventName

Короткое название или описание события.

ReportEvent

public static void ReportEvent(string eventName, string jsonData)

Отправляет сообщение о событии в формате JSON в виде строки.

Параметры:
eventName

Короткое название или описание события.

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

ReportEvent

public static void ReportEvent<TItem>(string eventName, TItem serializableItem)

Отправляет сообщение о событии c дополнительными параметрами.

Параметры:
eventName

Короткое название или описание события.

serializableItemЗначение события. Он конвертируется в JSON-строку посредством системного класса DataContractJsonSerializer.

ReportLaunchUri

public static void ReportLaunchUri(Uri uri)

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

Параметры:
uriОбъект системного класса Uri, который содержит deeplink.

ReportUnhandledException

public static void ReportUnhandledException(Exception exception)

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

Чтобы избежать дублирования событий об исключениях, необходимо установить значение false для свойства YandexMetrica.Config.CrashTracking.

Параметры:
exception

Объект системного класса Exception.

Snapshot

public static void Snapshot()

Кэширует неотправленные события в памяти устройства.

Метод необходимо вызывать перед завершением работы в приложениях на C++ и в фоновых задачах.

Максимальный объем хранимых локально данных составляет 2 МБ.