API 接口文档

接口类说明

本文档所有接口所涉及的相关类及说明如下：

获取 GsManager

说明：

用于获取单例 GsManager 对象

返回：

返回 GsManager 单例对象

初始化

说明：

初始化SDK，初始化成功后SDK将自动生成应用活跃时长事件。

参数：

context：应用的 ApplicationContext

获取gtcid

说明：

获取gtcid，gtcid可用于查询用户画像标签。

参数：

context：应用的 ApplicationContext

自定义事件

计数事件

说明：

每次在事件触发时调用onEvent方法，应用统计平台根据eventId ，统计该事件触发的次数。

参数：

• eventId：自定义事件 Id ，用于标识事件的唯一
• jsonObject: 自定义属性，用于扩展统计需求
• ext: 用户自定义扩展字段，不纳入统计

代码示范：

public void onClick(View v) {
    // jsonObject 可不传
        try {
            JSONObject jsonObject = new JSONObject();
            jsonObject.put("buttonId", "onclick");
            GsManager.getInstance().onEvent("eventId", jsonObject);
        } catch (JSONException e) {
            e.printStackTrace();
        }
}

计时事件

说明：

在事件开始和结束时，分别调用onBeginEvent、onEndEvent方法，SDK会根据开始和结束的时间统计出事件的时长属性。

参数：

• eventId：自定义事件 Id ，用于标识事件的唯一，开始和结束使用的eventId必须一致时长事件才会生效
• jsonObject: 自定义属性，用于扩展统计需求，结束时传递的jsonObject会覆盖开始时传递的jsonObject
• ext: 用户自定义扩展字段，不纳入统计

代码示范：

public void onClick1(View v) {
    // jsonObject 可不传
        try {
            JSONObject jsonObject = new JSONObject();
            jsonObject.put("type", "download");
            GsManager.getInstance().onBeginEvent("eventId", jsonObject);
        } catch (JSONException e) {
            e.printStackTrace();
        }
}

public void onClick2(View v) {
    // jsonObject 可不传
        try {
            JSONObject jsonObject = new JSONObject();
            jsonObject.put("type", "download");
            GsManager.getInstance().onEndEvent("eventId", jsonObject);
        } catch (JSONException e) {
            e.printStackTrace();
        }
}

用户属性

说明：

设置⽤户属性，用于记录用户基本固定不变的属性，例如性别、年龄、注册时间、注册地域、注册渠道等。

参数：

• jsonObject: 自定义用户属性，用于扩展统计需求
• ext: 用户自定义扩展字段，不纳入统计

代码示范：

public void onClick(View v) {
        try {
            JSONObject jsonObject = new JSONObject();
            jsonObject.put("sex","男");
            jsonObject.put("age", 22);
            GsManager.getInstance().setProfile(jsonObject);
        } catch (JSONException e) {
            e.printStackTrace();
        }
}

设置开发者模式

说明

开启/关闭开启开发者模式，开发者模式下，将在logcat输出 SDK 相关日志。

请在调试的时候使用该接口，切勿发布到线上版本。

参数：

• debugEnable：开启/关闭开启开发者模式

设置AppId

说明

设置appid，这里设置的appid优先级比AndroidManifest文件中配置的appid优先级更高。

请在GsManager初始化之前调用。

参数：

• appId：从个推开发者平台申请的appid

设置计数/计时事件上传频率

说明

• 设置计数/计时事件的上传频率eventUploadInterval，默认值为10000，即10秒；
• 上传计数/计时事件前会先检测上次上传操作的时间，如果距离上次上传操作已经过去了eventUploadInterval这么多时间，则会触发事件上传操作，否则将等待下次符合要求再上传。

参数

• timeMillis：设置的eventUploadInterval值，单位毫秒。

设置计数/计时事件事件强制上传条数

说明

• 设置计数/计时事件的强制上传条数eventForceUploadSize，默认数量为30条；
• 如果距离上次上传计数/计时事件的时间不满足eventUploadInterval频率限制，SDK还会去检测现有的离线计数/计时事件条数，如果超过eventForceUploadSize这个条数，则会强制触发上传。

参数

• size：设置的eventForceUploadSize值。

设置用户属性事件上传频率

说明

• 设置用户属性事件传频率profileUploadInterval，默认值为5000，即5秒；
• 上传用户属性事件前会先检测上次上传操作的时间，如果距离上次上传操作已经过去了profileUploadInterval这么多时间，则会触发事件上传操作，否则将等待下次符合要求再上传。

参数

• timeMillis：设置的profileUploadInterval值，单位毫秒。

设置用户属性事件强制上传条数

说明

• 设置用户属性事件的强制上传条数profileForceUploadSize，默认数量为5条;
• 如果距离上次上传用户属性事件的时间不满足profileUploadInterval频率限制，SDK还会去检测现有的离线用户属性事件条数，如果超过profileForceUploadSize这个条数，则会强制触发上传。

参数

• size：设置的profileForceUploadSize值。

设置会话超时时长

说明

• 应用从前台退至后台，在后台运行时间超过 sessionTimeout 后，此时再回到前台，SDK将认为是一次全新的启动。

• sessionTimeout 的默认值为30秒。

参数

• timeoutMillis：sessionTimeout值，单位毫秒

设置最小有效活跃时长

说明

• SDK统计应用前台活跃时长时，会对时长做判定，如果该时长小于minAppActiveDuration，SDK将认为无效，不予上传。

• minAppActiveDuration的默认值为0；

参数

• minAppActiveDuration：最小有效活跃时长，单位毫秒

设置最大有效活跃时长

说明

• SDK统计应用前台活跃时长时，会对时长做判定，如果该时长大于maxAppActiveDuration，SDK将认为无效，不予上传。

• maxAppActiveDuration的默认值为12小时。

参数

• maxAppActiveDuration：最大有效活跃时长，单位毫秒