开发指南
注意：目前该插件仅支持PC千牛端应用。
一、申请阶段
1.申请权益中心插件
在淘宝开放平台控制台/能力中心/插件，选择新权益中心插件：https://open.taobao.com/ability#/detail?id=3300
申请使用，同步选择自己需要用到这个插件的开发者主体以及小程序。等待审核通过。
2.申请权限包
需要在商家端应用下申请已经创建的商家应用-权益中心插件权限包，等待审核通过。
审核通过后进入开发阶段。
二、开发阶段
1.整体流程
2.权益类型页面配置
1）在淘宝开放平台/能力中心/能力管理，选择“配置权益类型“操作。
2）配置页面配置好需要展示的权益类型，券类型以及奖池类型后，点击完成配置。
请注意：
① 这里配置的优惠券及权益为该商家应用供给商家使用后，商家可配置的权益类型范围。
② 针对优惠券的权益配置部分，目前支持【店铺券-全网自动推广】 【商品券-全网自动推广】【店铺券-商家抽奖平台】 【店铺券-购物小程序专享券】 【商品券-购物小程序专享券】等渠道，其中全网自动推广渠道券为默认会在相应渠道透出的，所有消费者可见。其他渠道券为不会自动透出，发送给特定消费者才可见，其中推荐使用购物小程序专属渠道。
3.商家应用插件使用说明
1）线上申请插件的使用
2）插件目前只支持组件方式展示
3）在app.json中声明组件
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 | { "pages": [ "pages/index/index", ], "plugins": { "myPlugin": { "version":"*", "provider":"3000000043145705" }, }, "window": { "defaultTitle": "My App" }} |
4）在index.json 文件中声明组件
1 2 3 4 5 6 7 8 9 10 11 | { "usingComponents": { }} |
5）在index.axml中使用组件
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 | // 使用创建插件 进行抽奖操作<button onTap='showCreatePlugin'></botton><plugin-a poolName='测试奖池' visible='{{visible}}' onClose='onClose' mode='DRAW' startTime="{{'1623484050000'}}" endTime='{{"1623570450000"}}' />// 使用编辑插件 进行编辑发奖操作 <plugin-bpoolName='测试奖池' visible='{{visible}}' onClose='onClose' poolId='{{"1519002029"}}' mode='SEND' startTime="{{'1623484050000'}}" endTime='{{"1623570450000"}}' /> |
组件属性说明
参数名 |
类型 |
参数说明 |
poolName |
string |
奖池名字 |
visible |
bool |
打开/隐藏插件 |
mode |
"DRAW" | "SEND" |
SEND 发奖 只能选一个 AWARD 抽奖 可以选十个 |
bizCode |
string |
小程序ID |
poolId |
string |
编辑态需要传入 奖池ID |
startTime |
string |
活动开始时间的时间戳 |
endTime |
string |
活动结束时间的时间戳 |
ename |
string |
编辑态需要传入 奖池ename |
onClose |
function |
点击关闭后回调用 |
onSuccess |
function |
成功后回调用 |
4.抽奖&发奖&查询的Top接口
1）alibaba.benefit.send发奖奖池，进入链接查看详细接口文档：【点击查看】
① （right_ename）即权益ename可以在勾选奖池时可以获得，用上面方法获得。
② （receiver_id）即权益发放到的用户的open-id，openid可通过云函数获取。【点击查看】
2）alibaba.benefit.draw抽奖奖池，进入链接查看详细接口文档：【点击查看】
① （ename）奖池ename在勾选奖池时可以获得。
② 该接口需获取到C端用户的授权才能使用，需要在配套的C端手淘商家应用内调用my.authorize获取scope.benefitSend，由用户授权，之后调用alibaba.benefit.draw才能抽奖成功。
消费者抽奖实践文档，请参考文档【点击查看】
3）alibaba.benefit.query奖池信息查询，进入链接查看详细接口文档【点击查看】
Tips:
① （ename）奖池ename在勾选奖池时可以获得。
② app_name是promotioncenter-${appId}，appid为小程序的具体appid。
注：appid一定要传对，否则校验不过,这里应传入前置页面配置时绑定的appid
③ award_type如果查询的是抽奖奖池值为 0，如果查的是发奖奖池值为1。
④ 常见错误码
错误码 |
错误码说明 |
COUPON_INVALID_OR_DELETED |
优惠券无效或者被删除 |
APPLY_OWNSELF_COUPON |
商家不能把自己的权益发给自己的帐号 |
APPLY_SINGLE_COUPON_COUNT_EXCEED_LIMIT |
用户该类型权益已达上限 |
权益已下线 |
|
311权益已经被锁定---被锁定是指？需要商家怎么操作？ |
权益邦定了店铺宝活动后，只能通过店铺店活动发放权益，其它方式无法发放，店铺宝权益和其它活动权益分开即可。 |
APPLY_ONE_SELLER_COUNT_EXCEED_LIMIT |
用户优惠券超出10张限制 |
ERRORserver-invoke-mtee-exception |
没查到，提供的错误是否准确 |
NO_RIGHT_QUANTITY |
权益库存不足 |
ERROR A_3_567、A_3_00_005、A_3_00_002 |
提示这些错误码的用户账号都存在风险，所以被拦截了，做安全防控的原因主要也是担心商家的权益发放被黑灰产盗刷 |
5）right_type_id 和right_type_name 的对照关系
right_type_id |
right_type_name |
1 |
平台支付宝红包 |
2 |
淘金币 |
7 |
淘宝现金红包 |
113 |
优酷会员 |
142 |
淘票票券 |
145 |
优酷会员 |
149 |
飞猪旅行红包 |
154 |
淘票票优惠券 |
155 |
书旗小说 |
156 |
饿了么超级会员 |
163 |
虾米音乐 |
167 |
口碑立减券 |
200 |
猫超卡 |
903 |
实物（虚拟权益） |
1017 |
淘票票代金券 |
三、使用阶段
券及权益配置
商家需要在PC千牛上打开ISV提供的B端后台进入【UMP插件权益配置】模块进行权益的数据配置
唤起权益中心插件的动作上需要服务商首先传递是抽奖类还是发奖类活动，根据此参数判断后续配置动作。
抽奖和发奖的选择和配置流程存在差异，发奖列表为单选，抽奖列表为多选（*多选上限为10条）。
1.发奖设置
2.抽奖设置
优惠券：包括店铺券和商品券。可以点击创建优惠券跳转至商家权益平台进行优惠券的设置。
权益：包括【淘票票优惠券、红包、支付宝红包、淘金币、饿了么超级会员、虾米音乐、实物凭证权益、口碑立减券】。
