txAnalysis

立即使用

概述

模块封装了腾讯MTA SDK。腾讯MTA为您的应用提供实时数据统计分析服务,监控版本质量、渠道状况、用户画像属性及用户细分行为,通过数据可视化展现,协助产品、运营和市场决策。登陆官网管理台,按照步骤提示注册应用,可获得AppKey

平台使用此模块之前必须先配置 config 文件,配置方法如下:

  • 名称:txAnalysis
  • 参数:appKey_iOS
  • 配置示例:
  <feature name="txAnalysis">
     <param name="appKey_iOS" value="I2E3KXDU1E2W"/>
    <param name="appKey_android" value="I2E3KXDU1E2W"/>
  </feature>
  • 字段描述:

    appKey_iOS:官网管理台申请的iOS平台的appKey

trackPageBegin

标记一次页面访问的开始,跟trackPageEnd配对使用

trackPageBegin({params})

params

page:

  • 类型:字符串类型
  • 描述:页面ID,ID需要先在MTA前台配置好才能生效
  • 默认:无

appkey:

  • 类型:字符串类型
  • 描述:(可选项)申请的appKey(仅ios支持)
  • 默认:config中配置的appKey

示例代码

var txAnalysis = api.require('txAnalysis');
txAnalysis.trackPageBegin({
    page : 'page'
});

可用性

iOS系统,Android系统

可提供的1.0.0及更高版本

trackPageEnd

标记一次页面访问的结束,跟trackPageBegin配对使用

trackPageEnd({params})

params

page:

  • 类型:字符串类型
  • 描述:页面ID,ID需要先在MTA前台配置好才能生效
  • 默认:无

appkey:

  • 类型:字符串类型
  • 描述:(可选项)申请的appKey
  • 默认:config中配置的appKey

isRealTime:

  • 类型:布尔类型
  • 描述:(可选项)是否实时上报,若传入true,则忽略全局上报策略实时上报。否则按照全局策略上报(仅ios支持)
  • 默认:false

示例代码

var txAnalysis = api.require('txAnalysis');
txAnalysis.trackPageEnd({
    page : 'page'
});

可用性

iOS系统,Android系统

可提供的1.0.0及更高版本

trackCustom

上报自定义事件

trackCustom({params})

params

event:

  • 类型:字符串类型
  • 描述:事件的ID,ID需要先在MTA前台配置好才能生效
  • 默认:无

props:

  • 类型:JSON对象
  • 描述:(可选项)事件的参数,参数需要先在MTA前台配置好才能生效
  • 默认:无

appkey:

  • 类型:字符串类型
  • 描述:(可选项)申请的appKey(仅ios支持)
  • 默认:config中配置的appKey

isRealTime:

  • 类型:布尔类型
  • 描述:(可选项)是否实时上报,若传入true,则忽略全局上报策略实时上报。否则按照全局策略上报(仅ios支持)
  • 默认:false

示例代码

var txAnalysis = api.require('txAnalysis');
txAnalysis.trackCustom({
    event : 'event',
    props:{name:'click'}
});

可用性

iOS系统,Android系统

可提供的1.0.0及更高版本

trackCustomBegin

开始统计自定义时长事件

trackCustomBegin({params})

params

event:

  • 类型:字符串类型
  • 描述:事件的ID,ID需要先在MTA前台配置好才能生效
  • 默认:无

props:

  • 类型:JSON对象
  • 描述:(可选项)事件的参数,参数需要先在MTA前台配置好才能生效
  • 默认:无

appkey:

  • 类型:字符串类型
  • 描述:(可选项)申请的appKey(仅ios支持)
  • 默认:config中配置的appKey

示例代码

var txAnalysis = api.require('txAnalysis');
txAnalysis.trackCustomBegin({
    event : 'event'
});

可用性

iOS系统,Android系统

可提供的1.0.0及更高版本

trackCustomEnd

结束统计自定义时长事件

trackCustomEnd({params})

params

event:

  • 类型:字符串类型
  • 描述:事件的ID,ID需要先在MTA前台配置好才能生效
  • 默认:无

props:

  • 类型:JSON对象
  • 描述:(可选项)事件的参数,参数需要先在MTA前台配置好才能生效
  • 默认:无

appkey:

  • 类型:字符串类型
  • 描述:(可选项)申请的appKey(仅ios支持)
  • 默认:config中配置的appKey

