礼物进阶互动效果

我的收藏

更新记录

时间	更新内容
2024.7.16	创建文档

一、能力说明

【小摇杆】功能介绍
•2024年8月6日起，直播小玩法的【小魔盒】将会升级为【小摇杆】
•【小摇杆】将承载多种互动组件，对于观众可降低玩法参与门槛和理解成本，对于开发者可提升直播间与玩法的结合度，并增加玩法的设计空间

接入效果：开发者在小玩法后台配置【礼物进阶互动效果】能力并接入openAPI后，观众可在小摇杆内查看礼物效果、组刷礼物。

适合玩法：礼物及效果描述为必接能力，组刷可根据玩法设计选接。

展示礼物效果

一键批量送礼

二、接入引导

接入流程

2.1 能力配置

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

2.2 API接入

能力名称	接入指引	能力作用
【必选】同步对局状态	API接口调用顺序、API接口明细请参考：【技术接入指南】礼物进阶互动效果	开发者在对局开始时调用，同步对局开始事件；在对局结束时再次调用，同步对局结束事件。
【必选】上报阵营数据		观众通过评论、点赞、送礼等方式加入玩法时，调用该接口上报当前观众的阵营数据。
【必选】查询观众阵营数据		查询观众当前阵营数据，在观众进入直播间打开小摇杆互动面板时，平台服务器请求该接口获取用户在指定直播间最新的阵营数据。

2.3 能力测试

测试项	配置说明	示意图
openAPI自测	•开发者可在【开发】-【自查工具】-【openAPI自测工具】-【查询观众阵营数据】中录入测试地址 •点击【查询】后，平台将向测试地址查询观众阵营数据，开发者返回的阵营标识将在查询结果中展示
直播间测试	•礼物进阶效果配置通过审核后将在小摇杆内展示，可在线上环境确认表现 •通过直播伴侣挂载本地包体时，小摇杆内将展示最近一次通过审核的礼物配置	/

FAQ

Q：配置【礼物进阶互动效果】后，还需要保留玩法内的规则贴纸吗？

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

Q：没有配置【礼物进阶互动效果】时，小摇杆内会什么都不展示吗？

不会，开发者未配置【礼物进阶互动效果】时，小摇杆会兜底展示包体上传时的礼物配置信息。

由于字数限制，兜底效果可能不佳，请开发者尽快完成【礼物进阶互动效果】配置。

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

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

Q：【礼物进阶互动效果】会和原本的礼物配置冲突吗？

不会，配置【礼物进阶互动效果】后将替换原本的礼物配置，包体上线后将展示最新的【礼物进阶互动效果】。