直播间礼物互动能力

我的收藏

一、能力介绍

功能点	实现效果	示意
设置玩法专属礼物	1.被选中的专属礼物会展示在直播间【小摇杆】及【礼物面板】中，用户能够发送相应的礼物。 2. 用户发送礼物后，平台将向开发者推送用户送礼数据。
设置礼物效果描述	1.礼物效果描述将展示在直播间【小摇杆】中，便于用户理解送礼效果，提升送礼转化
设置礼物组刷	1.开发者可依据玩法设计，自行设定组刷的数量及对应的效果，用户可在【小摇杆】内一键组刷

二、接入流程

能力申请

◦

登录开发者平台控制台。

◦

在「我的应用」页面中点击「直播小玩法」，然后在「直播小玩法」页签中点击已创建的应用。

◦

在应用详情页面左侧导航栏选择「能力」-「基础互动能力」，选择「直播间礼物互动能力」并点击「申请开通」。

能力配置

配置项	配置说明	示意图
能力申请	1.开发者可在小玩法后台【能力】-【能力配置】中找到【礼物进阶互动效果】，点击【申请开通】后即可开通能力 2.开通后请点击【配置信息】按钮跳转配置页
能力配置	添加礼物 •开发者可在礼物菜单中选择要使用的礼物，最多支持添加8种不同的礼物 •添加的礼物将展示在小摇杆互动区域内
	添加礼物描述 •开发者可配置送出礼物后对应的效果描述，最多允许输入 5 个字 •如：送出甜甜圈召唤小兵，可配置为：召唤小兵
	添加礼物数量 •每种礼物的保底数量 = 1 •开发者可根据玩法设计，配置多种礼物数量及对应的效果，当礼物数量 > 1时，小摇杆内将展示组刷区域以支持用户一键批量送礼 •如：送出66个甜甜圈召唤超级小兵，可配置为：礼物数量 = 66，礼物效果为“超级小兵”
	礼物效果区分阵营 •礼物效果支持区分阵营配置，最多支持区分4个阵营 •如果玩法内不同阵营具有不同的礼物效果，开发者可在【礼物效果是否区分阵营】中选择【是】，并对应阵营来配置礼物信息 •区分阵营时，开发者必须添加group_id的参数名，并在用户加入玩法时上报到平台，平台将根据该字段向用户展示对应礼物效果 •如果在其他能力中也配置了Group_ID，则不同能力间Group_ID需保持一致，否则将影响包体提审。
配置审核	•礼物进阶互动配置必须与包体内容一致。开发者完成上述配置并接入能力后，需上传新的包体 •在包体上传流程中，礼物进阶互动配置将替换原礼物配置，并与包体内容同步审核 •新包体上线后，配置信息将对应包体版本同步生效
观众阵营数据配置	•平台需查询观众阵营数据，开发者可在【开发】-【开发配置】-【观众阵营数据配置】中录入查询地址

三、接口列表

获取礼物数据

详见：数据开放

API 名称	API 描述
获取access_token	该接口用于获取开放能力接口的调用凭证 access_token
启动任务	启动直播间数据推送，启动成功后，直播间数据才会同步推送给开发者服务器
停止任务	停止直播间数据推送成功后，抖音平台会等停止前产生的存量数据推送完成，然后停止推送新数据
查询任务状态	抖开提供接口给开发者查询推送任务状态
分页查询推送失败数据(仅支持礼物数据)	开发者可以定时请求api分页查询推送失败的数据
弹幕数据上报	服务端推送直播间内特定礼物的数据，设计玩法内交互，如赠送礼物可获得武器加成，支持对局数据上报

分阵营展示礼物

详见：礼物进阶互动效果

API 名称	API 描述
同步对局状态	开发者在对局开始时调用，同步对局开始事件；在对局结束时再次调用，同步对局结束事件。
上报阵营数据	观众通过评论、点赞、送礼等方式加入玩法时，调用该接口上报当前观众的阵营数据。
查询观众阵营数据	查询观众当前阵营数据，在观众进入直播间打开小摇杆互动面板时，平台服务器请求该接口获取用户在指定直播间最新的阵营数据。

FAQ

Q：添加礼物效果描述后，还需要保留玩法内的规则贴纸吗？

需要，玩法内依然需要设置贴纸向观众展示规则。

Q：上传新包体后，旧版本的礼物配置后受影响吗？

不会，礼物配置会和包体版本对应生效。