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

AppMetrica Unity

AppMetrica Unity — это плагин для игровой платформы Unity3d, включающий поддержку AppMetrica SDK версии 2.0 и выше для платформ Android и iOS.

Внимание! В версии 2.0 файлы плагина перенесены в единую директорию Assets/AppMetrica. Для обновления плагина удалите из проекта директорию Assets/AppMetrica и файлы AppMetrica из директории Assets/Plugins/. Затем импортируйте плагин новой версии (обратите внимание на особенности настройки плагина).

Интеграция AppMetrica Unity плагина

Шаг 1. Загрузите плагин.

Шаг 2. Добавьте плагин в проект — откройте проект в Unity Editor, импортируйте плагин AppMetrica.unitypackage (AssetsImport PackageCustom Package).

Шаг 3. Откройте папку Assets/AppMetrica и перетащите префаб AppMetrica с помощью мыши на главную сцену проекта.

Если плагин интегрирован данным образом, скрипт AppMetrica на добавленном префабе автоматически инициализирует AppMetrica SDK, настроит отслеживание сессий и ошибок.

Добавленный префаб AppMetrica является синглтоном. Он не удаляется при переходе в новую сцену Unity и удаляет другие объекты, на которых будет установлен скрипт AppMetrica.

Настройка плагина

В панели Inspector, вы можете указать настройки добавленного на сцену префаба:

  • API key — уникальный идентификатор приложения, который выдается при добавлении приложения в веб-интерфейсе AppMetrica.
  • Exceptions Reporting — включить / отключить отправку ошибок.
  • Session Timeout Sec — тайм-аут, по истечению которого прекращается сессия, при условии отсутствия активности приложения.
  • Track Location — включить / отключить передачу данных о местоположении.
  • Logging Enabled — включить / отключить логирование работы библиотеки.
  • Handle First Activation As Update — включить / отключить возможность сообщать о том, что первый запуск приложения с AppMetrica Plugin это первый запуск обновленной версии приложения, а не его установка.
Примечание. В каталоге AppMetrica/ExampleUI находятся примеры использования AppMetrica в приложении.

Для запуска iOS-версии в Unity 4 необходимо скопировать файл Other/Unity.iOS.Extensions.Xcode.dll в каталог Assets/AppMetrica/Editor.

Если вы не хотите собирать данные о местоположении устройства, в интерфейсе Unity 3d (SettingsOther SettingsScripting Define Symbols) добавьте директиву APP_METRICA_TRACK_LOCATION_DISABLED.

В каталоге Assets/AppMetrica/Plugins/Android/ находится пример файла AndroidManifest.xml. Он содержит компоненты, необходимые для работы AppMetrica. По умолчанию, файл манифеста расположен в директории приложения: Editor/Data/PlaybackEngines/AndroidDevelopmentPlayer/AndroidManifest.xml.

Примечание. Если вы используете свой AndroidManifest.xml, внесите в него изменения, следуя инструкции.

Если вы не хотите собирать данные о местоположении устройства:

  1. Не добавляйте в AndroidManifest.xml разрешение android.permission.ACCESS_COARSE_LOCATION.
  2. В интерфейсе Unity 3d (SettingsOther SettingsScripting Define Symbols) добавьте директиву APP_METRICA_TRACK_LOCATION_DISABLED.

Методы API

В коде для обращения к AppMetrica используйте AppMetrica.Instance.

Активация плагина
void ActivateWithAPIKey (string apiKey);
void ActivateWithConfiguration (YandexAppMetricaConfig config);
event ConfigUpdateHandler OnActivation;
YandexAppMetricaConfig? ActivationConfig { get; }
Отслеживание событий
void ReportEvent(string message);
void ReportEvent(string message, Hashtable parameters);
void ReportError(string condition, string stackTrace);
Отслеживание сессий
void OnResumeApplication();
void OnPauseApplication();
Настройки AppMetrica
void SetTrackLocationEnabled(bool enabled);
void SetLocation(Coordinates coordinates);
void SetSessionTimeout(uint sessionTimeoutSeconds);
void SetReportCrashesEnabled(bool enabled);
void SetCustomAppVersion(string appVersion);
void SetLoggingEnabled();
void SetEnvironmentValue(string key, string value);

bool CollectInstalledApps { get; set; }
Информация об используемой версии AppMetrica
int LibraryApiLevel { get; }
string LibraryVersion { get; }

Подробно о методах и интеграции AppMetrica в приложение см. разделы документации для Android и iOS.