tt.showDouyinOpenAuth
收藏我的收藏
基础库 1.93.0 开始支持本方法,这是一个异步方法。
提供小程序获取抖音权限的能力,展示出抖音权限授权弹窗。在使用接口前,除创建粉丝群,其他Scope需要小程序拥有者前往「抖音开放平台控制台」> 应用详情 > 「能力」>「用户数据能力」>「抖音账号数据」页面申请开通小程序需要的权限。
语法
tt.showDouyinOpenAuth(options)
参数说明
options 为 object 类型,属性如下:
属性名 | 类型 | 默认值 | 必填 | 说明 | 最低支持版本 |
---|---|---|---|---|---|
scopes | object | 是 | 需要获取权限的信息。scopes是旧版本参数,目前兼容该字段传入,不推荐使用 | 1.93.0 | |
scopeList | Array<string> | 是 | 推荐使用该参数,需要获取权限列表,若使用该参数则无需再传入scopes参数。二者同时传入时scopeList优先生效,详情见下方scope说明 | 3.5.0 | |
success | function | 否 | 接口调用成功的回调函数 | 1.93.0 | |
fail | function | 否 | 接口调用失败的回调函数 | 1.93.0 | |
complete | function | 否 | 接口调用结束的回调函数(调用成功、失败都会执行) | 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 类型,属性如下:
属性名 | 类型 | 说明 | 最低支持版本 |
---|---|---|---|
errNo | number | 错误码 | 1.93.0 |
errMsg | string | 错误信息 | 1.93.0 |
错误码
errorCode | errMsg | errorType | 说明 | 最低支持版本 |
---|---|---|---|---|
117499 | scopes is empty | D | scopes 字段没传或空数组 | 1.93.0 |
117401 | login fail onLoginFail failReason:login fail background | D | 未登录或登录时不在前台 | 1.93.0 |
117487 | feature is not supported in app | D | 没有实现协议时 | 1.93.0 |
117479 | api scope is not declared in the privacy agreement | U | 开启校验且当前 scope 在后台未配置的情况下 | 1.93.0 |
117490 | auth deny | U | 用户手动拒绝授权 | 1.93.0 |
117404 | request auth ticket fail % | D | 请求授权票据失败 | 1.93.0 |
117402 | request auth code fail , msg = %@, code = %ld | D | 授权融合需求后,除了“取消”的所有错误都使用这个,再细分的授权错误码见 errMsg 里的 code | 1.93.0 |
117403 | request auth scope info fail %s | D | 请求授权权限信息失败 | 1.93.0 |
117405 | no usage scope | D | 没有可用的授权权限(开发者申请授权的权限全部没有被开通权限) | 1.93.0 |
117487 | don't support openPlatform auth | F | 小程序框架内部错误,有需要请创建工单咨询 | 1.93.0 |