Appcues iOS SDK

Appcues iOS SDK允许您将Appcues体验集成到您的原生iOS和iPadOS应用程序中。

该SDK是一个Swift库，可以用于向Appcues API发送用户属性和事件，并基于这些属性和事件检索和渲染Appcues内容。

• Appcues iOS SDK
  • 🚀入门
    • 安装
      • Segment
      • Swift Package Manager
      • Cocoapods
      • XCFramework
    • 一次性设置
      • 初始化SDK
      • 支持调试和预览体验
    • 识别用户
    • 跟踪屏幕和事件
  • 🛠定制
  • 📝文档
  • 🎬示例
  • 👷贡献
  • 📄许可证

🚀入门

安装

将Appcues iOS SDK包添加到您的应用程序中。有几种支持的安装选项。还有一个教程视频可供参考，展示了如何使用Swift Package Manager进行安装。

Segment

Appcues 支持与 Segment 的 analytics-swift 库集成。要使用 Segment 进行安装，您需要使用 Segment Appcues 插件。

Swift Package Manager

将 Swift 包作为依赖添加到您的 Xcode 项目中

1. 在 Xcode 中，打开您的项目，导航到 文件 → 添加包…
2. 输入包 URL https://github.com/appcues/appcues-ios-sdk
3. 对于 依赖规则，选择 直到下一个主要版本
4. 单击 添加包

另外，如果您的项目有 Package.swift 文件，您可以将 Appcues iOS SDK 添加到依赖中

dependencies: [
    .package(url: "https://github.com/appcues/appcues-ios-sdk", from: "2.0.0"),
]

Cocoapods

1. 将 pod 添加到您的 Podfile

   pod 'Appcues'

2. 在终端中运行

   pod install

XCFramework

每个 版本 都附带一个 XCFramework。

1. 下载最新发布版 中附带的 AppcuesKit.xcframework.zip 并解压。
2. 在 Xcode 中，打开您的项目，导航至 文件 → 将文件添加到 ""…
3. 在文件浏览器中找到 XCFramework 并选择它
4. 确保勾选了“如有需要则复制项目”选项，并选择您的应用目标
5. 单击 添加
6. 在 项目导航器 中选择您的项目，然后选择应用目标并在 通用 选项卡下，在 框架、库和嵌入式内容 下将 AppcuesKit.xcframework 设置为 嵌入 & 签名

一次性设置

安装包后，您可以通过使用 import AppcuesKit 导入包来引用 Appcues iOS SDK。

初始化 SDK

当您的应用启动时，应初始化 Appcues iOS SDK 实例。如 application(_:didFinishLaunchingWithOptions:) 这样的生命周期方法是常见的位置。

func application(_ application: UIApplication, didFinishLaunchingWithOptions launchOptions: [UIApplication.LaunchOptionsKey: Any]?) -> Bool {
  let appcuesConfig = Appcues.Config(
    accountID: <#APPCUES_ACCOUNT_ID#>,
    applicationID: <#APPCUES_APPLICATION_ID#>)
    
  appcues = Appcues(config: appcuesConfig)
}

初始化 SDK 需要您提供两个值，即 Appcues 帐户 ID 和 Appcues 移动应用 ID。这些值可以从您的 Appcues 设置 中获取。有关更多信息，请参阅 在 Studio 中注册您的移动应用 的帮助文档。

支持调试和经验预览

在安装过程中，按照 配置 Appcues URL Scheme 中概述的步骤操作。这对于实现 Appcues 建造者最佳体验以及支持调试和经验预览是必需的。有关使用 Appcues 调试器的详细信息，请参阅 调试指南。

识别用户

为了在正确的时间将内容定位给正确的用户，您需要识别用户并发送 Appcues 关于他们的数据。通过唯一的用户 ID 来识别用户。

• identify(userID:)

跟踪屏幕和事件

事件是用户在您的应用中采取的“操作”，可以是从点击某个按钮到查看特定屏幕的任何内容。安装并初始化了Appcues iOS SDK之后，您可以使用以下方法开始跟踪屏幕和事件

• track(name:)
• screen(title:)

关于更多详细信息，请参阅完整的入门指南。

🛠定制

有关详细信息，请参阅扩展指南。

📝文档

SDK文档可在https://appcues.github.io/appcues-ios-sdk/documentation/appcueskit找到，完整的Appcues文档可在https://docs.appcues.com/找到。

🎬示例

存储库中的Examples目录包含了展示不同安装方法和提供Appcues API使用引用的完整iOS应用程序示例。

👷贡献

请参阅贡献指南，了解如何进行开发以及如何为项目做出贡献。

📄许可证

此项目采用MIT许可证。有关更多信息，请参阅LICENSE。