抖音开放平台Logo
控制台

tt.updateSidebarActivity
收藏
我的收藏

​基础库 3.26.0 开始支持本方法，低版本需做兼容处理，这是一个异步方法​
实时更新侧边栏活动的圈选用户，将用户和特定侧边栏活动绑定或解绑。详细产品功能见侧边栏复访营销​

​语法​

JavaScript
复制
tt.updateSidebarActivity(options)

​参数说明​

options 为 object 类型，属性如下：​
​属性名​
​类型​
​默认值​
​必填​
​说明​
​最低支持版本​
type​
string​
​
是​
add：将用户绑定到侧边栏活动​
​remove ：将用户与侧边栏活动解绑​
3.26.0​
activity​
string​
​
是​
需要圈选用户的侧边栏活动 id​
​创建活动id：使用 OpenAPI 创建营销活动 或在小程序控制台-运营-营销-营销活动-复访营销中创建。​
​查询活动id：使用 JsAPI tt.getSidebarActivity、或在小程序控制台-运营-营销-营销活动-复访营销中查询。​
3.26.0​
​success​
​function​
​​
​否​
​接口调用成功的回调函数​
​3.26.0​
​fail​
​function​
​​
​否​
​接口调用失败的回调函数​
​3.26.0​
​complete​
​function​
​​
​否​
​接口调用结束的回调函数（调用成功、失败都会执行）​
​3.26.0​

​回调成功 ​

​object 类型，属性如下：​
属性名​
类型​
说明​
最低支持版本​
errMsg​
string​
"updateSidebarActivity:ok"​
​3.26.0​
logId​
string​
请求的唯一标识​
​3.26.0​

​回调失败 ​

​object 类型，属性如下：​
属性名​
类型​
说明​
最低支持版本​
errMsg​
string​
"updateSidebarActivity:fail " + 详细错误信息​
​3.26.0​
errNo​
number​
错误码​
​3.26.0​
logId​
string​
请求的唯一标识​
​3.26.0​

​错误说明​

​errNo​
errMsg​
说明​
最低支持版本​
20000 ​
"updateSidebarActivity:fail expect params.activity to be should be string but got xx" ​
参数类型错误 ​
​3.26.0​
20000 ​
"updateSidebarActivity:fail expect params.type to be one of "add", "remove"，but got xx“ ​
参数类型错误 ​
​3.26.0​
10602 ​
"updateSidebarActivity:fail login canceled by user" ​
用户未登录 ​
​3.26.0​
21100 ​
"updateSidebarActivity:fail activity not exist" ​
activity不存在 ​
​3.26.0​
21101​
"updateSidebarActivity:fail user already has locked welfare" ​
用户在该小程序已有绑定福利​
​3.26.0​
21102​
"updateSidebarActivity:fail server error" ​
服务端错误 ​
​3.26.0​
10401 ​
"updateSidebarActivity:fail internal error" ​
内部错误 ​
​3.26.0​

​扫码体验​

​代码示例​

​开发者工具中预览​
JavaScript
复制
tt.updateSidebarActivity({
type: 'add',
activity: '7361703755663835xxx', // 替换为小程序生效中的侧边栏活动id
success: function(data) {
console.log(data)
},
fail: function(data) {
console.log(data)
}
})

​Bug & Tip​

​开发者工具暂不支持触发侧边栏活动，请使用真机调试。​