TIKI SDK (iOS) —消费者数据许可
TIKI SDK 为 iOS 应用程序提供了添加消费者数据许可的简便方法。它是用户将互动以接受(或拒绝)数据许可要约的客户端组件。TIKI 的 SDK 使用加密散列创建不可变、数字签名的许可记录,形成审计跟踪。使用针对开发人员友好的数据结构和 API 以编程方式消费记录并对客户端或服务器端的条款进行管理。
该库包括可配置的预构建 UI 流程/元素和原生低级 API,用于构建自定义体验。
开始使用我们的 📚 SDK 文档,或直接进入 📘 API 参考。
安装
注意:在您开始之前,您需要一个发布 ID。创建一个免费的 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 —只需 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();
贡献
-
使用 GitHub Issues 报告您发现的任何错误或请求改进。
-
如果您想与本团队或其他活跃的贡献者取得联系,请加入我们的 👾 Discord。
-
如果您打算向本项目添加代码,请使用 常规提交。
项目结构
该项目利用和捆绑 Flutter 引擎在原生界面和核心库之间创建双向通道。
-
/Sources
:库的主要实现源。 -
/Ui
:声明性 UI 流程和元素(SwiftUI) -
/Resources
&/Media.xcassets
:捆绑,如图形。 -
/Core
:使用 Flutter 引擎 与捆绑的 tiki-sdk-dart 库进行双向通信。 -
/Tests
:集成测试。需要一个设备或仿真器,打开Tests.xcodeproj
来运行。 -
/TikiSdkExample
:一个简单的示例应用程序,展示如何入门配置添加SDK到基本的iOS应用程序。
贡献者 ✨
以下这些优秀的人士的贡献(表情符号键)表示感谢
里卡多·贡卡尔维斯 💻 📖 🚧 |
迈克·奥迪 👀 |
此项目遵循所有贡献者规范。欢迎任何形式的贡献!