isRealTime:

  • 类型:布尔类型
  • 描述:(可选项)是否实时上报,若传入true,则忽略全局上报策略实时上报。否则按照全局策略上报(仅ios支持)
  • 默认:false

示例代码

var txAnalysis = api.require('txAnalysis');
txAnalysis.trackCustomEnd({
    event : 'event'
});

可用性

iOS系统,Android系统

可提供的1.0.0及更高版本

trackCustomDuration

直接上报自定义时长事件(仅ios支持)

trackCustomDuration({params})

params

duration:

  • 类型:数值类型
  • 描述:自定义事件的时长,单位秒
  • 默认:无

event:

  • 类型:字符串类型
  • 描述:事件的ID,ID需要先在MTA前台配置好才能生效
  • 默认:无

props:

  • 类型:JSON对象
  • 描述:(可选项)事件的参数,参数需要先在MTA前台配置好才能生效
  • 默认:无

appkey:

  • 类型:字符串类型
  • 描述:(可选项)申请的appKey
  • 默认:config中配置的appKey

isRealTime:

  • 类型:布尔类型
  • 描述:(可选项)是否实时上报,若传入true,则忽略全局上报策略实时上报。否则按照全局策略上报
  • 默认:false

示例代码

var txAnalysis = api.require('txAnalysis');
txAnalysis.trackCustomDuration({
    event : 'event',
    duration : 250
});

可用性

iOS系统,Android系统

可提供的1.0.0及更高版本

trackActiveBegin

开始统计使用时长,建议在App进入前台时调用(android会话统计用于统计启动次数,由SDK本身维护,通常开发者无需额外设置或调用接口。如有需要可以调用以下接口,也会视为用户打开一次新的会话:)

trackActiveBegin()

示例代码

var txAnalysis = api.require('txAnalysis');
txAnalysis.trackActiveBegin();

可用性

iOS系统,Android系统

可提供的1.0.0及更高版本

trackActiveEnd

结束统计使用时长,建议在App离开前台时调用(仅ios支持)

trackActiveEnd()

示例代码

var txAnalysis = api.require('txAnalysis');
txAnalysis.trackActiveEnd();

可用性

iOS系统,Android系统

可提供的1.0.0及更高版本

reportQQ

用户画像(仅ios支持)

reportQQ({params})

params

qq:

  • 类型:字符串类型
  • 描述:qq 号
  • 默认:无

appkey:

  • 类型:字符串类型
  • 描述:(可选项)申请的appKey
  • 默认:config中配置的appKey

isRealTime:

  • 类型:布尔类型
  • 描述:(可选项)是否实时上报,若传入true,则忽略全局上报策略实时上报。否则按照全局策略上报
  • 默认:false

示例代码

var txAnalysis = api.require('txAnalysis');
txAnalysis.reportQQ({
    qq : '11111222222'
});

可用性

iOS系统,Android系统

可提供的1.0.0及更高版本

trackError

统计程序逻辑错误,逻辑错误只有描述,没有堆栈信息(仅ios支持)

trackError({params})

params

error:

  • 类型:字符串类型
  • 描述:错误描述
  • 默认:无

appkey:

  • 类型:字符串类型
  • 描述:(可选项)申请的appKey
  • 默认:config中配置的appKey

isRealTime:

  • 类型:布尔类型
  • 描述:(可选项)是否实时上报,若传入true,则忽略全局上报策略实时上报。否则按照全局策略上报
  • 默认:false

示例代码

var txAnalysis = api.require('txAnalysis');
txAnalysis.trackError({
    error : ''
});

可用性

iOS系统,Android系统

可提供的1.0.0及更高版本

trackCustomBeginEvent

开始带有统计时长的自定义参数事件(仅android支持)

trackCustomBeginEvent({params})

params

event:

  • 类型:字符串类型
  • 描述:事件的ID

args:

  • 类型:字符串类型
  • 描述:事件的参数

示例代码

var txAnalysis = api.require('txAnalysis');
txAnalysis.trackCustomBeginEvent({
    event : 'event',
    args:‘level15’
});

可用性

iOS系统,Android系统

可提供的1.0.0及更高版本

trackCustomEndEvent

结束带有统计时长的自定义参数事件(仅android支持)

trackCustomEndEvent({params})

