支持设备 |
命名空间 |
最低手淘版本 |
iOS android |
|
9.16.0 |
小部件跳转到关联的小程序（小部件创建&投放时，需要关联相应的小程序，并绑定关联的小程序链接）。
注意：仅支持购物小程序 业务场景。
名称 |
类型 |
必选 |
说明 |
extraData |
|
是 |
需要传递给目标小程序的数据，为键值对的格式，数值的类型为字符串。目标小程序在 |
success |
|
是 |
调用成功的回调 |
fail |
|
是 |
调用失败的回调 |
my.navigateToRelationMiniProgram ({ //需要传递给目标小程序的数据，为键值对的格式，数值的类型为字符串。 //目标小程序可在 App.onLaunch() 、 App.onShow() 中获取到这份数据。 extraData: { "data1" : "test", }, success: (res) => { console.log(JSON.stringify(res)); }, fail: (res) => { console.log(JSON.stringify(res)); }, });
购物小程序URL由投放计划下发，业务对接的时候通过小部件容器组件属性relationUrl将该URL传入组件。
开发者调用my.navigateToRelationMiniProgram跳转到绑定的购物小程序（无需传入URL）。
根据debugUrl上relationId参数进行拼接，拼接规则：
// relationId替换实际值
https://m.duanqu.com?_ariver_appid=relationId
支持设备 |
命名空间 |
最低手淘版本 |
iOS android |
|
9.16.0 |
小部件降级API，由业务方主动触发，场景会收到renderError事件
renderError事件返回参数如下。
{ errorCode : "CL_PAGE_ERROR", errorMessage : "Page Error, Need Downgrade" }
名称 |
类型 |
必选 |
说明 |
success |
|
是 |
调用成功的回调 |
fail |
|
是 |
调用失败的回调 |
my.widgetDowngrade({ success: (res) => { console.log(JSON.stringify(res.data)); }, fail: (res) => { console.log(JSON.stringify(res)); }, });
renderError事件返回参数如下： { errorCode : "CL_PAGE_ERROR", errorMessage : "Page Error, Need Downgrade" }
支持设备 |
命名空间 |
最低手淘版本 |
iOS android |
|
9.18.0 |
获取小部件关联的小程序信息（小部件创建&投放时，需要关联相应的小程序，并绑定关联的小程序链接）。
注意：仅支持购物小程序 业务场景。
名称 |
类型 |
必选 |
说明 |
success |
|
是 |
调用成功的回调 |
fail |
|
是 |
调用失败的回调 |
名称 |
类型 |
说明 |
relationAppId |
|
关联的小程序ID |
query |
|
关联的小程序url（relationUrl）上的query，如果query格式有问题，则返回{} |
my.getRelationAppInfo({ success: (res) => { console.log(JSON.stringify(res)); }, fail: (res) => { console.log(JSON.stringify(res)); }, });
支持设备 |
命名空间 |
最低手淘版本 |
iOS android |
|
9.26.0 |
获取小部件运行时所处的场景信息，具体参数参考：小部件容器组件。
名称 |
类型 |
必选 |
说明 |
success |
|
是 |
调用成功的回调 |
fail |
|
是 |
调用失败的回调 |
code |
信息 |
10 |
sceneInfo format exception |
名称 |
类型 |
说明 |
sceneInfo |
|
场景信息，内容与小部件容器组件 |
query |
|
关联的小程序url（relationUrl）上的query，如果query格式有问题，则返回{} |
sceneInfo 基本参数
名称 |
类型 |
必选 |
说明 |
sceneId |
number |
是 |
小部件目前所在场景id，店铺首页值是20，minishop值是23，每日好店是31 空值会触发 |
sellerId |
number |
是 |
小部件所属商家ID |
isPreview |
|
是 |
是否为预览小部件 |
orderId |
number |
是 |
投放计划Id，表示商家针对应用，在某个场景产生的一次投放。同一个模块实例在不同场景下通过my.getSceneInfo获取到的order不一样； |
shareParams |
|
是 |
小部件通过分享API携带的参数信息，由场景从分享链接解析后更新，类型为未解析的JSON字符串 注意：该参数会逐步废弃！请使用 |
widgetShareParams |
|
是 |
小部件通过分享API携带的参数信息，由场景从分享链接解析后更新 |
widgetViewId |
number |
是 |
商家针对小部件，配置相关数据以后，产生的小部件视图卡片Id，具有唯一性，同一个模块实例不同场景下通过my.getSceneInfo获取到的widgetViewId不变。 |
不同场景额外参数
名称 |
sceneId |
扩展参数 |
|
Preview（预览） |
|
/ |
|
Live（直播） |
|
liveId |
直播ID |
Shop（店铺） |
|
shopId |
店铺ID |
pageUrl |
店铺地址 |
||
widgetId |
小部件所在店铺模块ID，用于所见即所得定位 |
||
widgetViewId |
小部件视图卡片Id |
||
templateId |
模板ID |
||
moduleName |
为模块名称，用于生意参谋埋点 |
||
Subscribe（订阅） |
|
/ |
|
Member（会员） |
|
/ |
|
Minishop（每日好店） |
|
/ |
|
my.getSceneInfo({ success: function(res) { my.alert({content: '获取成功：' + res}); }, fail: function(res){ my.alert({content: '获取失败：' + res}); } });
支持设备 |
命名空间 |
最低手淘版本 |
iOS android |
|
9.26.0 |
在小部件中获取商家配置的表单信息（商家信息由sceneParams发下，开发者不需要传入）。
之前使用my.getBizData 后续不再维护，请使用最新的 my.tb.getConfigData。
名称 |
类型 |
必选 |
说明 |
success |
|
是 |
调用成功的回调 |
fail |
|
是 |
调用失败的回调 |
名称 |
类型 |
说明 |
data |
|
数据结构为字典，若返回数据的格式不正确则触发fail回调，数据结构可以参考下方示例。 |
my.tb.getConfigData({ success: function(res) { console.log(res); // { // "data": { // "data": { // // 这里结构为表单数据内容 // "nam": "测试 configData 数据" // }, // "schemaDataId": 123, // "schemaId": 123, // "schemaVersion": “version” // } // } const formData = res?.data?.data || {}; // 表单数据 const name = formData.name; }, fail: function(res){ console.error(res); } });
支持设备 |
命名空间 |
最低手淘版本 |
iOS android |
|
9.26.0 |
在小部件中获取商家配置的表单信息（商家信息由sceneParams发下，开发者不需要传入）。
名称 |
类型 |
必选 |
说明 |
success |
|
是 |
调用成功的回调 |
fail |
|
是 |
调用失败的回调 |
code |
信息 |
10 |
bizData format exception |
11 |
sellerId or schemaDataId empty |
12 |
网络错误（errorCode + ":" + errorMessage） |
名称 |
类型 |
说明 |
bizData |
|
数据结构为字典，若返回数据的格式不正确则触发fail回调，错误码为10；若bizData为空，错误码为11 |
出参格式说明
my.getBizData({ success: function(res) { my.alert({content: '获取成功：' + res}); }, fail: function(res){ my.alert({content: '获取失败：' + res}); } });
支持设备 |
命名空间 |
最低手淘版本 |
iOS android |
|
10.2.0 |
设置小部件手势模式
名称 |
类型 |
必选 |
说明 |
|
success |
|
是 |
调用成功的回调 |
|
fail |
|
是 |
调用失败的回调 |
|
gestureMode |
|
是 |
"default" |
默认手势模式 |
"inner" |
沉浸式手势模式 |
|||
default模式：以对角线划分，纵向手势由小部件所在场景容器处理，小部件不响应手势；横向手势由小部件处理，场景容器不处理手势；
inner模式：所有手势由小部件响应；注意，该模式下会出现场景列表无法响应手势上下滑动的情况！
my.setGestureMode({ gestureMode: "inner", success: function(res) { my.alert({content: '获取成功：' + res}); }, fail: function(res){ my.alert({content: '获取失败：' + res}); } });
支持设备 |
命名空间 |
最低手淘版本 |
iOS android |
|
10.5.0 |
打开分享面板，分享当前页面，可自定义参数。
分享回流参数获取使用my.getSceneInfo，返回参数中sceneInfo.widgetShareParams。
名称 |
类型 |
必选 |
说明 |
success |
|
是 |
调用成功的回调 |
fail |
|
是 |
调用失败的回调 |
query |
|
是 |
分享时额外参数，可通过
|
title |
|
是 |
分享的标题 |
imageUrl |
|
是 |
分享的图片地址 |
/// 打开分享面板 my.showSharePanel({ query: { name: 'txink', address: 'hangzhou' }, title: '测试自定义标题', imageUrl: 'https://gw.alicdn.com/bao/upload/bao/i2/670988855/O1CN01cDLGb42FHdqYmh2hX_!!670988855.jpg_570x10000q50.jpg', success: function(res) { my.alert({content: '成功：' + res}); }, fail: function(res){ my.alert({content: '失败：' + res}); } }); /// 通过分享链接打开的小部件获取分享参数 my.getSceneInfo({ success: function(res) { let params = res.widgetShareParams; my.alert({content: '获取成功：' + params}); }, fail: function(res){ my.alert({content: '获取失败：' + res}); } });
