Installation and initialization

Step 1. Download the plugin.

Step 2. Add the plugin to the project. Open the project in Unity Editor and import the plugin AppMetrica.unitypackage (Assets → Import Package → Custom Package).

Step 3. Open the Assets/AppMetrica folder and drag the prefab AppMetrica to the project's main stage.

If the plugin is integrated this way, the AppMetrica script on the added prefab automatically initializes the AppMetrica SDK and configures tracking of sessions and errors.

The added AppMetrica prefab is a singleton. It isn't deleted when switching to a new Unity stage, and it deletes other objects that the AppMetrica script is installed on.

In the Inspector panel, you can specify settings for the prefab added to the stage:

• API key — The unique application identifier that is issued in the AppMetrica web interface during app registration.
• Exceptions Reporting — Enable or disable sending errors.
• Session Timeout Sec — The timeout for ending the session if the app is inactive.
• Location Tracking — Enable or disable transmitting location data.
• Logs — Enable or disable logging the library's activity.
• Handle First Activation As Update — Enable or disable the ability to confirm that the first launch of an app with the AppMetrica Plugin is an app update, and not an install.
• StatisticsSending — Enable or disable sending statistics.

In the code, use AppMetrica.Instance for accessing AppMetrica.

Activating the plugin

void ActivateWithConfiguration(YandexAppMetricaConfig config);
event ConfigUpdateHandler OnActivation;
YandexAppMetricaConfig? ActivationConfig { get; }

Event tracking

void ReportEvent(string message);
void ReportEvent(string message, Dictionary<string, object> parameters);
void ReportError(string condition, string stackTrace);

Monitoring sessions

void ResumeSession();
void PauseSession();

AppMetrica settings

void SetLocationTracking(bool enabled);
void SetLocation(YandexAppMetricaConfig.Coordinates? coordinates);
void SetUserProfileID(string userProfileID);

Sending Revenue

void ReportRevenue(YandexAppMetricaRevenue revenue);

Sending user profiles

void ReportUserProfile(YandexAppMetricaUserProfile userProfile);

Disabling sending statistics

void SetStatisticsSending(bool enabled);

Force sending events from the buffer

void SendEventsBuffer();

Getting the AppMetrica ID

void RequestAppMetricaDeviceID(Action<string, YandexAppMetricaRequestDeviceIDError?> action);

Information about the version of AppMetrica used

int LibraryApiLevel { get; }
string LibraryVersion { get; }

YandexAppMetricaConfig class

YandexAppMetricaConfig(string apiKey);

string ApiKey { get; private set; }
string AppVersion { get; set; }
Coordinates? Location { get; set; }
int? SessionTimeout { get; set; }
bool? CrashReporting { get; set; }
bool? LocationTracking { get; set; }
bool? Logs { get; set; }
bool? InstalledAppCollecting { get; set; }
bool? HandleFirstActivationAsUpdate { get; set; }
YandexAppMetricaPreloadInfo? PreloadInfo { get; set; }
bool? StatisticsSending { get; set; }

YandexAppMetricaConfig.Coordinates class

double Latitude { get; set; }
double Longitude { get; set; }

YandexAppMetricaPreloadInfo class

YandexAppMetricaPreloadInfo(string trackingId);
            
tring TrackingId { get; private set; }
Dictionary<string, string> AdditionalInfo { get; private set; }

YandexAppMetricaRevenue class

YandexAppMetricaRevenue(double price, string currency);

double Price { get; private set; }
int? Quantity { get; set; }
string Currency { get; private set; }
string ProductID { get; set; }
YandexAppMetricaReceipt? Receipt { get; set; }
string Payload { get; set; }

YandexAppMetricaReceipt class

string Data { get; set; }
string Signature { get; set; }
string TransactionID { get; set; }

YandexAppMetricaUserProfile class

List<YandexAppMetricaUserProfileUpdate> GetUserProfileUpdates();
YandexAppMetricaUserProfile Apply(YandexAppMetricaUserProfileUpdate update);
YandexAppMetricaUserProfile ApplyFromArray(List<YandexAppMetricaUserProfileUpdate> updates);

YandexAppMetricaAttribute class

static YandexAppMetricaBirthDateAttribute BirthDate();
static YandexAppMetricaGenderAttribute Gender();
static YandexAppMetricaNameAttribute Name();
static YandexAppMetricaNotificationsEnabledAttribute NotificationsEnabled();
static YandexAppMetricaBooleanAttribute CustomBoolean(string key);
static YandexAppMetricaCounterAttribute CustomCounter(string key);
static YandexAppMetricaNumberAttribute CustomNumber(string key);
static YandexAppMetricaStringAttribute CustomString(string key);

YandexAppMetricaBirthDateAttribute class

YandexAppMetricaUserProfileUpdate WithAge(int age);
YandexAppMetricaUserProfileUpdate WithBirthDate(DateTime date);
YandexAppMetricaUserProfileUpdate WithBirthDate(int year);
YandexAppMetricaUserProfileUpdate WithBirthDate(int year, int month);
YandexAppMetricaUserProfileUpdate WithBirthDate(int year, int month, int day);
YandexAppMetricaUserProfileUpdate WithValueReset();

YandexAppMetricaBooleanAttribute class

YandexAppMetricaUserProfileUpdate WithValue(bool value);
YandexAppMetricaUserProfileUpdate WithValueIfUndefined(bool value);
YandexAppMetricaUserProfileUpdate WithValueReset();

YandexAppMetricaCounterAttribute class

YandexAppMetricaUserProfileUpdate WithDelta(double value);

YandexAppMetricaGenderAttribute class

YandexAppMetricaUserProfileUpdate WithValue(Gender value);
YandexAppMetricaUserProfileUpdate WithValueReset();

YandexAppMetricaNameAttribute class

YandexAppMetricaUserProfileUpdate WithValue(string value);
YandexAppMetricaUserProfileU