params

event:

  • 类型:字符串类型
  • 描述:事件的ID,

args:

  • 类型:字符串类型
  • 描述:事件的参数

示例代码

var txAnalysis = api.require('txAnalysis');
txAnalysis.trackCustomEndEvent({
    event : 'event',
    args:‘level15’
});

可用性

iOS系统,Android系统

可提供的1.0.0及更高版本

setJavaCrashHandlerStatus

开启或关闭Java异常捕获(仅android支持)

setJavaCrashHandlerStatus({params})

params

open:

  • 类型:布尔类型
  • 描述:是否开启
  • 默认:true

示例代码

var txAnalysis = api.require('txAnalysis');
txAnalysis.setJavaCrashHandlerStatus({
    open : false,
});

可用性

iOS系统,Android系统

可提供的1.0.0及更高版本

setJniNativeCrashStatus

开启或关闭Native异常捕获(仅android支持)

setJniNativeCrashStatus({params})

params

open:

  • 类型:布尔类型
  • 描述:是否开启
  • 默认:true

示例代码

var txAnalysis = api.require('txAnalysis');
txAnalysis.setJniNativeCrashStatus({
    open : false,
});

可用性

iOS系统,Android系统

可提供的1.0.0及更高版本

addCrashCallback

监听Crash发生(仅android支持)

addCrashCallback({params})

callback(ret)

ret:

  • 类型:JSON 对象
  • 内部字段:
{

    status:true                //布尔类型;true/状态良好,false/参考err查看错误信息
    no:,                            //数字类型;监听序列号
     type:,                        //字符串类型;crash类型;‘java’/java crash,‘native’/native crash
     crash:'',                    //字符串类型;crash内容
    }

err:

  • 类型:JSON 对象
  • 内部字段:
{
msg:'',                        //字符串类型;错误信息
}

示例代码

var txAnalysis = api.require('txAnalysis');
txAnalysis.addCrashCallback({
});

可用性

iOS系统,Android系统

可提供的1.0.0及更高版本

removeCrashCallback

取消监听Crash发生(仅android支持)

removeCrashCallback({params})

parameter

no:

  • 类型:数字类型
  • 描述:监听序列号,addCrashCallback中返回

callback(ret)

ret:

  • 类型:JSON 对象
  • 内部字段:
{

    status:true                //布尔类型;true/状态良好,false/参考err查看错误信息
    }

err:

  • 类型:JSON 对象
  • 内部字段:
{
msg:'',                        //字符串类型;错误信息
}

示例代码

var txAnalysis = api.require('txAnalysis');
txAnalysis.removeCrashCallback({
no:1,
});

可用性

iOS系统,Android系统

可提供的1.0.0及更高版本

setSessionTimoutMillis

设置会话时长(默认30000ms,30000ms回到应用的用户视为同一次会话)(仅android支持)

setSessionTimoutMillis({params})

parameter

millis:

  • 类型:数字类型
  • 描述:会话时长;单位:ms

callback(ret)

ret:

  • 类型:JSON 对象
  • 内部字段:
{

    status:true                //布尔类型;true/状态良好,false/参考err查看错误信息
    }

err:

  • 类型:JSON 对象
  • 内部字段:
{
msg:'',                        //字符串类型;错误信息
}

示例代码

var txAnalysis = api.require('txAnalysis');
txAnalysis.setSessionTimoutMillis({
millis:5000,
});

可用性

iOS系统,Android系统

可提供的1.0.0及更高版本

setMaxSendRetryCount

消息失败重发次数(默认3)(仅android支持)

setMaxSendRetryCount({params})

parameter

count:

  • 类型:数字类型
  • 描述:重发次数
  • 默认:3

callback(ret)

ret:

  • 类型:JSON 对象
  • 内部字段:
{

    status:true                //布尔类型;true/状态良好,false/参考err查看错误信息
    }

err:

  • 类型:JSON 对象
  • 内部字段:
{
msg:'',                        //字符串类型;错误信息
}

示例代码

var txAnalysis = api.require('txAnalysis');
txAnalysis.setMaxSendRetryCount({
count:5,
});

可用性

iOS系统,Android系统

可提供的1.0.0及更高版本

setMaxParallelTimmingEvents

设置用户自定义时间类型事件的最大并行数量(默认1024)(仅android支持)

