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

    绑定侧边栏复访福利活动并返回已配置的复访福利活动信息

    前提条件

    请确认已通过开发者平台控制台中或通过 OpenAPI 创建小程序券模板和小程序营销活动,接入方式详见:侧边栏复访营销

    业务背景
    使用限制

    暂不支持抖音开发者工具调试,真机调试请参考小程序线上调试彩蛋

    注意事项

    该能力需要开发者前置在控制台或通过 openapi 创建复访营销活动并且复访营销活动的引流方式需要为小程序内组件调用,弹窗样式需要选择自定义样式,才可进行调用,具体申请流程可参考>>小程序券创建流程小程序营销活动创建流程

    支持沙盒
    相关教程

    语法

    SceneActivityContext.bind(options)

    参数说明

    options 为 object 类型,属性如下:

    属性名类型默认值必填说明最低支持版本
    activityIdstring
    • 需要绑定侧边栏复访福利活动 id,若活动 id为空字符串, 基础库侧将默认选择最后创建的活动。
    • 营销活动 id:使用 OpenAPI  创建营销活动 或在小程序控制台-运营-营销-营销活动-复访营销中创建。
    • 查询活动id:使用 SceneActivityContext.query 查询、或在小程序控制台-运营-营销-营销活动-复访营销中查询。
    • 若小程序无有效活动,将会返回失败。
    3.27.0
    successfunction
    接口调用成功的回调函数
    3.27.0
    failfunction
    接口调用失败的回调函数
    3.27.0
    completefunction
    接口调用结束的回调函数(调用成功、失败都会执行)
    3.27.0

    回调成功

    object 类型,属性如下:

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

    主标题

    3.27.0
    subTitlestring

    副标题

    3.27.0
    imageUrlstring

    封面图片

    3.27.0
    leftButtonTextstring

    关闭按钮文案

    3.27.0
    rightButtonTextstring

    引导标题文案

    3.27.0
    extrastring

    福利信息

    3.27.0
    errMsgstring
    "SceneActivityContext.bind:ok"
    3.27.0

    回调失败

    object 类型,属性如下:

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

    错误码

    errNoerrMsg说明最低支持版本
    21001ActivityContext.bind:fail activity does not exist

    营销复访活动不存在,请先查阅《小程序营销活动创建流程

    3.27.0
    21011ActivityContext.bind:fail invalid activity

    无效活动id 或者 营销复访活动已失效

    3.27.0
    21021already in the sidebar scene, do not repeat boot

    用户已在侧边栏场景下访问,请勿重复引导复访

    3.27.0

    扫码体验

    请使用字节宿主APP扫码

    代码示例

    开发者工具中预览

    <view class="container"> <view class="body-space"> <view tt:if="{{canShowRelation}}" class="page-section"> <view class="title">请在非侧边栏场景下调用</view> <button class="button-group" type="primary" bindtap="bind">关联侧边栏复访福利</button> <button tt:if="{{relationResult}}" type="primary" bindtap="jump">跳转</button> </view> </view> </view>
    Page({ activityContext: undefined, data: { canShowRelation: false, relationResult: '', }, onLoad() { this.activityContext = tt.createSceneActivityContext(); }, onShow() { this.setData({ canShowRelation: this.activityContext.checkScene({ scene: 'bind', }), }); }, bind() { const canRelation = this.activityContext.checkScene({ scene: 'bind', }); if (!canRelation) { tt.showToast({ title: '请在非侧边栏场景下使用', }); return; } this.activityContext.bind({ activityId: '', success: (res) => { if (res.mainTitle) { console.log('关联侧边栏福利成功', res); tt.showToast({ title: '关联侧边栏福利成功', }); this.setData({ relationResult: JSON.stringify(res), }); } }, fail: (err) => { console.log('关联侧边栏福利失败', err); tt.showToast({ title: '关联侧边栏福利失败', icon: 'none', }); }, }); }, jump() { this.activityContext.jump({ fail(e) { console.log('跳转失败', e); }, }); }, });