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

Библиотека AppMetrica состоит из двух фреймворков: один содержит основную функциональность SDK, другой — обработку крэшей. Если вы не используете обработку крэшей средствами AppMetrica, то подключение только основного фреймворка позволит уменьшить размер приложения.

AppMetrica SDK также поддерживает следующие платформы:

Шаг 1. Подключите библиотеку

Библиотека может работать со следующими системами управления зависимостями:

Библиотека поддерживает статический и динамический фреймворки для CocoaPods.

Примечание. Для подключения AppMetrica SDK начиная с 3.17.0 необходима версия CocoaPods 1.10 или выше.

Чтобы подключить библиотеку с обработкой крэшей, добавьте в Podfile проекта зависимость:

Статический фреймворк
```
pod 'YandexMobileMetrica', '4.5.2'
Скопировано
```
Пример подключения статического фреймворка на GitHub.

Динамический фреймворк

pod 'YandexMobileMetrica/Dynamic', '4.5.2'
Скопировано

Чтобы подключить библиотеку без обработки крэшей, используйте зависимость YandexMobileMetrica/Static/Core или YandexMobileMetrica/Dynamic/Core.

Примечание. Если в Podfile присутствует строка use_frameworks!, рекомендуем использовать динамический фреймворк.

Примечание. Для подключения AppMetrica SDK начиная с 3.17.0 необходима версия Carthage 0.38 или выше.

Чтобы подключить библиотеку, добавьте в Cartfile следующую зависимость и сохраните файл:

binary "https://raw.githubusercontent.com/yandexmobile/metrica-sdk-ios/master/YandexMobileMetrica.json" ~> 4.5.2
Скопировано

Чтобы подключить библиотеку, выполните следующее:

В Xcode, в своем проекте выберите вкладку Swift Packages.
Укажите URL репозитория https://github.com/yandexmobile/metrica-sdk-ios, в нем находится Swift-пакет.
Настройте правило для выбора версии пакета.

Ограничение.
Подключение с помощью Swift Package Manager поддерживается, начиная с версии 3.14.0 AppMetrica SDK.
Выберите необходимые библиотеки.

Если вы не используете указанные системы управления зависимостями

Для подключения библиотеки выполните следующее:

Загрузите библиотеку AppMetrica.
Добавьте YandexMobileMetrica.framework в проект.
(Опционально) Для подключения обработки крэшей добавьте YandexMobileMetricaCrashes.framework.
Добавьте следующие зависимости: 'SystemConfiguration', 'UIKit', 'Foundation', 'CoreTelephony', 'CoreLocation', 'CoreGraphics', 'AdSupport', 'z', 'sqlite3', 'Security', 'c++', 'WebKit', 'SafariServices' (с настройкой Optional).
Добавьте -ObjC в Other Linker Flags.

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

Добавьте импорт:

#import <YandexMobileMetrica/YandexMobileMetrica.h>

Инициализируйте библиотеку в методе initialize в Main Entry Point расширения (точек активации может быть несколько):

+ (void)initialize 
{
    if ([self class] == [MMSInterfaceController class]) { 
        // Initializing the AppMetrica SDK.
        YMMYandexMetricaConfiguration *configuration = [[YMMYandexMetricaConfiguration alloc] initWithApiKey:@"API_key"];
        [YMMYandexMetrica activateWithConfiguration:configuration];
    }
}
Скопировано

или

+ (void)initialize 
{ 
    if ([self class] == [MMSNotificationController class]) { 
        // Initializing the AppMetrica SDK.
        YMMYandexMetricaConfiguration *configuration = [[YMMYandexMetricaConfiguration alloc] initWithApiKey:@"API_key"];
        [YMMYandexMetrica activateWithConfiguration:configuration];
    }
}
Скопировано

Добавьте импорт:

import YandexMobileMetrica

Инициализируйте библиотеку в методе initialize в Main Entry Point расширения (точек активации может быть несколько):

override class func initialize() {
    if self === MMSInterfaceController.self {
        // Initializing the AppMetrica SDK.
        let configuration = YMMYandexMetricaConfiguration.init(apiKey: "API_key")
        YMMYandexMetrica.activate(with: configuration!)
    }
}
Скопировано

или

override class func initialize() {
    if self === MMSNotificationController.self {
        // Initializing the AppMetrica SDK.
        let configuration = YMMYandexMetricaConfiguration.init(apiKey: "API_key")
        YMMYandexMetrica.activate(with: configuration!)
    }
}
Скопировано

Что такое API key?

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

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

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

Примечание. Требования: deployment target 8.0 и выше.

Шаг 3. (Опционально) Настройте отправку событий, атрибутов профиля и Revenue

Чтобы собирать информацию о действиях в приложении, настройте отправку собственных событий. Подробнее в разделе Отправка собственных событий.

Чтобы собирать информацию о пользователях, настройте отправку атрибутов профиля. Подробнее в разделе Профили.

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

Чтобы отслеживать покупки в приложении, настройте отправку Revenue. Подробнее в разделе In-App покупки.

Шаг 4. Протестируйте работу библиотеки

Чтобы проверить работу библиотеки:

Запустите приложение с AppMetrica SDK и используйте его некоторое время.
Убедитесь, что устройство подключено к интернету.
В интерфейсе AppMetrica убедитесь, что:
- В отчете Аудитория появился новый пользователь.
- В отчете Вовлечённость → Сессии увеличилось число сессий.
- В отчете События и Профили появились отправленные события и атрибуты профиля.

Возможные проблемы и их решение

Не увеличивается число сессий

Проверьте настройки отслеживания сессий. Подробнее в разделе Отслеживание активности пользователей.

Нет событий

Совершите в приложении минимум 10 действий, которые инициируют отправку событий.
Это необходимо, потому что события накапливаются и отправляются на сервер по несколько штук.
Подождите 10 минут и проверьте отчет. События отображаются в отчете не сразу.

Проблемы со Swift Package Manager

Ознакомьтесь со статьей Проблемы при использовании Swift Package Manager.

В списке нет моей проблемы

Если в списке нет вашей проблемы, обратитесь в службу поддержки. В обращении укажите:

Пример интеграции SDK в вашем приложении.
ID приложения в веб-интерфейсе AppMetrica.
ID устройства.
Как получить Apple IDFA
Установите приложение AppMetrica на тестовое устройство.

Авторизуйтесь и выберите из списка ваше приложение в AppMetrica.

В левом верхнем углу нажмите → Устройство.

Apple IDFA указан в поле IDFA. Укажите его в веб-интерфейсе AppMetrica.

Примечание. Тестирование атрибуции можно включить в приложении AppMetrica. Для этого включите Тест атрибуции.
Производителя и модель устройства, платформу и версию ОС, версию AppMetrica SDK.

Если вы не нашли ответ на свой вопрос, то вы можете задать его через форму обратной связи. Пожалуйста, опишите возникшую проблему как можно подробнее. Если возможно, приложите скриншот.