# 定制化桌面快捷方式引导弹窗

# 介绍

快手小游戏支持平台级别定制化的桌面快捷方式引导弹窗。开发者无需调用 ks.addShortcut 等接口触发添加桌面快捷方式逻辑,简化了开发者接入流程。

添加桌面快捷方式引导弹窗功能目前仅邀请开通,可联系小游戏官方运营人员@胡绵伟 @于航 进一步了解。

# 支持版本

仅 Android 客户端支持,客户端最低版本为 10.2.10 ,低版本配置不会展示定制化弹窗。开发者可以在低版本调用相关 API 实现添加桌面快捷方式逻辑。

# 接入与定制弹窗

  1. 开发者首先需要准备两张图片,分别为弹窗的背景图和弹窗的点击按钮。横屏游戏和竖屏游戏对图片素材的尺寸要求如下所示:

    游戏类型 背景图尺寸(长 * 宽) 按钮尺寸(长 * 宽)
    竖屏游戏 828px * 966px 400px * 112px
    横屏游戏 976px * 732px 400px * 112px
  2. 将游戏包导入到快手开发者工具后,在根目录创建名为 "ks-user-custom-config.json" 的配置文件

  3. ks-user-custom-config.json 文件中指定弹窗背景图和按钮图片的路径。其中 apkGuidePosterPath 为背景图, actionButtonPath 为点击按钮图片。

    {
      "apkGuideInfo" : {
        "apkGuidePosterPath" : "/a.png",
        "actionButtonPath" : "/b.png"
      }
    }
    
  4. 开发者定制图片时,应遵循如下规则:

    注意:上图中,关闭按钮由平台统一实现,开发者不需要在弹窗中加入关闭按钮。

# 设计建议与参考

弹窗素材应带有丰富奖励道具,以吸引用户进行下载。

参考样式: