安装与配置 Unity SDK

Adapty SDK 包含两个关键模块,可无缝集成到您的 Unity 应用中:

  • Core Adapty:这是 Adapty 正常运行所必需的核心 SDK。
  • AdaptyUI:如果您使用 Adapty 付费墙编辑工具(一款无需编写代码即可轻松创建跨平台付费墙的可视化工具),则需要此模块。

想了解 Adapty SDK 是如何集成到移动应用中的真实案例吗?欢迎查看我们的示例应用,其中演示了完整的接入流程,包括展示付费墙、发起购买以及其他基础功能。

环境要求

Adapty SDK 支持 iOS 13.0+,但需要 iOS 15.0+ 才能与付费墙编辑工具中创建的付费墙配合使用。

Adapty 兼容 Google Play Billing Library 最高至 8.x 版本。默认情况下,Adapty 使用 Google Play Billing Library v7.0.0。如需使用更新版本,请在 Android 构建中覆盖 Billing 依赖项

安装 SDK 是 Adapty 配置流程的第 5 步。在应用内购买正常运行之前,您还需要将应用连接到各应用商店,然后在 Adapty 看板中创建产品、付费墙和版位。快速入门指南涵盖了所有必要步骤。

安装 Adapty SDK

Release

选择你偏好的安装方式:

安装 SDK 后,请完成以下步骤:

  1. 安装 External Dependency Manager (EDM) 插件。Adapty SDK 使用它来处理 iOS Cocoapods 依赖项和 Android gradle 依赖项。

  2. 安装 EDM 后,您可能需要调用依赖管理器:

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

    以及

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

  3. 在为 iOS 构建 Unity 项目时,您会得到 Unity-iPhone.xcworkspace 文件,您必须打开该文件而非 Unity-iPhone.xcodeproj,否则 Cocoapods 依赖项将不会被使用。

激活 Adapty SDK 的 Adapty 模块

在你的应用代码中激活 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" 替换为实际值。

或者,使用 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 对每个应用都是唯一的,如果您有多个应用,请确保选择正确的那个。
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 SDK 方法之前,请等待 Activate 完成回调。完整调用顺序请参阅 Unity SDK 调用顺序

设置事件监听

创建一个脚本来监听 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) { }
}

我们建议调整脚本执行顺序,将 AdaptyListener 放在 Default Time 之前,以确保 Adapty 尽早完成初始化。

activate_unity.webp

接下来,在应用中配置付费墙:

激活 Adapty SDK 的 AdaptyUI 模块

如果您计划使用付费墙编辑工具并已安装 AdaptyUI 模块,则需要激活 AdaptyUI。您可以在配置过程中激活它:

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

可选设置

日志记录

配置日志系统

Adapty 会记录错误和其他重要信息,帮助你了解运行情况。以下是可用的日志级别:

LevelDescription
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);

禁止采集和共享广告 ID

在激活 Adapty 模块时,将 SetAppleIDFACollectionDisabled 和/或 SetGoogleAdvertisingIdCollectionDisabled 设置为 true 可禁用广告标识符的收集。默认值为 false

如需遵守 App Store/Google Play 政策、避免触发 App 跟踪透明度提示,或者你的应用不需要基于广告 ID 的广告归因或分析功能,可使用此参数。

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 自动备份配置。如果多个 SDK 都定义了备份规则,Android 清单合并工具可能会报错,提示 android:fullBackupContentandroid:dataExtractionRulesandroid: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"/>

    

在 Unity 中,请将上述更改应用到 Assets/Plugins/Android/AndroidManifest.xml,并在 Assets/Plugins/Android/res/xml/ 目录下创建备份规则文件。

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

如果启动购买流程的 Activity 使用了非默认的 launchMode,当用户从 Google Play、银行应用或浏览器返回时,Android 可能会以错误的方式重建或复用该 Activity。这会导致购买结果丢失或被当作已取消处理。 为确保购买流程正常运行,请仅将启动购买流程的 Activity 的启动模式设置为 standardsingleTop,避免使用其他任何模式。

AndroidManifest.xml 中,确保启动购买流程的 Activity 设置为 standardsingleTop

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

Android 上显示付费墙时应用崩溃

如果应用在 Android 上显示付费墙时崩溃,可能是因为 Gradle 配置中缺少 Kotlin 插件。添加方法如下:

  1. Player Settings 中,确保已勾选 Custom Launcher Gradle TemplateCustom 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'
  1. 将以下内容添加到 /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**
    }