用户战绩与排行榜

我的收藏

更新记录

时间	更新内容
2024.7.16	创建文档
2024.8.7	添加榜单与用户数据的FAQ介绍。

一、能力说明

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

接入效果：开发者在小玩法后台配置【用户战绩与排行榜】能力并接入openAPI后，观众可在小摇杆内查看单局榜、总榜及历史战绩。

适合玩法：存在榜单设计的玩法可接入。

小摇杆内展示总榜排名

用户单局榜

用户总榜

用户历史对局

二、接入引导

2.1 能力配置

配置项	配置说明	示意图
能力申请	1.开发者可在小玩法后台【能力】-【能力配置】中找到【用户战绩与排行榜】，点击【申请开通】后即可开通能力 2.开通后请点击【配置信息】按钮跳转配置页
排行榜配置	添加排行榜 •开发者最多可配置2个榜单，每个榜单可选择单局榜、总榜其中一种 •平台后续将开发更多榜单类型
	排行榜数据 •小摇杆为排行榜提供了2个数值展示区域，分别为核心数值和次要数值 •核心数值为榜单排名依赖的数值，当前提供了【个人积分】类型，开发者上报用户积分的数值即可 •次要数值提供了【连胜】和【胜点】2类，排行榜将根据开发者选择的类型展示文案，开发者上报对应的数值即可。如：选择【连胜】，排行榜内将展示【连胜】，开发者上传连胜次数即可 •平台后续将开放更多数值类型
	截榜时间 •当开发者配置【总榜】时，须根据玩法设计配置截榜时间 •截榜时间支持按【月】、【双周】、【周】的维度统计
	榜单奖励 •当玩法设计了【总榜】奖励时，开发者需要在【榜单奖励】内选择【有】，并上传1张排名与奖励的映射说明图，图片将在小摇杆【说明】入口内向用户展示 •开发者须严格按规则向获奖观众发放奖励
排行榜配置审核	•榜单配置须与包体内容一致 •开发者完成上述配置并接入能力后，需上传新的包体，排行榜配置将与包体内容同步审核 •新包体上线后，配置信息将对应包体版本同步生效	/

2.2 API接入

能力名称	接入指引	能力作用
【必选】设置当前生效的世界榜单版本	API接口调用顺序、API接口明细请参考：【技术接入指南】用户战绩与排行榜	设置线上环境/测试环境生效的世界榜单版本，设置后，小摇杆的「世界榜」将展示新世界榜单版本的数据。
【必选】上传世界榜单列表		设置正式环境/测试环境的世界榜单列表数据，榜单最多设置150个成员。
【必选】上报用户世界榜单数据		上报用户世界榜单的累计战绩，单次调用最多上报50名用户。
【必选】完成用户世界榜单数据的上报		当到达截榜时间且有线上生效的世界榜单版本时，在完成用户世界榜单的累计战绩上报后，调用本接口，标记本次截榜时间内的世界榜单累计战绩完成了上报。
【必选】同步对局状态		开发者在对局开始时调用，同步对局开始事件；在对局结束时再次调用，同步对局结束事件。
【必选】上报对局榜单列表		对局结束后，上报对局榜单列表，榜单最多设置150个成员。
【必选】上报用户对局数据		对局结束后，上报用户对局数据，需要分批次调用，单批次最多上报50个用户对局数据。
【必选】完成用户对局数据上报		当完成用户对局数据上报后，调用本接口，标记对局数据上报已完成，小摇杆的「本局榜」将展示本局榜单数据。

2.3 能力测试

测试项	配置说明	示意图
单局榜测试	1.使用真实的抖音账号添加调试成员 2.通过伴侣挂载本地包体，调试成员参与玩法后可在单局榜内确认表现当前暂不支持在测试时展示连胜、胜点数值	/
总榜测试	1.使用真实的抖音账号添加调试成员 2.在openAPI中设置总榜的测试环境 3.通过伴侣挂载本地包体，调试成员参与玩法后，将从总榜的测试环境中读取数据 4.玩法上线后，请删除测试账号的调试成员配置注：每个抖音账号仅能添加1个玩法的调试成员，有多个玩法需要调试时，请使用其他抖音号或重新添加调试成员	/

FAQ

Q：没有配置【用户战绩与排行榜】时，小摇杆内会怎么展示？

开发者未配置【用户战绩与排行榜】时，小摇杆内不会展示战绩、排行榜信息。

Q：不同版本的【用户战绩与排行榜】配置会冲突吗？

不会，不同包体版本的【用户战绩与排行榜】配置会对应版本号生效。