You need to enable JavaScript to run this app.
导航
​Cordova SDK 集成开发指南​(SaaS-修订中)
最近更新时间:2024.06.04 20:58:11首次发布时间:2023.06.09 16:02:39

1. 集成SDK

1.1 版本支持须知

  • Cordova版本支持:5.0.0及以上
  • App适配最低系统版本:Android 4.4-10 ,iOS 8.0

1.2 集成 Cordova 插件

cordova plugin add cordova-plugin-rangersapplog

1.3 集成 iOS 原生端依赖

1.3.1 集成iOS SDK

如您使用CocoaPods远程集成,请参考【外部】iOS SDK集成1.1~1.4小节;
如您需手动引入集成,请参考1.5小节。

1.3.2 配置Scheme(可选)

如需使用实时埋点检测(https://www.volcengine.com/docs/6285/66054)功能,请参考【外部】iOS SDK集成 第3节,配置Scheme。

1.4 集成 Android 原生端依赖

1.4.1 集成Android SDK

如您使用远程集成,请参考【外部】Android SDK集成 1.1~1.5小节;
如您需手动引入集成,请参考1.7小节。

1.4.2 配置Scheme(可选)

如需使用实时埋点检测(https://www.volcengine.com/docs/6285/66054)功能,请参考【外部】Android SDK集成 第3节,配置Scheme。

2. 初始化SDK

说明
SDK会在初始化的时候就采集用户信息,请确保您采集用户信息之前已经获得用户授权。
合规建议操作如下:
用户授权后再进行SDK的初始化,取得用户授权前所有的信息都不会采集,预置事件也不会被采集。

2.1 获取appid

在开始集成前,首先需要在集团中接入一个项目及应用,进行SDK集成前,您需要获取对应应用的appid信息。
私有化场景下您可以在「全局设置」->「系统设置」->「集团设置」-> 「项目列表」中查看项目详情,可查看其中的appid,详情请参见集团设置
图片

2.2 获取数据上送地址

私有化部署版本需要获取数据上送地址。
如您不清楚此地址,请联系您的项目经理或客户成功经理。

2.3 初始化SDK(SaaS版本)

Cordova目前需在原生端代码中完成初始化,分别初始化Android SDK、iOS SDK。
如您使用SaaS部署版本,请参考如下代码:

2.4 初始化SDK(私有化版本)

Cordova目前需在原生端代码中完成初始化,分别初始化Android SDK、iOS SDK。
如您使用私有化部署版本,请参考如下代码:

3. 用户与用户属性

3.1 登录态变化调用

3.1.1 账户登录

如您的产品中有账户体系,请在用户登录后立即设置uuid,以保证用户登录前后口径一致性。

const AppLog = cordova.plugins.AppLog;

// 登录时设置您账号体系的ID, 并保证其唯一性
AppLog.setUserUniqueId('{{USER_UNIQUE_ID}}',(v)=>{
    console.log("登录成功");
},(err) =>{
    console.log(err.message);
});

3.1.2 账户登出

在账户登出时调用。

const AppLog = cordova.plugins.AppLog;

// 登出时设置uuid为null
AppLog.setUserUniqueId(null,()=>{
    console.log("登出成功");
},(err) =>{
    console.log(err.message);
});

3.2 设置用户属性

3.2.1 profileSet

设置用户属性,存在则覆盖,不存在则创建。

const AppLog = cordova.plugins.AppLog;

// 示例:设置用户属性,属性名为key,属性值为value
AppLog.profileSet({
    "key": "value"
}, () => {
    console.log('设置用户属性成功');
}, (err) => {
    console.log('设置用户属性失败:' + err.message);
});

3.2.2 profileSetOnce

设置用户属性,存在则不设置,不存在则创建,适合首次相关的用户属性,比如首次访问时间等。

const AppLog = cordova.plugins.AppLog;

// 示例:设置用户属性,属性名为key_once,属性值为value_once
AppLog.profileSetOnce({
    "key_once": "value_once"
}, () => {
    console.log('设置用户属性成功');
}, (err) => {
    console.log('设置用户属性失败:' + err.message);
});

3.2.3 profileIncrement

设置数值类型的属性,可进行累加。

const AppLog = cordova.plugins.AppLog;

// 示例:设置用户属性,属性名为key,属性值为1
AppLog.profileIncrement({
    "key": 1
}, () => {
    console.log('设置用户属性成功');
}, (err) => {
    console.log('设置用户属性失败:' + err.message);
});

3.2.4 profileAppend

设置List类型的用户属性,可持续向List内添加。

const AppLog = cordova.plugins.AppLog;

// 示例:置用户属性,属性名为key,原本已有属性值,现添加属性值为value_append
AppLog.profileAppend({
    "key": "value_append"
}, () => {
    console.log('设置用户属性成功');
}, (err) => {
    console.log('设置用户属性失败:' + err.message);
});

3.2.5 profileUnset

删除用户的属性。

const AppLog = cordova.plugins.AppLog;

// 示例:删除用户属性,属性名为key
AppLog.profileUnset("key", () => {
    console.log('设置用户属性成功');
}, (err) => {
    console.log('设置用户属性失败:' + err.message);
});

4. 获取AB实验参数

4.1 获取AB实验值

可以直接传入 key,从配置中读取需要的值(Anrdoid 不支持)。

const AppLog = cordova.plugins.AppLog;

// 示例:获取 key 为 ab_test_key 的 value
AppLog.getABTestConfigValueForKey("ab_test_key", (value) => {
    console.log('获取Ab实验值成功:' + value);
}, (err) => {
    console.log('获取Ab实验值失败:' + err.message);
});

4.2 获取所有AB实验版本

返回值是所有实验版本ID,以逗号隔开(Anrdoid 不支持)。

const AppLog = cordova.plugins.AppLog;

// 示例:获取所有 ab sdk version
AppLog.getAbSdkVersions((vids) => {
    console.log('获取AbSdkVersions成功:' + vids);
}, (err) => {
    console.log('获取AbSdkVersions失败:' + err.message);
});

5.事件与事件属性

5.1 上报代码埋点

用户行为日志采用事件event+属性params的形式,事件一般对应多个属性,也可以仅有事件没有属性。
仅上报事件的代码埋点,示例如下:

const AppLog = cordova.plugins.AppLog;

// 示例:上报事件event,该事件不包含属性
AppLog.onEventV3("event", {}, () => {
    console.log('调用上报埋点成功');
}, (err) => {
    console.log('调用上报埋点失败:' + err.message);
});

上报事件和对应属性的代码埋点,示例如下:

const AppLog = cordova.plugins.AppLog;

// 示例:上报事件event,该事件包含两个属性
//      一个string类型的属性,属性名为key_string,属性值为value_string
//      一个int类型的属性,属性名为key_int,属性值为10
AppLog.onEventV3("event", {
    "key_string": "value_string",
    "key_int": 10
}, () => {
    console.log('调用上报埋点成功');
}, (err) => {
    console.log('调用上报埋点失败:' + err.message);
});

5.2 设置公共属性

关于自定义 “公共属性” 请注意:

  1. 上报机制是随着每一次日志发送进行提交,默认的日志发送频率是1分钟,所以如果在一分钟内连续修改自定义公共属性,按照日志发送前的最后一次修改为准。
  2. 不推荐高频次修改,如每秒修改一次。
const AppLog = cordova.plugins.AppLog;

// 示例:设置自定义的公共属性,属性名为key_public,属性值为value_public
AppLog.setHeaderInfo({
    "key_public": "value_public"
}, () => {
    console.log('设置公共属性成功');
}, (err) => {
    console.log('设置公共属性失败:' + err.message);
});

6. 其他功能

6.1 获取平台ID与通知

请注意 deviceid 是火山生成的 id,不是原始设备id,此功能Android暂不支持。

const AppLog = cordova.plugins.AppLog;

// 示例:获取did
AppLog.getDeviceID((did) => {
    console.log('获取did成功:' + did);
}, (err) => {
    console.log('获取did失败:' + err.message);
});