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：離線存儲的最大事件數

總結

以上是生活随笔為你收集整理的android api接口文档,API 接口文档的全部內容，希望文章能夠幫你解決所遇到的問題。

如果覺得生活随笔網站內容還不錯，歡迎將生活随笔推薦給好友。