API 接口文档

接口类说明

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

接口

说明

GsManager

SDK 功能接口类，用于调用个数相关功能

GsConfig

SDK 配置接口类，用于设置个数相关参数(注意：GsConfig 配置类需要在 SDK 初始化之前配置。)

获取 GsManager

类名

com.getui.gs.sdk.GsManager

接口

public static GsManager getInstance()

说明：

用于获取单例 GsManager 对象

返回：

返回 GsManager 单例对象

初始化

类名

com.getui.gs.sdk.GsManager

接口

public void init(Context context)

说明：

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

参数：

context：应用的 ApplicationContext

自定义事件

计数事件

类名

com.getui.gs.sdk.GsManager

接口

public void onEvent(String eventId, JSONObject jsonObject)

说明：

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

参数：

eventId：自定义事件 Id ，用于标识事件的唯一

jsonObject: 自定义属性，用于扩展统计需求

代码示范：

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();

}

}

计时事件

类名

com.getui.gs.sdk.GsManager

接口

public void onBeginEvent(String eventId, JSONObject jsonObject)

接口

public void onEndEvent(String eventId, JSONObject jsonObject)

说明：

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

参数：

eventId：自定义事件 Id ，用于标识事件的唯一，开始和结束使用的eventId必须一致时长事件才会生效

jsonObject: 自定义属性，用于扩展统计需求，结束时传递的jsonObject会覆盖开始时传递的jsonObject

代码示范：

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();

}

}

用户属性

类名

com.getui.gs.sdk.GsManager

接口

public void setProfile(JSONObject jsonObject)

说明：

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

参数：

jsonObject: 自定义用户属性，用于扩展统计需求

代码示范：

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();

}

}

设置开发者模式

类名

com.getui.gs.ias.core.GsConfig

接口

public void setDebugEnable(boolean debugEnable)

说明

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

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

参数：

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

设置两次应用时长的间隔

类名

com.getui.gs.ias.core.GsConfig

接口

public void setSessionTimoutMillis(long timeoutMillis);

说明

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

sessionTimeout 的默认值为30秒。

参数

timeoutMillis：sessionTimeout值，单位毫秒

设置最小有效活跃时长

类名

com.getui.gs.ias.core.GsConfig

接口

public void setMinAppActiveDuration(long minAppActiveDuration);

说明

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

minAppActiveDuration的默认值为1秒。

参数

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

设置最大有效活跃时长

类名

com.getui.gs.ias.core.GsConfig

接口

public void setMaxAppActiveDuration(long maxAppActiveDuration);

说明

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

maxAppActiveDuration的默认值为12小时。

参数

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

设置最大离线事件数

类名

com.getui.gs.ias.core.GsConfig

接口

public void setMaxOfflineEventCount(long maxOfflineEventCount);

说明

设置离线存储的最大事件数，默认值是2000

超出这个值后，在插入新的事件时，会自动删除多出的时间较早的事件。

参数

maxOfflineEventCount：离线存储的最大事件数