modulebaidumtj

来自于:百度移动统计立即使用

概述

BaiduMtj 模块封装了百度移动统计SDK,通过调用本模块可实现百度移动统计功能。使用之前需要到百度移动统计创建应用。可以通过startWithAppkey接口将appkey、appVersion等参数传进去,完成模块初始化。其他方法需在初始化后才能使用。

Methods

初始化

startWithAppkey

事件统计

onEvent

onEventWithAttributes

onEventStart

onEventEnd

onEventEndWithAttributes

onEventWithDurationTime

onEventDurationWithAttributes

页面统计

onPageStart

onPageEnd

获取测试设备id

getTestDeviceId

设置自定义userid

setUserId

模块接口

startWithAppkey

SDK模块初始化

startWithAppkey({parmas})

params

appkey:

  • 类型:字符串
  • 描述:在百度移动统计平台注册的应用appkey,如果应用支持iOS、Android双平台,那么需要自行获取平台类型,判断不同平台类型,传入不同的appkey

appVersion:

  • 类型:字符串
  • 描述:用于统计使用的应用版本号

channelId:

  • 类型:字符串
  • 描述:用于统计使用的应用渠道号

enableExceptionLog:

  • 类型:bool
  • 描述:是否使用Crash统计功能

enableDebugOn:

  • 类型:bool
  • 描述:是否打印调试Log,建议正式发布时设置为false

示例代码

  1. // 此处platform需要自行获取并做判断
  2. if (platform == "android") {
  3. // android平台的初始化
  4. var demo = api.require('modulebaidumtj');
  5. demo.startWithAppkey({
  6. appkey: 'AndroidAppKey',
  7. appVersion: '1.0',
  8. channelId: 'AndroidChannel',
  9. enableExceptionLog: 'true',
  10. enableDebugOn: 'true'
  11. });
  12. } else {
  13. // iOS平台的初始化
  14. var demo = api.require('modulebaidumtj');
  15. demo.startWithAppkey({
  16. appkey: 'iOSAppKey',
  17. appVersion: '2.0',
  18. channelId: 'iOSChannel',
  19. enableExceptionLog: 'true',
  20. enableDebugOn: 'true'
  21. });
  22. }

可用性

iOS系统,Android系统

可提供的 1.0.0 及更高版本

onEvent

无时长事件统计

onEvent({parmas})

调用接口之前,需要先在MTJ网站上创建事件eventid,然后接口中传入的eventid与创建的保持一致,才能实现统计。

创建方法:

  1. 登录MTJ网站,进入应用报告,在左侧栏目选择事件分析,然后点击+号添加埋点事件

    Add File 1

  2. 在弹出的窗口中,根据Web页面的提示,添加EventId及名称。这里的EventId就是在代码中埋点使用的id。

    Add File 1

params

eventId:

  • 类型:字符串
  • 描述:事件Id,提前在网站端创建

eventLabel:

  • 类型:字符串
  • 描述:事件标签,附加参数,不能为空字符串

示例代码

  1. function onEvent() {
  2. var demo = api.require('modulebaidumtj');
  3. demo.onEvent({
  4. eventId: 'event1',
  5. eventLabel: 'eventLabel1'
  6. });
  7. }

可用性

iOS系统,Android系统

可提供的 1.0.0 及更高版本

onEventWithAttributes

无时长事件统计,带附加自定义参数

onEventWithAttributes({parmas})

调用接口之前,需要先在MTJ网站上创建事件eventid,然后接口中传入的eventid与创建的保持一致,才能实现统计。

如果要传入附加参数,则附件参数attributes中的key值,也需要在MTJ网站上预先创建,并与代码中的key值保持一致。

Attributes创建方法:

  1. 在创建的事件右侧,点击设置

    Add File 1

  2. 在弹出的新页面中,填写参数配置。这里填写的配置名称,需要与代码中attributes参数的key值一致,具体调用代码可见下文。

    Add File 1

params

eventId:

  • 类型:字符串
  • 描述:事件Id,提前在网站端创建

eventLabel:

  • 类型:字符串
  • 描述:事件标签,附加参数,不能为空字符串

attributes:

  • 类型:字典
  • 描述:事件附加参数,字典格式,其中的key需要与提前创建的一致,value为字符串格式

示例代码

  1. function onEventWithAttributes() {
  2. var demo = api.require('modulebaidumtj');
  3. demo.onEventWithAttributes({
  4. eventId: 'event2',
  5. eventLabel: 'eventLabel2',
  6. attributes: {
  7. '商品类别': 'type1',
  8. '数量': '2',
  9. '价格': '100'
  10. }
  11. });
  12. }

可用性

iOS系统,Android系统

可提供的 1.0.0 及更高版本

onEventStart

自定义时长事件,开始统计,需要与onEventEnd函数成对调用

onEventStart({parmas})

调用接口之前,需要先在MTJ网站上创建事件eventid,然后接口中传入的eventid与创建的保持一致,才能实现统计。

params

eventId:

  • 类型:字符串
  • 描述:事件Id,提前在网站端创建

eventLabel:

  • 类型:字符串
  • 描述:事件标签,附加参数,不能为空字符串

示例代码

  1. function onEventStart() {
  2. var demo = api.require('modulebaidumtj');
  3. demo.onEventStart({
  4. eventId: 'event3',
  5. eventLabel: 'eventLabel3'
  6. });
  7. }

可用性

iOS系统,Android系统

可提供的 1.0.0 及更高版本

onEventEnd

自定义时长事件,结束统计,需要与onEventStart函数成对调用

onEventEnd({parmas})

end调用接口之前,需要先调用start接口,eventid与label保持一致。

