导航|地址|刷新
API 接口文档-个推文档中心






文档中心开发者中心

，欢迎您！

您的优惠服务将于到期。





基本资料



安全设置



应用管理




退出登录
登录/注册SDK下载个推学堂请选择产品
消息推送

用户运营

OneID服务

AI应用工坊

统计分析

用户分析

标签管理

模型管理

短信服务

数字人外呼

一键认证

合规检测

点击提升







体验更多产品服务


欢迎登录开发者中心

立即登录

本月不再提醒





产品简介

开通指南

客户端
Android
集成文档

API文档


iOS
集成文档

API文档


HarmonyOS
集成文档

API接口


H5&小程序
集成文档

API文档



SDK更新日志




当前位置：个推OneID > 客户端 > Android > API文档



API 接口文档


API 接口文档

接口类说明

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

接口	说明
OneIDManager	SDK 功能接口类，用于调用SDK相关功能

获取 OneIDManager

类名	com.getui.oneid.OneIDManager
接口	public static OneIDManager getInstance()

说明：

用于获取单例 OneIDManager 对象

返回：

返回 OneIDManager 单例对象

初始化

类名	com.getui.oneid.OneIDManager
接口	public void initialize(Context context, OneCallback callback)

说明：

初始化SDK，获取OneID。

参数：

context：应用的 ApplicationContext
callback: 初始化回调结果

示例代码：
//初始化OneIDManager.getInstance().initialize(getApplicationContext(), newOneCallback() { @Override public void onSuccess(String response) { //初始化成功Log.d("OneId", "success = " + response); } @Override public void onFailure(Throwable t) { //初始化失败Log.d("OneId", "error = " + t); } });
回调参数：
requestId: 单次请求ID
oneAID: 唯一ID
{ "requestId": "8af18ba411d14053824588c3147414f7", "oneAID": "A-d141229c1d62fc335f1ea77bf97d7399" }
场景查询

类名	com.getui.oneid.OneIDManager
接口	public void queryLBS(LBSCallback callback, int gpsInterval, int gpsTimeOut)

说明：

查询场景信息

参数：

callback: 场景查询回调接口
gpsInterval: GPS有效期设置，可以设置范围为-1 或 [0, 600]，单位秒。0：实时获取GPS数据。 -1：只使用系统缓存的GPS数据
gpsTimeout: GPS实时定位超时时间设置，可以设置范围为[10, 60]，单位秒, 建议设置20

说明:

获取gpsInterval时间间隔内的GPS数据，如果超出间隔则实时获取GPS数据，进行查询场景信息

SDK不会主动获取定位权限，需要开发者发起定位授权，SDK会根据当前用户的授权状态来进行查询。

未授权定位\定位失败\定位超时等，都将使用ip进行场景查询。

查询完成后，通过LBSCallback.onSuccess回调接口返回场景信息。

示例代码：
//设置GPS有效期为30秒，超时20秒，进行场景查询OneIDManager.getInstance().queryLBS(new LBSCallback() { @Override public void onSuccess(String response) { //查询成功Log.d("OneId", "response = " + response); } @Override public void onFailure(Throwable t) { //查询失败Log.d("OneId", "error = " + t); } }, 30, 20);
回调参数：

