Cordova埋点SDK

GitHub Demo:https://github.com/growingio/Cordova-Demo

Cordova版本支持:5.0.0及以上

App适配最低系统版本:iOS 8及以上、Android 4.2-10

1. 集成

1. 安装插件

在您项目主目录中执行以下操作:

cordova plugin add cordova-growingio-plugin

2. 添加跟踪代码

添加依赖

  • 建议使用 Android Studio 打开项目中, platforms文件夹中的android 文件夹

  • Cordova 埋点 SDK 是在 Android 原生 SDK 上的扩展,参照 Android SDK > 埋点 SDK集成,集成步骤的 1~4,操作步骤完全一致。

重要配置

按Android埋点SDK一致。

2. 自定义数据上传

采集自定义事件

track(eventId, eventLevelVariable, onSuccess, onFail)

采集自定义事件 eventId,该事件的属性信息属于事件级变量。

在添加所需要发送的事件代码之前,需要在打点管理用户界面配置事件以及事件级变量eventLevelVariable

参数说明:

参数限制条件:

参数违反以下条件将不发送数据,调用后请验证数据是否发送,事件类型tcstm

var gio = window.cordova.require('cordova-plugin-growingio.GrowingIO');
var onSucc = function(msg) {
    alert(msg);
};
var onFail = function(msg) {
    alert(msg);
};
// track API调用示例一
gio.track("registerSuccess",onSucc,onFail);
// track API调用示例二
gio.track("registerSuccess",{ 'item': '123' },onSucc,onFail);
// track API调用示例三
gio.track("loanAmount", 80000, 
            { "gender":"male","age":"21" },onSucc,onFail);

检验数据发送日志示例:

注意 t 等于 cstm 字段,表示自定义事件发送成功,只需注意 varnnum字段,其它字段无需仔细验证

//展示 track 接口调用示例三日志内容
{
    "s":"31e3aa14-5241-490c-821c-a741e9bf0f87",
    // t 为事件类型, track 接口调用发送的事件类型为 cstm
    "t":"cstm",
    "tm":1532085495251,
    "d":"com.growingio.android.test",
    // n 为 eventId 参数携带的值
    "n":"loanAmount",
    // var 为 eventLevelVariable 参数携带的值
    "var":{
        "gender":"male",
        "age":"21"
    },
    "ptm":0,
    // num 为 number 参数携带的值
    "num":80000,
    "gesid":18,
    "esid":0,
    "u":"b6247b01-a31a-3bc6-a391-4c456888c1ee"
}

推荐您使用MobileDebugger,我们为您列举了应用场景和验证示例,请移步查看:cstm 事件验证

设置转化变量

setEvar(conversionVariables, onSuccess, onFail)

发送一个转化信息用于高级归因分析,在添加代码之前必须在打点管理界面上声明转化变量。

转化变量是一种非常强大的变量类型,主要是为了归因而用,比如访问渠道、站外搜索关键词、站内搜索关键词等等。在 GrowingIO 里面可以定制变量的归因方式和持久性范围。

参数说明:

参数限制条件:

gio.setEvar({ "evarTest":111,
        "campaignId":"1234567890",
        "campaignOwner":"Li Si" },onSucc,onFail);

检验数据发送日志示例:

注意 t 等于evar字段,表示自定义事件发送成功,只需注意 var 字段,其它字段无需仔细验证

{
    "s":"e1c48845-dd60-4cf2-b1a5-a8e529d2188d",
    // t 为事件类型, evar 为转化事件
    "t":"evar",
    "tm":1532338526083,
    "d":"com.growingio.android.test",
    "cs1":"GrowingIO",
    // 转化变量
    "var":{
        "evarTest":111,
        "campaignId":"1234567890",
        "campaignOwner":"Li Si"
    },
    "gesid":300,
    "esid":22
}

推荐您使用 MobileDebugger,我们为您列举了应用场景和验证示例,请移步查看: evar 事件验证

设置登录用户变量

setPeopleVariable(peopleVariables, onSuccess, onFail)

设置用户自身属性相关的属性信息,比如用户姓名、邮件地址、信用等级等。

在添加代码之前必须在打点管理界面上声明用户变量。

参数说明:

参数限制条件:

gio.setPeopleVariable({ 'name': 'testName', 'email': 'testName@company.com' })

检验数据发送日志示例:

注意 t 等于ppl字段,表示用户变量发送成功,只需注意 var字段,其它字段无需仔细验证。

{
    "s":"a35872af-13df-4479-90bc-25558d12328e",
    // t 为事件类型, pvar 为发送用户变量事件
    "t":"ppl",
    "tm":1532339208991,
    "d":"com.growingio.android.test",
    "cs1":"GrowingIO",
    // 用户变量
    "var":{
        'name': 'testName', 
        'email': 'testName@company.com'
    },
    "gesid":311,
    "esid":0
}

推荐您使用 MobileDebugger,我们为您列举了应用场景和验证示例,请移步查看: ppl 事件验证

设置登录用户ID

setUserId(userId, onSuccess, onFail)

把 GrowingIO 识别的访问用户跟应用自身的注册用户做关联,用以登录用户行为分析。

参数说明:

gio.setUserId('xiaoming');

注:您的 App 每次用户升级版本时无需重新登录的话,建议在用户每次升级App 版本后初次访问时重新调用上述 setUserId 方法。

清除登录用户ID

clearUserId(onSuccess, onFail)

当访问用户跟注册用户关联后,之后触发的行为会绑定到该注册用户上。如果有需要解除绑定,比如用户退出登录后,可以通过该函数解决绑定。

参数说明

示例

gio.clearUserId();

设置访问用户变量

当用户未登录时,定义用户属性变量,也可用于A/B测试上传标签。

setVisitor(visitorVar,onSucc,onFail)

参数说明:

gio.setVisitor({"gender":"male","age":21});

3. 创建应用

添加代码之后,请先Clean项目,然后再进行编译,并在你的 App 安装了 SDK 后重新启动几次 App,保证行为采集数据自动发送给 GrowingIO,以便顺利完成检测。

在GrowingIO平台的应用创建页面继续完成应用创建的数据检测,检测成功后应用创建成功。

4. 验证SDK是否正常采集数据

了解GrowingIO平台数据采集类型请参考数据模型

GrowingIO为您提供多种验证SDK是否正常采集数据的方式:

方式一:Mobile Debugger​​

方式二:在SDK中设置了Debug模式后,在IDE编译器控制台查看数据采集日志。

检验数据发送日志示例:

注意 t 等于vstr字段,表示访问用户变量发送成功,其它字段无需仔细验证。

{
    "s":"d334b4a1-57eb-4bf4-b426-64c1cce5a5c0",
    // t 为事件类型, vstr 为发送访问用户变量事件
    "t":"vstr",
    "tm":1532341259134,
    "d":"com.growingio.android.test",
    "cs1":"GrowingIO",
    //访问用户变量
    "var":{
        "gender":"male",
        "age":21
    },
    "gesid":322,
    "esid":0
}

常见问题

1. 不支持 cordova-plugin-crosswalk-webview 插件

原因:

  1. 目前此仓库已经停止维护;

  2. 此插件在安卓高版本手机上兼容不好;

  3. 内部不是 webview 实现,而是 SurfaceView 。

最后更新于