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

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

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

Хотите увидеть реальный пример интеграции Adapty SDK в мобильное приложение? Посмотрите наше демо-приложение, которое демонстрирует полную настройку: отображение пейволов, совершение покупок и другую базовую функциональность.

Требования

Adapty SDK поддерживает iOS 13.0+, однако для работы с пейволами, созданными в Paywall Builder, требуется iOS 15.0+.

Adapty совместима с Google Play Billing Library версий до 8.x включительно. По умолчанию Adapty использует Google Play Billing Library v7.0.0. Чтобы использовать более новую версию, переопределите зависимость Billing в вашей Android-сборке.

Установка SDK — это шаг 5 настройки Adapty. Прежде чем покупки заработают в вашем приложении, вам также нужно подключить приложение к сторам, а затем создать продукты, пейвол и плейсмент в дашборде Adapty. Гайд по быстрому старту описывает все необходимые шаги.

Установка Adapty SDK

Release

  1. Скачайте adapty-unity-plugin-*.unitypackage с GitHub и импортируйте его в свой проект.
456bd98-adapty-unity-plugin.webp
  1. Скачайте и импортируйте плагин External Dependency Manager.

  2. SDK использует плагин External Dependency Manager для управления зависимостями iOS Cocoapods и Android Gradle. После установки может потребоваться вручную вызвать менеджер зависимостей:

    Assets -> External Dependency Manager -> Android Resolver -> Force Resolve

    и

    Assets -> External Dependency Manager -> iOS Resolver -> Install Cocoapods

  3. При сборке Unity-проекта под iOS вы получите файл Unity-iPhone.xcworkspace, который нужно открывать вместо Unity-iPhone.xcodeproj — иначе зависимости Cocoapods не будут использованы.

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

Активируйте 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" в коде на скопированный ключ.
  • Используйте Public SDK key для инициализации Adapty. Secret key предназначен только для серверного API.
  • SDK keys уникальны для каждого приложения, поэтому при наличии нескольких приложений убедитесь, что выбрали правильный ключ.
using UnityEngine;
using AdaptySDK;

public class AdaptyListener : MonoBehaviour, AdaptyEventListener {
    void Start() {
        DontDestroyOnLoad(this.gameObject);
        Adapty.SetEventListener(this);

        var builder = new AdaptyConfiguration.Builder("YOUR_PUBLIC_SDK_KEY");

        Adapty.Activate(builder.Build(), (error) => {
            if (error != null) {
                // handle the error
                return;
            }
        });
    }

    public void OnLoadLatestProfile(AdaptyProfile profile) { }
    public void OnInstallationDetailsSuccess(AdaptyInstallationDetails details) { }
    public void OnInstallationDetailsFail(AdaptyError error) { }
}

Настройка прослушивания событий

Создайте скрипт для прослушивания событий Adapty и назовите его AdaptyListener в вашей сцене. Рекомендуем использовать метод DontDestroyOnLoad для этого объекта, чтобы он сохранялся на протяжении всего жизненного цикла приложения.

2ccd564-create_adapty_listener.webp

Adapty использует пространство имён AdaptySDK. В начало файлов скриптов, работающих с Adapty SDK, можно добавить:

using AdaptySDK;

Подпишитесь на события Adapty:

using UnityEngine;
using AdaptySDK;

public class AdaptyListener : MonoBehaviour, AdaptyEventListener {
    public void OnLoadLatestProfile(AdaptyProfile profile) {
        // handle updated profile data
    }

    public void OnInstallationDetailsSuccess(AdaptyInstallationDetails details) { }
    public void OnInstallationDetailsFail(AdaptyError error) { }
}

Рекомендуем настроить порядок выполнения скриптов (Script Execution Order), поставив AdaptyListener перед Default Time. Это гарантирует, что Adapty инициализируется как можно раньше.

activate_unity.webp

