用户快捷选队

我的收藏

更新记录

时间	更新内容
2024.8.20	创建文档

一、能力说明

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

接入效果：开发者在小玩法后台配置用户快捷选队能力并接入openAPI后，观众可在小摇杆内通过点选按钮快捷加入玩法。

适合玩法：存在2-4个阵营设计的玩法可接入，阵营数量 > 4或无阵营设计的玩法无需接入。

二、接入引导

接入流程

2.1 能力配置

配置项	配置说明	示意图
能力申请	1.开发者可在小玩法后台【能力】-【能力配置】中找到【用户快捷选队】，点击【申请开通】后即可开通能力 2.开通后请点击【配置信息】按钮跳转配置页
快捷选队配置	【必配】选择阵营数量 •开发者可根据玩法内设计，选择：2阵营、3阵营、4阵营，小摇杆将根据该数量展示对应数量的按钮。 •阵营数量需要与玩法设计一致
	【必配】添加Group_ID •每个阵营都需要配置唯一的Group_ID，用户加入玩法后平台将返回该字段，作为用户的加入结果通知开发者。 •如果在【礼物进阶互动效果】中也配置了Group_ID，则不同能力间Group_ID需保持一致，否则将影响包体提审。
	【必配】添加阵营名称 •每个阵营需要配置唯一的阵营名称，最多5个字。 •阵营名称需要与玩法设计一致
	【选配】阵营按钮背景图 •开发者可为小摇杆的选阵营按钮添加一张按钮底图。 •底图设计时，需严格遵循设计规范，否则包体会被拒审： ◦两个按钮底图尺寸、比例、圆角等设计要素需完全一致 ◦按钮底图不可以撰写文字 ◦按钮需要很好的与白色文字、深色背景板有良好的对比度 •正确示范 •错误示范	•设计规范
开发配置	•观众阵营选择数据推送配置 ◦平台将在用户点选阵营按钮后，将选择结果（Group_ID）推送到此处配置的域名
开发配置	•平台查询观众阵营数据配置 ◦平台需查询观众阵营数据，开发者可在【开发】-【开发配置】-【观众阵营数据配置】中录入查询地址

2.2 API接入

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

2.3 能力测试

测试项	配置说明	示意图
openAPI自测	•观众阵营选择数据推送配置 a.配置协议类型及测试数据推送地址 a.选择角色并添加Group_ID后推送 a.开发者可根据返回的推送结果，确定接口调用的状态
openAPI自测	•平台查询观众阵营数据配置 a.配置协议类型及测试数据查询地址 a.选择角色并点击【查询】，平台将向测试地址查询观众阵营数据 a.开发者返回的阵营标识将在查询结果中展示
直播间测试	1.使用真实的抖音账号添加调试成员 2.通过伴侣挂载本地包体，调试成员可在直播间查看小摇杆内的快捷选队按钮 3.玩法上线后，请删除测试账号的调试成员配置注：每个抖音账号仅能添加1个玩法的调试成员，有多个玩法需要调试时，请使用其他抖音号或重新添加调试成员	/

FAQ

Q：开发者服务器收到【观众阵营选择数据】后，是否需要控制用户加入阵营？是否会推送入队的评论指令？

收到【观众阵营选择数据】后，需要控制用户加入阵营。

点击选阵营按钮是一种额外的加入方式，点击后平台不会再次推送评论指令。

Q：没有配置【用户快捷选队】能力时，小摇杆内会怎么展示？

未配置时，小摇杆内仅展示礼物信息。

Q：不同版本的【用户快捷选队】配置会冲突吗？

不会，不同包体版本的【用户快捷选队】配置会对应版本号生效。