Android SDK API

API 简介

// 发送事件 API
GrowingIO gio = GrowingIO.getInstance();
gio.track(String eventId);
gio.track(String eventId, Number eventNumber);
gio.track(String eventId, Number eventNumber, JSONObject eventLevelVariables);
gio.track(String eventId, JSONObject eventLevelVariables);

// 发送页面级变量 API
GrowingIO gio = GrowingIO.getInstance();
gio.setPageVariable(Activity activity, String key, String value);
gio.setPageVariable(Activity activity, String key, Number value);
gio.setPageVariable(Activity activity, String key, Boolean value);
gio.setPageVariable(Activity activity, JSONObject pageLevelVariables);

gio.setPageVariable(Fragment fragment, String key, String value);
gio.setPageVariable(Fragment fragment, String key, Number value);
gio.setPageVariable(Fragment fragment, String key, Boolean value);
gio.setPageVariable(Fragment fragment, JSONObject pageLevelVariables);

// 发送转化变量 API
GrowingIO gio = GrowingIO.getInstance();
gio.setEvar(String key, String value);
gio.setEvar(String key, Number value);
gio.setEvar(String key, Boolean value);
gio.setEvar(JSONObject conversionVariables);

// 发送用户变量 API
GrowingIO gio = GrowingIO.getInstance();
gio.setPeopleVariable(String key, String value);
gio.setPeopleVariable(String key, Number value);
gio.setPeopleVariable(String key, Boolean value);
gio.setPeopleVariable(JSONObject peopleVariables);

// 设置登录用户ID API
GrowingIO.getInstance().setUserId(String userId);

// 清除登录用户ID API
GrowingIO.getInstance().clearUserId();

track

发送一个事件。在添加所需要发送的事件代码之前，需要在打点管理用户界面配置事件以及事件级变量。

参数名称	参数类型	是否必须	说明
eventId	String	是	事件标识符
number	Number	否	事件的数值，没有number参数时，事件默认加1；当出现number参数时，事件自增number的数值。
eventLevelVariable	JSON Object	否	事件发生时所伴随的维度信息。

// track API原型
GrowingIO gio = GrowingIO.getInstance();
gio.track(String eventId);
gio.track(String eventId, Number eventNumber);
gio.track(String eventId, Number eventNumber, JSONObject eventLevelVariables);
gio.track(String eventId, JSONObject eventLevelVariables);

// track API调用示例一
GrowingIO gio = GrowingIO.getInstance();
gio.track("registerSuccess");

// track API调用示例二
GrowingIO gio = GrowingIO.getInstance();
gio.track("registerSuccess", {"gender":"male", "age":"21"});

// track API调用示例三
GrowingIO gio = GrowingIO.getInstance();
gio.track("loanAmount", 800000, {"loanType":"houseMortgage","province":"Zhejiang"});

setPageVariable

发送页面级别的信息，在添加代码之前必须在打点管理界面上声明页面级变量。

参数：

参数名称	参数类型	是否必须	说明
key	String	否	页面级变量的标识符
value	String	否	页面级变量的值
pageLevelVariables	JSON Object	否	页面级别的信息

// setPageVariable API原型
GrowingIO gio = GrowingIO.getInstance();
gio.setPageVariable(Activity activity, String key, String value);
gio.setPageVariable(Activity activity, String key, Number value);
gio.setPageVariable(Activity activity, String key, Boolean value);
gio.setPageVariable(Activity activity, JSONObject pageLevelVariables);

gio.setPageVariable(Fragment fragment, String key, String value);
gio.setPageVariable(Fragment fragment, String key, Number value);
gio.setPageVariable(Fragment fragment, String key, Boolean value);
gio.setPageVariable(Fragment fragment, JSONObject pageLevelVariables);

// page.set API调用示例一
GrowingIO gio = GrowingIO.getInstance();
gio.setPageVariable(myActivity, "author", "Zhang San");

// page.set API调用示例二
GrowingIO gio = GrowingIO.getInstance();
gio.setPageVariable(myActivity, {"pageName": "Home Page", "author": "Zhang San"});

setEvar

发送一个转化信息用于高级归因分析，在添加代码之前必须在打点管理界面上声明转化变量。

参数

参数名称	参数类型	是否必须	说明
key	String	否	转化变量的标识符
Value	String	否	转化变量的值
conversionVariables	JSON Object	否	转化变量用于高级归因分析

// setEvar API原型
GrowingIO gio = GrowingIO.getInstance();
gio.setEvar(String key, String value);
gio.setEvar(String key, Number value);
gio.setEvar(String key, Boolean value);
gio.setEvar(JSONObject conversionVariables);

// setEvar API调用示例一
GrowingIO gio = GrowingIO.getInstance();
gio.setEvar("campaignId", "1234567890");

// setEvar API调用示例二
GrowingIO gio = GrowingIO.getInstance();
gio.setEvar({"campaignId":"1234567890", "campaignOwner":"Li Si"}});

setPeopleVariable

发送用户信息用于用户信息相关分析，在添加代码之前必须在打点管理界面上声明转化变量。

参数：

参数名称	参数类型	是否必须	说明
key	String	否	用户变量的标识符
value	String	否	用户变量的值
customerVariables	JSON Object	否	用户变量用于用户信息相关的分析

// people.set API原型
GrowingIO gio = GrowingIO.getInstance();
gio.setPeopleVariable(String key, String value);
gio.setPeopleVariable(String key, Number value);
gio.setPeopleVariable(String key, Boolean value);
gio.setPeopleVariable(JSONObject peopleVariables);

// people.set API调用示例一
GrowingIO gio = GrowingIO.getInstance();
gio.setPeopleVariable("gender", "male");

// people.set API调用示例二
GrowingIO gio = GrowingIO.getInstance();
gio.setPeopleVariable({"gender":"male", "age":"25"});

setUserId

当用户登录之后调用setUserId API，设置登录用户ID。

参数名称	参数类型	是否必须	说明
userId	String	是	用户的登录用户ID

// setUserId API原型
GrowingIO.getInstance().setUserId(String userId);

// setuserId API调用示例
GrowingIO.getInstance().setUserId(String "1234567890");

注：如果您的应用是App，且每次用户升级App版本时无需重新登录的话，建议在用户每次升级App版本后初次访问时重新调用上述 setUserId 方法。

clearUserId

当用户登出之后调用clearUserId，清除已经设置的登录用户ID。

// clearUserId API原型
GrowingIO.getInstance().clearUserId();

// clearUserId API调用示例
GrowingIO.getInstance().clearUserId();