setMaxParallelTimmingEvents({params})

parameter

count:

  • 类型:数字类型
  • 描述:重发次数
  • 默认:1024

callback(ret)

ret:

  • 类型:JSON 对象
  • 内部字段:
{

    status:true                //布尔类型;true/状态良好,false/参考err查看错误信息
    }

err:

  • 类型:JSON 对象
  • 内部字段:
{
msg:'',                        //字符串类型;错误信息
}

示例代码

var txAnalysis = api.require('txAnalysis');
txAnalysis.setMaxParallelTimmingEvents({
count:5,
});

可用性

iOS系统,Android系统

可提供的1.0.0及更高版本

setInstallChannel

设置安装渠道(仅android支持)

setInstallChannel({params})

parameter

channel:

  • 类型:字符串类型
  • 描述:渠道名称

callback(ret)

ret:

  • 类型:JSON 对象
  • 内部字段:
{

    status:true                //布尔类型;true/状态良好,false/参考err查看错误信息
    }

err:

  • 类型:JSON 对象
  • 内部字段:
{
msg:'',                        //字符串类型;错误信息
}

示例代码

var txAnalysis = api.require('txAnalysis');
txAnalysis.setInstallChannel({
channel:‘’,
});

可用性

iOS系统,Android系统

可提供的1.0.0及更高版本

setAppKey

设置appKey(仅android支持)

setAppKey({params})

parameter

appKey:

  • 类型:字符串类型
  • 描述:appKey

callback(ret)

ret:

  • 类型:JSON 对象
  • 内部字段:
{

    status:true                //布尔类型;true/状态良好,false/参考err查看错误信息
    }

err:

  • 类型:JSON 对象
  • 内部字段:
{
msg:'',                        //字符串类型;错误信息
}

示例代码

var txAnalysis = api.require('txAnalysis');
txAnalysis.setAppKey({
appKey:‘’,
});

可用性

iOS系统,Android系统

可提供的1.0.0及更高版本

setEnableStatService

设置统计功能开关(仅android支持)

setEnableStatService({params})

parameter

open:

  • 类型:布尔类型
  • 描述:是否开启统计功能
  • 默认:true

callback(ret)

ret:

  • 类型:JSON 对象
  • 内部字段:
{

    status:true                //布尔类型;true/状态良好,false/参考err查看错误信息
    }

err:

  • 类型:JSON 对象
  • 内部字段:
{
msg:'',                        //字符串类型;错误信息
}

示例代码

var txAnalysis = api.require('txAnalysis');
txAnalysis.setEnableStatService({
open:false,
});

可用性

iOS系统,Android系统

可提供的1.0.0及更高版本

setEnableConcurrentProcess

设置是否支持多进程(仅android支持)

setEnableConcurrentProcess({params})

parameter

enable:

  • 类型:布尔类型
  • 描述:是否支持多进程
  • 默认:true

callback(ret)

ret:

  • 类型:JSON 对象
  • 内部字段:
{

    status:true                //布尔类型;true/状态良好,false/参考err查看错误信息
    }

err:

  • 类型:JSON 对象
  • 内部字段:
{
msg:'',                        //字符串类型;错误信息
}

示例代码

var txAnalysis = api.require('txAnalysis');
txAnalysis.setEnableConcurrentProcess({
enable:,
});

可用性

iOS系统,Android系统

可提供的1.0.0及更高版本

setEnableSmartReporting

智能选择发送策略功能:如果是WIFI网络,自动切换至实时发送(不会覆盖原有的发送策略),否则,保持原有的策略。 注意:由于每次发送消息都要检查网络状态,用户交互极其频繁的应用(如水果忍者)需慎重使用。(仅android支持)

setEnableSmartReporting({params})

parameter

enable:

  • 类型:布尔类型
  • 描述:是否启用智能发送策略
  • 默认:false

callback(ret)

ret:

  • 类型:JSON 对象
  • 内部字段:
{

    status:true                //布尔类型;true/状态良好,false/参考err查看错误信息
    }

err:

  • 类型:JSON 对象
  • 内部字段:
{
msg:'',                        //字符串类型;错误信息
}

示例代码

var txAnalysis = api.require('txAnalysis');
txAnalysis.setEnableSmartReporting({
enable:true,
});

可用性

iOS系统,Android系统

可提供的1.0.0及更高版本