OpenSet Android SDK接入文档(AndroidStudio)
2025年8月12日大约 4 分钟
OpenSet Android SDK接入文档(AndroidStudio)
接入前说明
SDK接入配置
1、在项目根目录的build.gradle文件中引入广告渠道仓库
buildscript {
repositories {
.
.
.
//bidmachine
maven { url "https://artifactory.bidmachine.io/bidmachine" }
//ironsource
maven { url "https://android-sdk.is.com" }
//mintegral
maven { url "https://dl-maven-android.mintegral.com/repository/mbridge_android_sdk_oversea" }
//pangle
maven { url "https://artifact.bytedance.com/repository/pangle" }
//Anythink(Core)
maven {
url "https://jfrog.anythinktech.com/artifactory/overseas_sdk"
}
// adSet
maven {
allowInsecureProtocol = true
url "http://maven.shenshiads.com/nexus/repository/adset/"
}
}
}
allprojects {
repositories {
//bidmachine
maven { url "https://artifactory.bidmachine.io/bidmachine" }
//ironsource
maven { url "https://android-sdk.is.com" }
//mintegral
maven { url "https://dl-maven-android.mintegral.com/repository/mbridge_android_sdk_oversea" }
//pangle
maven { url "https://artifact.bytedance.com/repository/pangle" }
//Anythink(Core)
maven {
url "https://jfrog.anythinktech.com/artifactory/overseas_sdk"
}
// adSet
maven {
allowInsecureProtocol = true
url "http://maven.shenshiads.com/nexus/repository/adset/"
}
}
}2、在module的build.gradle中引入sdk和第三方ADN(*号代表版本号,具体版本号查看demo中的引入)
dependencies {
//core
implementation 'com.shenshi-hw:ad-openset-sdk:1.4.1.2'
//BidMachine
implementation 'com.shenshi-hw:ad-bidmachine-adapter:3.1.1.3'
//bigo
implementation 'com.shenshi-hw:ad-bigo-adapter:5.3.0.2'
//DT(fyber)
implementation 'com.shenshi-hw:ad-fyber-adapter:8.3.7.2'
//inmobi
implementation 'com.shenshi-hw:ad-inmobi-adapter:10.8.2.2'
//ironsource
implementation 'com.shenshi-hw:ad-ironsource-adapter:8.7.0.0.2'
//kwai
implementation 'com.shenshi-hw:ad-kwai-adapter:1.2.19.1'
//applovin
implementation 'com.shenshi-hw:ad-max-adapter:13.3.1.2'
//mintegral
implementation 'com.shenshi-hw:ad-mingetral-adapter:16.9.91.1'
//pangle
implementation 'com.shenshi-hw:ad-pangle-adapter:7.2.0.6.2'
//topon(ADX)
implementation 'com.shenshi-hw:ad-topon-adapter:6.5.15.1'
//unity
implementation 'com.shenshi-hw:ad-unity-adapter:4.14.0.2'
//vungle
implementation 'com.shenshi-hw:ad-vungle-adapter:7.5.0.2'
}混淆配置
不需要额外的的混淆配置
初始化SDK
public class MyApplication extends Application {
@Override
public void onCreate() {
super.onCreate();
// userId传你们的用户Id,有就传没有就不传,用于根据用户反馈问题,查问题用的
OSETSDK.getInstance().setUserId("aaaa");
OSETSDK.getInstance().init(Application, APPKEY, OSETInitListener);
}
}注意,如果是欧盟区的用户,请在初始化成功以后再请求广告,因为欧盟区的用户会弹一个隐私协议的弹框。用户同意之后才能拉取广告
| OSETSDK | 初始化 |
|---|---|
| setUserId(String var1) | 设置用户id(对接的app的用户唯一id,没有可不传) |
| getVersionCode() | 获取AdSet SDK 版本号 |
| getVersionName() | 获取AdSet SDK 版本名 |
| setPrivacyPolicy(String privacyPolicyUrl) | 设置隐私协议地址 (privacyPolicyUrl:隐私协议地址) 针对接入Google Admob广告并在EU地区发布运营的App,其他地区或者没有接入google Admob 广告的请忽略 |
| setTermsOfServices(String termsOfServicesUrl) | 设置用户协议地址 (termsOfServicesUrl:用户协议地址) 针对接入Google Admob广告并在EU地区发布运营的App,其他地区或者没有接入google Admob 广告的请忽略 |
| OSETInitListener | 初始化结果状态回调接口 |
|---|---|
| onError(String var1) | 初始化失败 (var1:失败信息) |
| onSuccess() | 初始化成功 |
广告模块
开屏广告
OSETAppOpen.getInstance()
.setPosId(Common.POS_ID_Splash)
.show(this, new OSETAppOpenListener())| OSETAppOpen | 开屏广告 |
|---|---|
| show(Activity var1,ViewGroup container, OSETSplashListener var2) | 播放开屏广告(var1:Activity,container:开屏广告容器,var2 开屏广告状态监听) |
| OSETAppOpenListener | 开屏广告状态监听 |
|---|---|
| onShow | 广告曝光哦 |
| onError(String var1,String var2) | 广告加载/曝光失败(var1:错误码,var2:错误信息) |
| onClick | 广告点击 |
| onClose | 广告关闭 |
banner广告
OSETBanner.getInstance()
.setUserId(Common.USER_ID)
.setPosId(Common.POS_ID_Banner)
.loadAd(this, osetBannerListener);| OSETBanner | Banner广告 |
|---|---|
| setUserId(String var1) | 设置用户唯一id |
| setContext(Activity var1) | 设置Activity |
| setPosId(String var1) | 设置banner广告位 |
| startLoad() | 广告预加载,全局调用一次即可 |
| loadAd(Activity var1, OSETBannerListener var2) | 加载Banner广告(var1:Activity, var2:Banner广告回调监听) |
| OSETBannerListener | Banner广告回调监听 |
|---|---|
| onShow(View var1) | 广告曝光(var1:广告view) |
| onClose(View var1) | 广告关闭(var1:广告view) |
| onClick(View var1) | 广告点击(var1:广告view) |
| onLoad(View var1) | 广告加载成功(var1:广告view) |
| onError(String var1, String var2) | 广告点击(var1:错误码, var2:错误信息) |
插屏广告
播放广告
OSETInterstitial
.getInstance()
.setUserId(Common.USER_ID)
.setPosId(Common.POS_ID_INTERSTITIAL)
.showAd(Activity,OSETInterstitialListener);| OSETInterstitial | 插屏广告 |
|---|---|
| setUserId(String var1) | 设置用户唯一id |
| setContext(Activity var1) | 设置Activity |
| setPosId(String var1) | 设置插屏广告位 |
| startLoad() | 广告预加载,全局调用一次即可 |
| showAd(Activity var1,OSETInterstitialListener var2) | 播放插屏广告(var1 Activity, var2 广告回调监听) |
| OSETInterstitialListener | 插屏广告回调监听 |
|---|---|
| onShow() | 广告曝光 |
| onClick() | 广告点击 |
| onClose() | 广告关闭 |
| onError(String var1,String var2) | 广告加载/播放失败(var1:错误码, var2:错误信息) |
激励视频广告
缓存广告
OSETRewardVideo.getInstance()
.setContext(this)
.setUserId(Common.USER_ID)
.setPosId(Common.POS_ID_REWARD_VIDEO)
.showAd(Activity,OSETRewardListener);| OSETRewardVideo | 激励广告 |
|---|---|
| setUserId(String var1) | 设置用户唯一id |
| setContext(Activity var1) | 设置Activity |
| setPosId(String var1) | 设置插屏广告位 |
| startLoad() | 广告预加载,全局调用一次即可 |
| showAd(Activity var1,OSETRewardListener var2) | 播放激励广告(var1:Activity, var2:广告回调监听) |
| OSETRewardListener | 激励广告回调监听 |
|---|---|
| onShow(String var1) | 广告曝光(广告唯一id) |
| onVideoStart(String var1) | 视频开始播放 |
| onClick() | 广告点击 |
| onReward(String var1,int var2) | 广告关闭(广告唯一id) |
| onVideoEnd(String var1) | 视频播放结束 |
| onClose(String var1) | 广告关闭(广告唯一id) |
| onError(String var1,String var2) | 广告加载/播放失败(var1:错误码, var2:错误信息) |
原生广告
OSETNative.getInstance()
.setContext(this)
.setUserId(Common.USER_ID)
.setPosId(Common.POS_ID_FULL_VIDEO)
.loadAd(Activity,OSETNativeListener);| OSETNative | 模板信息流广告 |
|---|---|
| setUserId(String var1) | 设置用户唯一id |
| setContext(Activity var1) | 设置Activity |
| setPosId(String var1) | 设置插屏广告位 |
| startLoad() | 广告预加载,全局调用一次即可 |
| loadAd(Activity var1,OSETNativeListener var2) | 加载原生广告(var1:Activity, var2:广告回调监听) |
| OSETNativeListener | 模板信息流广告回调监听 |
|---|---|
| onShow(View var1) | 广告曝光(广告view) |
| onRenderFail(View var1) | 广告渲染失败 |
| onRenderSuccess(View var1) | 广告渲染成功(广告view) |
| onClick(View var1) | 广告点击(广告view) |
| onLoad(View var1) | 广告加载成功(广告view) |
| onClose(View var1) | 广告关闭(广告view) |
| onError(String var1,String var2) | 广告加载/播放失败(var1:错误码, var2:错误信息) |
测试广告位id
| AppKey | E6097975B89E83D6 |
|---|---|
| Banner | 107EB50EDFE65EA3306C8318FD57D0B3 |
| 开屏 | 7D5239D8D88EBF9B6D317912EDAC6439 |
| 插屏 | 1D273967F51868AF2C4E080D496D06D0 |
| 激励 | 09A177D681D6FB81241C3DCE963DCB46 |
| 原生 | 89FEEA66F9228ED3F6420294B89A902B |
