# 侧边栏复访能力接入指南

更新时间：2025-05-29 15:42:52

# 一、能力介绍

随着快手侧边栏日活持续增长，用户逐渐习惯通过该入口便捷访问历史小游戏。平台建议开发者接入首页侧边栏复访功能，通过「快手→侧边栏→小游戏」的直达路径培养用户习惯，结合激励任务引导用户从侧边栏快速进入游戏，可有效提升用户留存。

注：2025年5月29日能力升级后，支持游戏内点击拉起侧边栏界面

适配游戏：仅支持完成备案的游戏接入

适配宿主：快手、快手极速版

适配系统：安卓、iOS

适配版本：快手安卓版本>=13.4.40，iOS版本>=13.4.40

# 二、能力应用示意

开发者在游戏内接入礼包引导复访能力，游戏版本发布后，用户流程如下：游戏主界面展示礼包提示 → 用户点击按钮拉起侧边栏 → 通过侧边栏入口进入游戏 → 在礼包界面领取奖励

步骤1	步骤2	步骤3	步骤4

# 方案示意图

# 三、技术方案流程

# 参考流程图：

# 详细路径：

步骤	说明
一、监听判断是否展示礼包入口	1.游戏热启动时ks.onShow拿到进入游戏的from是否是sidebar_new（侧边栏外露小程序），根据from判断是否由侧边栏进入，从侧边栏进入说明侧边栏可用，展示入口（游戏冷启动使用ks.getLaunchOptionsSync监听） 2.ks.checkSliderBarIsAvaliable判断侧边栏是否可用。若不可用，不展示礼包入口，可用即展示礼包入口
二、引导跳转侧边栏访问游戏	1.自动跳转侧边栏：可增加一个跳转按钮，用户点击后跳转侧边栏按钮点击回调事件设置为：关闭当前奖励界面并调用ks.navigateToScene。用户点击按钮时会自动跳转到侧边栏
三、奖励展示	用户点击奖励入口时，通过获取ks.onShow的最新启动状态，判断当前用户是否从侧边栏进入游戏：侧边栏启动：奖励按钮显示「领取奖励」。非侧边栏启动：奖励按钮显示未完成，继续展示《前往侧边栏引导状态》。

注意事项

请确保使用快手最新版本客户端进行开发测试；
为保障体验，单用户游戏内唤起侧边栏每日限制5次，超限会提示报错；
强烈建议必接「自动跳转侧边栏」能力ks.navigateToScene (opens new window)，能大幅度提升用户入口访问心智，提升留存率。

# 四、接口说明

# 监听用户是否侧边栏进入语法

ks.checkSliderBarIsAvailable (Options) (opens new window)

Options参数说明

属性名	类型	必填	说明
success	function	是	接口调用成功的回调函数
fail	function	是	接口调用失败的回调函数

回调成功参数

属性名	类型	说明
available	Boolean	侧边栏是否可用

回调失败参数

属性名	类型	说明
code	int	状态码
msg	string	错误信息

调用Demo:

ks.checkSliderBarIsAvailable({
    success: (result) => {
        this.content.string =
            "侧边栏调用成功: " + JSON.stringify(result);
    },
    fail: (result) => {
        this.content.string =
            "侧边栏调用失败: " + JSON.stringify(result);
    },
});

# 跳转到某个小游戏入口场景

ks.navigateToScene(Options) (opens new window)

调用该API可跳转某个小游戏入口，当前仅支持侧边栏

快手安卓版本>=13.4.40，iOS版本>=13.4.40，低版本需做兼容处理（需要游戏完成备案）

Options参数说明

字段名	类型	描述
scene	string	需要确认的入口场景
success	function	接口调用成功的回调函数
fail	function	接口调用失败的回调函数
complete	function	接口调用结束的回调函数（调用成功、失败都会执行）

scene的合法值

值	说明	最低版本
sidebar	侧边栏场景	13.4.40

回调成功

字段名	类型	描述
msg	string	success

回调失败

字段名	类型	描述
code	int	异常错误码
msg	string	错误信息

错误码

code	msg	描述
-10005	only for kuaishou system version >= 13.4.40	低于支持版本
-20001	unknown error	系统内部异常
-20041	frequency limit	API调用次数超过频控限制
-20042	game not registered	游戏未备案
-20043	navigateToScene scene illegal, please check	scene不合法

调用Demo:

ks.navigateToScene({
    scene: "sidebar",
    success: (res) => {
        console.log("navigate to scene success");
        // 跳转成功回调逻辑
    },
    fail: (res) => {
        console.log("navigate to scene fail: ", res);
        // 跳转失败回调逻辑
    },
});

# 五、设计参考

游戏需要根据本游戏整体风格及定位，设计相关图片素材，包括不限于礼包领取入口、点击礼包后引导弹窗及内容。建议礼包入口放置于小游戏主界面显眼位置。

模块	建议文案	建议设计
引导入口	文案需直观，快速让用户理解，建议为「限定福利」「入口有奖」等	小游戏主页面显眼位置强曝光，红点动态提醒可将入口引导和游戏日常任务相结合
任务界面	建议包含以下内容：顶部标题：「侧边栏入口奖励」步骤文案：点击「去侧边栏」按钮在侧边栏，点击「XXXXX」（游戏名）返回游戏，领取奖励按钮文案：去侧边栏（未完成态）/ 领取奖励（完成态）需注意设计关闭弹窗的按钮	可参考平台示意图，结合游戏风格自行设计
激励设计	建议做成每日任务形式用户每天通过侧边栏进入游戏，可以领取奖励。养成用户从侧边栏进入游戏的习惯，有效提升游戏留存 icon保留用户领取完每日奖励后，icon不消失，强化用户对侧边栏入口的认知礼包设计提供对用户有吸引力的道具，例如游戏一级货币、体力或装备等；或是设置成连续签到任务形式，随着用户完成任务天数，礼包价值也随之提升

# 六、常见问题

# Q1：是否需要激励用户每天从侧边栏复访？

建议设置为【每日访问奖励】，激励用户复访行为，该能力已验证有效提升用户留存。

# Q2：侧边栏接口回调false是什么原因？

可根据文档中错误码描述定位问题。

其他问题，请提供appid，联系官方运营人员。

# Q3：之前接了侧边栏，这次还要接入唤起侧边栏能力吗？

强烈建议必接「自动跳转侧边栏」能力，能大幅度提升用户入口访问心智，提升留存率