Next14 CMP for iOS
要求
Next14 CMP SDK需要一个iOS 11.0或更高版本的部署目标。以下架构得到支持:设备上的arm64,iOS模拟器上的i386和x86_64。还支持Bitcode。
安装
- 将以下内容添加到Podfile中
pod 'Next14CMP', '~> 2.0.0'
- 在包含Podfile的目录中运行以下命令以安装Pod
$ pod install
更多关于CocoaPods的详细信息请点击这里。
如何使用
初始化
Next14 CMP SDK 需要在启动时检索配置,这些配置包含向用户展示同意屏幕所需的所有数据。
初始化通过 start
方法来完成。
CMP.shared.start(apiKey: "<YOUR API KEY>", settings: customSettings) { result in
if case .success(_) = result {
print("Configurations downloaded successfully")
}
}
参数
参数 | 说明 | 必需 |
---|---|---|
apiKey | CMP平台上的应用唯一标识符 | 是 |
settings | 用于自定义SDK行为的附加设置 | 否 |
CMPSettings
参数 | 说明 | 默认 |
---|---|---|
consentPreferenceValidityDays | 自用户上次同意之日起的天数,之后再次向用户展示同意请求 | 180 |
显示同意屏幕
SDK初始化后,应用程序应调用 shouldPresentCMP
方法检查是否需要向用户展示同意屏幕,如果是的话,应调用 present
方法。
present
方法接受一个可选的 onComplete:
回调,当用户表达了他的同意且同意UI已完全关闭时会被调用。
if (CMP.shared.shouldPresentCMP()) {
CMP.shared.present(from: self) {
// The user has expressed his consent
}
}
CMPSdk.present 参数
参数 | 说明 | 必需 |
---|---|---|
from | 展示 UIVERIFYController | 是 |
gdprApplies | GDPR是否适用于当前用户 | 否 |
onComplete | 可选回调,用于通知当同意屏幕关闭时 | 否 |