Добавление Kotlin Plugin в проект

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

  1. В Player Settings убедитесь, что выбраны опции Custom Launcher Gradle Template и Custom Base Gradle Template.

    kotlin-plugin1.webp
  2. Добавьте следующую строку в /Assets/Plugins/Android/launcherTemplate.gradle:

    apply plugin: 'com.android.application'
    apply plugin: 'kotlin-android'
    apply from: 'setupSymbols.gradle'
    apply from: '../shared/keepUnitySymbols.gradle'
  3. Добавьте следующую строку в /Assets/Plugins/Android/baseProjectTemplate.gradle:

    plugins {
        // If you are changing the Android Gradle Plugin version, make sure it is compatible with the Gradle version preinstalled with Unity
        // See which Gradle version is preinstalled with Unity here https://docs.unity3d.com/Manual/android-gradle-overview.html
        // See official Gradle and Android Gradle Plugin compatibility table here https://developer.android.com/studio/releases/gradle-plugin#updating-gradle
        // To specify a custom Gradle version in Unity, go do "Preferences > External Tools", uncheck "Gradle Installed with Unity (recommended)" and specify a path to a custom Gradle version
        id 'com.android.application' version '8.3.0' apply false
        id 'com.android.library' version '8.3.0' apply false
        id 'org.jetbrains.kotlin.android' version '1.8.0' apply false
        **BUILD_SCRIPT_DEPS**
    }

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

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

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

var builder = new AdaptyConfiguration.Builder("YOUR_PUBLIC_SDK_KEY")
    .SetActivateUI(true);

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

Логирование

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

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

УровеньОписание
errorЗаписываются только ошибки
warnЗаписываются ошибки и сообщения SDK, которые не вызывают критических ошибок, но заслуживают внимания
infoЗаписываются ошибки, предупреждения и различные информационные сообщения
verboseЗаписывается любая дополнительная информация, которая может быть полезна при отладке: вызовы функций, API-запросы и т.д.

Уровень логирования можно задать при конфигурации Adapty в вашем приложении:

// 'verbose' is recommended for development and the first production release
var builder = new AdaptyConfiguration.Builder("YOUR_PUBLIC_SDK_KEY");
builder.LogLevel = AdaptyLogLevel.Verbose;

Также можно изменить уровень логирования во время выполнения:

Adapty.SetLogLevel(AdaptyLogLevel.Verbose, (error) => {
    // handle result
});

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

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

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

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

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

var builder = new AdaptyConfiguration.Builder("YOUR_PUBLIC_SDK_KEY")
    .SetIPAddressCollectionDisabled(true);

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

При активации модуля Adapty установите SetAppleIDFACollectionDisabled и/или SetGoogleAdvertisingIdCollectionDisabled в true, чтобы отключить сбор рекламных идентификаторов. Значение по умолчанию — false.

Используйте этот параметр для соответствия политикам App Store/Google Play, чтобы не вызывать запрос App Tracking Transparency, или если вашему приложению не нужна рекламная атрибуция или аналитика на основе рекламных идентификаторов.

var builder = new AdaptyConfiguration.Builder("YOUR_PUBLIC_SDK_KEY")
    .SetAppleIDFACollectionDisabled(true)
    .SetGoogleAdvertisingIdCollectionDisabled(true);

Настройка конфигурации медиакэша для AdaptyUI

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

Используйте SetAdaptyUIMediaCache для переопределения настроек кэша по умолчанию:

var builder = new AdaptyConfiguration.Builder("YOUR_PUBLIC_SDK_KEY")
    .SetAdaptyUIMediaCache(
        100 * 1024 * 1024, // MemoryStorageTotalCostLimit 100MB
        null, // MemoryStorageCountLimit
        100 * 1024 * 1024 // DiskStorageSizeLimit 100MB
    );

Параметры:

ПараметрОбязательныйОписание
memoryStorageTotalCostLimitопциональноОбщий размер кэша в памяти в байтах. По умолчанию — значение, специфичное для платформы.
memoryStorageCountLimitопциональноМаксимальное количество элементов в кэше памяти. По умолчанию — значение, специфичное для платформы.
diskStorageSizeLimitопциональноМаксимальный размер кэша на диске в байтах. По умолчанию — значение, специфичное для платформы.

Включение локальных уровней доступа (Android)

По умолчанию локальные уровни доступа включены на iOS и отключены на Android. Чтобы включить их и на Android, установите SetGoogleLocalAccessLevelAllowed в true:

var builder = new AdaptyConfiguration.Builder("YOUR_PUBLIC_SDK_KEY")
    .SetGoogleLocalAccessLevelAllowed(true);

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

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

Удаляется только локальный кэш SDK. История транзакций с Apple и данные пользователя на серверах Adapty остаются без изменений.

var builder = new AdaptyConfiguration.Builder("YOUR_PUBLIC_SDK_KEY")
    .SetAppleClearDataOnBackup(true);

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

Правила резервного копирования Android (конфигурация Auto Backup)

