淘宝开放平台

登录
文档中心 > API

API

addShortcut: 将小游戏快捷方式添加到手机桌面上

更新时间：2025/05/23 访问次数：44

功能描述

该方法用于将小游戏添加到用户手机桌面上。

在android系统中，是否可以成功添加取决于android系统对“添加快捷方式”的授权程度。该方法在不授权的情况下会引导用户前往设置。

注意：该方法只适用于高性能模式，请先确认完成高性能模式接入。

示例

const sdk = my.tb.getInteractiveSDK();
sdk.addShortcut({
  success({ code, msg }) {
    if (code === 'SUCCESS') {
      console.log('添加成功')
    } else {
      console.log('添加失败, 失败信息：', msg);
    }
  },
  fail(err) {
    console.log('添加失败, 错误信息：', err);
  },
});

入参

对象，属性如下

属性名

类型

是否必填

说明

success

function

否

接口调用成功的回调

fail

function

否

接口调用失败的回调

complete

function

否

接口调用结束的回调（无论成功、失败都会执行）

回调成功参数说明

字段

类型

说明

code

string

添加结果编码

msg

string

检查结果详细信息

Code说明

Code编码

含义说明

SUCCESS

成功

NOT_SUPPORTED

不支持

ADD_FAILED

添加失败

ADD_FAILED_BECAUSE_EXIST

添加失败，因为已经存在于当前桌面

TIMEOUT

添加失败，因为超时

ADD_FAILED_BECAUSE_SYSTEM_AUTH_DENY

添加失败，因为系统权限不足

场景示例

android

调用addShortcut，返回结果中，code是添加结果，msg是添加结果说明。

1、添加成功

系统完全授权成功，一次性添加成功

2、添加失败

  • 场景一: 桌面上已存在目标应用，code = ADD_FAILED_BECAUSE_EXIST

  • 场景二: 安卓手机系统拒绝授权添加桌面快捷方式，code = ADD_FAILED_BECAUSE_SYSTEM_AUTH_DENY，msg中显示了用户是否选择去设置

  • 场景三: 用户在引导弹窗上停留超过15s无操作，code = TIMEOUT

IOS

调用addShortcut，返回结果中，code是添加结果，msg是添加结果说明。

返回结果为成功，ios会从手淘自动跳转到safari浏览器中。页面上有一个静态引导图，教育用户将小游戏添加到桌面。

快捷方式回访

小游戏用户从快捷方式渠道访问时，开发者可通过以下方式识别：

const sdk = my.tb.getInteractiveSDK();
const tagInfo = sdk.getChannelTag();

const isFromShortcut = tagInfo?.extra?.raw === 'desktop_widget';

FAQ

关于此文档暂时还没有FAQ
有用(0) 我要提问
返回
顶部