TIKI SDK (iOS) —消费者数据许可
TIKI SDK 为 iOS 应用程序添加消费者数据许可变得容易。它是用户交互以接受(或拒绝)数据许可提议的客户端组件。TIKI 的 SDK 使用加密散列创建不可变、数字签名的许可记录,形成审计跟踪。使用开发者友好的数据结构和API以客户端或服务器端方式编程消费记录并强制执行条款。
此库包括可配置的预构建 UI 流程/元素和用于构建自定义体验的原生低级别 API。
请查看我们的📚 SDK 文档 以开始,或直接跳入📘 API 参考。
安装
注意:在您开始之前,您需要一个发布 ID。创建一个新项目是免费的;只需登录到我们的🧑💻 开发者控制台并创建一个新项目。
Podfile
- 在 Podfile 中添加 TikiSdk 依赖项
target 'TikiSdkExample' do
use_frameworks!
# ... other dependencies
pod 'TikiSdkDebug', '2.1.9', :configurations => 'Debug'
pod 'TikiSdkRelease', '2.1.9', :configurations => 'Release'
end
- 运行
pod install
。
就是这样。是的,这真的很简单。
初始化
使用 TIKI 预构建 UI 和自定义数据提议,只需几分钟即可初始化 TIKI SDK——只需一个构建函数 (交互示例)。
try? TikiSdk.config()
.theme
.primaryTextColor(Color(red: 0.11, green: 0, blue: 0))
.secondaryTextColor(Color(red: 0, green: 0, blue: 0).opacity(0.6))
.primaryBackgroundColor(Color(red: 1, green: 1, blue: 1))
.secondaryBackgroundColor(Color(red: 0.96, green:0.96, blue:0.96))
.accentColor(Color(red: 0, green: 0.7, blue: 0.44))
.fontFamily("SpaceGrotesk")
.and()
.offer
.description("Trade your IDFA (kind of like a serial # for your phone) for a discount.")
.reward("offerImage")
.bullet(text: "Learn how our ads perform ", isUsed: true)
.bullet(text: "Reach you on other platforms", isUsed: false)
.bullet(text: "Sold to other companies", isUsed: false)
.terms("terms")
.ptr("db2fd320-aed0-498e-af19-0be1d9630c63")
.tag(.deviceId)
.use(usecases: [Usecase.attribution])
.permission(Permission.tracking)
.add()
.initialize( publishingId: "<your-publishing-id>", id: "<your-user-id>")
有关样式、选择元数据和设计您提供的详细信息,请查看我们的 📚 SDK 文档 →。
UI 流程
SDK 包含 2 个预构建流程:`present()` 和 `settings()`。使用 `present()` 向用户显示新的数据许可提议。
try TikiSdk.present();
使用 `settings()` 渲染一个 ...设置屏幕 😲,用户可以在其中改变主意并退出现有的许可协议。
try TikiSdk.settings();
贡献
-
使用 GitHub Issues 报告您发现的任何错误或请求增强功能。
-
如果您想与我们的团队合作或其他活跃的贡献者取得联系,请加入我们的 👾 Discord。
-
如果您打算向此项目添加代码,请使用 conventional commits。
项目结构
此项目利用并捆绑 Flutter 引擎来在原生接口和核心库之间创建双向通道。
-
/Sources
:库的主要实现源。 -
/Ui
:声明式 UI 流程和元素(SwiftUI) -
/Resources
和/Media.xcassets
:捆绑,例如图形。 -
/Core
使用 Flutter 引擎与捆绑的 tiki-sdk-dart 库进行双向通信。 -
/Tests
:集成测试。需要设备或模拟器,要运行,请打开Tests.xcodeproj
。 -
/TikiSdkExample
:这是一个简单的示例应用,展示了如何入门配置和添加SDK到基本的iOS应用中。
贡献者 ✨
感谢这些杰出的人们(《emoji key》)
Ricardo Gonçalves 💻 📖 🚧 |
Mike Audi 👀 |
本项目遵循all-contributors规范。欢迎各种类型的贡献!