alibcTrade
来自于:AC模块工作室立即使用
概述
alibcTrade模块 封装了阿里百川电商sdk,能够使你的app快速集成淘宝的电商功能,包括授权登录,查看商品详情,查看店铺,查看我的订单,查看购物车和商品支付等整个交易闭环,同时支持外部webview的方式打开电商组件,同时支持唤醒手淘/高佣转链/跨店结算功能,详情请查看淘宝公告 。使用此模块,需要登录阿里百川,进入控制台,创建应用并获取sdk的安全图片。
基本流程
在阿里百川控制台创建应用获取appkey:
在阿里百川控制台“API申请”中申请相应的API权限:
在阿里百川控制台"我的产品后台"中开通新版百川电商sdk:
生成安全图片:(android 需要上传apk,即为自己要发布的应用,iOS只需要填写 bundleId:可在apicloud控制台概览里查看)
配置 Android 自定义模块 aliTradeAppendix:
首先下载 alibcTradeAppendix 模块,将其解压并将Android的安全图片 yw_1222.jpg 放到文件夹 alibcTradeAppendix\res_alibcTradeAppendix\res\drawable 下,重新打包成zip,即可作为自定义模块使用
配置 iOS 自定义模块 aliTradeAppendix:
首先下载 alibcTradeAppendix模块,将其解压并将iOS的安全图片 yw_1222.jpg 放到 aliTradeAppendix/target 目录下,重新打包成zip,即可作为自定义模块使用
使用此模块之前需先配置 config.xml 文件,配置完毕,需通过云端编译生效,配置方法如下:
- 名称:alibcTrade
- 参数:urlScheme, querySchemes
- 参数说明:
- urlScheme参数用于处理应用间的跳转,值为tbopen+appkey, appkey是在阿里百川上申请的appkey.
- querySchemes参数用于配置可被检测的URL Scheme,多个参数用逗号隔开,本模块需添加tbopen,tmall两个参数.
- 配置示例:
<preference name="urlScheme" value="tbopen23442471"/>
<preference name="querySchemes" value="tbopen,tmall"/>
android编译说明
- android使用升级环境编译
- android编译需在Android 3.0 (API 11) 及其以上
initSDK
初始化SDK(调用优先级最高,只需要调用一次)
initSDK({param},callback(ret,err))
callback(ret)
ret:
- 类型:JSON对象
- 描述:返回值
- 内部字段:
{
status: true //布尔型,初始化成功
}
err:
- 类型:JSON对象
- 描述:返回值
- 内部字段:
{
code:-1 //数字型,错误提示码
message:'' //字符串,提示信息
}
示例代码
var alibcTrade = api.require('alibcTrade');
alibcTrade.initSDK({
},function(ret,err){
});
可用性
iOS系统,Android系统
可提供的1.0.0及更高版本
setIsSyncForTaoke
设置是否对淘客使用同步打点
setIsSyncForTaoke({params}, callback(ret))
注意:初始化完成后调用才能生效
params
isSync:
- 类型:布尔类型
- 默认值:true
描述:(可选项)是否对淘客使用同步打点
注意:在加购场景下,只有异步淘客打点
callback(ret)
ret:
- 类型:JSON对象
- 描述:返回值 仅Android有返回
- 内部字段:
{
status: true|false //布尔型,返回同步淘客打点策略是否设置成功
}
示例代码
var alibcTrade = api.require('alibcTrade');
alibcTrade.setIsSyncForTaoke({
isSync:false},
function(ret,err){
alert(JSON.stringify(ret));
});
可用性
iOS系统,Android系统
可提供的1.0.0及更高版本
setTaokeParams
设置淘客全局参数
setTaokeParams({params}, callback(ret))
注意:初始化完成后调用才能生效
params
pid:
- 类型:字符串
- 描述:淘客pid,获取流程参考:http://baichuan.taobao.com/portal/doc?articleId=220
- 注意:Pid不能为空且必须以 mm_ 开头
taokeAppkey:
- 类型:字符串
- 描述:(可选项) 淘宝联盟后台的APPKEY字段。新版本SDK新增 高佣转链/跨店结算 功能所需, 如果需要高分佣能力,务必传入adzoneId和taokeAppkey 参数 功能介绍
adzoneId:
- 类型:字符串
- 描述:(可选项)淘宝联盟adzoneId。新版本SDK新增 高佣转链/跨店结算 功能所需, 如果需要高分佣能力,务必传入adzoneId和taokeAppkey 参数 功能介绍
callback(ret)
ret:
- 类型:JSON对象
- 描述:返回值 仅Android有返回
- 内部字段:
{
status: true|false //布尔型,返回淘客参数是否设置成功
}
示例代码
var alibcTrade = api.require('alibcTrade');
alibcTrade.setTaokeParams(
{pid:'mm_xxxx_xxxx_xxxx'},function(ret,err){
alert(JSON.stringify(ret));
});
可用性
iOS系统,Android系统
可提供的1.0.0及更高版本
setChannel
设置渠道信息,渠道专享价专用。
setChannel({params})
注意:初始化完成后调用才能生效
params
type:
- 类型:字符串
- 默认值:'0'
- 描述:(可选项)设置渠道类型
name:
- 类型:字符串
- 默认值:null
- 描述:(可选项)设置渠道名称
示例代码
var alibcTrade = api.require('alibcTrade');
alibcTrade.setChannel({
type:'0',
name:'developer'
},function(ret,err){});
可用性
iOS系统,Android系统
可提供的1.0.0及更高版本
showLogin
授权登录
showLogin(callback(ret,err))
callback(ret,err)
ret:
- 类型:JSON对象
- 描述:返回值
- 内部字段:
{
status: true, //是否授权登录成功
isLogin : true, //是否授权登录成功
nick : '', //昵称
avatarUrl : '', //头像地址
openId : '', //用户标识
openSid : '' //用户标识
}
err:
- 类型:JSON对象
- 描述:返回值
- 内部字段:
{
code : 1, //数字类型;错误码
message : '', //字符串;错误提示信息
}
示例代码
var alibcTrade = api.require('alibcTrade');
alibcTrade.showLogin(function(ret,err){
if(ret.status){
alert(JSON.stringify(ret));
}else{
alert(JSON.stringify(err));
}
});
可用性
ios系统,Android系统
可提供的1.0.0及更高版本
logout
退出登录
logout(callback(ret,err))
callback(ret,err)
ret:
- 类型:JSON对象
- 描述:返回值
- 内部字段:
{
status: true, //布尔值,操作成功
}
err:
- 类型:JSON对象
- 描述:返回值
- 内部字段:
{
code : 1, //数字类型;错误码
message : '', //字符串;错误提示信息
}
示例代码
var alibcTrade = api.require('alibcTrade');
alibcTrade.logout(function(ret,err){
if(ret.status){
alert(JSON.stringify(ret));
}else{
alert(JSON.stringify(err));
}
});
可用性
ios系统,Android系统
可提供的1.0.0及更高版本
getUserInfo
获取用户信息
getUserInfo(callback(ret,err))
callback(ret)
ret:
- 类型:JSON对象
- 描述:返回值
- 内部字段:
{
status: true|false, //布尔值,操作是否成功
isLogin : true, //是否授权登录了淘宝
nick : '', //昵称
avatarUrl : '', //头像地址
openId : '', //用户标识
openSid : '' //用户标识
}
示例代码
var alibcTrade = api.require('alibcTrade');
alibcTrade.getUserInfo(function(ret,err){
if(ret.status){
alert(JSON.stringify(ret));
}else{
alert(JSON.stringify(ret));
}
});
可用性
ios系统,Android系统
可提供的1.0.0及更高版本
#addPageFinishListener 监听页面加载完成后返回页面的title和url。 注意:当采用外部传入webview方式打开电商组件时(本模块中调用show...Web系列接口打开淘宝页面时)有效。 addPageFinListener(callback(ret,err)) ##callback(ret) ret: - 类型:JSON对象 - 描述:返回值 - 内部字段:js
{
added:true //布尔值,标识已经添加监听
status: true, //布尔值,成功获取到title 和 url
title : '', //页面的标题
url : '', //页面的url
}
##示例代码
js
var alibcTrade = api.require('alibcTrade');
alibcTrade.addPageFinishListener(function(ret,err){
if(ret.status){
alert(JSON.stringify(ret));
}
});
##可用性
ios系统,Android系统
可提供的1.0.0及更高版本
#addLoadingListener
对页面shouldStartLoadWithRequest时进行监听,返回页面的title和跳转的url。
注意:当采用外部传入webview方式打开电商组件时(本模块中调用show...Web系列接口打开淘宝页面时)有效。
addLoadingListener(callback(ret,err))
##callback(ret)
ret:
- 类型:JSON对象
- 描述:返回值
- 内部字段:
js
{
added:true //布尔值,标识已经添加监听
status: true, //布尔值,成功获取到title 和 url
title : '', //页面的标题
url : '', //页面的url
}
##示例代码
js
var alibcTrade = api.require('alibcTrade');
alibcTrade.addLoadingListener(function(ret,err){
if(ret.status){
alert(JSON.stringify(ret));
}
});
##可用性
ios系统,Android系统
可提供的1.0.0及更高版本
webGoBack
控制当前外部的webview回退
webGoBack(callback(ret))
callback(ret)
ret:
- 类型:JSON对象
- 描述:当webview不能回退时返回
- 内部字段:
{
status: true, //布尔值,操作成功
message : '最后一个页面了', //字符串,提示信息
}
示例代码
var alibcTrade = api.require('alibcTrade');
alibcTrade.webGoBack(function(ret,err){
alert(JSON.stringify(ret));
});
可用性
ios系统,Android系统
可提供的1.0.0及更高版本
showDetailPage
打开淘宝商品详情页
showDetailPage({params},callback(ret,err))
params
itemId:
- 类型:字符串
- 描述:商品真实ID或者混淆(open)ID。支持itemId和openItemId的商品(如:37196464781L,AAHd5d-HAAeGwJedwSnHktBI),必填,不允许为null
- 注意:客户端openItemId(或者openId)即将下线,请注意使用。
openType:
- 类型:字符串
- 默认:'h5'
- 描述:(可选项)打开页面的方式:拉起手淘/天猫 和 h5打开页面,默认值:h5
- 取值范围:
- 'auto' //智能判断
- 'native' //手机淘宝/天猫
- 'h5' //h5
linkKey:
- 类型:字符串
- 默认:无
- 描述:(可选项)当打开页面的方式(openType)为native时,设置拉起手淘or天猫。(不传则走百川默认设置,建议传值)
- 取值范围:
- 'tmall' //拉起天猫
- 'taobao' //拉起手淘
taokeAppkey:
- 类型:字符串
- 描述:(可选项) 淘宝联盟后台的APPKEY字段。新版本SDK新增 高佣转链/跨店结算 功能所需, 如果需要高分佣能力,务必传入adzoneId和taokeAppkey 参数 并且openType设置为'native' 功能介绍
adzoneId:
- 类型:字符串
- 描述:(可选项)淘宝联盟adzoneId。新版本SDK新增 高佣转链/跨店结算 功能所需, 如果需要高分佣能力,务必传入adzoneId和taokeAppkey 参数 并且openType设置为'native' 功能介绍
pid:
- 类型:字符串
- 描述:(可选项) 淘客 pid (需登录阿里妈妈,实名认证后可获取 pid)
pageClose:
- 类型:布尔型
- 默认:true
- 描述:(可选项) 购买商品支付成功后是否关闭淘宝页面。true:关闭,false:不关闭。仅Android有效
callback(ret,err)
ret:
- 类型:JSON对象
- 描述:购买成功后返回
- 内部字段:
{
status: true, //布尔值,购买操作成功
orderResultList : [], //字符串数组,购买成功后返回的订单号
}
err:
- 类型:JSON对象
- 描述:错误时返回
- 内部字段:
{
code: 0, //数值类型,淘宝返回的错误code
message : '', //字符串,错误信息
}
示例代码
var alibcTrade = api.require('alibcTrade');
alibcTrade.showDetailPage(
{
itemId:'37196464781L',
openType:'h5',
pid:'mm_xxxxxx_xxxxxx'
},function(ret,err){
if(ret){
alert(JSON.stringify(ret));
}else{
alert(JSON.stringify(err));
}
});
可用性
ios系统,Android系统
可提供的1.0.0及更高版本
showDetailPageWeb
使用外部webview打开淘宝商品详情页
showDetailPageWeb({params},callback(ret,err))
params
itemId:
- 类型:字符串
- 描述:商品id。支持itemId和openItemId的商品(如:37196464781L,AAHd5d-HAAeGwJedwSnHktBI),必填,不允许为null
- 注意:客户端openItemId(或者openId)即将下线,请注意使用。
pid:
- 类型:字符串
- 描述:(可选项) 淘客 pid (需登录阿里妈妈,实名认证后可获取 pid)
rect:
- 类型:JSON 对象
- 默认值:充满整个父页面
- 描述:(可选项)frame 的位置和大小。
- 内部字段:
{
x:0, //(可选项)数字类型;左上角x坐标
y:0, //(可选项)数字类型;左上角y坐标
w:320, //(可选项)数字类型;宽度
h:480 //(可选项)数字类型;高度
}
fixedOn:
- 类型:字符串类型
- 描述:(可选项)模块视图添加到指定 frame 的名字(只指 frame,传 window 无效)
- 默认:模块依附于当前 window
fixed:
- 类型:布尔
- 默认值:true
- 描述:是否将模块视图固定到窗口上,不跟随窗口上下滚动,可为空
jsObjectName:
- 类型:字符串
- 描述:(可选项) 注入到h5页面的全局window属性对象名称,可与addJsToPage配合使用。
callback(ret,err)
ret:
- 类型:JSON对象
- 描述:购买成功后返回
- 内部字段:
{
status: true, //布尔值,操作状态
orderResultList : [], //字符串数组,订单号数组
}
err:
- 类型:JSON对象
- 描述:错误时返回
- 内部字段:
{
code: -1, //数值类型,code
message : '', //字符串,提示信息
}
示例代码
var alibcTrade = api.require('alibcTrade');
alibcTrade.showDetailPageWeb(
{
itemId:'37196464781L',
pid:'',
rect:{
x:0,
y:0,
w:320,
h:480
},
jsObjectName:'aliBC'
},function(ret,err){
if(ret){
alert(JSON.stringify(ret));
}else{
alert(JSON.stringify(err));
}
});
可用性
ios系统,Android系统
可提供的1.0.0及更高版本
showAddCartPage
打开淘宝加入购物车页面
showAddCartPage({params},callback(ret,err))
params
itemId:
- 类型:字符串
- 描述:商品id。支持itemId和openItemId的商品(如:37196464781L,AAHd5d-HAAeGwJedwSnHktBI),必填,不允许为null
- 注意:客户端openItemId(或者openId)即将下线,请注意使用。
pid:
- 类型:字符串
- 描述:(可选项) 淘客 pid (需登录阿里妈妈,实名认证后可获取 pid)
pageClose:
- 类型:布尔型
- 默认:true
- 描述:(可选项) 购买商品支付成功后是否关闭淘宝页面。true:关闭,false:不关闭。仅Android有效
callback(ret,err)
ret:
- 类型:JSON对象
- 描述:加购/购买成功后返回
- 内部字段:
{
status: true, //布尔值,操作状态
message : '加购成功', //字符串,仅在加购成功后返回的提示信息
orderResultList: [], //字符串数组,仅在购买成功后返回的订单号
}
err:
- 类型:JSON对象
- 描述:错误时返回
- 内部字段:
{
code: -1, //数值类型,code
message : '', //字符串,提示信息
}
示例代码
var alibcTrade = api.require('alibcTrade');
alibcTrade.showAddCartPage(
{
itemId:'37196464781L',
openType:'h5',
pid:''
},function(ret,err){
if(ret){
alert(JSON.stringify(ret));
}else{
alert(JSON.stringify(err));
}
});
可用性
ios系统,Android系统
可提供的1.0.0及更高版本
showAddCartPageWeb
使用外部webview方式,打开淘宝加入购物车页面
showAddCartPageWeb({params},callback(ret,err))
params
itemId:
- 类型:字符串
- 描述:商品id。支持itemId和openItemId的商品(如:37196464781L,AAHd5d-HAAeGwJedwSnHktBI),必填,不允许为null
- 注意:客户端openItemId(或者openId)即将下线,请注意使用。
pid:
- 类型:字符串
- 描述:(可选项) 淘客 pid (需登录阿里妈妈,实名认证后可获取 pid)
rect:
- 类型:JSON 对象
- 默认值:充满整个父页面
- 描述:(可选项)frame 的位置和大小。
- 内部字段:
{
x:0, //(可选项)数字类型;左上角x坐标
y:0, //(可选项)数字类型;左上角y坐标
w:320, //(可选项)数字类型;宽度
h:480 //(可选项)数字类型;高度
}
fixedOn:
- 类型:字符串类型
- 描述:(可选项)模块视图添加到指定 frame 的名字(只指 frame,传 window 无效)
- 默认:模块依附于当前 window
fixed:
- 类型:布尔
- 默认值:true
- 描述:是否将模块视图固定到窗口上,不跟随窗口上下滚动,可为空
jsObjectName:
- 类型:字符串
- 描述:(可选项) 注入到h5页面的全局window属性对象名称,可与addJsToPage配合使用。
callback(ret,err)
ret:
- 类型:JSON对象
- 描述:加购/购买成功后返回
- 内部字段:
{
status: true, //布尔值,操作状态
message : '加购成功', //字符串,仅在加购成功后返回的提示信息
orderResultList : [], //字符串数组,仅在购买成功后返回的订单号
}
err:
- 类型:JSON对象
- 描述:错误时返回
- 内部字段:
{
code: -1, //数值类型,code
message : '', //字符串,提示信息
}
示例代码
var alibcTrade = api.require('alibcTrade');
alibcTrade.showAddCartPageWeb(
{
itemId:'37196464781L',
pid:'',
rect:{
x:0,
y:0,
w:320,
h:480
},
jsObjectName:'aliBC'
},function(ret,err){
if(ret){
alert(JSON.stringify(ret));
}else{
alert(JSON.stringify(err));
}
});
可用性
ios系统,Android系统
可提供的1.0.0及更高版本
#showMyOrders 打开我的订单页面 showMyOrders({params},callback(ret,err)) ##params orderType: - 类型:int - 默认:0 - 描述:默认跳转页面。0为全部订单; 1为待付款订单; 2为待发货订单; 3为待收货订单; 4为待评价订单. isAllOrder: - 类型:布尔型 - 默认:false - 描述:false 进行订单分域(只展示通过当前app下单的订单),true 显示所有订单 pid: - 类型:字符串 - 描述:(可选项) 淘客 pid (需登录阿里妈妈,实名认证后可获取 pid) openType: - 类型:字符串 - 默认:'h5' - 描述:(可选项)打开页面的方式:拉起手淘/天猫 和 h5打开页面,默认值:h5 - 取值范围: 'auto' //智能判断 'native' //手机淘宝/天猫 'h5' //h5 linkKey: - 类型:字符串 - 默认:无 - 描述:(可选项)当打开页面的方式(openType)为native时,设置拉起手淘or天猫。(不传则走百川默认设置,建议传值) - 取值范围: 'tmall' //拉起天猫 'taobao' //拉起手淘 pageClose: - 类型:布尔型 - 默认:true - 描述:(可选项) 购买商品支付成功后是否关闭淘宝页面。true:关闭,false:不关闭。*仅Android有效 ##callback(ret,err) ret: - 类型:JSON对象 - 描述:购买成功后返回 - 内部字段:js
{
status: true, //布尔值,操作状态
orderResultList : [], //字符串数组,订单号数组
}
err:
- 类型:JSON对象
- 描述:错误时返回
- 内部字段:
js
{
code: -1, //数值类型,code
message : '', //字符串,提示信息
}
##示例代码
js
var alibcTrade = api.require('alibcTrade');
alibcTrade.showMyOrders(
{
orderStatus:0,
allOrder:false
pid:''
},function(ret,err){
if(ret){
alert(JSON.stringify(ret));
}else{
alert(JSON.stringify(err));
}
});
##可用性
ios系统,Android系统
可提供的1.0.0及更高版本
showMyOrdersWeb
使用外部webview方式,打开我的订单页面
showMyOrdersWeb({params},callback(ret,err))
params
orderType:
- 类型:int
- 默认:0
- 描述:默认跳转页面。0为全部订单; 1为待付款订单; 2为待发货订单; 3为待收货订单; 4为待评价订单.
isAllOrder:
- 类型:布尔型
- 默认:false
- 描述:是否显示所有订单
pid:
- 类型:字符串
- 描述:(可选项) 淘客 pid (需登录阿里妈妈,实名认证后可获取 pid)
rect:
- 类型:JSON 对象
- 默认值:充满整个父页面
- 描述:(可选项)frame 的位置和大小。
- 内部字段:
{
x:0, //(可选项)数字类型;左上角x坐标
y:0, //(可选项)数字类型;左上角y坐标
w:320, //(可选项)数字类型;宽度
h:480 //(可选项)数字类型;高度
}
fixedOn:
- 类型:字符串类型
- 描述:(可选项)模块视图添加到指定 frame 的名字(只指 frame,传 window 无效)
- 默认:模块依附于当前 window
fixed:
- 类型:布尔
- 默认值:true
- 描述:是否将模块视图固定到窗口上,不跟随窗口上下滚动,可为空
jsObjectName:
- 类型:字符串
- 描述:(可选项) 注入到h5页面的全局window属性对象名称,可与addJsToPage配合使用。
callback(ret,err)
ret:
- 类型:JSON对象
- 描述:购买成功后返回
- 内部字段:
{
status: true, //布尔值,操作状态
orderResultList : [], //字符串数组,订单号数组
}
err:
- 类型:JSON对象
- 描述:错误时返回
- 内部字段:
{
code: -1, //数值类型,code
message : '', //字符串,提示信息
}
示例代码
var alibcTrade = api.require('alibcTrade');
alibcTrade.showMyOrdersWeb(
{
orderStatus:0,
allOrder:false,
pid:'',
rect:{
x:0,
y:0,
w:320,
h:480
},
jsObjectName:'aliBC'
},function(ret,err){
if(ret){
alert(JSON.stringify(ret));
}else{
alert(JSON.stringify(err));
}
});
可用性
ios系统,Android系统
可提供的1.0.0及更高版本
showMyCarts
打开我的购物车
showMyCarts({params},callback(ret,err))
params
pid:
- 类型:字符串
- 描述:(可选项) 淘客 pid (需登录阿里妈妈,实名认证后可获取 pid)
openType:
- 类型:字符串
- 默认:'h5'
- 描述:(可选项)打开页面的方式:拉起手淘/天猫 和 h5打开页面,默认值:h5
- 取值范围:
- 'auto' //智能判断
- 'native' //手机淘宝/天猫
- 'h5' //h5
linkKey:
- 类型:字符串
- 默认:无
- 描述:(可选项)当打开页面的方式(openType)为native时,设置拉起手淘or天猫。(不传则走百川默认设置,建议传值)
- 取值范围:
- 'tmall' //拉起天猫
- 'taobao' //拉起手淘
pageClose:
- 类型:布尔型
- 默认:true
- 描述:(可选项) 购买商品支付成功后是否关闭淘宝页面。true:关闭,false:不关闭。仅Android有效
callback(ret,err)
ret:
- 类型:JSON对象
- 描述:购买成功后返回
- 内部字段:
{
status: true, //布尔值,操作状态
orderResultList : [], //字符串数组,订单号数组
}
err:
- 类型:JSON对象
- 描述:错误时返回
- 内部字段:
{
code: -1, //数值类型,code
message : '', //字符串,提示信息
}
示例代码
var alibcTrade = api.require('alibcTrade');
alibcTrade.showMyCarts(
{
pid:''
},function(ret,err){
if(ret){
alert(JSON.stringify(ret));
}else{
alert(JSON.stringify(err));
}
});
可用性
ios系统,Android系统
可提供的1.0.0及更高版本
showMyCartsWeb
使用外部webview方式,打开我的购物车
showMyCartsWeb({params},callback(ret,err))
params
pid:
- 类型:字符串
- 描述:(可选项) 淘客 pid (需登录阿里妈妈,实名认证后可获取 pid)
rect:
- 类型:JSON 对象
- 默认值:充满整个父页面
- 描述:(可选项)frame 的位置和大小。
- 内部字段:
{
x:0, //(可选项)数字类型;左上角x坐标
y:0, //(可选项)数字类型;左上角y坐标
w:320, //(可选项)数字类型;宽度
h:480 //(可选项)数字类型;高度
}
fixedOn:
- 类型:字符串类型
- 描述:(可选项)模块视图添加到指定 frame 的名字(只指 frame,传 window 无效)
- 默认:模块依附于当前 window
fixed:
- 类型:布尔
- 默认值:true
- 描述:是否将模块视图固定到窗口上,不跟随窗口上下滚动,可为空
jsObjectName:
- 类型:字符串
- 描述:(可选项) 注入到h5页面的全局window属性对象名称,可与addJsToPage配合使用。
callback(ret,err)
ret:
- 类型:JSON对象
- 描述:购买成功后返回
- 内部字段:
{
status: true, //布尔值,操作状态
ordersId : [], //字符串数组,订单号数组
}
err:
- 类型:JSON对象
- 描述:错误时返回
- 内部字段:
{
code: -1, //数值类型,code
message : '', //字符串,提示信息
}
示例代码
var alibcTrade = api.require('alibcTrade');
alibcTrade.showMyCartsWeb(
{
pid:'',
rect:{
x:0,
y:0,
w:320,
h:480
},
jsObjectName:'aliBC'
},function(ret,err){
if(ret){
alert(JSON.stringify(ret));
}else{
alert(JSON.stringify(err));
}
});
可用性
ios系统,Android系统
可提供的1.0.0及更高版本
showShopPage
打开淘宝店铺页面
showShopPage({params},callback(ret,err))
params
shopId:
- 类型:字符串
- 描述:店铺id,支持明文id
openType:
- 类型:字符串
- 默认:'h5'
- 描述:(可选项)打开页面的方式:拉起手淘/天猫 和 h5打开页面,默认值:h5
- 取值范围:
- 'auto' //智能判断
- 'native' //手机淘宝/天猫
- 'h5' //h5
linkKey:
- 类型:字符串
- 默认:无
- 描述:(可选项)当打开页面的方式(openType)为native时,设置拉起手淘or天猫。(不传则走百川默认设置,建议传值)
- 取值范围:
- 'tmall' //拉起天猫
- 'taobao' //拉起手淘
pid:
- 类型:字符串
- 描述:(可选项) 淘客 pid (需登录阿里妈妈,实名认证后可获取 pid)
pageClose:
- 类型:布尔型
- 默认:true
- 描述:(可选项) 购买商品支付成功后是否关闭淘宝页面。true:关闭,false:不关闭。仅Android有效
callback(ret,err)
ret:
- 类型:JSON对象
- 描述:购买成功后返回
- 内部字段:
{
status: true, //布尔值,操作状态
orderResultList : [], //字符串数组,订单号数组
}
err:
- 类型:JSON对象
- 描述:错误时返回
- 内部字段:
{
code: -1, //数值类型,code
message : '', //字符串,提示信息
}
示例代码
var alibcTrade = api.require('alibcTrade');
alibcTrade.showShopPagge(
{
shopId:'60552065',
openType:'h5',
pid:''
},function(ret,err){
if(ret){
alert(JSON.stringify(ret));
}else{
alert(JSON.stringify(err));
}
});
可用性
ios系统,Android系统
可提供的1.0.0及更高版本
showShopPageWeb
使用外部webview方式,打开淘宝店铺页面
showShopPageWeb({params},callback(ret,err))
params
shopId:
- 类型:字符串
- 描述:店铺id,支持明文id
pid:
- 类型:字符串
- 描述:(可选项) 淘客 pid (需登录阿里妈妈,实名认证后可获取 pid)
rect:
- 类型:JSON 对象
- 默认值:充满整个父页面
- 描述:(可选项)frame 的位置和大小。
- 内部字段:
{
x:0, //(可选项)数字类型;左上角x坐标
y:0, //(可选项)数字类型;左上角y坐标
w:320, //(可选项)数字类型;宽度
h:480 //(可选项)数字类型;高度
}
fixedOn:
- 类型:字符串类型
- 描述:(可选项)模块视图添加到指定 frame 的名字(只指 frame,传 window 无效)
- 默认:模块依附于当前 window
fixed:
- 类型:布尔
- 默认值:true
- 描述:是否将模块视图固定到窗口上,不跟随窗口上下滚动,可为空
jsObjectName:
- 类型:字符串
- 描述:(可选项) 注入到h5页面的全局window属性对象名称,可与addJsToPage配合使用。
callback(ret,err)
ret:
- 类型:JSON对象
- 描述:购买成功后返回
- 内部字段:
{
status: true, //布尔值,操作状态
orderResultList : [], //字符串数组,订单号数组
}
err:
- 类型:JSON对象
- 描述:错误时返回
- 内部字段:
{
code: -1, //数值类型,code
message : '', //字符串,提示信息
}
示例代码
var alibcTrade = api.require('alibcTrade');
alibcTrade.showShopPageWeb(
{
shopId:'60552065',
pid:'',
rect:{
x:0,
y:0,
w:320,
h:480
},
jsObjectName:'aliBC'
},function(ret,err){
if(ret){
alert(JSON.stringify(ret));
}else{
alert(JSON.stringify(err));
}
});
可用性
ios系统,Android系统
可提供的1.0.0及更高版本
showPageByUrl
打开url展示页面。(注意 目前ios下 若为二合一页面会强制跳转手淘)
showPageByUrl({params},callback(ret,err))
params
url:
- 类型:字符串
- 描述:url
openType:
- 类型:字符串
- 默认:'h5'
- 描述:(可选项)打开页面的方式:拉起手淘/天猫 和 h5打开页面,默认值:h5
- 取值范围:
- 'auto' //智能判断
- 'native' //手机淘宝/天猫
- 'h5' //h5
linkKey:
- 类型:字符串
- 默认:无
- 描述:(可选项)当打开页面的方式(openType)为native时,设置拉起手淘or天猫。(不传则走百川默认设置,建议传值)
- 取值范围:
- 'tmall' //拉起天猫
- 'taobao' //拉起手淘
pid:
- 类型:字符串
- 描述:(可选项) 淘客 pid (需登录阿里妈妈,实名认证后可获取 pid)
taokeAppkey:
- 类型:字符串
- 描述:(可选项) 淘宝联盟后台的APPKEY字段。新版本SDK新增 高佣转链/跨店结算 功能所需, 如果需要高分佣能力,务必传入adzoneId和taokeAppkey 参数 并且openType设置为'native' 功能介绍
adzoneId:
- 类型:字符串
- 描述:(可选项)淘宝联盟adzoneId。新版本SDK新增 高佣转链/跨店结算 功能所需, 如果需要高分佣能力,务必传入adzoneId和taokeAppkey 参数 并且openType设置为'native' 功能介绍
pageClose:
- 类型:布尔型
- 默认:true
- 描述:(可选项) 购买商品支付成功后是否关闭淘宝页面。true:关闭,false:不关闭。仅Android有效
callback(ret,err)
ret:
- 类型:JSON对象
- 描述:购买成功后返回
- 内部字段:
{
status: true, //布尔值,操作状态
orderResultList : [], //字符串数组,订单号数组
}
err:
- 类型:JSON对象
- 描述:错误时返回
- 内部字段:
{
code: -1, //数值类型,code
message : '', //字符串,提示信息
}
示例代码
var alibcTrade = api.require('alibcTrade');
alibcTrade.showPageByUrl(
{
url:'',
pid:'',
pageClose:false
},function(ret,err){
if(ret){
alert(JSON.stringify(ret));
}else{
alert(JSON.stringify(err));
}
});
可用性
ios系统,Android系统
可提供的1.0.0及更高版本
showPageByUrlWeb
使用外部webview方式,打开url展示页面。
showPageByUrlWeb({params},callback(ret,err))
params
url:
- 类型:字符串
- 描述:url
pid:
- 类型:字符串
- 描述:(可选项) 淘客 pid (需登录阿里妈妈,实名认证后可获取 pid)
rect:
- 类型:JSON 对象
- 默认值:充满整个父页面
- 描述:(可选项)frame 的位置和大小。
- 内部字段:
{
x:0, //(可选项)数字类型;左上角x坐标
y:0, //(可选项)数字类型;左上角y坐标
w:320, //(可选项)数字类型;宽度
h:480 //(可选项)数字类型;高度
}
fixedOn:
- 类型:字符串类型
- 描述:(可选项)模块视图添加到指定 frame 的名字(只指 frame,传 window 无效)
- 默认:模块依附于当前 window
fixed:
- 类型:布尔
- 默认值:true
- 描述:是否将模块视图固定到窗口上,不跟随窗口上下滚动,可为空
jsObjectName:
- 类型:字符串
- 描述:(可选项) 注入到h5页面的全局window属性对象名称,可与addJsToPage配合使用。
callback(ret,err)
ret:
- 类型:JSON对象
- 描述:购买成功后返回
- 内部字段:
{
status: true, //布尔值,操作状态
orderResultList : [], //字符串数组,订单号数组
}
err:
- 类型:JSON对象
- 描述:错误时返回
- 内部字段:
{
code: -1, //数值类型,code
message : '', //字符串,提示信息
}
示例代码
var alibcTrade = api.require('alibcTrade');
alibcTrade.showPageByUrlWeb(
{
url:'',
pid:'',
rect:{
x:0,
y:0,
w:320,
h:480
},
jsObjectName:'aliBC'
},function(ret,err){
if(ret){
alert(JSON.stringify(ret));
}else{
alert(JSON.stringify(err));
}
});
可用性
ios系统,Android系统
可提供的1.0.0及更高版本
removeWeb
从视图中移除当前通过show...Web打开的百川页面。
removeWeb()
示例代码
var alibcTrade = api.require('alibcTrade');
alibcTrade.removeWeb();
可用性
iOS系统,Android系统
可提供的1.0.0及更高版本