抖音开放平台Logo
开发者文档
控制台

tt.createLiveCard
收藏
我的收藏

基础库 3.41.0 开始支持本方法,这是一个异步方法。

创建一个玩法卡片。

前提条件
业务背景
使用限制

一个互动工具小程序内最多只能创建一个玩法卡片。

注意事项
支持沙盒
相关教程

语法

tt.createLiveCard(options)

参数说明

options 为 object 类型,属性如下:

属性名类型默认值必填说明最低支持版本
urlstring
创建的玩法卡片路径,支持绝对路径和相对路径,路径后可以带参数,参数与路径之间使用 ? 分隔,参数键与参数值用 = 相连,不同参数用 & 分隔,如 "path?key=value&key2=value2"
3.41.0
widthnumber
玩法卡片的初始宽度,单位 px
3.41.0
heightnumber
玩法卡片的初始高度,单位 px
3.41.0
successfunction
接口调用成功的回调函数
3.41.0
failfunction
接口调用失败的回调函数
3.41.0
completefunction
接口调用结束的回调函数(调用成功、失败都会执行)
3.41.0

回调成功

object 类型,属性如下:

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

返回一个 CardContext 对象

3.41.0
errMsgstring

"createLiveCard:ok"

3.41.0

回调失败

object 类型,属性如下:

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

"createLiveCard:fail " + 错误信息

3.41.0

代码示例

tt.createLiveCard({ url: '/live-card/card', width: 300, height: 300, success: (res) => { console.log('调用成功:', res.cardContext); }, fail: (res) => { console.log('调用失败:', res); }, })