Установка и настройка Adapty SDK в чистом проекте React Native

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

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

Требования

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

Установка Adapty SDK

1. Установите Adapty SDK (при этом автоматически установится и @adapty/core):

   # using npm
   npm install react-native-adapty
   
   # or using yarn
   yarn add react-native-adapty  

2. Для iOS установите поды:

   cd ios && pod install

...
buildscript {
  ...
  dependencies {
    ...
    classpath "org.jetbrains.kotlin:kotlin-gradle-plugin:1.8.0"
  }
}
...

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

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

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

Скопируйте следующий код в App.tsx для активации Adapty:

adapty.activate('YOUR_PUBLIC_SDK_KEY');

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

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

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

Если вы планируете использовать Paywall Builder, вам понадобится модуль AdaptyUI. Он активируется автоматически при активации основного модуля — никаких дополнительных действий не требуется.

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

Логирование

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

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

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

// Set log level before activation
// 'verbose' is recommended for development and the first production release
adapty.setLogLevel('verbose');

// Or set it during configuration
adapty.activate('YOUR_PUBLIC_SDK_KEY', {
  logLevel: 'verbose',
});

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

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

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

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

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

adapty.activate('YOUR_PUBLIC_SDK_KEY', {
  ipAddressCollectionDisabled: true,
});

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

При активации модуля Adapty установите ios.idfaCollectionDisabled (iOS) или android.adIdCollectionDisabled (Android) в true, чтобы отключить сбор рекламных идентификаторов. Значение по умолчанию — false.

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

adapty.activate('YOUR_PUBLIC_SDK_KEY', {
  ios: {
    idfaCollectionDisabled: true,      
  },
  android: {
    adIdCollectionDisabled: true,      
  },
});

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

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

Используйте mediaCache, чтобы переопределить настройки кэша по умолчанию:

adapty.activate('YOUR_PUBLIC_SDK_KEY', {
  mediaCache: {
    memoryStorageTotalCostLimit: 200 * 1024 * 1024, // Optional: memory cache size in bytes
    memoryStorageCountLimit: 2147483647,            // Optional: max number of items in memory
    diskStorageSizeLimit: 200 * 1024 * 1024,       // Optional: disk cache size in bytes
  },
});

Параметры:

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

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

adapty.activate('YOUR_PUBLIC_SDK_KEY', {
  android: {
     localAccessLevelAllowed: true,      
  },
});

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

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

adapty.activate('YOUR_PUBLIC_SDK_KEY', {
   ios: {
      clearDataOnBackup: true
   },
});

Советы для среды разработки

Отложенная активация SDK для разработки

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

Однако в симуляторе iOS это может стать проблемой, поскольку он часто запрашивает аутентификацию во время разработки. Adapty не может управлять процессом аутентификации StoreKit, но может отложить собственные запросы на получение актуальных пользовательских данных.

Включив свойство __debugDeferActivation, вызов активации будет удерживаться до следующего обращения к Adapty SDK. Это предотвращает лишние запросы аутентификационных данных, если они не нужны.

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

Рекомендуемый способ использования:

try {
  adapty.activate('PUBLIC_SDK_KEY', {
    __debugDeferActivation: isSimulator(), // 'isSimulator' from any 3rd party library
  });
} catch (error) {
  console.error('Failed to activate Adapty SDK:', error);
  // Handle the error appropriately for your app
}

Устранение ошибок активации SDK при использовании Fast Refresh в React Native

При разработке с Adapty SDK в React Native вы можете столкнуться с ошибкой: Adapty can only be activated once. Ensure that the SDK activation call is not made more than once.

Это происходит из-за того, что функция быстрого обновления React Native вызывает несколько активаций во время разработки. Чтобы этого избежать, используйте опцию __ignoreActivationOnFastRefresh, установив её в __DEV__ (флаг режима разработки React Native).

try {
  adapty.activate('PUBLIC_SDK_KEY', {
    __ignoreActivationOnFastRefresh: __DEV__, 
  });
} catch (error) {
  console.error('Failed to activate Adapty SDK:', error);
  // Handle the error appropriately for your app
}

Настройка mock-режима для локального тестирования

Для локальной разработки и тестирования можно включить mock-режим, чтобы обойтись без sandbox-аккаунтов App Store/Google Play и ускорить итерации. В mock-режиме нативные модули Adapty полностью обходятся, а вместо них возвращаются симулированные данные.

Чтобы включить mock-режим, установите enableMock в true:

adapty.activate('YOUR_PUBLIC_SDK_KEY', {
  enableMock: true,
});

Когда mock-режим активен:

• Все методы Adapty возвращают mock-данные без сетевых запросов к серверам Adapty.
• По умолчанию начальный mock-профиль не имеет активных подписок.
• По умолчанию makePurchase(...) симулирует успешную покупку и предоставляет премиум-доступ.

Вы можете настроить mock-данные с помощью mockConfig при активации. Формат конфигурации и поддерживаемые параметры смотрите здесь.

try {
   await adapty.activate('YOUR_PUBLIC_SDK_KEY', {
      mockConfig: {
         // Customize the initial mock profile (optional)
      },
   });
} catch (error) {
   console.error('Failed to activate Adapty SDK:', error);
}

Если вам нужно вызвать методы SDK до активации (например, isActivated() или setLogLevel()), используйте enableMock() перед activate(). Если бридж уже инициализирован, этот метод ничего не делает.

adapty.enableMock(); // Optional: pass mockConfig to customize mock data

// Now you can call methods before activation

await adapty.activate('YOUR_PUBLIC_SDK_KEY');

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

Ошибка минимальной версии iOS

Если вы получаете ошибку минимальной версии iOS, обновите Podfile:

-platform :ios, min_ios_version_supported
+platform :ios, '13.0'  # For core features only
# OR
+platform :ios, '15.0'  # If using paywalls created in the paywall builder

Конфликт манифеста 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)

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

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

• Создать файлы правил резервного копирования, объединяющие правила 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, которые поддерживает ваше приложение.

Для 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"/>

    

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

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

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

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

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