抖音开放平台Logo
开发者文档
“/”唤起搜索
控制台

使用注意

    1.setCatalog(设置目录)需要在剧维度变化后及时设置:为避免发生资金损失及信息不对称,插件页不存储用户权益信息,建议开发者在 onChangeEpisode(剧维度变化)后及时更新
    2.返回挽留推荐属于客户端能力,使用前使用tt.canIUse('back-recommend')判断是否可用;

效果展示(完播/Feed流推荐)

备注
功能概述:官方播放器新增「完播推荐」能力,即在某部短剧最后一集观看完毕之后,可推荐其他短剧,支持以下2种类型的推荐方式,详见接口「setRecommendConfig - 设置推荐位」
    平台策略模型自动推荐
    开发者自行同步需要推荐的短剧
    完播推荐位默认关闭,开发者可通过推荐位控制接口打开
    推荐位样式同正常短剧播放器样式,开发者可在推荐位出现前增加文案引导
实验效果:平台内部针对「开发者自行设置推荐剧目」、「平台模型自动推荐」2种场景进行效果分析,结果显示:
    使用推荐位较不使用推荐位,小程序停留时长+0.0122%、次均内流vv+1.43%、订单GMV+0.0552%,均有正向提升
    平台推荐位较开发者自推荐位,小程序停留时长+0.0915%、流量主广告收入+0.038%上更有优势
视频第8-20s:未配置setRecommendConfig(推荐信息)时,短剧插件页行为不变,以demo为例:
第1集时无法向上滑动,第76集时无法向下滑动
视频第27s:点击demo case,设置推荐视频为:第一部第一集,代码示例:
setRecommendConfig({ entryType: 1 , switchStatus: true, data:{ albumId: '7349101834553786889', // 请使用自己的剧ID seq: 1 } })
视频第33s:滑动至目标剧集;
注:发生剧维度切换后,需要开发者重新调用setCatalog进行剧集设置,否则会如38s所示,为避免发生资损,全部剧集默认加锁;
视频第42s:继续上划可返回至上一部剧,返回后需要再次重新调用setCatalog进行剧集设置;

效果展示(挽留推荐)

    1.功能概述:官方播放器新增「左上角返回按钮可配置推荐剧」能力,即支持开发者在小程序左上角返回按钮位置设置推荐位,如开发者启用返回按钮的短剧推荐位,则用户点击「返回」后,展示推荐剧卡片
    2.功能说明:详见接口「setRecommendConfig - 设置推荐位」
    a.配置开关:支持开发者可自行配置是否启动「返回按钮」的推荐位
    b.短剧推荐方式:支持开发者配置平台推荐或自行推荐,如选择自行推荐需传入推荐位数据(若开启推荐位且选择自行推荐位,传入推荐剧数量建议≥6,如果不传默认平台推荐剧兜底)
    c.推荐卡片:样式由平台设计
代码示例:
// 使用前使用tt.canIUse('back-recommend')判断是否可用 setRecommendConfig({ entryType: 2 , data:[{ albumId: '7349101834553786889', // 请使用自己的剧ID seq: 1 }, { albumId: 'xxx', seq: 1 }] })
代码调用时机与完播(Feed流)推荐一致;
触发时机存在差异:
    1.Feed流推荐触发时机是:最后一集完播
    2.挽留推荐触发时机是:用户点击左上角返回

代码实现

setRecommendConfig - 设置推荐位

开发者主动设置推荐位信息

语法

this.template.setRecommendConfig()

参数说明

属性名
类型
默认值
必填
说明
entryType
number
1
推荐位类型
    1.Feed流推荐
    2.挽留推荐
switchStatus
boolean
true
是否开启
data
FeedRecommendData | FeedRecommendData[]
推荐位数据,不填则划到底部后走系统推荐,推荐数据格式错误会发生报错
    1.Feed流推荐完播后去往下一集,需要填写一个对象;
    2.挽留推荐会推荐多部剧,需要填写一个数组;

FeedRecommendData

属性名
类型
默认值
必填
说明
albumId
string
推荐剧
seq
number
推荐集

EnteyType

说明
1
Feed 流推荐,最后一集完播、下滑,可跳转至推荐剧集
2
挽留推荐,点击左上角返回,弹窗展示多部推荐剧集,用户点击后可跳转推荐剧集;

返回值

使用示例

this.template.setRecommendConfig({ entryType: 1 | 2 | 3, // 槽位,当前仅1、2可用 switchStatus: true | false, data: {} | [{ }] });