Некоторые SDK (включая Adapty) поставляются с собственной конфигурацией Android Auto Backup. Если вы используете несколько SDK, каждый из которых определяет правила резервного копирования, слияние манифестов Android может завершиться ошибкой, связанной с android:fullBackupContent, android:dataExtractionRules или android:allowBackup.

Типичные симптомы ошибки: Manifest merger failed: Attribute application@dataExtractionRules value=(@xml/your_data_extraction_rules) is also present at [com.other.sdk:library:1.0.0] value=(@xml/other_sdk_data_extraction_rules)

Эти изменения нужно вносить в директорию Android-платформы (обычно находится в папке android/ вашего проекта).

Чтобы решить проблему, необходимо:

  • Указать механизму слияния манифестов использовать значения вашего приложения для атрибутов, связанных с резервным копированием.

  • Создать файлы правил резервного копирования, объединяющие правила Adapty с правилами других SDK.

1. Добавьте пространство имён tools в манифест

В файле AndroidManifest.xml убедитесь, что корневой тег <manifest> включает tools:

<manifest xmlns:android="http://schemas.android.com/apk/res/android"
xmlns:tools="http://schemas.android.com/tools"
package="com.example.app">

    ...
</manifest>

2. Переопределите атрибуты резервного копирования в <application>

В том же файле AndroidManifest.xml обновите тег <application>, чтобы ваше приложение предоставляло итоговые значения и указывало механизму слияния манифестов заменять значения библиотек:

<application
android:name=".App"
android:allowBackup="true"
android:fullBackupContent="@xml/sample_backup_rules"           
android:dataExtractionRules="@xml/sample_data_extraction_rules"
tools:replace="android:fullBackupContent,android:dataExtractionRules">

    ...
</application>

Если какой-либо SDK также задаёт android:allowBackup, включите его в tools:replace:

tools:replace="android:allowBackup,android:fullBackupContent,android:dataExtractionRules"

3. Создайте объединённые файлы правил резервного копирования

Создайте XML-файлы в директории res/xml/ вашего Android-проекта, объединяющие правила Adapty с правилами других SDK. Android использует разные форматы правил резервного копирования в зависимости от версии ОС, поэтому создание обоих файлов обеспечивает совместимость со всеми версиями Android, которые поддерживает ваше приложение.

В примерах ниже в качестве стороннего SDK используется AppsFlyer. Замените или добавьте правила для других SDK, которые используются в вашем приложении.

Для Android 12 и выше (используется новый формат правил извлечения данных):

<?xml version="1.0" encoding="utf-8"?>
<data-extraction-rules>
    <cloud-backup>
        
        <exclude domain="sharedpref" path="appsflyer-data"/>
        <exclude domain="sharedpref" path="appsflyer-purchase-data"/>
        <exclude domain="database" path="afpurchases.db"/>
        
        <exclude domain="sharedpref" path="AdaptySDKPrefs.xml"/>
    </cloud-backup>

    <device-transfer>
        
        <exclude domain="sharedpref" path="appsflyer-data"/>
        <exclude domain="sharedpref" path="appsflyer-purchase-data"/>
        <exclude domain="database" path="afpurchases.db"/>
        <exclude domain="sharedpref" path="AdaptySDKPrefs.xml"/>
    </device-transfer>
</data-extraction-rules>

Для Android 11 и ниже (используется устаревший формат полного резервного копирования):

<?xml version="1.0" encoding="utf-8"?>
<full-backup-content>
    
    <exclude domain="sharedpref" path="appsflyer-data"/>

    
    <exclude domain="sharedpref" path="AdaptySDKPrefs.xml"/>

    

В Unity применяйте эти изменения к Assets/Plugins/Android/AndroidManifest.xml и создавайте файлы правил резервного копирования в Assets/Plugins/Android/res/xml/.

Покупки не завершаются после возврата из другого приложения на Android

Если Activity, запускающий процесс покупки, использует нестандартный launchMode, Android может неправильно пересоздать или переиспользовать его, когда пользователь возвращается из Google Play, банковского приложения или браузера. Это может привести к потере результата покупки или её обработке как отменённой.

Чтобы покупки работали корректно, используйте только режимы запуска standard или singleTop для Activity, запускающего процесс покупки, и избегайте любых других режимов.

В вашем AndroidManifest.xml убедитесь, что Activity, запускающий процесс покупки, использует режим standard или singleTop:

<activity
    android:name=".MainActivity"
    android:launchMode="standard" />