QuickApp SDK API

SDK 初始化 API

• JAnalyticsInterface.init(context,appkey:string,channel:string)

  • 接口说明：
    • 初始化接口。需app.ux的onCreate中调用。之后在其它模块中可使用this.$app.JAnalyticsInterface方式进行其它接口调用。

  • 参数说明：

    • context：应用上下文
    • appkey：官网中创建应用后分配的appkey
    • channel：渠道名称，默认值为:default-channel
  • 调用示例：

    this.JAnalyticsInterface=JAnalyticsInterface.init(this,"官网中创建应用后分配的appkey","自定义channel");

• JAnalyticsInterface.setDebugMode(enable:boolean)
  • 接口说明：
    • 设置是否开启debug模式。true则会打印更多的日志信息。设置false则会关闭sdk的所有日志打印,建议在init接口之前调用。
  • 参数说明：
    • enable：debug开关
  • 调用示例：

    JAnalyticsInterface.setDebugMode(true);

页面流统计 API

• JAnalyticsInterface.onPageStart(pageName:string)
  • 接口说明：
    • 页面启动接口。在页面的相关生命周期内调用，和onPageEnd需要成对调用。页面生命周期方法可参考Quick App官方文档
  • 参数说明：
    • pageName：页面名称
  • 调用示例：

    this.$app.JAnalyticsInterface.onPageStart("page1");

• JAnalyticsInterface.onPageEnd(pageName:string)
  • 接口说明：
    • 页面结束接口。在页面的相关生命周期内调用，和onPageStart需要成对调用。
  • 参数说明：
    • pageName：页面名称
  • 调用示例：

    this.$app.JAnalyticsInterface.onPageEnd("page1");

自定义事件统计 API

• JAnalyticsInterface.onEvent(event:Event)

  • 接口说明：
    • 自定义事件。通过传入不同的事件模型来进行各种事件的统计，具体的事件模型请查看事件模型介绍
  • 参数说明：
    • event:事件模型，支持CountEvent(计数事件)、CalculateEvent(计算事件)、RegisterEvent(注册事件)、LoginEvent(登录事件)、BrowseEvent(浏览事件)、PurchaseEvent(购买事件)
      关于自定义事件做如下说明：

• 字符串字段（key与 value）限制大小不超过256字节，超过限制的key或value该事件将会被丢弃.

• 自定义键值对数目不能超过10个，超过10个限制该事件将会被丢弃.
  

计数事件模型

• CountEvent
  该模型是自定义计数事件模型，可以设置参数进行数据上报。

参数说明：

调用示例:

    let { CountEvent } = this.$app.JAnalyticsInterface.Event;
    let cEvent = new CountEvent("eventId",{"key_count_event_extra1":"value_extra1"});
    this.$app.JAnalyticsInterface.onEvent(cEvent);

注意：

    自定义计数事件模型中扩展参数中不能使用以下 key 值：
    event_id
    此类 key 已被模型使用，如果使用则会导致统计到的数据不准确.

计算事件模型

• CalculateEvent
  该模型是自定义计算事件模型，计算事件会通过相同的事件不同的值进行累加，可以设置参数进行数据上报。

参数说明：

调用示例:

    let { CalculateEvent } = this.$app.JAnalyticsInterface.Event;
    let cEvent = new CalculateEvent("test2_event_id","test2_event_value");
    cEvent.setEventValue(1.1).addKeyValue("key1","value1").addKeyValue("key2","value2");
    this.$app.JAnalyticsInterface.onEvent(cEvent);

注意：

 自定义计算事件模型中扩展参数中不能使用以下 key 值：
 event_id
 event_value
 此类 key 已被模型使用，如果使用则会导致统计到的数据不准确.

登录事件模型

• LoginEvent
  该模型是登录事件模型，可以设置参数进行数据上报。

参数说明：

调用示例:

    let { LoginEvent } = this.$app.JAnalyticsInterface.Event;
    let lEvent = new LoginEvent("qq",true);
    lEvent.addKeyValue("key1","value1").addKeyValue("key2","value2");
    this.$app.JAnalyticsInterface.onEvent(lEvent);

注意：

 登录事件模型中扩展参数中不能使用以下 key 值：
 login_method
 login_success
 此类 key 已被模型使用，如果使用则会导致统计到的数据不准确.

注册事件模型

• RegisterEvent
  该模型是注册事件模型，可以设置参数进行数据上报。

参数说明：

调用示例:

    let { RegisterEvent } = this.$app.JAnalyticsInterface.Event;
    let rEvent = new RegisterEvent("sina",true);
    rEvent.addKeyValue("key1","value1").addKeyValue("key2","value2");
    this.$app.JAnalyticsInterface.onEvent(rEvent);

注意：

注册事件模型中扩展参数中不能使用以下 key 值:
register_method
register_success
此类 key 已被模型使用，如果使用则会导致统计到的数据不准确.

浏览事件模型

• BrowseEvent
  该模型是浏览事件模型，可以设置参数进行数据上报。

参数说明：

调用示例:

    let { BrowseEvent } = this.$app.JAnalyticsInterface.Event;
    let bEvent = new BrowseEvent("browse_id","深圳热点新闻","news",30);
    bEvent.addKeyValue("key1","value1").addKeyValue("key2","value2");
    this.$app.JAnalyticsInterface.onEvent(bEvent);

注意：

浏览事件模型中扩展参数中不能使用以下 key 值：
browse_content_id
browse_name
browse_type
browse_duration
此类 key 已被模型使用，如果使用则会导致统计到的数据不准确.

购买事件模型

• PurchaseEvent
  该模型是购买事件模型，可以设置参数进行数据上报。

参数说明：

调用示例:

    let { PurchaseEvent } = this.$app.JAnalyticsInterface.Event;
    let pEvent = new PurchaseEvent("goodsId","篮球",300,true,"CNY","sport",1);
    pEvent.addKeyValue("key1","value1").addKeyValue("key2","value2");
    this.$app.JAnalyticsInterface.onEvent(pEvent);

注意：

购买事件模型中扩展参数中不能使用以下 key 值：
purchase_goods_id
purchase_goods_name
purchase_price
purchase_currency
purchase_goods_type
purchase_quantity
此类 key 已被模型使用，如果使用则会导致统计到的数据不准确.

账户维度模型介绍

开发者可以为用户增加账户信息，使统计数据可以以账户维度做统计分析 现开发的属性有：

具体使用方法，是先调用Account设置属性，再调用JAnalyticsInterface.identifyAccount(context, account, callback)登记账户信息也可以只设置部分属性，再次调用identifyAccount修改账户信息调用示例：

let { Account } = this.$app.JAnalyticsInterface.Account;、
let account = new Account("account001");    //account001为账号id
account.setCreationTime(1513749859);        //账户创建的时间戳
account.setName("张三");
account.setSex(1);
account.setPaid(1);
account.setBirthdate("19880920");       //"19880920"是yyyyMMdd格式的字符串
account.setPhone("13800000000");
account.setEmail("support@jiguang.cn");
account.setExtraAttr("attr1","value1");  //key如果为空，或者以极光内部namespace(符号$)开头，会设置失败并打印日志
this.$app.JAnalyticsInterface.identifyAccount(this, account,    new function(code,msg) {
        console.log("code = " + code  + " msg =" + msg);
    }
})

错误码

如果要解绑当前用户信息，调用JAnalyticsInterface.detachAccount(context, callback);调用示例：

this.$app.JAnalyticsInterface.detachAccount(this, function(code,msg){
    console.log("code = " + code  + " msg =" + msg);
})