Installation and initialization

The AppMetrica library consists of two frameworks: core and crash-handling. If you don't use AppMetrica crash handling, add only the core part of the library. This will reduce the size of the application.

The AppMetrica library supports the following platforms:

iOS
iOS Extension
iOS Watch version 1.x (beta)
tvOS

Step 1. Integrating the library

To connect the library, use the method for the appropriate platform:

The library can work with the following dependency managers:

The library supports static and dynamic frameworks for CocoaPods.

To connect the crash-handling framework, add the following dependency to your project's Podfile:

Static framework
```
pod 'YandexMobileMetrica', '3.8.1'
Copied to clipboard
```
Example of enabling a static framework on GitHub.

Dynamic framework

pod 'YandexMobileMetrica/Dynamic', '3.8.1'
Copied to clipboard

To enable the library without crash handling, use the YandexMobileMetrica/Static/Core or YandexMobileMetrica/Dynamic/Core dependency.

Note. If the Podfile has the line use_frameworks!, we recommend using the dynamic framework.

To enable the library, add the following dependency to the Cartfile and save the file:

binary "https://raw.githubusercontent.com/yandexmobile/metrica-sdk-ios/master/YandexMobileMetrica.json" ~> 3.8.1
Copied to clipboard

If you don't use these dependency managers

To enable the library, follow these steps:

Download the AppMetrica library.
Add YandexMobileMetrica.framework to the project.
(Optional) To enable crash handling, add YandexMobileMetricaCrashes.framework.
Add the following dependencies: 'SystemConfiguration', 'UIKit', 'Foundation', 'CoreTelephony', 'CoreLocation', 'CoreGraphics', 'AdSupport', 'z', 'sqlite3', 'Security', 'c++', 'SafariServices' (with the Optional setting).
Add -ObjC to Other Linker Flags.

The library supports static and dynamic frameworks for CocoaPods.

To connect the crash-handling framework, add the following dependency to your project's Podfile:

Static framework

pod 'YandexMobileMetrica/Static-TV', '3.8.1'
Copied to clipboard

Dynamic framework

pod 'YandexMobileMetrica/Dynamic-TV', '3.8.1'
Copied to clipboard

To enable the library without crash handling, use the YandexMobileMetrica/Static-TV/Core or YandexMobileMetrica/Dynamic-TV/Core dependency.

Note. If the Podfile has the line use_frameworks!, we recommend using the dynamic framework.

If you don't use CocoaPods

To enable the library, follow these steps:

Download the AppMetrica library.
Add YandexMobileMetrica.framework to the project from the tvos/static or tvos / dynamic directory.
(Optional) To enable crash handling, add YandexMobileMetricaCrashes.framework from the tvos/static or tvos/dynamic directory.
Add the following dependencies: 'SystemConfiguration', 'UIKit', 'Foundation', 'CoreTelephony', 'CoreLocation', 'CoreGraphics', 'AdSupport', 'z', 'sqlite3', 'Security', 'c++', 'SafariServices' (with the Optional setting).
Add -ObjC to Other Linker Flags.

Step 2. Initializing the library

To initialize the library, use the method for the appropriate platform:

Initialize the library in the application:didFinishLaunchingWithOptions: method of your UIApplicationDelegate:

- (BOOL)application:(UIApplication *)application didFinishLaunchingWithOptions:(NSDictionary *)launchOptions
{
    // Initializing the AppMetrica SDK.
    YMMYandexMetricaConfiguration *configuration = [[YMMYandexMetricaConfiguration alloc] initWithApiKey:API_key];
    [YMMYandexMetrica activateWithConfiguration:configuration];
}
Copied to clipboard

Initialize the library in the initialize method of the NSExtensionPrincipalClass extension:

+ (void)initialize 
{
    if ([self class] == [MMSTodayViewController class]) {
        // Initializing the AppMetrica SDK.
        YMMYandexMetricaConfiguration *configuration = [[YMMYandexMetricaConfiguration alloc] initWithApiKey:API_key];
        [YMMYandexMetrica activateWithConfiguration:configuration];
    }
}
Copied to clipboard

Initialize the library in the initialize method in Main Entry Point of the extension (there may be multiple activation points):

+ (void)initialize 
{
    if ([self class] == [MMSInterfaceController class]) { 
        // Initializing the AppMetrica SDK.
        YMMYandexMetricaConfiguration *configuration = [[YMMYandexMetricaConfiguration alloc] initWithApiKey:API_key];
        [YMMYandexMetrica activateWithConfiguration:configuration];
    }
}
Copied to clipboard

+ (void)initialize 
{ 
    if ([self class] == [MMSNotificationController class]) { 
        // Initializing the AppMetrica SDK.
        YMMYandexMetricaConfiguration *configuration = [[YMMYandexMetricaConfiguration alloc] initWithApiKey:API_key];
        [YMMYandexMetrica activateWithConfiguration:configuration];
    }
}
Copied to clipboard

What is the API key?

The API key is a unique application identifier that is issued in the AppMetrica web interface during app registration.

Make sure you have entered it correctly.

AppMetrica allows tracking pre-installed apps. For more information, see Tracking pre-installed apps.

Note. Requirements: deployment target 8.0 and higher.