旧版安装指南

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

Adapty SDK 版本AdaptyUI SDK 版本
2.7.x, 2.8.x2.0.x
2.9.x - 2.10.02.1.2
2.10.12.1.3
2.10.3 及所有后续 2.10.x 版本2.1.5
2.11.12.11.1
2.11.22.11.2
2.11.32.11.3

您可以通过 CocoaPods 或 Swift Package Manager 安装 AdaptySDK 和 AdaptyUI SDK。

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

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

通过 Swift Package Manager 安装 SDK

  1. 在 Xcode 中,前往 File -> Add Package Dependency…。请注意,不同版本的 Xcode 添加包依赖的方式可能有所不同,如有需要请参阅 Xcode 文档。
  2. 输入仓库地址 https://github.com/adaptyteam/AdaptySDK-iOS.git
  3. 选择版本后,点击 Add package 按钮。Xcode 将把包依赖添加到您的项目中,之后即可导入使用。
  4. Choose Package Products 窗口中,再次点击 Add package 按钮。该包将出现在 Packages 列表中。
  5. 对 AdaptyUI SDK 重复步骤 2-3,URL 为:https://github.com/adaptyteam/AdaptyUI-iOS.git

通过 CocoaPods 安装 SDK

CocoaPods 目前处于维护模式,官方已停止开发。我们建议切换至 Swift Package Manager

  1. 将 Adapty 添加到您的 Podfile

    pod 'Adapty', '~> 2.11.3'
    pod 'AdaptyUI', '~> 2.11.3'
  2. 运行:

    pod install

这将为您的应用创建一个 .xcworkspace 文件。请在应用后续的所有开发过程中使用该文件。

配置 Adapty SDK

您只需在应用生命周期的早期配置一次 Adapty SDK:

参数说明:

参数是否必填描述
apiKey必填您可以在 Adapty 中应用设置的 Public SDK key 字段中找到该密钥:App settings -> General 选项卡 -> API keys 子章节
observerMode可选

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

默认值为 false

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

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

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

以及用户 IP 地址的共享。

默认值为 false

有关 IDFA 收集的更多详情,请参阅分析集成章节。

ipAddressCollectionDisabled可选

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

默认值为 false

logLevel可选Adapty 会记录错误及其他重要信息,以帮助您了解应用的运行状态。可用的日志级别如下:
  • error:仅记录错误。
  • warn:记录错误以及 SDK 中不会引发严重错误但值得关注的消息。
  • info:记录错误、警告以及重要信息(例如各模块生命周期相关的日志)。
  • verbose:记录调试时可能有用的所有附加信息,例如函数调用、API 请求等。
  • 请注意,StoreKit 2 自 iOS 15.0 起可用。Adapty 将为更低版本实现旧版逻辑。
  • 请确保使用 Public SDK key 初始化 Adapty,Secret key 仅应用于服务端 API
  • SDK keys 对每个应用都是唯一的,如果您有多个应用,请确保选择正确的密钥。

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