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

    收藏
    我的收藏

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

    获取生效中侧边栏活动 id 列表,可结合 tt.navigateToScene 一起使用。

    前提条件
    业务背景
    使用限制
    支持宿主:抖音
    注意事项
    支持沙盒
    相关教程

    语法

    tt.getSidebarActivity(options)

    参数说明

    options 为 object 类型,属性如下:

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

    回调成功

    object 类型,属性如下:

    属性名类型说明最低支持版本
    errMsgstring
    "getSidebarActivity:ok"
    3.6.0
    activityListarray
    生效中活动 id 数组
    3.6.0

    回调失败

    object 类型,属性如下:

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

    错误码

    errorCodeerrMsgerrorType说明最低支持版本
    172991server errorF
    小程序框架内部错误,有需要请创建工单咨询
    3.6.0

    扫码体验

    请使用字节宿主APP扫码

    代码示例

    开发者工具中预览

    tt.getSidebarActivity({ success: (data) => { if (data.activityList.length) { tt.navigateToScene({ scene: 'sidebar', activity: data.activityList[0], // 获取到生效中的id,用于调用 tt.navigateToScene success: (data) => { console.log(data) }, fail: (data) => { console.log(data) } }) } } })