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

    基础库 1.93.0 开始支持本方法,这是一个异步方法。

    提供小程序获取抖音权限的能力,展示出抖音权限授权弹窗。在使用接口前,除创建粉丝群,其他Scope需要小程序拥有者前往「抖音开放平台控制台」> 应用详情 > 「能力」>「用户数据能力」>「抖音账号数据」页面申请开通小程序需要的权限。

    前提条件
    业务背景
    使用限制
    注意事项
    • Tip:该接口只支持抖音,所以请在抖音 APP 中调用;
    • Tip:每次申请授权的抖音权限必须是在抖音开发平台已经申请并且审批开通的权限,否则会导致本次授权操作失败;
    • Tip:在请求服务端接口时,应用唯一标识在小程序场景下,对应的是小程序 appId;应用唯一标识对应的密钥对应的是小程序的 APP Secret。
    • 增量授权能力已经默认支持,无需在调用时传入 incremental_authorization 。
    • 「抖音开发者工具」模拟器中暂不支持该能力,请使用真机预览调试
    支持沙盒
    相关教程

    语法

    tt.showDouyinOpenAuth(options)

    参数说明

    options 为 object 类型,属性如下:

    属性名类型默认值必填说明最低支持版本
    scopesobject

    需要获取权限的信息。scopes是旧版本参数,目前兼容该字段传入,不推荐使用

    1.93.0
    scopeListArray<string>

    推荐使用该参数,需要获取权限列表,若使用该参数则无需再传入scopes参数。二者同时传入时scopeList优先生效,详情见下方scope说明

    3.5.0
    successfunction
    接口调用成功的回调函数
    1.93.0
    failfunction
    接口调用失败的回调函数
    1.93.0
    completefunction
    接口调用结束的回调函数(调用成功、失败都会执行)
    1.93.0

    scopeList 参数说明

    scope 说明

    能力权限分为以下几个场景,需要满足以下条件:


    1. 场景限制

    每次调用授权时,仅支持授权一种场景的能力,不允许多个场景组合授权,场景和能力合法值见下表。

    场景一:获取抖音账号数据

    Scope名称

    能力名称

    描述

    接口文档

    ma.user.data

    抖音主页数据

    查询近30天该抖音账号的主页数据含点赞、粉丝、评论、分享、主页访问

    获取用户视频情况

    获取用户粉丝数

    获取用户点赞数

    获取用户评论数

    获取用户分享数

    获取用户主页访问数

    场景二:获取抖音视频数据

    Scope名称

    能力名称

    描述

    接口文档

    ma.video.bind

    视频数据查询

    最新1天的查询视频id的基础信息(标题、发布时间等)和实时数据(播放、点赞、评论等)

    查询特定视频的视频数据

    ma.item.data

    近30天视频数据查询

    查询近30天的视频id基础信息(标题、发布时间等)和实时数据(播放、点赞、评论等)

    获取视频基础数据

    获取视频点赞数据

    获取视频评论数据

    获取视频播放数据

    获取视频分享数据

    ma.item.comment

    视频评论数据

    经用户授权后获取其抖音公开视频下的所有评论及评论回复,包含评论内容、评论点赞、评论回复等内容

    评论列表

    评论回复列表

    回复视频评论

    场景三:获取抖音行为数据

    Scope名称

    能力名称

    描述

    接口文档

    apps.task.writeoff_video

    核销视频任务

    核销短视频任务

    核销视频任务

    apps.task.writeoff_live

    核销直播任务

    核销直播任务

    核销直播任务

    注意:此处申请的权限在抖音开放平台必须是已开通状态


    2.数量限制

    单次授权的scope不能超过3个


    scopeList & scopes

    scopeList 与 scopes 选择其中一个即可,新接入的小程序推荐使用 scopeList 。scopes 是历史版本的参数,目前仍能解析该字段,但不再支持设置权限勾选状态,不推荐使用。同时传入二者时 scopeList 优先生效。

    scopes 参数为 object 类型,其中 key 值是申请权限的 scope,value 仅支持 2(非必选,默认不选中)

    说明

    最低支持版本

    0

    必选项(不支持)

    1.93.0

    1

    非必选,默认选中(不支持)

    1.93.0

    2

    非必选,默认不选中

    1.93.0

    回调成功

    object 类型,属性如下:

    属性名类型说明最低支持版本
    errMsgstring

    回调信息

    1.93.0
    ticketstring

    请求授权返回的票据,详情见 ticket 说明

    1.93.0
    grantPermissionsarray

    用户授权的权限

    1.93.0

    ticket 参数说明

    ticket说明

    ticket 是临时票据,即 “开放平台的接口文档” 中获取 access_token 请求参数里的code,是用来获取用户的长期票据 access_token 的。开放平台的授权 流程示意图如下:

    回调失败

    object 类型,属性如下:

    属性名类型说明最低支持版本
    errNonumber

    错误码

    1.93.0
    errMsgstring

    错误信息

    1.93.0

    错误码

    errorCodeerrMsgerrorType说明最低支持版本
    117499scopes is emptyD
    scopes 字段没传或空数组
    1.93.0
    117401login fail onLoginFail failReason:login fail backgroundD
    未登录或登录时不在前台
    1.93.0
    117487feature is not supported in appD
    没有实现协议时
    1.93.0
    117479api scope is not declared in the privacy agreementU
    开启校验且当前 scope 在后台未配置的情况下
    1.93.0
    117490auth denyU
    用户手动拒绝授权
    1.93.0
    117404request auth ticket fail %D
    请求授权票据失败
    1.93.0
    117402request auth code fail , msg = %@, code = %ldD
    授权融合需求后,除了“取消”的所有错误都使用这个,再细分的授权错误码见 errMsg 里的 code
    1.93.0
    117403request auth scope info fail %sD
    请求授权权限信息失败
    1.93.0
    117405no usage scopeD
    没有可用的授权权限(开发者申请授权的权限全部没有被开通权限)
    1.93.0
    117487don't support openPlatform authF
    小程序框架内部错误,有需要请创建工单咨询
    1.93.0

    扫码体验

    请使用字节宿主APP扫码

    代码示例