params

eventId:

  • 类型:字符串
  • 描述:事件Id,提前在网站端创建

eventLabel:

  • 类型:字符串
  • 描述:事件标签,附加参数,不能为空字符串

示例代码

  1. function onEventEnd() {
  2. var demo = api.require('modulebaidumtj');
  3. demo.onEventEnd({
  4. eventId: 'event3',
  5. eventLabel: 'eventLabel3'
  6. });
  7. }

可用性

iOS系统,Android系统

可提供的 1.0.0 及更高版本

onEventEndWithAttributes

自定义时长事件,结束统计,带附加自定义参数,需要与onEventStart函数成对调用

onEventEndWithAttributes({parmas})

调用接口之前,需要先调用start接口,eventid与label保持一致。

params

eventId:

  • 类型:字符串
  • 描述:事件Id,提前在网站端创建

eventLabel:

  • 类型:字符串
  • 描述:事件标签,附加参数,不能为空字符串

attributes:

  • 类型:字典
  • 描述:事件附加参数,字典格式,其中的key需要与提前创建的一致,value为字符串格式

示例代码

  1. function onEventEndWithAttributes() {
  2. var demo = api.require('modulebaidumtj');
  3. demo.onEventEndWithAttributes({
  4. eventId: 'event4',
  5. eventLabel: 'eventLabel4',
  6. attributes: {
  7. '商品类别': 'type1',
  8. '数量': '2',
  9. '价格': '100'
  10. }
  11. });
  12. }

可用性

iOS系统,Android系统

可提供的 1.0.0 及更高版本

onEventWithDurationTime

固定时长事件统计

onEventWithDurationTime({parmas})

调用接口之前,需要先在MTJ网站上创建事件eventid,然后接口中传入的eventid与创建的保持一致,才能实现统计。

params

eventId:

  • 类型:字符串
  • 描述:事件Id,提前在网站端创建

eventLabel:

  • 类型:字符串
  • 描述:事件标签,附加参数,不能为空字符串

durationTime:

  • 类型:数字
  • 描述:持续时长,单位ms

示例代码

  1. function onEventWithDurationTime() {
  2. var demo = api.require('modulebaidumtj');
  3. demo.onEventWithDurationTime({
  4. eventId: 'event5',
  5. eventLabel: 'eventLabel5',
  6. durationTime: 1200
  7. });
  8. }

可用性

iOS系统,Android系统

可提供的 1.0.0 及更高版本

onEventDurationWithAttributes

固定时长事件统计, 带附加自定义参数。

调用接口之前,需要先在MTJ网站上创建事件eventid,然后接口中传入的eventid与创建的保持一致,才能实现统计。

onEventDurationWithAttributes({parmas})

params

eventId:

  • 类型:字符串
  • 描述:事件Id,提前在网站端创建

eventLabel:

  • 类型:字符串
  • 描述:事件标签,附加参数,不能为空字符串

durationTime:

  • 类型:数字
  • 描述:持续时长,单位ms

attributes:

  • 类型:字典
  • 描述:事件附加参数,字典格式,其中的key需要与提前创建的一致,value为字符串格式

示例代码

  1. function onEventDurationWithAttributes() {
  2. var demo = api.require('modulebaidumtj');
  3. demo.onEventDurationWithAttributes({
  4. eventId: 'event6',
  5. eventLabel: 'eventLabel6',
  6. durationTime: 1200,
  7. attributes: {
  8. '商品类别': 'type1',
  9. '数量': '2',
  10. '价格': '100'
  11. }
  12. });
  13. }

可用性

iOS系统,Android系统

可提供的 1.0.0 及更高版本

onPageStart

页面统计,页面开始时调用,需要与onPageEnd成对调用。

onPageStart({parmas})

params

pageName:

  • 类型:字符串
  • 描述:页面名称

示例代码

  1. function onPageStart() {
  2. var demo = api.require('modulebaidumtj');
  3. demo.onPageStart({
  4. pageName: 'page1'
  5. });
  6. }

可用性

iOS系统,Android系统

可提供的 1.0.0 及更高版本

onPageEnd

页面统计,页面结束时调用,需要与onPageStart成对调用。

onPageEnd({parmas})

params

pageName:

  • 类型:字符串
  • 描述:页面名称

示例代码

  1. function onPageEnd() {
  2. var demo = api.require('modulebaidumtj');
  3. demo.onPageEnd({
  4. pageName: 'page1'
  5. });
  6. }

可用性

iOS系统,Android系统

可提供的 1.0.0 及更高版本

testDeviceId

如果要使用百度移动统计的在线调试功能,需要调用该接口获取测试设备id,并上传到MTJ平台上。

在线调试功能介绍

testDeviceId()

ret

ret:

  • 类型:字符串
  • 描述:测试设备id

示例代码

  1. function getTestDeviceId() {
  2. var demo = api.require('modulebaidumtj');
  3. var testDeviceId = demo.getTestDeviceId();
  4. api.toast({
  5. msg: testDeviceId
  6. });
  7. }

可用性

iOS系统,Android系统

可提供的 1.0.0 及更高版本

setUserId

上传用户自定义的用户识别id,设置一次UserId后,用户被永久标记。传入新的userId将替换老的userId。 传入空字符串,可清空标记

用户分群功能介绍

setUserId()

params

setUserId:

  • 类型:字符串
  • 描述:自定义用户id

示例代码

  1. function setUserId() {
  2. var demo = api.require('modulebaidumtj');
  3. demo.setUserId({
  4. userId: 'testUserId'
  5. });
  6. }

可用性

iOS系统,Android系统

可提供的 1.0.0 及更高版本