Руководство по миграции на версию 5.0.0

Если зависимости установлены через XcodeЕсли зависимости установлены через Xcode

1. Удалите зависимость metrika-sdk-ios.

   

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

   

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

   

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

   

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

Если используется Package.swift манифестЕсли используется Package.swift манифест

1. Удалите из файла Package.swift в вашем проекте зависимость .package с YandexMobileMetrica, а также все указания на зависимости в разделе targets: внутри вашего проекта.

2. Вставьте следующий код для добавления новой зависимости от appmetrica-sdk-ios:

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

3. Добавьте необходимые модули к таргетам вашего проекта.

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

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

Если зависимости установлены через XcodeЕсли зависимости установлены через Xcode

Откройте проект в Xcode. Убедитесь, что в Package Dependencies нет YandexMobileMetrica.

Если используется Package.swift манифестЕсли используется Package.swift манифест

Если ваш проект использует Package.swift манифест для управления зависимостями, выполните в терминале команду swift package show-dependencies в директории вашего проекта. Это выведет список всех зависимостей проекта, включая транзитивные.

.
└── yandex-ads-sdk-ios<https://github.com/yandexmobile/yandex-ads-sdk-ios.git@6.4.0>
  ├── metrica-sdk-ios<https://github.com/yandexmobile/metrica-sdk-ios@4.5.2>
  └── divkit-ios<https://github.com/divkit/divkit-ios@28.13.0>
      └── vgsl<https://github.com/yandex/vgsl.git@2.4.1>

Также можно проверить файл Package.resolved на наличие зависимости YandexMobileMetrica.

{
  "object": {
    "pins": [
      //...
      {
        "package": "YandexMobileMetrica",
        "repositoryURL": "https://github.com/yandexmobile/metrica-sdk-ios",
        "state": {
          "branch": null,
          "revision": "13d8b11181a33938ef42759d49466a621df5e7db",
          "version": "4.5.2"
        }
      },
      //...
    ]
  },
  // ...
}

#import <YandexMobileMetrica/YandexMobileMetrica.h>

Замените на:

#import <AppMetricaCore/AppMetricaCore.h>
#import <AppMetricaCrashes/AppMetricaCrashes.h> // при необходимости работы с ошибками/крэшами
#import <AppMetricaWebKit/AppMetricaWebKit.h> // при необходимости настроить отправку событий из WebView

Префикс YMM сменился на AMA.

• Интерфейс YMMYandexMetrica переименован в AMAAppMetrica.
  • Метод +handleOpenURL: переименован в +trackOpeningURL:.
  • Метод +initWebViewReporting:onFailure: переименован в +setupWebViewReporting:onFailure:, смотрите подробнее в Отправка события из JavaScript-кода WebView.
  • Метод +libraryVersion: удален, используйте свойство libraryVersion.
  • Метод +reportError:exception:onFailure: удален, смотрите инструкцию Работа с крэшами и ошибками
  • Метод +reportError:onFailure: перенесен в класс AppMetricaCrashes и в модуль AppMetricaCrashes, смотрите инструкцию Работа с крэшами и ошибками.
  • Метод +reportError:options:onFailure: перенесен в класс AppMetricaCrashes и в модуль AppMetricaCrashes, смотрите инструкцию Работа с крэшами и ошибками.
  • Метод +reportEvent:params:onFailure: переименован в +reportEvent:parameters:onFailure:
  • Метод +reportNSError:onFailure: перенесен в класс AppMetricaCrashes и в модуль AppMetricaCrashes, смотрите инструкцию Работа с крэшами и ошибками.
  • Метод +reportNSError:options:onFailure: перенесен в класс AppMetricaCrashes и в модуль AppMetricaCrashes, смотрите инструкцию Работа с крэшами и ошибками.
  • Метод +reportReferralUrl: удален.
  • Метод +reporterForApiKey: переименован в +reporterForAPIKey:.
  • Метод +requestAppMetricaDeviceIDWithCompletionQueue: удален, используйте +requestStartupIdentifiersWithKeys:completionQueue:completionBlock:.
  • Метод +setErrorEnvironmentValue:forKey: удален, используйте [[AMAAppMetricaCrashes crashes] setErrorEnvironmentValue:value forKey:key].
  • Метод +setLocation: удален, используйте свойство customLocation.
  • Метод +setLocationTracking: удален, используйте свойство locationTrackingEnabled.
  • Метод +setStatisticsSending: переименован в +setDataSendingEnabled:.
  • Метод +setUserProfileID: удален, используйте свойство userProfileID.
