Установка и настройка iOS SDK

SDK Adapty включает два ключевых модуля для бесшовной интеграции в ваше мобильное приложение:

• Core Adapty: Основной SDK, необходимый для работы Adapty в вашем приложении.
• AdaptyUI: Опциональный модуль, нужный если вы используете Adapty Paywall Builder — удобный no-code инструмент для создания кросс-платформенных пейволов.

Для полного пошагового руководства по реализации вы также можете посмотреть видео:

Требования

Хотя SDK технически поддерживает iOS 13.0+ для базового модуля, на практике требуется iOS 15.0+, поскольку:

• Все функции StoreKit 2 требуют iOS 15.0+
• Модуль AdaptyUI поддерживает только iOS 15.0+

Установка Adapty SDK

Adapty SDK устанавливается через Swift Package Manager. В Xcode перейдите в File -> Add Package Dependency…. Обратите внимание, что шаги по добавлению зависимостей могут отличаться в разных версиях Xcode — при необходимости обратитесь к документации Xcode.

1. Введите URL репозитория:

   https://github.com/adaptyteam/AdaptySDK-iOS.git

2. Выберите версию (рекомендуется последняя стабильная) и нажмите Add Package.
3. В окне Choose Package Products выберите нужные модули:
   • Adapty (основной модуль)
   • AdaptyUI (опционально — только если планируете использовать Paywall Builder)
   Примечание:

   • Чтобы включить режим Kids, выберите Adapty_KidsMode вместо Adapty.
   • Не выбирайте другие пакеты из списка — они вам не понадобятся.
4. Нажмите Add Package, чтобы завершить установку.
5. Проверьте установку: в навигаторе проекта вы должны увидеть «Adapty» (и «AdaptyUI», если он был выбран) в разделе Package Dependencies.

Активация модуля Adapty в SDK

Активируйте Adapty SDK в коде вашего приложения.

Чтобы получить Public SDK Key:

1. Откройте дашборд Adapty и перейдите в App settings → General.
2. В разделе Api keys скопируйте Public SDK Key (не Secret Key).
3. Замените "YOUR_PUBLIC_SDK_KEY" в коде на скопированный ключ.

@main
struct YourApp: App {
  init() {
    // Configure Adapty SDK
    let configurationBuilder = AdaptyConfiguration
      .builder(withAPIKey: "YOUR_PUBLIC_SDK_KEY") // Get from Adapty dashboard

   Adapty.logLevel = .verbose // recommended for development and the first production release

    let config = configurationBuilder.build()

    // Activate Adapty SDK asynchronously
    Task {
      do {
        try await Adapty.activate(with: config)
      } catch {
        // Handle error appropriately for your app
        print("Adapty activation failed: ", error)
      }
    }

    var body: some Scene {
      WindowGroup {
        // Your content view
      }
    }
  }
}

// In your AppDelegate class:
// If you only use an AppDelegate, place the following code in the
// application(_:didFinishLaunchingWithOptions:) method.

// If you use a SceneDelegate, place the following code in the
// scene(_:willConnectTo:options:) method.


Task {
  do {
    let configurationBuilder = AdaptyConfiguration
      .builder(withAPIKey: "YOUR_PUBLIC_SDK_KEY") // Get from Adapty dashboard
      .with(logLevel: .verbose) // recommended for development and the first production release

    let config = configurationBuilder.build()
    try await Adapty.activate(with: config)
  } catch {
    // Handle error appropriately for your app
    print("Adapty activation failed: ", error)
  }
}

Теперь настройте пейволы в приложении:

• Если вы используете Adapty Paywall Builder, сначала активируйте модуль AdaptyUI ниже, а затем следуйте быстрому старту Paywall Builder.
• Если вы создаёте собственный UI пейвола, см. быстрый старт для кастомных пейволов.

Активация модуля AdaptyUI в составе Adapty SDK

Если вы планируете использовать Paywall Builder и установили модуль AdaptyUI, его также необходимо активировать.

@main
struct YourApp: App {
  init() {
    // ...ConfigurationBuilder steps

    // Активация Adapty SDK асинхронно
    Task {
      do {
        try await Adapty.activate(with: config)
        try await AdaptyUI.activate()
      } catch {
        // Обработайте ошибку в соответствии с логикой вашего приложения
        print("Adapty activation failed: ", error)
      }
    }

    // основное тело...
  }
}

// Если вы используете только AppDelegate, разместите следующий код в методе
// application(_:didFinishLaunchingWithOptions:).

// Если вы используете SceneDelegate, разместите следующий код в методе
// scene(_:willConnectTo:options:).


Task {
   do {
      let configurationBuilder = AdaptyConfiguration
         .builder(withAPIKey: "YOUR_PUBLIC_SDK_KEY") // Получите из дашборда Adapty
         .with(logLevel: .verbose) // рекомендуется для разработки

   let config = configurationBuilder.build()
   try await Adapty.activate(with: config)
   try await AdaptyUI.activate()
      } catch {
      // Обработайте ошибку соответствующим образом
      print("Adapty activation failed: ", error)
   }
}

