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

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

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

Библиотека поддерживает статический и динамический фреймворки для CocoaPods. Для подключения библиотеки добавьте в Podfile проекта зависимость:

  • Статический фреймворк

    pod 'YandexMobileMetricaPush', '0.8.0'
    Скопировано
  • Динамический фреймворк

    pod 'YandexMobileMetricaPush/Dynamic', '0.8.0'
    Скопировано
Если вы не используете указанные системы управления зависимостями

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

  1. Добавьте YandexMobileMetricaPush.framework в проект.
Примечание. Библиотеки AppMetrica SDK и AppMetrica Push SDK должны быть подключены одним из этих способов.

Шаг 2. Зарегистрируйте приложение в Apple Push Notification Service (APNs)

Регистрация необходима для подготовки приложения к работе с push-уведомлениями. Для отправки уведомлений на устройства с iOS версии 7 и выше добавьте в код приложения следующие изменения:

// Register for push notifications
if #available(iOS 8.0, *) {
    if #available(iOS 10.0, *) {
        // iOS 10.0 and above.
        let center = UNUserNotificationCenter.current()
        center.requestAuthorization(options:[.badge, .alert, .sound]) { (granted, error) in
            // Enable or disable features based on authorization.
        }
    } else {
        // iOS 8 and iOS 9.
        let settings = UIUserNotificationSettings(types: [.badge, .alert, .sound], categories: nil)
        application.registerUserNotificationSettings(settings)
    }
    application.registerForRemoteNotifications()
} else {
    // iOS 7
    application.registerForRemoteNotifications(matching: [.badge, .alert, .sound])
}
Скопировано
Как правило, эти данные передаются в следующем методе
func application(_ application: UIApplication, didFinishLaunchingWithOptions
                 launchOptions: [UIApplicationLaunchOptionsKey :Any]? = nil) -> Bool

Для интеграции в iOS версии 10 и выше внесите следующие изменения в код:

import UserNotifications

// In the "func application(_ application: UIApplication, didFinishLaunchingWithOptions 
//                            launchOptions: [UIApplicationLaunchOptionsKey : Any]? = nil) -> Bool" method:
if #available(iOS 10.0, *) {
    let delegate = YMPYandexMetricaPush.userNotificationCenterDelegate()
    UNUserNotificationCenter.current().delegate = delegate
}
Скопировано

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

YMPYandexMetricaPush.userNotificationCenterDelegate().nextDelegate = yourDelegate
Скопировано

Подробно об используемых методах в документации на developer.apple.com:

Шаг 3. Зарегистрируйте device token вашего приложения

Для отправки push-уведомления с помощью AppMetrica необходим device token вашего приложения. Чтобы зарегистрировать его, добавьте следующий код в AppDelegate:

func application(_ application: UIApplication, didRegisterForRemoteNotificationsWithDeviceToken deviceToken: Data)
{
    // If the AppMetrica SDK library was not initialized before this step,
    // calling the method causes the app to crash.
    YMPYandexMetricaPush.setDeviceTokenFrom(deviceToken)
}
Скопировано

Чтобы зарегистрировать device token и отправить окружение APNs, используйте следующий код:

func application(_ application: UIApplication, didRegisterForRemoteNotificationsWithDeviceToken deviceToken: Data)
{
    // If the AppMetrica SDK library was not initialized before this step,
    // calling the method causes the app to crash.
    #if DEBUG
        let pushEnvironment = YMPYandexMetricaPushEnvironment.development
    #else
        let pushEnvironment = YMPYandexMetricaPushEnvironment.production
    #endif
    YMPYandexMetricaPush.setDeviceTokenFrom(deviceToken, pushEnvironment: pushEnvironment)
}
Скопировано
Внимание. AppMetrica позволяет отправлять push-уведомления в Sandbox APNs. Но обработка push-уведомлений может работать некорректно, если на устройстве запускались версии приложения с разным окружением (development и production). Чтобы избежать этого, можно использовать отдельный тестовый API key для development окружения.

Шаг 4. Настройте обработку открытия push-уведомления

Добавьте следующий код в соответствующие методы AppDelegate:

func application(_ application: UIApplication, didReceiveRemoteNotification userInfo: [AnyHashable : Any])
{
    self.handlePushNotification(userInfo)
}

func application(_ application: UIApplication, didReceiveRemoteNotification userInfo: [AnyHashable : Any], fetchCompletionHandler completionHandler: @escaping (UIBackgroundFetchResult) -> Void)
{
    self.handlePushNotification(userInfo)
    completionHandler(.newData)
}

func handlePushNotification(_ userInfo: [AnyHashable : Any])
{
    // Track received remote notification.
    // Method [YMMYandexMetrica activateWithApiKey:] should be called before using this method.
    YMPYandexMetricaPush.handleRemoteNotification(userInfo)
}
Скопировано

Шаг 5. (Опционально) Включите актуализацию push-токенов

Сервис APNS может отозвать push-токен устройства, например, если пользователь долго не запускал приложение. AppMetrica хранит push-токены на сервере и не может отправить push-уведомление на устройство с устаревшим токеном.

Чтобы автоматически собирать актуальные push-токены, перейдите в настройки приложения в веб-интерфейса AppMetrica и выберите опцию Актуализировать токены с помощью Silent Push-уведомлений во вкладке Push-уведомления.

Отправка дополнительной информации

При необходимости вы можете передавать вместе с push-уведомлением дополнительную информацию. Эти данные указываются в веб-интерфейсе AppMetrica при настройке push-кампании. Чтобы получать эту информацию, используйте метод:

let userData = YMPYandexMetricaPush.userData(forNotification: userInfo)
Скопировано

где userInfo содержит данные о push-уведомлении.

Определение получателя уведомления

AppMetrica позволяет определить "свои" push-уведомления, если в приложение были встроены несколько Push SDK.

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

let isRelatedToAppMetricaSDK = YMPYandexMetricaPush.isNotificationRelated(toSDK: userInfo)
Скопировано