• Интерфейс YMMYandexMetricaConfiguration переименован в AMAAppMetricaConfiguration.
  • Конструктор -initWithApiKey: переименован в -initWithAPIKey:.
  • Свойство apiKey переименован в APIKey.
  • Свойство appForKids удалено, смотрите инструкцию Использование SDK для детских приложений.
  • Свойство crashReporting удалено, смотрите инструкцию Работа с крэшами и ошибками.
  • Свойство location переименовано в customLocation.
  • Свойство logs переименовано в logsEnabled.
  • Свойство statisticsSending переименовано в dataSendingEnabled.
• Интерфейс YMMYandexMetricaPreloadInfo переименован в AMAAppMetricaPreloadInfo.

Reporter

• Интерфейс YMMMutableReporterConfiguration переименован в AMAMutableReporterConfiguration.
  • Свойство logs переименовано в logsEnabled.
  • Свойство statisticsSending переименовано в dataSendingEnabled.
• Интерфейс YMMReporterConfiguration переименован в AMAReporterConfiguration.
  • Конструктор -initWithApiKey: переименован в -initWithAPIKey:.
  • Свойство apiKey переименовано в APIKey.
  • Свойство logs переименовано в logsEnabled.
  • Свойство statisticsSending переименовано в dataSendingEnabled.
• Протокол YMMYandexMetricaReporting переименован в AMAAppMetricaReporting.
  • Метод +reportError:onFailure: перенесен в класс AppMetricaCrashes и в модуль AppMetricaCrashes, смотрите инструкцию Работа с крэшами и ошибками.
  • Метод +reportError:options:onFailure: перенесен в класс AppMetricaCrashes и в модуль AppMetricaCrashes, смотрите инструкцию Работа с крэшами и ошибками.
  • Метод +reportEvent:params:onFailure: переименован в +reportEvent:parameters:onFailure:.
  • Метод +reportNSError:onFailure: перенесен в класс AppMetricaCrashes и в модуль AppMetricaCrashes, смотрите инструкцию Работа с крэшами и ошибками.
  • Метод +reportNSError:options:onFailure: перенесен в класс AppMetricaCrashes и в модуль AppMetricaCrashes, смотрите инструкцию Работа с крэшами и ошибками.
  • Метод +setStatisticsSending: переименован в +setDataSendingEnabled:.

Атрибуты пользователя

• Интерфейс YMMMutableUserProfile переименован в AMAMutableUserProfile.
• Интерфейс YMMProfileAttribute переименован в AMAProfileAttribute.
• Интерфейс YMMUserProfile переименован в AMAUserProfile.
• Перечисление YMMGenderType переименовано в AMAGenderType.
• Протокол YMMBirthDateAttribute переименован в AMABirthDateAttribute.
• Протокол YMMCustomBoolAttribute переименован в AMACustomBoolAttribute.
• Протокол YMMCustomCounterAttribute переименован в AMACustomCounterAttribute.
• Протокол YMMCustomNumberAttribute переименован в AMACustomNumberAttribute.
• Протокол YMMCustomStringAttribute переименован в AMACustomStringAttribute.
• Протокол YMMGenderAttribute переименован в AMAGenderAttribute.
• Протокол YMMNameAttribute переименован в AMANameAttribute.
• Протокол YMMNotificationsEnabledAttribute переименован в AMANotificationsEnabledAttribute.

Ошибки

• Интерфейс YMMError переименован в AMAError.
• Константа YMMBacktraceErrorKey переименована в AMABacktraceErrorKey.
• Перечисление YMMErrorReportingOptions переименовано в AMAErrorReportingOptions.
• Протокол YMMErrorRepresentable переименован в AMAErrorRepresentable.

AdRevenue

• Интерфейс YMMAdRevenueInfo переименован в AMAAdRevenueInfo.
• Интерфейс YMMMutableAdRevenueInfo переименован в AMAMutableAdRevenueInfo.
• Перечисление YMMAdType переименовано в AMAAdType.