requestId: 单次请求ID
sceneInfoList: 场景信息
coarseAddress: 粗略位置
addressCode: 位置代码
{ "requestId": "xxxxxxxxf0eb4432897d6be2xxxxxxxx", "sceneInfoList": [ { "sceneTypeList": [ { //一级分类，指该位置所属的场景的类型，如：交通设施服务、购物服务、餐饮服务等。"st1": "科教文化服务" } ] } ], "coarseAddress": "xxxxxx", "addressCode": { //省Code "province": "450000", //市Code "city": "450100", //区Code "area": "450108" } }
具体开通联系右侧技术支持，或对应商务

应用列表采集开关

类名	com.getui.oneid.OneIDManager
接口	public boolean setAppListEnable(Context context, boolean enable)

说明：

设置应用列表的采集开关

参数：

context：应用的 Context

enable：true表示允许采集，false不允许采集

返回：

true：设置成功；false：设置失败

mac采集开关

类名	com.getui.oneid.OneIDManager
接口	public boolean setMacEnable(Context context, boolean enable)

说明：

设置mac的采集开关

参数：

context：应用的 Context

enable：true表示允许采集，false不允许采集

返回：

true：设置成功；false：设置失败

位置相关信息采集开关

类名	com.getui.oneid.OneIDManager
接口	public boolean setLocationEnable(Context context, boolean enable)

说明：

设置位置相关信息的采集开关

参数：

context：应用的 Context

enable：true表示允许采集，false不允许采集

返回：

true：设置成功；false：设置失败

cellInfo采集开关

类名	com.getui.oneid.OneIDManager
接口	public boolean setCellInfoEnable(Context context, boolean enable)

说明：

设置cellInfo的采集开关

参数：

context：应用的 Context

enable：true表示允许采集，false不允许采集

返回：

true：设置成功；false：设置失败

wifi信息采集开关

类名	com.getui.oneid.OneIDManager
接口	public boolean setWifiEnable(Context context, boolean enable)

说明：

设置wifi信息的采集开关

参数：

context：应用的 Context

enable：true表示允许采集，false不允许采集

返回：

true：设置成功；false：设置失败

广告ID采集开关

类名	com.getui.oneid.OneIDManager
接口	public boolean setAdvertisingIdEnable(Context context, boolean enable)

说明：

设置广告ID的采集开关

参数：

context：应用的 Context

enable：true表示允许采集，false不允许采集

返回：

true：设置成功；false：设置失败

AndroidID采集开关

类名	com.getui.oneid.OneIDManager
接口	public boolean setAndroidIdEnable(Context context, boolean enable)

说明：

设置AndroidID的采集开关

参数：

context：应用的 Context

enable：true表示允许采集，false不允许采集

返回：

true：设置成功；false：设置失败

imei采集开关

类名	com.getui.oneid.OneIDManager
接口	public boolean setImeiEnable(Context context, boolean enable)

说明：

设置imei的采集开关

参数：

context：应用的 Context

enable：true表示允许采集，false不允许采集

返回：

true：设置成功；false：设置失败

Iccid采集开关

类名	com.getui.oneid.OneIDManager
接口	public boolean setIccidEnable(Context context, boolean enable)

说明：

设置Iccid的采集开关

参数：

context：应用的 Context

enable：true表示允许采集，false不允许采集

返回：

true：设置成功；false：设置失败

imsi采集开关

类名	com.getui.oneid.OneIDManager
接口	public boolean setImsiEnable(Context context, boolean enable)

说明：

设置imsi的采集开关

参数：

context：应用的 Context

enable：true表示允许采集，false不允许采集

返回：

true：设置成功；false：设置失败

序列号采集开关

类名	com.getui.oneid.OneIDManager
接口	public boolean setSerialNumberEnable(Context context, boolean enable)

说明：

设置序列号的采集开关

参数：

context：应用的 Context

enable：true表示允许采集，false不允许采集

返回：

true：设置成功；false：设置失败

获取 SDK 版本号

类名	com.getui.oneid.OneIDManager
接口	public String getVersion()

说明：

获取当前 SDK 版本号

返回：

当前 SDK 版本号字符串




以上文档对您是否有帮助？
有帮助没帮助



您的改进建议

是否遇到以下问题

问题类型


1、内容与功能不一致；

2、文章描述不清晰；

3、图片和视频难理解；

4、对产品功能不满意；

5、不是我想要的内容；

6、其他:


问题类型不能为空



反馈建议



联系方式



取 消提 交





反馈成功

非常感谢您的反馈，我们会继续努力做到更好！
确定






在这篇文章中：接口类说明获取 OneIDManager初始化场景查询应用列表采集开关mac采集开关位置相关信息采集开关cellInfo采集开关wifi信息采集开关广告ID采集开关AndroidID采集开关imei采集开关Iccid采集开关imsi采集开关序列号采集开关获取 SDK 版本号







文档中心搜索

搜 索















------
导航页 打开网址