Дополнительная настройка

Логирование

Настройка системы логирования

Adapty записывает ошибки и другую важную информацию, чтобы помочь вам разобраться в происходящем. Доступны следующие уровни логирования:

 let configurationBuilder = AdaptyConfiguration
         .builder(withAPIKey: "YOUR_PUBLIC_SDK_KEY")
         .with(logLevel: .verbose) // recommended for development

Перенаправление сообщений системы логирования

Если вам нужно отправлять лог-сообщения Adapty в вашу систему или сохранять их в файл, используйте метод setLogHandler и реализуйте в нём собственную логику логирования. Этот обработчик получает записи логов, содержащие текст сообщения и уровень важности.

Adapty.setLogHandler { record in
    writeToLocalFile("Adapty \(record.level): \(record.message)")
}

Политика работы с данными

Adapty не хранит персональные данные ваших пользователей, если вы явно их не передаёте, но вы можете настроить дополнительные политики безопасности данных в соответствии с требованиями стора или законодательства конкретной страны.

Отключение сбора и передачи IDFA

При активации модуля Adapty установите idfaCollectionDisabled в значение true, чтобы отключить сбор и передачу IDFA. Используйте этот параметр для соблюдения требований App Store Review Guidelines или чтобы не вызывать запрос App Tracking Transparency, если IDFA не нужен вашему приложению. Значение по умолчанию — false. Подробнее о сборе IDFA см. в разделе Интеграция аналитики.

let configurationBuilder =
    AdaptyConfiguration
        .builder(withAPIKey: "YOUR_PUBLIC_SDK_KEY")
        .with(idfaCollectionDisabled: true)

Отключение сбора и передачи IP-адреса

При активации модуля Adapty установите ipAddressCollectionDisabled в значение true, чтобы отключить сбор и передачу IP-адресов пользователей. Значение по умолчанию — false.

Используйте этот параметр для защиты конфиденциальности пользователей, соблюдения региональных нормативов по защите данных (например, GDPR или CCPA) или сокращения лишнего сбора данных, если функции на основе IP-адресов не нужны вашему приложению.

let configurationBuilder =
    AdaptyConfiguration
        .builder(withAPIKey: "YOUR_PUBLIC_SDK_KEY")
        .with(ipAddressCollectionDisabled: true)

Конфигурация медиакеша для пейволов в AdaptyUI

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

// Configure AdaptyUI
        let adaptyUIConfiguration = AdaptyUI.Configuration(
            mediaCacheConfiguration: .init(
                memoryStorageTotalCostLimit: 100 * 1024 * 1024,
                memoryStorageCountLimit: .max,
                diskStorageSizeLimit: 100 * 1024 * 1024
            )
        )

        // Activate AdaptyUI
        AdaptyUI.activate(configuration: adaptyUIConfiguration)

Параметры:

Поведение завершения транзакций

По умолчанию Adapty автоматически завершает транзакции после успешной валидации. Однако если вам нужна расширенная валидация транзакций (например, серверная проверка чеков, обнаружение мошенничества или реализация собственной бизнес-логики), вы можете настроить SDK на ручное завершение транзакций.

let configurationBuilder = AdaptyConfiguration
    .builder(withAPIKey: "YOUR_PUBLIC_SDK_KEY")
    .with(transactionsFinishBehavior: .manual) // .auto is the default

Подробнее о завершении транзакций читайте в гайде.

Очистка данных при восстановлении из резервной копии

Если clearDataOnBackup установлен в true, SDK определяет, когда приложение восстанавливается из резервной копии iCloud, и удаляет все локально сохранённые данные SDK: кешированную информацию о профиле, сведения о продуктах и пейволах. После этого SDK инициализируется с чистого состояния. Значение по умолчанию — false.

let configurationBuilder = AdaptyConfiguration
    .builder(withAPIKey: "YOUR_PUBLIC_SDK_KEY")
    .with(clearDataOnBackup: true) // default – false

Устранение неполадок

Ошибка конкурентности Swift 6 при использовании Tuist

При сборке с Tuist могут возникать ошибки строгой проверки конкурентности Swift 6. Типичные симптомы — несоответствия атрибута @Sendable в AdaptyUIBuilderLogic или аналогичные ошибки Sendability между модулями. Это происходит потому, что Tuist генерирует Xcode-проекты из SPM-пакетов, но не сохраняет настройку swift-tools-version: 6.0. В результате некоторые таргеты Adapty (Adapty, AdaptyUI, AdaptyUIBuilder) компилируются по правилам Swift 5, тогда как другие используют Swift 6, что вызывает межмодульные несоответствия @Sendable.

Решение: обновитесь до Adapty SDK 3.15.5 или более поздней версии — это устраняет проблему независимо от смешанных версий Swift.

Обходной путь: если обновиться не получается, явно задайте Swift 6 для всех трёх таргетов Adapty в конфигурации Tuist:

targetSettings: [
  "Adapty": .init().swiftVersion("6"),
  "AdaptyUI": .init().swiftVersion("6"),
  "AdaptyUIBuilder": .init().swiftVersion("6"),
]