ECommerce

• Интерфейс YMMECommerceAmount переименован в AMAECommerceAmount.
• Интерфейс YMMECommerceCartItem переименован в AMAECommerceCartItem.
• Интерфейс YMMECommerceOrder переименован в AMAECommerceOrder.
• Интерфейс YMMECommercePrice переименован в AMAECommercePrice.
• Интерфейс YMMECommerceProduct переименован в AMAECommerceProduct.
• Интерфейс YMMECommerceReferrer переименован в AMAECommerceReferrer.
• Интерфейс YMMECommerceScreen переименован в AMAECommerceScreen.
• Интерфейс YMMECommerce переименован в AMAECommerce.

Revenue

• Интерфейс YMMMutableRevenueInfo переименован в AMAMutableRevenueInfo.
• Интерфейс YMMRevenueInfo переименован в AMARevenueInfo.
  • Конструктор -initWithPrice:currency: удален, используйте -initWithPriceDecimal:currency:.
  • Конструктор -initWithPrice:currency:quantity:productID:transactionID:receiptData:payload: удален, используйте -initWithPriceDecimal:currency:quantity:productID:transactionID:receiptData:payload:.

Во все файлы, где используется API крэшей или ошибок, добавьте импорт:

#import <AppMetricaCrashes/AppMetricaCrashes.h>

Настройка стратегии отправки крэшей задается с помощью класса AMAAppMetricaCrashesConfiguration:

AMAAppMetricaCrashesConfiguration *configuration = [[AMAAppMetricaCrashesConfiguration alloc] init];
configuration.autoCrashTracking = YES; // Если этот параметр включен, крэши будут автоматически отправляться в AppMetrca
configuration.probablyUnhandledCrashReporting = YES; // Используйте этот параметр для включения или отключения отслеживания неявных сбоев, например, OOM крэшей
configuration.ignoredCrashSignals = @[]; // Эта настройка позволяет указать массив номеров UNIX-сигналов из sys/signal.h, которые будут проигнорированы системой отслеживания сбоев
configuration.applicationNotRespondingDetection = YES; // Эта настройка включает обнаружение ситуации, когда основной поток приложения перестает отвечать (ANR)
configuration.applicationNotRespondingWatchdogInterval = 4.0; // Устанавливает интервал времени, который будет ожидать watchdog, прежде чем сообщить о состоянии "Приложение не отвечает" (ANR)
configuration.applicationNotRespondingPingInterval = 0.1; // Устанавливает частоту, с которой watchdog будет проверять состояние "Приложение не отвечает" (ANR)
[[AMAAppMetricaCrashes crashes] setConfiguration:configuration];

Для отправки ошибок воспользуйтесь методами из класса AppMetricaCrashes. Их сигнатура совпадает с сигнатурами аналогичных методов из YMMYandexMetrica. Поэтому достаточно заменить YMMYandexMetrica на [AMAAppMetricaCrashes crashes].

[[AMAAppMetricaCrashes crashes] reportError:error onFailure:nil];
[[AMAAppMetricaCrashes crashes] reportError:error options:options onFailure:nil];
[[AMAAppMetricaCrashes crashes] reportNSError:error onFailure:nil];
[[AMAAppMetricaCrashes crashes] reportNSError:error options:options onFailure:nil];

В каждом файле, где используется настройка WebView, добавьте следующую строку:

#import <AppMetricaWebKit/AppMetricaWebKit.h>

Необходимо заменить экземпляр WKUserContentController на экземпляр обертки AMAJSController. Замените:

WKUserContentController *userController = [[WKUserContentController alloc] init];
[YMMYandexMetrica initWebViewReporting:userController onFailure:nil];

на

WKUserContentController *userController = [[WKUserContentController alloc] init];
[AMAAppMetrica setupWebViewReporting:[[AMAJSController alloc] initWithUserContentController:userController] onFailure:nil];

Если зависимости установлены через XcodeЕсли зависимости установлены через Xcode

Исключите AppMetricaAdSupport из Frameworks, Libraries, and Embedded Content для вашего таргета.

Если используется Package.swift манифестЕсли используется Package.swift манифест

Отключите модуль AppMetricaAdSupport:

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