android api接口文档,API 接口文档
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 接口文档相关推荐
- 干掉 Swagger + Postman?测试接口直接生成API文档,这个国产文档工具真香!
点击上方"芋道源码",选择"设为星标" 管她前浪,还是后浪? 能浪的浪,才是好浪! 每天 10:33 更新文章,每天掉亿点点头发... 源码精品专栏 原创 | ...
- 干掉 Postman?测试接口直接生成API文档,这工具真香!
前几天粉丝群有小伙伴问,有啥好用的API文档工具推荐,无意间发现了一款工具,这里马不停蹄的来给大家分享一下. ShowDoc一个非常适合团队的在线API文档工具,也支持用docker自建文档服务,不过 ...
- 干掉 Postman?测试接口直接生成API文档,这个工具我爱了
前几天粉丝群有小伙伴问,有啥好用的API文档工具推荐,无意间发现了一款工具,这里马不停蹄的来给大家分享一下. ShowDoc一个非常适合团队的在线API文档工具,也支持用docker自建文档服务,不过 ...
- Zimbra开发接口文档API下载地址
开源版本下载地址: https://www.zimbra.com/documentation/ 文档API接口下载地址: https://wiki.zimbra.com/wiki/SOAP_API_R ...
- api es7 删除所有数据_【Elasticsearch7.0】文档接口之查询delete接口
功能介绍 删除除了之前讲的之外,还有可以根据条件来进行删除._delete_by_query接口是对查询到的结果进行删除操作,如示例: curl -XPOST "http://127.0.0 ...
- api数据接口文档_接口文档示例(Taobao/jd/pinduoduo/开放接口调用)
api数据接口文档_接口文档示例 本文主要是提供了一个接口文档的范文,内容修订历史.目录.时序图.接口要素描述.接口说明.使用示例.字典.FAQ. 使用MD格式文档(makedown),选择原因,容 ...
- 推特开发者账号申请失败【推特开发者文档系列7】——通过API接口发布、检索推文
文章转自:https://www.jianshu.com/p/2c208994ff9a 本系列是对推特开发者文档进行的翻译,以便帮助开发人员使用API接口,难免有些地方存在不足,还请谅解. 关于如何获 ...
- 干掉 Postman?测试接口直接生成API文档,这个工具贼好用
大家好,我是小码哥~ 前几天粉丝群有小伙伴问,有啥好用的API文档工具推荐,无意间发现了一款工具,这里马不停蹄的来给大家分享一下. ShowDoc一个非常适合团队的在线API文档工具,也支持用dock ...
- 批量调取接口_批量请求接口-API文档-开发指南-Web服务 API | 高德地图API
产品介绍 特别说明:受产品策略调整影响,自2020年11月起,建议您不再使用此批量接口.后续平台会逐步废弃并下线此服务. 批量接口通过用户传入合并后的请求,同时返回多个请求的顺序集合,目前最多支持20 ...
最新文章
- 汉字书写解码_《汉字解码学》 第一部分
- Nginx 主要应用场景
- 使用R语言进行中文分词
- QT的QNetworkProxy类的使用
- 分布式文件系统研究-测试-搭建测试环境
- 执行 redis-dump 报错:Error connecting to Redis on localhost:6379 (Redis::TimeoutError)
- AMD院士站台 异构计算与OpenCL编程师资培训首站清华开讲
- 双重检查锁实现单例模式的线程安全问题
- udp怎么保证不丢包_在 Flink 算子中使用多线程如何保证不丢数据?
- JAVA springboot ssm b2b2c多用户商城系统源码(三)SpringBoot用JdbcTemplates访问Mysql
- oracle查询学生人数语句,Oracle期末复习题-带答案
- 初学网站建设,要学习些什么?
- 基于jquery.fixedheadertable 表格插件左侧固定 对齐
- Julia学习01——Julia安装与卸载
- WPS ppt添加幻灯片编号无反应
- 大数据基础课02 从萌芽到爆发,大数据经历了哪些发展?
- 计算机专门存储数据的单元,认识算法的数据存储单元——变量
- 计算机专业考研上岸率,考研“寒冬年”?2020考研上岸几率到底有多大?
- 13C同位素脉冲标记法浅析(实验解析)
- Vue + Element UI 表格分页记忆选中
热门文章
- Lakehouse 架构解析与云上实践
- 海云健康:上云为10万家药店带去了什么价值?
- 3+1保障:高可用系统稳定性是如何炼成的?
- “开源”vs“商业”,差别到底有多大?这篇测试一目了然
- 菜鸟网络宣布推出物流加速上云行动“鲲鹏计划”
- MSSQL-最佳实践-Always Encrypted
- 无法恢复,欧洲云服务巨头数据中心起火
- AI行业真实现状:做芯片没工作,做视觉、语音血赚
- 我们研究了1.5万场活动,换个大城市生活可能对你有用
- 约稿——码字能赢得百万人生?不开玩笑