tbkUnionUltimate

概述

淘宝联盟简介

淘宝联盟是促成生态合作伙伴与广告主生意经营的平台,合作伙伴包含且不仅限于各类流量媒体、内容媒体、社交个人、网红达人、MCN机构、招商服务商、工具服务商、代理机构等。平台优势:零门槛,淘宝账户登录即可推广;零成本,专做商品推荐与分享不囤货不发货;零风险,分享推广轻松学会带来成交拿佣金。

tbkUnion 插件概述

本插件封装了淘宝联盟的原生 SDK,可用于实现淘宝导购闭环。

插件使用攻略

使用之前须从淘宝联盟平台申请开发者账号并创建应用,获取 appid。

淘宝联盟申请地址淘宝联盟

使用此插件之前建议先配置 config.xml 文件,配置完毕,需通过云端编译生效,配置方法如下:

  • 名称:tbkUnion
  • 配置示例:
    
    <preference name="querySchemes" value="tbopen,tmall,taobao,taobaolite"/>

    <feature name="tbkUnionUltimate">
        <param name="urlScheme" value=""/>
        <param name="android_appKey" value=""/>
        <param name="ios_appKey" value=""/>
    </feature>

插件接口

initSdk

sdk 初始化

initSdk({params},callback(ret, err))

params

callback(ret, err)

ret:

  • 类型:JSON 对象
  • 内部字段:
{
    status: true, //初始化状态
    code: 0, //状态码
    type: 'onSuccess', //事件类型 onSuccess  onFailure
    msg: "onSuccess",//描述
    result:{ //其他结果数据
        version:"3.3.9" //sdk 版本号
    }
}

示例代码

var tbkUnionUltimate = api.require('tbkUnionUltimate');
tbkUnionUltimate.initSdk({
    debug:false //选填
},function(ret, err) {
    if (ret.status) {
        alert("sdk 初始化成功");
    } else {
        alert('sdk 初始化失败');
    }
});

可用性

iOS系统,Android系统

可提供的1.0.0及更高版本

showLogin

登录

showLogin({params}, callback(ret, err))

params

callback(ret, err)

ret:

  • 类型:JSON 对象
  • 内部字段:
{
    status: true, //初始化状态
    code: 0, //状态码
    type: 'onSuccess', //事件类型 onSuccess  onFailure
    msg: "描述",//描述
    result:{ //其他结果数据
        
    }
}

示例代码

var tbkUnionUltimate = api.require('tbkUnionUltimate');
tbkUnionUltimate.showLogin({

}, function(ret, err) {
    if (ret.status) {

    } else {
        alert(err.code);
    }
});

可用性

iOS系统,Android系统

可提供的1.0.0及更高版本

isLogin

验证登录

isLogin({params}, callback(ret, err))

params

callback(ret, err)

ret:

  • 类型:JSON 对象
  • 内部字段:
{
    status: true, //初始化状态
    code: 0, //状态码
    type: 'onSuccess', //事件类型 onSuccess  onFailure
    msg: "描述",//描述
    result:{ //其他结果数据
        
    }
}

示例代码

var tbkUnionUltimate = api.require('tbkUnionUltimate');
tbkUnionUltimate.isLogin({

}, function(ret, err) {
    if (ret.status) {

    } else {
        alert(ret.msg);
    }
});

可用性

iOS系统,Android系统

可提供的1.0.0及更高版本

getUserInfo

获取用户信息

getUserInfo({params}, callback(ret, err))

params

callback(ret, err)

ret:

  • 类型:JSON 对象
  • 内部字段:
{
    status: true, //初始化状态
    code: 0, //状态码
    type: 'onSuccess', //事件类型 onSuccess  onFailure
    msg: "描述",//描述
    result:{ //其他结果数据
        
    }
}

示例代码

var tbkUnionUltimate = api.require('tbkUnionUltimate');
tbkUnionUltimate.getUserInfo({

}, function(ret, err) {
    if (ret.status) {

    } else {
        alert(ret.msg);
    }
});

可用性

iOS系统,Android系统

可提供的1.0.0及更高版本

logout

登出

logout({params}, callback(ret, err))

