抖音开放平台Logo
开发者文档
控制台
  • API 概览
  • 开放能力
  • 登录
  • 社交转发裂变
  • 用户信息及授权
  • 小游戏收藏
  • 群聊
  • 关注
  • 游戏互推组件
  • 添加到桌面
  • 游戏排行榜
  • 数据分析
  • 视频拍摄器
  • 订阅消息
  • 关系链
  • 客服能力
  • 侧边栏能力
  • 推荐流直出游戏能力
  • tt.requestFeedSubscribe
  • tt.checkFeedSubscribeStatus
  • 基础
  • 渲染
  • 设备
  • 文件
  • 位置
  • 媒体
  • 网络
  • 游戏转发分享
  • 实时语音
  • 数据缓存
  • 系统
  • 广告
  • 界面
  • 支付
  • Worker
  • 基础库 3.34.0 开始支持本方法,这是一个异步方法。

    向用户请求授权,允许游戏在满足一定的条件后出现在 Feed 流中

    前提条件
    已申请开通小游戏直玩能力,在申请开通后可以获得 contentID
    业务背景
    1. 游戏供给更加偏向中重度,因此以游戏内的「关键节点」为高价值信息牵引用户复访成为效率更高的一种手段;
    2. 业务侧期望,发挥小游戏的即点即玩特性,且整体无限贴合抖音:刷、推信息本身的体验,尝试为用户提供一种新型的小游戏游玩体验;
    使用限制
    1. 必须在调用 tt.login 后才能调用本接口。
    2. 本接口存在频控限制,需要注意调用场景和频率。
    3. 全场景订阅(allScene 为 true)必须要由用户点击触发,也就是只能在 tt.onTouchEnd 的回调里面同步调用该 API。
    注意事项
    相关教程

    语法

    tt.requestFeedSubscribe(options)

    参数说明

    options 为 object 类型,属性如下:

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

    订阅的场景 ID(非全场景下必传)

    3.34.0
    contentIDsArray<string>

    Array<string>,自定义文案 contentID 数组(非全场景下必传),contentID 在后台申请开通直玩能力后可获取

    3.34.0
    allScenebooleanfalse

    是否为全场景订阅

    3.45.0
    typeenum

    订阅 Feed 流的类型,目前只支持传 'play'

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

    scene 参数说明

    说明

    1

    离线收益场景

    2

    体力恢复场景

    3

    重要事件掉落

    type 的合法值

    说明最低支持版本
    play

    直玩场景

    3.34.0

    回调成功

    object 类型,属性如下:

    属性名类型说明最低支持版本
    errMsgstring
    "requestFeedSubscribe:ok"
    3.34.0
    successboolean

    用户的订阅结果(true 为成功,false 为订阅失败,具体原因看 errMsg)

    3.34.0

    回调失败

    object 类型,属性如下:

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

    错误码

    errNoerrMsg说明最低支持版本
    10301feature is not supported in app
    宿主不支持该功能
    3.34.0
    21100host does not have permission
    该app未开通该能力
    3.34.0
    21101no permission
    该游戏没有订阅权限
    3.34.0
    10601not login
    需要调用tt.login登录
    3.34.0
    20001params contentIDs or scene is required
    参数错误
    3.34.0
    21102network error
    网络环境问题,一般指无网环境
    3.34.0
    21103service error:具体错误信息
    网络请求失败
    3.34.0
    21104internal error:具体错误信息
    弹窗跳转失败等
    3.34.0
    21105frequency control
    频控限制
    3.34.0
    21500must be invoked by user gesture

    交互类型限制,全场景订阅必须由玩家点击触发

    在 tt.touchEnd 回调内调用该接口

    3.45.0

    扫码体验

    请使用字节宿主APP扫码

    代码示例

    开发者工具中预览

    发起单场景订阅

    tt.requestFeedSubscribe({ type: "play", scene: 1, contentIDs: ["CONTENT123", "CONTENT234"], success(res) { console.log(res.success) }, fail(res) { console.log(res.errMsg) }, })

    发起全场景订阅

    tt.requestFeedSubscribe({ type: "play", allScene: true, success(res) { console.log(res.success) }, fail(res) { console.log(res.errMsg) }, })