在纯 React Native 项目中安装与配置 Adapty SDK
本指南仅适用于纯 React Native(非 Expo)项目。
如果您使用的是 Expo,请改为参阅 Expo 安装指南。
Adapty SDK 包含两个关键模块,可无缝集成到您的 React Native 应用中:
- Core Adapty:此模块是 Adapty 在您的应用中正常运行所必需的。
- AdaptyUI:如果您使用 Adapty 付费墙编辑工具(一款用户友好的无代码工具,可轻松创建跨平台付费墙),则需要此模块。AdaptyUI 会随核心模块一起自动激活。
想查看 Adapty SDK 集成到移动应用的真实示例吗?请查看我们的示例应用,其中展示了完整配置,包括显示付费墙、进行购买以及其他基本功能。
要求
Adapty React Native SDK 支持 iOS 13.0+,但使用 Adapty 付费墙编辑工具创建的付费墙需要 iOS 15.0+。
Adapty 兼容 Google Play Billing Library 8.x 及以下版本。默认情况下,Adapty 使用 Google Play Billing Library v7.0.0,但如果您希望强制使用更高版本,可以手动添加依赖项。
安装 SDK 是 Adapty 配置流程的第 5 步。在您的应用内购买功能正常运行之前,您还需要将应用连接到应用商店,然后在 Adapty 控制台中创建产品、付费墙和版位。快速入门指南 将引导您完成所有必要步骤。
安装 Adapty SDK
- 安装 Adapty SDK(这也会自动安装
@adapty/core):# using npm npm install react-native-adapty # or using yarn yarn add react-native-adapty - 对于 iOS,安装 pods:
cd ios && pod install
对于 Android,如果您的 React Native 版本低于 0.73.0(点击展开)
更新 /android/build.gradle 文件。确保其中包含 kotlin-gradle-plugin:1.8.0 依赖项或更高版本:
...
buildscript {
...
dependencies {
...
classpath "org.jetbrains.kotlin:kotlin-gradle-plugin:1.8.0"
}
}
...激活 Adapty SDK 的 Adapty 模块
要获取您的 Public SDK Key:
- 前往 Adapty 控制台,导航至 App settings → General。
- 在 Api keys 部分,复制 Public SDK Key(不是 Secret Key)。
- 将代码中的
"YOUR_PUBLIC_SDK_KEY"替换为您的密钥。
- 请确保使用 Public SDK key 进行 Adapty 初始化,Secret key 仅应用于服务端 API。
- SDK keys 对每个应用都是唯一的,如果您有多个应用,请确保选择正确的密钥。
将以下代码复制到 App.tsx 以激活 Adapty:
import { adapty } from 'react-native-adapty';
adapty.activate('YOUR_PUBLIC_SDK_KEY');
为避免在开发环境中出现激活错误,请参阅提示。
现在在您的应用中配置付费墙:
- 如果您使用 Adapty 付费墙编辑工具,请遵循付费墙编辑工具快速入门。
- 如果您自行构建付费墙 UI,请参阅自定义付费墙快速入门。
激活 Adapty SDK 的 AdaptyUI 模块
如果您计划使用付费墙编辑工具,则需要 AdaptyUI 模块。激活核心模块时,它会自动激活,无需执行任何其他操作。
可选配置
日志记录
设置日志记录系统
Adapty 会记录错误和其他重要信息,以帮助您了解正在发生的情况。可用的日志级别如下:
| 级别 | 描述 |
|---|---|
error | 仅记录错误 |
warn | 记录错误以及 SDK 中不会导致严重错误但值得关注的消息 |
info | 记录错误、警告以及各种信息性消息 |
verbose | 记录调试期间可能有用的任何附加信息,例如函数调用、API 查询等 |
您可以在应用中于 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,
});
禁用广告 ID 收集和共享
激活 Adapty 模块时,将 ios.idfaCollectionDisabled(iOS)或 android.adIdCollectionDisabled(Android)设置为 true 以禁用广告标识符的收集。默认值为 false。
使用此参数可遵守 App Store/Play Store 政策、避免触发应用跟踪透明度提示,或在您的应用不需要基于广告 ID 的广告归因或分析时使用。
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
},
});
参数:
| 参数 | 是否必需 | 描述 |
|---|---|---|
| memoryStorageTotalCostLimit | 可选 | 内存中的总缓存大小(字节)。默认值取决于平台。 |
| memoryStorageCountLimit | 可选 | 内存存储的最大条目数。默认值取决于平台。 |
| diskStorageSizeLimit | 可选 | 磁盘上的文件大小限制(字节)。默认值取决于平台。 |
启用本地访问等级(Android)
默认情况下,本地访问等级在 iOS 上已启用,在 Android 上已禁用。要在 Android 上也启用它们,请将 localAccessLevelAllowed 设置为 true:
adapty.activate('YOUR_PUBLIC_SDK_KEY', {
android: {
localAccessLevelAllowed: true,
},
});
备份恢复时清除数据
当 clearDataOnBackup 设置为 true 时,SDK 会检测应用从 iCloud 备份恢复的情况,并删除所有本地存储的 SDK 数据,包括缓存的用户画像信息、产品详情和付费墙。SDK 随后会以干净状态初始化。默认值为 false。
仅删除本地 SDK 缓存。与 Apple 的交易记录及 Adapty 服务器上的用户数据保持不变。
adapty.activate('YOUR_PUBLIC_SDK_KEY', {
ios: {
clearDataOnBackup: true
},
});
开发环境提示
出于开发目的延迟 SDK 激活
Adapty 在 SDK 激活时预先获取所有必要的用户数据,以便更快速地访问最新数据。
但是,这在 iOS 模拟器中可能存在问题,因为模拟器在开发过程中会频繁提示身份验证。尽管 Adapty 无法控制 StoreKit 身份验证流程,但它可以延迟 SDK 为获取最新用户数据而发出的请求。
通过启用 __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
}
排查 React Native 快速刷新时的 SDK 激活错误
在 React Native 中使用 Adapty SDK 进行开发时,您可能会遇到以下错误: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
}
为本地测试设置模拟模式
对于本地开发和测试,您可以启用模拟模式,以避免需要沙盒 App Store/Google Play 账号并加快迭代速度。模拟模式会完全绕过 Adapty 的原生模块并返回模拟数据。
模拟模式不是测试真实购买的工具:
- 它不会打开 App Store / Google Play 购买流程,也不会创建真实交易。
- 它不会渲染使用 Adapty 付费墙编辑工具(AdaptyUI) 创建的付费墙/用户引导。
- Adapty 的原生模块被完全绕过——即使 Xcode/Android 构建中缺少原生 SDK 文件或 API 密钥无效也不会触发错误。
- 不会向 Adapty 服务器发送任何数据。
要测试真实购买和付费墙编辑工具付费墙,请禁用模拟模式并使用沙盒账号。
要启用模拟模式,请将 enableMock 设置为 true:
adapty.activate('YOUR_PUBLIC_SDK_KEY', {
enableMock: true,
});
当模拟模式激活时:
- 所有 Adapty 方法均返回模拟数据,不向 Adapty 服务器发起网络请求。
- 默认情况下,初始模拟用户画像没有活跃订阅。
- 默认情况下,
makePurchase(...)会模拟成功购买并授予高级访问权限。
您可以在激活期间使用 mockConfig 自定义模拟数据。请参阅此处的配置格式和支持的参数。
import { adapty } from 'react-native-adapty';
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()),请在 activate() 之前使用 enableMock()。如果桥接已初始化,此方法不执行任何操作。
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 自动备份清单冲突
部分 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. 创建合并后的备份规则文件
在您 Android 项目的 res/xml/ 目录中创建 XML 文件,将 Adapty 的规则与其他 SDK 的规则合并。Android 根据操作系统版本使用不同的备份规则格式,因此同时创建这两个文件可确保您的应用在所有支持的 Android 版本上的兼容性。
以下示例使用 AppsFlyer 作为第三方 SDK 的示例。请替换或添加您应用中实际使用的其他 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"/>
在 Android 上从其他应用返回后购买失败
如果启动购买流程的 Activity 使用了非默认的 launchMode,当用户从 Google Play、银行应用或浏览器返回时,Android 可能会错误地重新创建或复用该 Activity。这可能导致购买结果丢失或被视为已取消。
为确保购买正常工作,请仅对启动购买流程的 Activity 使用 standard 或 singleTop 启动模式,避免使用任何其他模式。
在您的 AndroidManifest.xml 中,确保启动购买流程的 Activity 设置为 standard 或 singleTop:
<activity
android:name=".MainActivity"
android:launchMode="standard" />