安装并配置 Android SDK

Adapty SDK 包含两个关键模块，帮助你将其无缝集成到移动应用中：

• Core Adapty：这是 Adapty 正常运行所必需的基础 SDK。
• AdaptyUI：如果你使用 Adapty 付费墙编辑工具（一款无需编写代码即可轻松创建跨平台付费墙的可视化工具），则需要此模块。AdaptyUI 会随核心模块一同自动激活。

系统要求

最低 SDK 要求：minSdkVersion 21

安装 Adapty SDK

选择依赖配置方式：

• 标准 Gradle：将依赖项添加到模块级 build.gradle
• 如果你的项目使用 .gradle.kts 文件，将依赖项添加到模块级 build.gradle.kts
• 如果你使用版本目录，将依赖项添加到 libs.versions.toml 文件，然后在 build.gradle.kts 中引用

dependencies {
    ...
    implementation platform('io.adapty:adapty-bom:<the latest SDK version>')
    implementation 'io.adapty:android-sdk'
    
    // Only add this line if you plan to use Paywall Builder
    implementation 'io.adapty:android-ui'
}

dependencies {
    ...
    implementation(platform("io.adapty:adapty-bom:<the latest SDK version>"))
    implementation("io.adapty:android-sdk")
    
    // 仅在计划使用付费墙编辑工具时添加此行：
    implementation("io.adapty:android-ui")
}

//libs.versions.toml

[versions]
..
adaptyBom = "<the latest SDK version>"

[libraries]
..
adapty-bom = { module = "io.adapty:adapty-bom", version.ref = "adaptyBom" }
adapty = { module = "io.adapty:android-sdk" }

// Only add this line if you plan to use Paywall Builder:
adapty-ui = { module = "io.adapty:android-ui" }

//module-level build.gradle.kts

dependencies {
    ...
    implementation(platform(libs.adapty.bom))
    implementation(libs.adapty)
    
    // Only add this line if you plan to use Paywall Builder:
    implementation(libs.adapty.ui)
}

如果依赖无法解析，请确认你的 Gradle 脚本中包含 mavenCentral()。

allprojects {
    repositories {
        ...
        mavenCentral()
    }
}

dependencyResolutionManagement {
    ...
    repositories {
        ...
        mavenCentral()
    }
}

激活 Adapty SDK 的 Adapty 模块

基本设置

在你的应用代码中激活 Adapty SDK。

获取您的 Public SDK Key：

1. 打开 Adapty 看板，导航至 App settings → General。
2. 在 Api keys 部分，复制 Public SDK Key（不是 Secret Key）。
3. 将代码中的 "YOUR_PUBLIC_SDK_KEY" 替换为实际值。

或者，使用 Adapty CLI 以编程方式获取：

npm install -g adapty
adapty auth login
adapty apps list

或者，直接运行：

npx adapty auth login
adapty apps list

• 请确保使用 Public SDK key 初始化 Adapty，Secret key 仅用于服务端 API。
• SDK keys 对每个应用都是唯一的，如果您有多个应用，请确保选择正确的那个。

// In your Application class

class MyApplication : Application() {
    override fun onCreate() {
        super.onCreate()
        Adapty.activate(
            applicationContext,
            AdaptyConfig.Builder("PUBLIC_SDK_KEY")
                .build()
        )
    }
}

// In your Application class

public class MyApplication extends Application {
    @Override
    public void onCreate() {
        super.onCreate();
        Adapty.activate(
            getApplicationContext(),
            new AdaptyConfig.Builder("PUBLIC_SDK_KEY")
                .build()
        );
    }
}

接下来在你的应用中配置付费墙：

• 如果你使用 Adapty 付费墙编辑工具，请参阅付费墙编辑工具快速入门。
• 如果你自行构建付费墙界面，请参阅自定义付费墙快速入门。

激活 Adapty SDK 的 AdaptyUI 模块

如果您计划使用付费墙编辑工具，则需要 AdaptyUI 模块。当您激活核心模块时，它会自动激活，无需执行任何其他操作。

配置 Proguard

在将应用发布到生产环境之前，请将 -keep class com.adapty.** { *; } 添加到您的 Proguard 配置中。

可选配置

日志记录

配置日志系统

Adapty 会记录错误和其他重要信息，帮助你了解当前状况。以下是可用的日志级别：

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

Adapty.setLogLevel(AdaptyLogLevel.VERBOSE);
//recommended for development and the first production release

将日志系统消息重定向

如果你需要将 Adapty 的日志消息发送到自己的系统或保存到文件中，可以覆盖默认行为：

Adapty.setLogHandler { level, message ->
    //handle the log
}

Adapty.setLogHandler((level, message) -> {
    //handle the log
});

数据政策

除非你主动发送，Adapty 不会存储用户的个人数据。不过，你也可以启用额外的数据安全策略，以符合应用商店或所在国家/地区的规定。

禁用 IP 地址的收集与共享

激活 Adapty 模块时，将 ipAddressCollectionDisabled 设置为 true 即可禁止收集和共享用户 IP 地址。默认值为 false。 使用此参数可增强用户隐私保护、遵守特定地区的数据保护法规（如 GDPR 或 CCPA），或在应用不需要基于 IP 的功能时减少不必要的数据收集。

AdaptyConfig.Builder("PUBLIC_SDK_KEY")
    .withIpAddressCollectionDisabled(true)
    .build()

new AdaptyConfig.Builder("PUBLIC_SDK_KEY")
    .withIpAddressCollectionDisabled(true)
    .build();

