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 进行安装。

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

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

1. 在 Xcode 中，打开您的项目并导航到 File → Add Packages…
2. 输入包 URL https://github.com/appcues/appcues-ios-sdk
3. 对于 Dependency Rule，选择 Up to Next Major Version
4. 点击 Add Package

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

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

1. 将 pod 添加到您的 Podfile

   pod 'Appcues'

2. 在终端中，运行

   pod install

每个版本都附带一个 XCFramework。

1. 下载附加到最新版本的 AppcuesKit.xcframework.zip 并解压缩。
2. 在 Xcode 中，打开您的项目并导航到 File → Add Files to "<Project>"…
3. 在文件导航器中找到 XCFramework 并选择它
4. 确保选中“如果需要，复制项目”选项，并选择您应用的目标
5. 点击 Add
6. 在项目导航器中选择您的项目，选择您的应用目标，然后选择 General 选项卡。 在 Frameworks, Libraries, and Embedded Content 下，将 AppcuesKit.xcframework 设置为 Embed & Sign

安装该软件包后，您可以通过使用 import AppcuesKit 导入该软件包来引用 Appcues iOS 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 方案 中概述的步骤操作。 这对于完整的 Appcues 构建器体验是必需的，它支持体验预览、屏幕捕获和调试。 有关使用 Appcues 调试器的详细信息，请参阅 调试指南。

在安装过程中，请按照 配置推送通知 中概述的步骤操作。

为了在正确的时间将内容定向到正确的用户，您需要识别用户并向 Appcues 发送有关他们的信息。 用户通过唯一的 ID 标识。

• identify(userID:)

在识别用户之后，您可以选择将该用户与群组相关联。

• group(groupID:)

事件是您的用户在您的应用程序中执行的“操作”，它可以是从单击某个按钮到查看特定屏幕的任何操作。 一旦您安装并初始化了 Appcues iOS SDK，您就可以开始使用以下方法跟踪屏幕和事件

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

锚定工具提示使用元素定位来直接指向应用程序中的特定视图。 有关如何配置应用程序的视图以进行元素定位的更多信息，请参阅 锚定工具提示指南。

在您的应用程序布局中添加 AppcuesFrameView 实例以支持嵌入式体验内容，采用非模态演示。 有关如何配置应用程序布局以使用框架视图的更多信息，请参阅关于 配置 Appcues 框架 的指南。

实现 AppcuesCustomComponentViewController 实例并在 Appcues 中注册它们，以利用构建自己的组件并在体验中使用它们。 有关更多信息，请参阅关于 配置 AppcuesCustomComponentView 的指南

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

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

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

请参阅 贡献指南，了解如何设置开发环境以及如何为该项目做出贡献。

本项目根据 MIT 许可证获得许可。 有关更多信息，请参阅 LICENSE。