rangersAppLog
概述
巨量引擎转化跟踪简介
巨量引擎智能平台为广告主及合作伙伴提供一站式辅助投放工具,从广告创意制作到效果优化,巨量引擎智能工具帮您一站式完成,让您的广告推广更加简单。
klevinAds 插件概述
本插件封装了巨量引擎转化跟踪的原生 SDK，集成了app内部事件监听。
插件使用攻略
使用之前须从巨量引擎转化跟踪平台申请开发者账号并创建应用，获取 appId。
巨量引擎转化跟踪申请地址巨量引擎转化跟踪
插件依赖
- 注意：
如需获取全量设备的oaid，需确保已接入信通院sdk，否则只能获取到华为、小米和oppo的oaid。
1.为不与其他包含 miitMsa (移动安全联盟sdk) 插件冲突，此插件不包含所需的 miitMsa 依赖包
2.如果当前应用不包含 miitMsa ，请移步到论坛反馈获取移动安全联盟依赖自定义插件包
3.论坛地址：https://community.yonyou.com/bbs/thread-191332-1-1.html
使用此插件之前建议先配置 config.xml 文件，配置完毕，需通过云端编译生效，配置方法如下：
- 名称：rangersAppLog
- 参数：android_appId、ios_appId
- 配置示例:
<feature name="rangersAppLog">
<param name="android_appId" value="xxx" />
<param name="ios_appId" value="xxx" />
</feature>
字段描述:
android_appId：安卓平台应用appid
ios_appId：苹果平台应用appid
插件接口
initSdk
sdk 初始化
initSdk({params},callback(ret, err))
params
appName：
- 类型：字符串
- 描述：（必填）APP名称 (对应平台填写的名称)
channel：
- 类型：字符串
- 描述：（必填）渠道 （自定义）
enablePlay：
- 类型：布尔
- 描述：（选填）是否开启游戏模式 (默认：false)
enableAb：
- 类型：布尔
- 描述：（选填）是否开启A/B Test功能 (默认：false)
enableAutoStart：
- 类型：布尔
- 描述：（选填）是否自动开始 (默认：true)
language：
- 类型：字符串
- 描述：（选填）语言标识
region：
- 类型：字符串
- 描述：（选填）地区标识
callback(ret, err)
ret：
- 类型：JSON 对象
- 内部字段：
{
status: true, //初始化状态
code: 0, //状态码
type: 'onInit', //事件类型
msg: "onInitSdk",//描述
result:{ //其他结果数据
}
}
示例代码
var rangersAppLog = api.require('rangersAppLog');
rangersAppLog.initSdk({
appName: api.appName,
channel:"appStore",//应用宝 appstore oppo vivo 360 huawei 百度
enablePlay: false,//是否开启游戏模式
enableAb: false,//是否开启A/B Test功能
enableAutoStart: true,//是否自动开始
language: "",//语言标识
region: "",//地区标识
},function(ret, err) {
if (ret.status) {
alert("sdk 初始化成功");
} else {
alert('sdk 初始化失败');
}
});
可用性
iOS系统，Android系统
可提供的1.0.0及更高版本
setUserUniqueId
设置用户唯一标识
setUserUniqueId({params}, callback(ret, err))
params
userUniqueId：
- 类型：字符串
- 描述：（必填）设置用户唯一标识
callback(ret, err)
ret：
- 类型：JSON 对象
- 内部字段：
无
示例代码
var rangersAppLog = api.require('rangersAppLog');
rangersAppLog.setUserUniqueId({
userUniqueId:"1"
}, function(ret, err) {
});
可用性
iOS系统，Android系统
可提供的1.0.0及更高版本
clearUserUniqueId
清除用户标识（用于账号退出登录时使用[android此方法空执行，避免客户端的判断]）
clearUserUniqueId({params}, callback(ret, err))
params
无
callback(ret, err)
ret：
- 类型：JSON 对象
- 内部字段：
无
示例代码
var rangersAppLog = api.require('rangersAppLog');
rangersAppLog.clearUserUniqueId({
}, function(ret, err) {
});
可用性
iOS系统，Android系统
可提供的1.0.0及更高版本
customEvent
自定义事件上报
customEvent({params}, callback(ret, err))
params
type：
- 类型：字符串
- 描述：（必填）事件类型
params：
- 类型：对象
- 描述：（必填）事件参数 （自定义）
{
type: "wechat",
sex: "1",
age: "18"
}
callback(ret, err)
ret：
- 类型：JSON 对象
- 内部字段：
无
示例代码
var rangersAppLog = api.require('rangersAppLog');
rangersAppLog.customEvent({
type:"register", //事件类型
params:{
type: "wechat",
sex: "1",
age: "18"
}
}, function(ret, err) {
});
可用性
iOS系统，Android系统
可提供的1.0.0及更高版本
viewContentEvent
内容/商品详情页面事件上报
viewContentEvent({params}, callback(ret, err))
params
id：
- 类型：字符串
- 描述：（必填）内容ID
type：
- 类型：字符串
- 描述：（必填）内容类型
name：
- 类型：字符串
- 描述：（必填）内容名称
callback(ret, err)
ret：
- 类型：JSON 对象
- 内部字段：
无
示例代码
var rangersAppLog = api.require('rangersAppLog');
rangersAppLog.viewContentEvent({
id:"1", //内容ID
type:"detail", //内容类型
name:"活动1", //内容名称
}, function(ret, err) {
});
可用性
iOS系统，Android系统
可提供的1.0.0及更高版本
registerEvent
注册事件上报
registerEvent({params}, callback(ret, err))
params
type：
- 类型：字符串
- 描述：（必填）类型
callback(ret, err)
ret：
- 类型：JSON 对象
- 内部字段：
无
示例代码
var rangersAppLog = api.require('rangersAppLog');
rangersAppLog.registerEvent({
type:"wechat", //类型 wechat QQ weibo
}, function(ret, err) {
});
可用性
iOS系统，Android系统
可提供的1.0.0及更高版本
loginEvent
登录事件上报
loginEvent({params}, callback(ret, err))
params
type：
- 类型：字符串
- 描述：（必填）类型
callback(ret, err)
ret：
- 类型：JSON 对象
- 内部字段：
无
示例代码
var rangersAppLog = api.require('rangersAppLog');
rangersAppLog.loginEvent({
type:"wechat", //类型 wechat QQ weibo
}, function(ret, err) {
});
可用性
iOS系统，Android系统
可提供的1.0.0及更高版本
accessAccountEvent
账号绑定事件上报
accessAccountEvent({params}, callback(ret, err))
params
type：
- 类型：字符串
- 描述：（必填）类型
callback(ret, err)
ret：
- 类型：JSON 对象
- 内部字段：
无
示例代码
var rangersAppLog = api.require('rangersAppLog');
rangersAppLog.accessAccountEvent({
type:"wechat", //类型 wechat QQ weibo
}, function(ret, err) {
});
可用性
iOS系统，Android系统
可提供的1.0.0及更高版本
accessPaymentChannelEvent
绑定支付渠道事件上报
accessPaymentChannelEvent({params}, callback(ret, err))
params
type：
- 类型：字符串
- 描述：（必填）类型
callback(ret, err)
ret：
- 类型：JSON 对象
- 内部字段：
无
示例代码
var rangersAppLog = api.require('rangersAppLog');
rangersAppLog.accessPaymentChannelEvent({
type:"wechat", //类型 wechat QQ weibo
}, function(ret, err) {
});
可用性
iOS系统，Android系统
可提供的1.0.0及更高版本
addCartEvent
添加购物车事件上报
addCartEvent({params}, callback(ret, err))
params
id：
- 类型：字符串
- 描述：（必填）商品ID
type：
- 类型：字符串
- 描述：（必填）商品类型
name：
- 类型：字符串
- 描述：（必填）商品名称
num：
- 类型：字符串
- 描述：（必填）商品数量
callback(ret, err)
ret：
- 类型：JSON 对象
- 内部字段：
无
示例代码
var rangersAppLog = api.require('rangersAppLog');
rangersAppLog.addCartEvent({
id:"1", //商品ID
type:"gift", //商品类型
name:"商品名称", //商品名称
num:1, //商品数量
}, function(ret, err) {
});
可用性
iOS系统，Android系统
可提供的1.0.0及更高版本
addFavoriteEvent
添加收藏事件上报
addFavoriteEvent({params}, callback(ret, err))
params
id：
- 类型：字符串
- 描述：（必填）商品ID
type：
- 类型：字符串
- 描述：（必填）商品类型
name：
- 类型：字符串
- 描述：（必填）商品名称
num：
- 类型：字符串
- 描述：（必填）商品数量
callback(ret, err)
ret：
- 类型：JSON 对象
- 内部字段：
无
示例代码
var rangersAppLog = api.require('rangersAppLog');
rangersAppLog.addFavoriteEvent({
id:"1", //商品ID
type:"gift", //商品类型
name:"商品名称", //商品名称
num:1, //商品数量
}, function(ret, err) {
});
可用性
iOS系统，Android系统
可提供的1.0.0及更高版本
checkOutEvent
提交订单事件上报
checkOutEvent({params}, callback(ret, err))
params
id：
- 类型：字符串
- 描述：（必填）商品ID
type：
- 类型：字符串
- 描述：（必填）商品类型
name：
- 类型：字符串
- 描述：（必填）商品名称
num：
- 类型：字符串
- 描述：（必填）商品数量
payChannel：
- 类型：字符串
- 描述：（必填）付款渠道
isVirtualCurrency：
- 类型：字符串
- 描述：（必填）是否虚拟货币
currency：
- 类型：字符串
- 描述：（必填）货币类型
amount：
- 类型：字符串
- 描述：（必填）订单金额
callback(ret, err)
ret：
- 类型：JSON 对象
- 内部字段：
无
示例代码
var rangersAppLog = api.require('rangersAppLog');
rangersAppLog.checkOutEvent({
id:"1", //商品ID
type:"gift", //商品类型
name:"商品名称", //商品名称
num:1, //商品数量
payChannel:"wechat", //支付渠道 wechat alipay QQ unionPay
isVirtualCurrency:false, //是否未虚拟货币
currency:"￥",//货币类型 ￥ $
amount:1, //付款金额
}, function(ret, err) {
});
可用性
iOS系统，Android系统
可提供的1.0.0及更高版本
purchaseEvent
付款事件上报
purchaseEvent({params}, callback(ret, err))
params
id：
- 类型：字符串
- 描述：（必填）商品ID
type：
- 类型：字符串
- 描述：（必填）商品类型
name：
- 类型：字符串
- 描述：（必填）商品名称
num：
- 类型：字符串
- 描述：（必填）商品数量
payChannel：
- 类型：字符串
- 描述：（必填）付款渠道
currency：
- 类型：字符串
- 描述：（必填）货币类型
amount：
- 类型：字符串
- 描述：（必填）订单金额
callback(ret, err)
ret：
- 类型：JSON 对象
- 内部字段：
无
示例代码
var rangersAppLog = api.require('rangersAppLog');
rangersAppLog.purchaseEvent({
id:"1", //商品ID
type:"gift", //商品类型
name:"商品名称", //商品名称
num:1, //商品数量
payChannel:"wechat", //支付渠道 wechat alipay QQ unionPay
currency:"￥",//货币类型 ￥ $
amount:1, //付款金额
}, function(ret, err) {
});
可用性
iOS系统，Android系统
可提供的1.0.0及更高版本
createGameRoleEvent
创建角色事件上报
createGameRoleEvent({params}, callback(ret, err))
params
id：
- 类型：字符串
- 描述：（必填）角色ID
callback(ret, err)
ret：
- 类型：JSON 对象
- 内部字段：
无
示例代码
var rangersAppLog = api.require('rangersAppLog');
rangersAppLog.createGameRoleEvent({
id:"1", //角色ID
}, function(ret, err) {
});
可用性
iOS系统，Android系统
可提供的1.0.0及更高版本
updateLevelEvent
角色升级事件上报
updateLevelEvent({params}, callback(ret, err))
params
level：
- 类型：字符串
- 描述：（必填）角色等级
callback(ret, err)
ret：
- 类型：JSON 对象
- 内部字段：
无
示例代码
var rangersAppLog = api.require('rangersAppLog');
rangersAppLog.updateLevelEvent({
level:"88", //角色等级
}, function(ret, err) {
});
可用性
iOS系统，Android系统
可提供的1.0.0及更高版本
questEvent
完成任务事件上报
questEvent({params}, callback(ret, err))
params
id：
- 类型：字符串
- 描述：（必填）任务ID
type：
- 类型：字符串
- 描述：（必填）任务类型
name：
- 类型：字符串
- 描述：（必填）任务名称
sort：
- 类型：字符串
- 描述：（必填）任务项
state：
- 类型：字符串
- 描述：（必填）任务状态
desc：
- 类型：字符串
- 描述：（必填）任务描述
callback(ret, err)
ret：
- 类型：JSON 对象
- 内部字段：
无
示例代码
var rangersAppLog = api.require('rangersAppLog');
rangersAppLog.questEvent({
id:"1", //任务ID
type:"tasktype", //任务类型
name:"任务名称", //任务名称
sort:0, //任务项 （第几项任务）
state:true, //任务状态
desc:"任务描述", //任务描述
}, function(ret, err) {
});
可用性
iOS系统，Android系统
可提供的1.0.0及更高版本
getAbParams
获取AB参数
getAbParams({params}, callback(ret, err))
params
params：
- 类型：对象
- 描述：（必填）属性参数 （自定义）
["age","type","sex"]
callback(ret, err)
ret：
- 类型：JSON 对象
- 内部字段：
{
status: true, //初始化状态
code: 0, //状态码
type: 'getAbParams', //事件类型
msg: "getAbParams",//描述
result:{ //其他结果数据
age:"18",
type:"1",
sex:"1",
}
}
示例代码
var rangersAppLog = api.require('rangersAppLog');
rangersAppLog.getAbParams({
params:["age","type","sex"],
}, function(ret, err) {
if (ret.status) {
var result = ret.result; //参数结果集
}
});
可用性
iOS系统，Android系统
可提供的1.0.0及更高版本
getSsid
获取ssid
getSsid({params}, callback(ret, err))
params
无
callback(ret, err)
ret：
- 类型：JSON 对象
- 内部字段：
{
status: true, //初始化状态
code: 0, //状态码
type: 'getSsid', //事件类型
msg: "getSsid",//描述
result:{ //其他结果数据
ssid:"",
}
}
示例代码
var rangersAppLog = api.require('rangersAppLog');
rangersAppLog.getSsid({
}, function(ret, err) {
if (ret.status) {
var result = ret.result; //参数结果集
var ssid = result.ssid;
}
});
可用性
Android系统
可提供的1.0.0及更高版本
getDid
获取did
getDid({params}, callback(ret, err))
params
无
callback(ret, err)
ret：
- 类型：JSON 对象
- 内部字段：
{
status: true, //初始化状态
code: 0, //状态码
type: 'getDid', //事件类型
msg: "getDid",//描述
result:{ //其他结果数据
did:"",
}
}
示例代码
var rangersAppLog = api.require('rangersAppLog');
rangersAppLog.getDid({
}, function(ret, err) {
if (ret.status) {
var result = ret.result; //参数结果集
var did = result.did;
}
});
可用性
Android系统
可提供的1.0.0及更高版本
getIid
获取iid
getIid({params}, callback(ret, err))
params
无
callback(ret, err)
ret：
- 类型：JSON 对象
- 内部字段：
{
status: true, //初始化状态
code: 0, //状态码
type: 'getIid', //事件类型
msg: "getIid",//描述
result:{ //其他结果数据
iid:"",
}
}
示例代码
var rangersAppLog = api.require('rangersAppLog');
rangersAppLog.getIid({
}, function(ret, err) {
if (ret.status) {
var result = ret.result; //参数结果集
var iid = result.iid;
}
});
可用性
Android系统
可提供的1.0.0及更高版本