TIKI SDK (iOS) —消费者数据许可
TIKI SDK为iOS应用添加消费者数据许可提供简单易用的接口。它是用户交互以接受(或拒绝)数据许可提议的客户端组件。TIKI SDK通过加密散列创建不可变的、数字签名的许可记录,形成一个审计跟踪。使用开发者友好的数据结构和API,在客户端或服务器端程序化地消耗记录和强制实施条款。
这个库包括可配置的预构建UI流程/组件,以及用于构建自定义体验的原生低级API。
安装
注意:在开始之前,您需要一个发布ID。创建一个ID是免费的;只需登录到我们的🧑💻 开发者控制台并创建一个新项目。
添加Swift Package存储库(此存储库):https://github.com/tiki/tiki-sdk-ios
如果您不熟悉Swift Package Manager,请查看Apple的说明。
- 如果您以调试模式运行并打算使用模拟器,那么您已经准备就绪。
- 如果您**准备好部署发布版本**,请将存储库设置为最新发布版本。截至本书编写,为2.0.3,但请确保检查注册。我们经常发布。
就是这样。是的,真的这么简单。
初始化
使用TIKI预构建UI和自定义数据提议,在几分钟内初始化TIKI SDK ——只需要1个构建函数(交互示例)。
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();
贡献
项目结构
该项目利用并捆绑了Flutter引擎,在原生界面和核心库之间创建双向通道。
/Sources
: 库的主要实现源。/Ui
: 声明式 UI 流程和元素(SwiftUI)。/Resources
和/Media.xcassets
:捆绑资源,如图形。/Core
与捆绑的tiki-sdk-dart库双向通信,使用Flutter Engine。
/Tests
: 集成测试。需要设备或模拟器,打开Tests.xcodeproj
运行。/TikiSdkExample
: 简单示例应用程序,展示如何开始配置并添加 SDK 到基本 iOS 应用中。
贡献者 ✨
感谢这些可爱的人(表情符号键)
Ricardo Gonçalves 💻 📖 🚧 |
Mike Audi 👀 |
本项目遵循all-contributors规范。欢迎各种形式的贡献!