Android SDK使用文档

正在持续完善中

一、使用自定义事件上报功能

可以通过该事件接口,来记录和上报用户关键事件,从而对事件发生次数,耗时,流量消耗等进行统计分析。

自定义事件 方法:boolean onUserAction(String eventName, boolean isSucceed, long elapse, long size, Map<String, String> params, boolean isRealTime, boolean isImmediatelyUpload)

说明:在需要进行用户操作事件记录的地方调用。

调用示例:

@Override
public void onClick(View v){
Map<String, String> map = new HashMap<String, String>();
map.put("testKey", "testValue");
UserAction.onUserAction("test_common_event", true, -1, -1, map, false, false);
}

说明:该接口的返回值为 boolean 类型,返回 true,说明事件被记录成功;返回 false,说明事件记录失败。 事件上报失败的两种可能:

  • 事件数据不符合规范,会有相应日志说明提醒

  • 灯塔初始化还未成功,这种情况下可通过实现com.tencent.beacon.upload.InitHandleListener接口里面的初始化结束函数 onInitEnd()进行判断。

二、其他扩展接口

方法:UserAction.setUserID(String userID) 说明:用于用户ID的设置,比如产品自己生成的 guid,openid等(建议初始化前调用) 参数:userID 用户身份标识字符串

方法:UserAction.setQQ(String qq) 说明:用于 QQ 帐号的设置(建议初始化前调用) 参数:qq 号

方法:UserAction.setChannelID(String channelID) 说明:渠道ID的设置,(未在AndroidManifest中配置时,需要初始化前调用) 参数:channelID 渠道标识字符串

方法:UserAction.getQIMEI() 说明:灯塔 QIMEI 终端唯一身份标识 ID 获取接口接口调用时机,在调用初始化接口后延迟 100ms 调用(服务端未返回结果时,可能会用IMEI/AndroidID填充) 参数:无

方法:UserAction.getSDKVersion() 说明:获取灯塔SDK版本 参数:无

方法:UserAction.getCloudParas(String key) 说明:通过key获取配置的云端参数接口调用时机,在调用初始化接口后,初始化结束回调接口触发后调用 参数:key 云端参数配置的 key

方法:UserAction.flushObjectsToDB(boolean isSync) 说明:强制将实时事件和普通事件的内存数据冲刷到DB 参数:isSync true为同步进行, false为异步进行

方法:setAdditionalInfo(Map<String, String> extraInfo) 说明:添加全局的附加信息,每条事件都会附带上这些信息 参数:extraInfo为附加参数,最多20个k-v对