Подключение и инициализация

Внимание.

Развитие и поддержка плагина прекращены. Корректная работа SDK не гарантируется.

  1. Шаг 1. Подключите библиотеки плагина AppMetrica Xamarin
  2. Шаг 2. Инициализируйте библиотеку AppMetrica
  3. Шаг 3. (Android) Подключите библиотеку Play Install Referrer

AppMetrica Xamarin — плагин для платформы Xamarin. Он включает поддержку AppMetrica SDK для Android и iOS.

Ниже представлена общая схема использования плагина:

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

YandexMetricaPCL

Библиотека реализует интерфейс для работы с кросс-платформенными частями приложения. Библиотека содержит:

  • общий интерфейс AppMetrica — IYandexMetrica;
  • статический прокси-класс YandexMetrica для работы через данный интерфейс с реализацией под текущую платформу;
  • заглушку YandexMetricaDummy (реализующую интерфейс IYandexMetrica), используемую, если никакая реализация не произвела регистрацию в прокси-классе YandexMetrica.
YandexMetricaAndroid

Библиотека содержит AAR-файл библиотеки AppMetrica, сгенерированный код для работы с методами библиотеки и класс YandexMetricaImplementation, который реализует интерфейс IYandexMetrica.

YandexMetricaiOS

Библиотека содержит A-файлы библиотеки AppMetrica, сгенерированный код для работы с методами библиотеки и класс YandexMetricaImplementation, который реализует интерфейс IYandexMetrica.

Шаг 1. Подключите библиотеки плагина AppMetrica Xamarin

Загрузите и подключите библиотеки плагина одним из способов:

  • подключите проекты YandexMetrica.Xamarin.PCL, YandexMetrica.Xamarin.iOSBinding и YandexMetrica.Xamarin.AndroidBinding;
  • соберите и подключите библиотеки из проектов. После сборки библиотеки будут доступны в каталогах:
    • YandexMetrica.Xamarin.PCL/bin/(Debug|Release)/YandexMetrica.Xamarin.PCL.dll;
    • YandexMetrica.Xamarin.iOSBinding/bin/(Debug|Release)/YandexMetrica.Xamarin.iOS.dll;
    • YandexMetrica.Xamarin.AndroidBinding/bin/(Debug|Release)/YandexMetrica.Xamarin.Android.dll.

Шаг 2. Инициализируйте библиотеку AppMetrica

Инициализируйте библиотеку AppMetrica с помощью метода Activate() класса YandexMetricaImplementation. Данный метод также производит регистрацию реализации интерфейса IYandexMetrica.

public static void Activate(Context context, YandexMetricaConfig config, Application app = null) {...}
Параметр Значение по умолчанию Описание
config

Расширенная стартовая конфигурация. Для ее создания необходимо передать apiKey: YandexMetricaConfig(string apiKey)

app null

Позволяет включить/отключить автоматическое отслеживание жизненного цикла приложения. По умолчанию отслеживание отключено.

Если параметр принимает значение null, для корректного отображения сессий используйте методы OnPause() и OnResume() класса YandexMetricaImplementation в соответствующих частях проекта

Параметр Значение по умолчанию Описание
config

Расширенная стартовая конфигурация. Для ее создания необходимо передать apiKey: YandexMetricaConfig(string apiKey)

app null

Позволяет включить/отключить автоматическое отслеживание жизненного цикла приложения. По умолчанию отслеживание отключено.

Если параметр принимает значение null, для корректного отображения сессий используйте методы OnPause() и OnResume() класса YandexMetricaImplementation в соответствующих частях проекта

Что такое API key?

API key — это уникальный идентификатор приложения, который выдается в веб-интерфейсе AppMetrica при добавлении приложения.

Убедитесь, что он указан верно.

Примеры подключения

Ниже представлены примеры работы с демонстрационными проектами.

Подключается библиотека YandexMetricaPCL. Работа с AppMetrica производится через класс YandexMetrica.Implementation.

using System;
using YandexMetricaPCL;
using System.Collections.Generic;

namespace Metrica.Xamarin.CrossPlatform
{
    public class SharedLogic
    {
        public static void LogClick(int clickNumber)
        {
            var dict = new Dictionary<string, string>{ { "click", clickNumber.ToString() } };
            YandexMetrica.Implementation.ReportEvent("Click from shared logic", dict);
        }
    }
}
Скопировано

Шаг 3. (Android) Подключите библиотеку Play Install Referrer

Подключение библиотеки Play Install Referrer обязательно. Она используется для отслеживания источника установок.

  1. Скачайте последнюю версию библиотеки Play Install Referrer.
  2. Добавьте её в проект, например, в директорию lib.
  3. Установите для неё Build Action в AndroidAarLibrary.