Интеграция SDK

SDK под iOS предоставляется в виде модулей с исходным кодом.

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

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

pod 'AppMetricaAnalytics', '~> 5.9.0'
У меня детское приложение

Если ваше приложение предназначено для детей, подключите модули без использования AppMetricaAdSupport:

pod 'AppMetricaCore', '~> 5.9.0'
pod 'AppMetricaCrashes', '~> 5.9.0'
pod 'AppMetricaWebKit', '~> 5.9.0'
Мне не нужен весь функционал

Если вам не нужен полный функционал AppMetrica SDK, подключите только необходимые модули:

pod 'AppMetricaCore', '~> 5.9.0' # Основной модуль для работы с AppMetrica SDK, обязателен для подключения
pod 'AppMetricaAdSupport', '~> 5.9.0' # Необходим для сбора идентификаторов, без него не будет собираться IDFA
pod 'AppMetricaCrashes', '~> 5.9.0' # Модуль для отлова крэшей и отправки ошибок
pod 'AppMetricaWebKit', '~> 5.9.0' # Модуль для настройки отправки событий из JS-кода в WebView

Интеграция через интерфейс Xcode

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

  1. В окне Xcode навигатора проектов (Project Navigator) выберите свой проект (если у вас используется Workspace). Затем в верхнем меню нажмите File и выберите Add Package Dependencies....

  2. Укажите URL репозитория https://github.com/appmetrica/appmetrica-sdk-ios.

  3. Оставьте только нужные модули (чтобы выключить модуль в Add to Target выберите значение None):

    • AppMetricaCore — обязательный основной модуль SDK. Должен быть подключен для работы с AppMetrica.
    • AppMetricaAdSupport — модуль используется для сбора идентификаторов, включая IDFA.
    • AppMetricaCrashes — модуль предназначен для отлова крэшей и отправки ошибок.
    • AppMetricaWebKit — модуль позволяет осуществлять отправку событий из JavaScript кода в WebView.

    Примечание

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

Интеграция через Package.swift манифест

Для начала добавьте следующую зависимость в массив dependencies: вашего пакета:

dependencies: [
   .package(
      url: "https://github.com/appmetrica/appmetrica-sdk-ios",
      from: "5.9.0"
   )
],

Модули AppMetrica SDK, которые вы можете подключить в зависимости от потребностей вашего проекта:

  • AppMetricaCore — обязательный основной модуль SDK. Должен быть подключен для работы с AppMetrica.
  • AppMetricaAdSupport — модуль используется для сбора идентификаторов, включая IDFA.
  • AppMetricaCrashes — модуль предназначен для отлова крэшей и отправки ошибок.
  • AppMetricaWebKit — модуль позволяет осуществлять отправку событий из JavaScript кода в WebView.

Примечание

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

Пример подключения модулей в массиве dependencies: таргета:

.target(
   name: "MyTargetName",
   dependencies: [
      .product(name: "AppMetricaCore", package: "AppMetrica"),
      .product(name: "AppMetricaCrashes", package: "AppMetrica"),
      .product(name: "AppMetricaWebKit", package: "AppMetrica"),
      // .product(name: "AppMetricaAdSupport", package: "AppMetrica"), // Этот модуль отлючен
   ]
),

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

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

import AppMetricaCore

Инициализируйте библиотеку в методе application(_:didFinishLaunchingWithOptions:) вашего UIApplicationDelegate:

func application(_ application: UIApplication, didFinishLaunchingWithOptions launchOptions: [UIApplication.LaunchOptionsKey : Any]? = nil) -> Bool {
    // Initializing the AppMetrica SDK.
    let configuration = AppMetricaConfiguration(apiKey: "API key")
    AppMetrica.activate(with: configuration!)
}

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

#import <AppMetricaCore/AppMetricaCore.h>

Инициализируйте библиотеку в методе application:didFinishLaunchingWithOptions: вашего UIApplicationDelegate:

- (BOOL)application:(UIApplication *)application didFinishLaunchingWithOptions:(NSDictionary *)launchOptions
{
    // Initializing the AppMetrica SDK.
    AMAAppMetricaConfiguration *configuration = [[AMAAppMetricaConfiguration alloc] initWithAPIKey:@"API key"];
    [AMAAppMetrica activateWithConfiguration:configuration];
    return YES;
}
Что такое API key?

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

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

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

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

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

    Примечание

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

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

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

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

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

Узнайте больше

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

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

Написать в службу поддержки
Предыдущая
AppMetrica Push SDK. Миграция на версию 2.0.0
Следующая
Примеры использования методов