params

callback(ret, err)

示例代码

var tbkUnionUltimate = api.require('tbkUnionUltimate');
tbkUnionUltimate.logout({

}, function(ret, err) {
    
});

可用性

iOS系统,Android系统

可提供的1.0.0及更高版本

setChannel

设置渠道

setChannel({params}, callback(ret, err))

params

type:

  • 类型:字符串
  • 描述:(必填)渠道类型

name:

  • 类型:字符串
  • 描述:(必填)渠道名称

callback(ret, err)

示例代码

var tbkUnionUltimate = api.require('tbkUnionUltimate');
tbkUnionUltimate.setChannel({type:"",name:""});

可用性

iOS系统,Android系统

可提供的1.0.0及更高版本

setIsvVersion

设置三方媒体应用版本号

setIsvVersion({params}, callback(ret, err))

params

version:

  • 类型:字符串
  • 描述:(必填)版本号

callback(ret, err)

示例代码

var tbkUnionUltimate = api.require('tbkUnionUltimate');
tbkUnionUltimate.setIsvVersion({version:""});

可用性

iOS系统,Android系统

可提供的1.0.0及更高版本

showAuth

showAuth

showAuth({params}, callback(ret, err))

params

appName:

  • 类型:字符串
  • 描述:(必填)app名称

appLogo:

  • 类型:字符串
  • 描述:(必填)app图标

appKey:

  • 类型:字符串
  • 描述:(必填)服务端接口appkey (可与阿百川appkey不同)

callback(ret, err)

ret:

  • 类型:JSON 对象
  • 内部字段:
{
    status: true, //初始化状态
    code: 0, //状态码
    type: 'onSuccess', //事件类型 onSuccess onFailure
    msg: "描述",//描述
    result:{ //其他结果数据
        
    }
}

示例代码

var tbkUnionUltimate = api.require('tbkUnionUltimate');
tbkUnionUltimate.showAuth({
    appLogo:"",
    appName:api.appName,
    appKey:"",//服务端接口appkey 可与阿百川appkey不同
}, function(ret, err) {
    if (ret.status) {

    } else {
        alert(ret.msg);
    }
});

可用性

iOS系统,Android系统

可提供的1.0.0及更高版本

openByCode

openByCode

openByCode({params}, callback(ret, err))

params

code:

  • 类型:字符串
  • 描述:(必填)***********

bizParams:

  • 类型:对象
  • 描述:(选填)业务参数
{
    id:'', //商品id(详情页面必传)
    shopId:'',// 店铺id(店铺页面必传)
    sellerId:'',//卖家id(店铺页面必传)
    extParams:{ //扩展业务参数(涉及到联盟侧诸如返佣比例等参数,具体含义及获取会在分佣相关部分说明)
        
    }
}

showParams:

  • 类型:对象
  • 描述:(选填)页面打开方式自定义参数
{
    title:'', //淘宝联盟
    backUrl:'',//config
    clientType:'',//taobao  (手淘:taobao,天猫:tmall)
    degradeType:'',//H5 (NONE,H5,Download);
    degradeUrl:'',
    openType:'',//true
    newWindow:'',//true
}

taokeParams:

  • 类型:对象
  • 描述:(选填) 淘客参数
{
    pid:'',// 淘客广告位 config
    subPid:'',// 三方的淘客广告位( config
    unionId:'', //淘客unionId
    relationId:'', //渠道id(非必填项)
    materialSourceUrl:'', //媒体物料来源url(非必填项):数据链路的回溯支持
    extParams:{ //扩展参数(分佣相关的)
        taokeAppkey:''
    }
}

trackParams:

  • 类型:对象
  • 描述:(选填) 链路跟踪参数(自定义)
{
    
}

callback(ret, err)

ret:

  • 类型:JSON 对象
  • 内部字段:
{
    status: true, //初始化状态
    code: 0, //状态码
    type: 'onSuccess', //事件类型 onSuccess onFailure
    msg: "描述",//描述
    result:{ //其他结果数据
        
    }
}

示例代码