禁用广告 ID（Ad ID）的收集与共享

激活 Adapty 模块时，将 adIdCollectionDisabled 设置为 true 可禁用用户广告 ID 的收集。默认值为 false。 使用此参数可遵守 Play Store 政策，避免触发广告 ID 权限请求，或者当你的应用不需要基于广告 ID 的广告归因或数据分析时使用。

AdaptyConfig.Builder("PUBLIC_SDK_KEY")
    .withAdIdCollectionDisabled(true)
    .build()

new AdaptyConfig.Builder("PUBLIC_SDK_KEY")
    .withAdIdCollectionDisabled(true)
    .build();

为 AdaptyUI 设置媒体缓存配置

默认情况下，AdaptyUI 会缓存媒体文件（如图片和视频），以提升性能并减少网络流量消耗。你可以通过提供自定义配置来调整缓存设置。 使用 AdaptyUI.configureMediaCache 可以覆盖默认的缓存大小和有效期。此步骤为可选项——如果不调用此方法，将使用默认值（磁盘大小 100MB，有效期 7 天）。

val cacheConfig = MediaCacheConfiguration.Builder()
    .overrideDiskStorageSizeLimit(200L * 1024 * 1024) // 200 MB
    .overrideDiskCacheValidityTime(3.days)
    .build()

AdaptyUI.configureMediaCache(cacheConfig)

MediaCacheConfiguration cacheConfig = new MediaCacheConfiguration.Builder()
    .overrideDiskStorageSizeLimit(200L * 1024 * 1024) // 200 MB
    .overrideDiskCacheValidityTime(TimeInterval.days(3))
    .build();

AdaptyUI.configureMediaCache(cacheConfig);

参数：

设置混淆账户 ID

Google Play 在某些场景下需要混淆账户 ID，以增强用户隐私保护和安全性。这些 ID 帮助 Google Play 识别购买行为的同时保持用户信息匿名，对防欺诈和数据分析尤为重要。

如果你的应用涉及敏感用户数据，或需要遵守特定隐私法规，则可能需要设置这些 ID。混淆 ID 让 Google Play 能够追踪购买记录，同时不暴露真实的用户标识符。

AdaptyConfig.Builder("PUBLIC_SDK_KEY")
    .withObfuscatedAccountId("YOUR_OBFUSCATED_ACCOUNT_ID")
    .build()

new AdaptyConfig.Builder("PUBLIC_SDK_KEY")
    .withObfuscatedAccountId("YOUR_OBFUSCATED_ACCOUNT_ID")
    .build();

在自定义进程中运行 Adapty

默认情况下，Adapty 只能在应用的主进程中运行。 如果你的应用使用多个进程，请只初始化 Adapty 一次，否则可能会出现意外行为。

如果需要在其他进程中运行 Adapty，请在配置中指定：

AdaptyConfig.Builder("PUBLIC_SDK_KEY")
    .withProcessName(":custom")
    .build()

new AdaptyConfig.Builder("PUBLIC_SDK_KEY")
    .withProcessName(":custom")
    .build();

如果你尝试在另一个进程中激活 Adapty 却未设置此值，SDK 将记录一条警告并跳过激活。

启用本地访问等级

默认情况下，本地访问等级在 Android 上是禁用的。要启用它，请将 withLocalAccessLevelAllowed 设置为 true：

AdaptyConfig.Builder("PUBLIC_SDK_KEY")
    .withLocalAccessLevelAllowed(true)
    .build()

new AdaptyConfig.Builder("PUBLIC_SDK_KEY")
    .withLocalAccessLevelAllowed(true)
    .build();

故障排查

Android 备份规则（Auto Backup 配置）

部分 SDK（包括 Adapty）自带 Android Auto Backup 配置。如果你同时使用多个定义了备份规则的 SDK，Android 清单合并器可能会报错，提示涉及 android:fullBackupContent、android:dataExtractionRules 或 android:allowBackup。

典型报错信息如下：Manifest merger failed: Attribute application@dataExtractionRules value=(@xml/sample_data_extraction_rules) is also present at [com.other.sdk:library:1.0.0] value=(@xml/other_sdk_data_extraction_rules) 要解决此问题，您需要：

• 告知清单合并器使用您应用的值来处理备份相关属性。

• 将 Adapty 和其他 SDK 的备份规则合并到一个 XML 文件中（对于 Android 12+，则合并为一对文件）。

1. 在清单中添加 tools 命名空间

如果尚未添加，请在根 <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> 标签，使应用提供最终值并告知 manifest 合并器替换库中的值：

<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. 创建合并的备份规则文件

在 app/src/main/res/xml/ 目录下创建 XML 文件，将 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"/>

    
    
</full-backup-content>

完成上述配置后：

• Adapty 的备份排除项（AdaptySDKPrefs.xml）已保留。

• 其他 SDK 的排除项（例如 appsflyer-data）也已生效。

• 清单合并使用应用配置，不再因备份属性冲突而失败。

从其他应用返回后购买失败

如果启动购买流程的 Activity 使用了非默认的 launchMode，当用户从 Google Play、银行应用或浏览器返回时，Android 可能会错误地重建或复用该 Activity，导致购买结果丢失或被视为已取消。

为确保购买流程正常运行，请仅为启动购买流程的 Activity 使用 standard 或 singleTop 启动模式，避免使用其他任何模式。 在您的 AndroidManifest.xml 中，确保启动购买流程的 Activity 的 launchMode 设置为 standard 或 singleTop：

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