旧版安装指南

Adapty 包含两个关键 SDK,用于无缝集成到您的移动应用程序中:

  • 核心 AdaptySDK:这是一个基础性的、必不可少的 SDK,是 Adapty 在您的应用程序中正常运行所必需的。
  • AdaptyUI SDK:如果您使用 Adapty 付费墙编辑工具,则需要此可选 SDK:这是一个用户友好的无代码工具,可轻松创建跨平台付费墙。这些付费墙在我们的看板中通过可视化编辑器构建,完全在设备上以原生方式运行,只需您付出极少的努力即可创建出表现出色的内容。

请参阅下方兼容性表格,选择正确的 Adapty SDK 和 AdaptyUI SDK 组合。

AdaptySDK-Unity 版本AdaptyUI-Unity 版本
2.7.12.0.1
2.9.0不兼容

发布应用前请完成发布检查清单

在发布您的应用程序之前,请务必仔细阅读发布检查清单。该清单确保您已完成所有必要步骤,并提供了评估集成成功与否的标准。

安装 Adapty SDK

安装 Adapty SDK 的步骤如下:

  1. 从 GitHub 下载 adapty-unity-plugin-*.unitypackage 并将其导入您的项目。
456bd98-adapty-unity-plugin.webp
  1. 从 GitHub 下载 adapty-ui-unity-plugin-*.unitypackage 并将其导入您的项目。
2ab0b4a-adapty-ui-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. 当您为 iOS 构建 Unity 项目时,将会生成 Unity-iPhone.xcworkspace 文件,您必须打开该文件而非 Unity-iPhone.xcodeproj,否则 Cocoapods 依赖项将不会被使用。

配置 Adapty SDK

要为 Unity 配置 Adapty SDK,首先初始化 Adapty Unity 插件,然后按照以下指南使用它。此外,请确保设置好您的日志系统,以便从 Adapty 接收错误和其他重要信息。

激活 Adapty SDK

您只需激活一次 Adapty SDK,通常在应用程序生命周期的早期进行。

using AdaptySDK;

var builder = new AdaptyConfiguration.Builder("YOUR_API_KEY")
  .SetCustomerUserId(null)
  .SetObserverMode(false)
  .SetServerCluster(AdaptyServerCluster.Default)
  .SetIPAddressCollectionDisabled(false)
  .SetIDFACollectionDisabled(false);
  .SetActivateUI(true)
  .SetAdaptyUIMediaCache(
    100 * 1024 * 1024, // MemoryStorageTotalCostLimit 100MB
    null, // MemoryStorageCountLimit
    100 * 1024 * 1024 // DiskStorageSizeLimit 100MB
  );
  
Adapty.Activate(builder.Build(), (error) => {
  if (error != null) {
    // handle the error
    return;
  }
});
参数必要性描述
apiKey必填您可以在 Adapty 应用设置的 Public SDK key 字段中找到此密钥:App settings-> General tab -> API keys subsection
logLevel可选Adapty 记录错误和其他关键信息,以便了解应用程序的运行状况。以下是可用的日志级别:
  • error:仅记录错误。
  • warn:记录错误以及来自 SDK 的不会导致严重错误但值得注意的消息。
  • info:记录错误、警告和重要信息消息,例如记录各模块生命周期的消息。
  • verbose:记录调试期间可能有用的任何附加信息,例如函数调用、API 查询等。
observerMode可选

一个布尔值,用于控制观察者模式。如果您自行处理购买和订阅状态,并使用 Adapty 发送订阅事件和分析数据,请启用此功能。

默认值为 false

🚧 在观察者模式下运行时,Adapty SDK 不会关闭任何交易,请确保您自行处理。

customerUserId可选您系统中用户的标识符。我们在订阅和分析事件中发送此标识符,以将事件归因到正确的用户画像。您也可以在 Profiles and Segments 菜单中通过 customerUserId 查找用户。
idfaCollectionDisabled可选

设置为 true 可禁用 IDFA 的收集和共享。

默认值为 false

有关 IDFA 收集的更多详细信息,请参阅分析集成部分。

ipAddressCollectionDisabled可选

设置为 true 可禁用用户 IP 地址的收集和共享。

默认值为 false

使用 Adapty Unity 插件

  1. 创建一个脚本来监听 Adapty 事件。在您的场景中将其命名为 AdaptyListener。我们建议对该对象使用 DontDestroyOnLoad 方法,以确保它在整个应用程序生命周期内持续存在。
2ccd564-create_adapty_listener.webp

Adapty 使用 AdaptySDK 命名空间。在使用 Adapty SDK 的脚本文件顶部,您可以添加:

using AdaptySDK;
  1. 订阅 Adapty 事件:
   using UnityEngine;
   using AdaptySDK;

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

     public void OnLoadLatestProfile(Adapty.Profile profile) {
       // handle updated profile data
     }
   }

请注意,为使付费墙和产品在您的移动应用程序中正常显示,以及使分析功能正常工作,您需要在应用程序中展示付费墙,并且如果您使用的是非付费墙编辑工具创建的付费墙,还需要处理购买流程