var tbkUnionUltimate = api.require('tbkUnionUltimate');
tbkUnionUltimate.openByCode({
    code:"",
    bizParams:{
        id:'', //商品id(详情页面必传)
        shopId:'',// 店铺id(店铺页面必传)
        sellerId:'',//卖家id(店铺页面必传)
        extParams:{ //扩展业务参数(涉及到联盟侧诸如返佣比例等参数,具体含义及获取会在分佣相关部分说明)
            
        }
    },
    showParams:{
        title:'', //淘宝联盟
        backUrl:'',//config
        clientType:'',//taobao  (手淘:taobao,天猫:tmall)
        degradeType:'',//H5 (NONE,H5,Download);
        degradeUrl:'',
        openType:'',//true
        newWindow:'',//true
    },
    taokeParams:{
        pid:'',// 淘客广告位 config
        subPid:'',// 三方的淘客广告位( config
        unionId:'', //淘客unionId
        relationId:'', //渠道id(非必填项)
        materialSourceUrl:'', //媒体物料来源url(非必填项):数据链路的回溯支持
        extParams:{ //扩展参数(分佣相关的)
            taokeAppkey:''
        }
    },
    trackParams:{
        
    }
}, function(ret, err) {
    if (ret.status) {

    } else {
        alert(ret.msg);
    }
});

可用性

iOS系统,Android系统

可提供的1.0.0及更高版本

closeByCode

关闭openByCode打开页面

closeByCode({params}, callback(ret, err))

params

callback(ret, err)

示例代码

var tbkUnionUltimate = api.require('tbkUnionUltimate');
tbkUnionUltimate.closeByCode();

可用性

iOS系统,Android系统

可提供的1.0.0及更高版本

openByUrl

openByUrl

openByUrl({params}, callback(ret, err))

params

url:

  • 类型:字符串
  • 描述:(必填)链接地址

showParams:

  • 类型:对象
  • 描述:(选填)页面打开方式自定义参数
{
    title:'', //淘宝联盟
    backUrl:'',//config
    clientType:'',//taobao  (手淘:taobao,天猫:tmall)
    degradeType:'',//H5 (NONE,H5,Download);
    degradeUrl:'',
    openType:'',//true
    newWindow:'',//true
}

taokeParams:

  • 类型:对象
  • 描述:(选填) 淘客参数
{
    pid:'',// 淘客广告位 config
    subPid:'',// 三方的淘客广告位( config
    unionId:'', //淘客unionId
    relationId:'', //渠道id(非必填项)
    materialSourceUrl:'', //媒体物料来源url(非必填项):数据链路的回溯支持
    extParams:{ //扩展参数(分佣相关的)
        taokeAppkey:''
    }
}

trackParams:

  • 类型:对象
  • 描述:(选填) 链路跟踪参数(自定义)
{
    
}

callback(ret, err)

ret:

  • 类型:JSON 对象
  • 内部字段:
{
    status: true, //初始化状态
    code: 0, //状态码
    type: 'onSuccess', //事件类型 onSuccess onFailure
    msg: "描述",//描述
    result:{ //其他结果数据
        
    }
}

示例代码

var tbkUnionUltimate = api.require('tbkUnionUltimate');
tbkUnionUltimate.openByUrl({
    url:'',
    showParams:{
        title:'', //淘宝联盟
        backUrl:'',//config
        clientType:'',//taobao  (手淘:taobao,天猫:tmall)
        degradeType:'',//H5 (NONE,H5,Download);
        degradeUrl:'',
        openType:'',//true
        newWindow:'',//true
    },
    taokeParams:{
        pid:'',// 淘客广告位 config
        subPid:'',// 三方的淘客广告位( config
        unionId:'', //淘客unionId
        relationId:'', //渠道id(非必填项)
        materialSourceUrl:'', //媒体物料来源url(非必填项):数据链路的回溯支持
        extParams:{ //扩展参数(分佣相关的)
            taokeAppkey:''
        }
    },
    trackParams:{
        
    }
}, function(ret, err) {
    if (ret.status) {

    } else {
        alert(ret.msg);
    }
});

可用性

iOS系统,Android系统

可提供的1.0.0及更高版本

是否仍需要帮助? 请保持联络!
最后更新于 2024/01/26