# HXSDK **Repository Path**: hx-sdk-android/hxsdk ## Basic Information - **Project Name**: HXSDK - **Description**: 明日彗星广告SDK - **Primary Language**: Java - **License**: Apache-2.0 - **Default Branch**: master - **Homepage**: None - **GVP Project**: No ## Statistics - **Stars**: 0 - **Forks**: 0 - **Created**: 2025-05-12 - **Last Updated**: 2026-03-26 ## Categories & Tags **Categories**: Uncategorized **Tags**: None ## README # HXSDK #### 介绍 明日彗星广告SDK # **Android集成文档说明** ## **SDK配置** ### 1、添加sdk文件依赖配置 在您的项目目录下build.gradle或setting.gradle文件中添加以下内容 ``` maven { url 'https://gitee.com/hx-sdk-android/hxsdk/raw/master/maven' } ``` ### 2、添加sdk文件依赖配置 在您的app目录下build.gradle文件中添加以下内容 ``` dependencies { //彗星SDK implementation 'com.hx.sdk:hx-sdk:3.1.21' //PTG SDK 不集成PTG广告时不需要集成 implementation 'com.hx.sdk:hx-ptg:2.9.3' //Ubix SDK 不集成Ubix广告时不需要集成 implementation 'com.hx.sdk:hx-ubix:2.8.0' //ICON广告必须集成canary和Glide, 不集成ICON广告时不需要集成 implementation 'com.hx.sdk.canary:canary-sdk:2.2.0' //Mobile SDK 不集成Mobile广告时不需要集成 implementation 'com.hx.sdk:hx-mobile:3.4.7' //YT SDK 不集成YT广告时不需要集成 implementation 'com.hx.sdk:hx-yt:3.14.11.2' //LH SDK 不集成LH广告时不需要集成 implementation 'com.hx.sdk:hx-lh:3.0.2.0' implementation 'com.google.code.gson:gson:2.8.6' implementation 'com.squareup.okhttp3:okhttp:3.12.1' implementation 'com.github.bumptech.glide:glide:4.12.0' // 最新版本参考官网 } ``` ### 3、配置混淆 -dontwarn com.hxad.sdk.** -keep class com.hxad.sdk.**{*;} //不集成Mobile广告时不需要集成 -keep class cj.mobile.**{*;} -keep interface cj.mobile.**{*;} ## **SDK 初始化** 注意:广告请求之前必须先调用SDK初始化方法 ### 1、初始化说明 HXInitConfig.Builder builder = new HXInitConfig.Builder(); //APPID由运营人员提供 builder.setAppId("71003"); //隐私合规设置 builder.setPrivacyConfig(new HXPrivacyConfig() { }); HXSDK.init(this, builder.build()); ### 2、HXInitConfig接口说明
| 方法 | 参数 | 说明 |
|---|---|---|
| setAppId | String | 设置应用的id |
| isUseTextureView | Boolean | 是否使用TextureView播放视频 |
| setAge | Integer | 设置用户年龄 |
| setGender/td> | Integer | 设置用户性别,0 未知 1 男 2 女,默认0 |
| isOpenDebug | Boolean | 是否开启debug开关 |
| setPrivacyConfig | HXPrivacyConfig | 设置聚合隐私控制开关 |
| 方法 | 说明 |
|---|---|
| boolean canUseLocation() | 是否允许SDK使用地理位置信息 |
| HXLocation getLocation() | 可传入位置信息 |
| boolean canUseWifiState() | 是否允许SDK使用wifi信息 |
| boolean canUseWriteExternal() | 是否允许SDK使用存储卡权限 |
| boolean canUseMacAddress() | 是否允许SDK使用Mac地址 |
| String getMacAddress() | 可传入MacAddress |
| boolean canUseOaid() | 是否允许sdk请求广告时获取oaid |
| String getDevOaid() | 可传入设备Oaid |
| boolean canUsePhoneState() | 是否允许SDK主动使用手机硬件参数 |
| String getDevImei() | 可传入设备Imei |
| boolean canUseAppList() | 是否允许SDK获取APP安装列表 |
| List |
可传入应用安装信息 |
| boolean canUseAndroidId() | 是否允许SDK使用AndroidId |
| boolean canUsePhoneState() | 是否允许SDK主动使用手机硬件参数 |
| String getAndroidId() | 可传入设备ID |
| int getPersonalizedState() | 传入个性化开关状态 0 开启个性化广告 1 表示关闭个性化广告 |
| int getProgrammaticRecommendState() | 程序化广告状态 0 开启程序化广告 1 表示关闭程序化广告 |
| boolean canUseSensor() | 是否允许传感器信息 |
| 方法 | 说明 |
|---|---|
| longitude | 经度 |
| latitude | 纬度 |
| 方法 | 参数 | 说明 |
|---|---|---|
| setSpaceId | String | 设置广告位id |
| setTimeout | Integer | 设置超时时间 |
| setWidth | Integer | 设置广告请求宽度,按照显示广告容器的实际宽度传递 |
| setHeight | Integer | 设置广告请求高度,按照显示广告容器的实际高度传递 |
| setCount | Integer | 设置广告请求数量,开屏广告只支持1条 |
| 方法名 | 说明 |
|---|---|
| HXSplashAd(Context context, HXRequestConfig config, HXSplashListener listener) | 构造方法,广告相关状态会通过listener通知开发者。参数说明:context(环境变量)、config(广告请求参数)、listener(广告状态监听器)。 |
| void loadAd() | 请求广告 |
| boolean isValid() | 广告是否有效,无效广告将无法展示 |
| void showAd(ViewGroup container) | 展示广告, 参数container(显示广告的容器) |
| int getEcpm() | 获取广告价格,单位分 |
| void sendWinNotice(Map |
发生竞胜通知,参数info(竞胜信息,key:winPrice, value:竞胜价格 ) |
| void sendLossNotice(Map |
发生竞败通知,参数info(竞败信息,key:winPrice, value:竞胜方价格,key:lossReason, value: 失败原因 0 其它 1 低价格 2 超时) |
| void destroy() | 销毁广告 |
| 方法名称 | 说明 |
|---|---|
| void onAdLoadSucceed() | 告加载成功回调 |
| void onAdLoadFailed(HXErrorInfo info) | ⼴告加载失败回调 |
| void onAdClicked() | ⼴告点击回调 |
| void onAdExposed() | ⼴告显示回调 |
| void onAdExposeFailed(HXErrorInfo info) | ⼴告展示失败回调 |
| void onAdClosed() | ⼴告消失回调(倒计时完成) |
| void onAdSkipped() | 点击倒计时跳过回调 |
| 方法 | 说明 |
|---|---|
| getCode() | 失败错误码 |
| getMessage() | 失败错误信息 |
| 方法名 | 说明 |
|---|---|
| HXNativeAd(Context context, HXRequestConfig config, HXNativeAdListener listener) | 构造方法,广告相关状态会通过listener通知开发者。参数说明:context(环境变量)、config(广告请求参数)、listener(广告状态监听器)。 |
| void loadAd() | 请求广告 |
| boolean isValid() | 广告是否有效,无效广告将无法展示 |
| void showAd(Context context) | 展示广告, 参数context(环境变量) |
| int getEcpm() | 获取广告价格,单位分 |
| void sendWinNotice(Map |
发生竞胜通知,参数info(竞胜信息,key:winPrice, value:竞胜价格 ) |
| void sendLossNotice(Map |
发生竞败通知,参数info(竞败信息,key:winPrice, value:竞胜方价格,key:lossReason, value: 失败原因 0 其它 1 低价格 2 超时) |
| void destroy() | 销毁广告 |
| 方法名称 | 说明 |
|---|---|
| void onAdLoadSucceed(List |
告加载成功回调 |
| void onAdLoadFailed(HXErrorInfo info) | ⼴告加载失败回调 |
| 方法名称 | 说明 |
|---|---|
| void setInteractionListener(HXNativeAdInteractionListener listener) | 设置广告交互 |
| void render() | 渲染广告 |
| View getNativeAdView() | 获取渲染好的广告View |
| void destroy() | 销毁广告 |
| 方法名称 | 说明 |
|---|---|
| void onAdClicked() | ⼴告点击回调 |
| void onAdExposed() | ⼴告显示回调 |
| void onAdExposeFailed() | ⼴告展示失败回调 |
| void onAdClosed() | ⼴告消失回调 |
| void onRenderSuccess(View view, float width, float height) | ⼴告渲染成功回调,view(渲染好的view)、width(渲染好的view宽度,可能为0)、height(渲染好的view高度,可能为0) |
| void onRenderFail(HXErrorInfo info) | ⼴告渲染失败 |
| 方法 | 说明 |
|---|---|
| getCode() | 失败错误码 |
| getMessage() | 失败错误信息 |
| 方法名 | 说明 |
|---|---|
| HXInterstitialAd(Context context, HXRequestConfig config, HXInterstitialListener listener) | 构造方法,广告相关状态会通过listener通知开发者。参数说明:context(环境变量)、config(广告请求参数)、listener(广告状态监听器)。 |
| void loadAd() | 请求广告 |
| boolean isValid() | 广告是否有效,无效广告将无法展示 |
| void showAd(Context context) | 展示广告, 参数context(环境变量) |
| int getEcpm() | 获取广告价格,单位分 |
| void sendWinNotice(Map |
发生竞胜通知,参数info(竞胜信息,key:winPrice, value:竞胜价格 ) |
| void sendLossNotice(Map |
发生竞败通知,参数info(竞败信息,key:winPrice, value:竞胜方价格,key:lossReason, value: 失败原因 0 其它 1 低价格 2 超时) |
| void destroy() | 销毁广告 |
| 方法名称 | 说明 |
|---|---|
| void onAdLoadSucceed() | 告加载成功回调 |
| void onAdLoadFailed(HXErrorInfo info) | ⼴告加载失败回调 |
| void onAdClicked() | ⼴告点击回调 |
| void onAdExposed() | ⼴告显示回调 |
| void onAdExposeFailed(HXErrorInfo info) | ⼴告展示失败回调 |
| void onAdClosed() | ⼴告消失回调 |
| 方法 | 说明 |
|---|---|
| getCode() | 失败错误码 |
| getMessage() | 失败错误信息 |
| 方法名 | 说明 |
|---|---|
| HXRewardVideoAd(Context context, HXRequestConfig config, HXRewardVideoListener listener) | 构造方法,广告相关状态会通过listener通知开发者。参数说明:context(环境变量)、config(广告请求参数)、listener(广告状态监听器)。 |
| void loadAd() | 请求广告 |
| boolean isValid() | 广告是否有效,无效广告将无法展示 |
| void showAd(Context context) | 展示广告, 参数context(环境变量) |
| int getEcpm() | 获取广告价格,单位分 |
| void sendWinNotice(Map |
发生竞胜通知,参数info(竞胜信息,key:winPrice, value:竞胜价格 ) |
| void sendLossNotice(Map |
发生竞败通知,参数info(竞败信息,key:winPrice, value:竞胜方价格,key:lossReason, value: 失败原因 0 其它 1 低价格 2 超时) |
| void destroy() | 销毁广告 |
| 方法名称 | 说明 |
|---|---|
| void onAdLoadSucceed() | 告加载成功回调 |
| void onAdLoadFailed(HXErrorInfo info) | ⼴告加载失败回调 |
| void onAdClicked() | ⼴告点击回调 |
| void onAdExposed() | ⼴告显示回调 |
| void onAdExposeFailed(HXErrorInfo info) | ⼴告展示失败回调 |
| void onAdClosed() | ⼴告消失回调 |
| void onReward(boolean isReward, int amount,Map |
⼴获取奖励回调,isRewar(奖励是否有效)、amount(奖励数量)、extraInfo(扩展信息) |
| void onVideoComplete() | 广告播放完成 |
| void onVideoError() | 广告播放失败 |
| 方法 | 说明 |
|---|---|
| getCode() | 失败错误码 |
| getMessage() | 失败错误信息 |
| 方法名 | 说明 |
|---|---|
| HXIconAd(Context context, HXRequestConfig config, HXIconListener listener) | 构造方法,广告相关状态会通过listener通知开发者。参数说明:context(环境变量)、config(广告请求参数)、listener(广告状态监听器)。 |
| void loadAd() | 请求广告 |
| boolean isValid() | 广告是否有效,无效广告将无法展示 |
| void showAd(ViewGroup container) | 展示广告, 参数container(显示广告的容器) |
| int getEcpm() | 获取广告价格,单位分 |
| void sendWinNotice(Map |
发生竞胜通知,参数info(竞胜信息,key:winPrice, value:竞胜价格 ) |
| void sendLossNotice(Map |
发生竞败通知,参数info(竞败信息,key:winPrice, value:竞胜方价格,key:lossReason, value: 失败原因 0 其它 1 低价格 2 超时) |
| void destroy() | 销毁广告 |
| 方法名称 | 说明 |
|---|---|
| void onAdLoadSucceed() | 告加载成功回调 |
| void onAdLoadFailed(HXErrorInfo info) | ⼴告加载失败回调 |
| void onAdClicked() | ⼴告点击回调 |
| void onAdExposed() | ⼴告显示回调 |
| void onAdExposeFailed(HXErrorInfo info) | ⼴告展示失败回调 |
| void onAdClosed() | ⼴告消失回调(倒计时完成) |
| 方法 | 说明 |
|---|---|
| getCode() | 失败错误码 |
| getMessage() | 失败错误信息 |
| 错误码 | 说明 |
|---|---|
| 2000 | context为空 |
| 2001 | 广告位ID错误 |
| 2002 | 无配置数据 |
| 3001 | ⼴告显示失败,container为空 |
| 3002 | ⼴告显示失败,广告为空 |
| 3003 | ⼴告显示失败,广告无效 |
| 3004 | ⼴告显示失败,未知异常 |
| 版本 | 发布日期 | 更新日志 |
|---|---|---|
| 3.1.21 | 2026-03-23 | 1、适配canary渠道 |
| 3.1.20 | 2026-03-11 | 1、适配GM渠道 |
| 3.1.19 | 2026-01-09 | 1、适配GM渠道 |
| 3.1.18 | 2025-12-24 | 1、更新适配Modbile渠道SDK |
| 3.1.17 | 2025-11-24 | 1、新增YT渠道SDK |
| 3.1.16 | 2025-11-20 | 1、新增LH渠道SDK |
| 3.1.14 | 2025-10-11 | 1、功能优化; 2、更新适配渠道SDK |
| 3.1.13 | 2025-08-29 | 1、功能优化; 2、更新适配渠道SDK |
| 3.1.11 | 2025-08-20 | 1、功能优化; 2、bug Fix;3、新增渠道 |
| 3.1.9 | 2025-08-12 | 1、功能优化;2、添加透传扩展参数 |
| 3.1.8 | 2025-07-23 | 1、功能优化 |
| 3.1.6 | 2025-07-08 | 1、添加ICON广告 |