• JS API 列表
  • 基础
  • TTML
  • 网络
  • 媒体
  • 地图
  • 文件
  • 数据缓存
  • 地理位置
  • 设备
  • 画布
  • 界面
  • 页面导航
  • 开放接口
  • 登录
  • 用户信息
  • 广告
  • 支付
  • 分享
  • 小程序跳转
  • 抖音视频能力
  • 收货地址
  • 设置
  • 授权
  • 评价能力
  • 数据分析
  • 视频拍摄器
  • 引导关注
  • 订阅消息
  • 电商插件能力(即将废弃)
  • 流量来源识别
  • 隐私信息授权
  • tt.requirePrivacyAuthorize
  • tt.openPrivacyContract
  • tt.onNeedPrivacyAuthorization
  • tt.getPrivacySetting
  • web化
  • 转发和挂载
  • 侧边栏能力
  • 直播能力
  • AI/AR能力
  • 安全能力
  • 行业开放
  • 第三方平台
  • 其它
  • tt.requirePrivacyAuthorize

    收藏
    我的收藏

    基础库 3.19.0 开始支持本方法,低版本需做兼容处理,这是一个异步方法。

    模拟隐私接口调用,并触发隐私弹窗逻辑。隐私合规开发指南详情可见 《小程序隐私协议开发指南》​

    前提条件
    业务背景
    使用限制

    抖音开发者工具 4.2.3 及以上开始支持此能力调试

    注意事项

    调用 tt.requirePrivacyAuthorize() 时:​

    • ​如果用户之前已经同意过隐私授权,会立即进入 success 回调,不会触发 tt.onNeedPrivacyAuthorization 事件​
    • 如果用户之前没有授权过,并且开发者注册了 tt.onNeedPrivacyAuthorization 事件监听,就会立即触发 tt.onNeedPrivacyAuthorization 事件,然后开发者在 onNeedPrivacyAuthorization 回调中弹出自定义隐私授权弹窗,用户点了同意后开发者调用 tt.onNeedPrivacyAuthorization 的回调接口 resolve({ event: 'agree', buttonId: 'agree-btn' }),会触发 requirePrivacyAuthorize 的 success 回调。开发者调用 tt.onNeedPrivacyAuthorization 的回调接口 resolve({ event: 'disagree' }) 的话,会触发 requirePrivacyAuthorize 的 fail 回调。​
    • 基于上述特性,开发者可以在调用任何真实隐私接口之前调用 tt.requirePrivacyAuthorize 接口来模拟隐私接口调用,并触发隐私弹窗逻辑。​
    支持沙盒
    相关教程

    语法

    tt.requirePrivacyAuthorize(options)

    参数说明

    options 为 object 类型,属性如下:

    属性名类型默认值必填说明最低支持版本
    successfunction
    接口调用成功的回调函数
    3.19.0
    failfunction
    接口调用失败的回调函数
    3.19.0
    completefunction
    接口调用结束的回调函数(调用成功、失败都会执行)
    3.19.0

    回调成功

    object 类型,属性如下:

    属性名类型说明最低支持版本
    errMsgstring
    "requirePrivacyAuthorize:ok"
    3.19.0

    回调失败

    object 类型,属性如下:

    属性名类型说明最低支持版本
    errMsgstring
    "requirePrivacyAuthorize:fail" + 详细错误信息
    3.19.0

    错误码

    errorCodeerrMsgerrorType说明最低支持版本
    168680requirePrivacyAuthorize:fail privacy permission is not authorizedU
    隐私协议未授权

    用户未授权隐私协议,请引导用户按需授权

    3.19.0
    168691requirePrivacyAuthorize:fail Internal error: no api callbackF
    小程序框架内部错误,有需要请拉客服咨询

    小程序框架异常,请创建工单反馈,会有专人协助您解决问题

    3.19.0
    168679requirePrivacyAuthorize:fail api scope is not declared in the privacy agreementD
    隐私能力不在申请的 scope 内

    检查隐私协议

    3.19.0

    扫码体验

    请使用字节宿主APP扫码

    代码示例

    开发者工具中预览

    tt.requirePrivacyAuthorize({ success(res) { console.log('requirePrivacyAuthorize 调用成功'); }, fail(res) { console.log('requirePrivacyAuthorize 调用失败:', res); }, });