自研聚合
SDK 初始化
务必在初始化接⼝回调后再调⽤其它接⼝
初始化接⼝调⽤⽅式有如下两种,初始化可以使用
快速初始化动态初始化其中的一种进行接入
快速初始化
在
app/src/main.AndroidManifest.xml配置 BeesAds 平台的 App Id。
<manifest>
<application>
<meta-data
android:name="com.bees.ads.sdk.APP_ID"
android:value="应用 id" />
</application>
</manifest>调用初始化接口
BeesSdk.getInstance(context).initialize(new OnSdkInitializationListener());参数说明如下:
参数名称
参数说明
context
上下文
listener
初始化监听器
代码示例:
动态初始化
调用如下初始化接口:
参数说明如下:
参数名称
参数说明
context
上下文
appId
BeesAds 后台应用 id
listener
初始化监听器
代码示例:
OnSdkInitializationListener 说明:
初始化回调接口
方法名称
方法说明
onInitializeSuccess()
SDK 初始化成功
onInitializeFailed(@NonNull AdsError adsError)
SDK 初始化失败
SDK 接口介绍
横幅广告
加载
大小
类型
说明
BannerSize.BANNER
标准横幅广告,尺寸:320x50
BannerSize.LARGE_BANNER
大号横幅广告,尺寸:320x100
BannerSize.MEDIUM_RECTANGLE
中矩形广告,尺寸:300x250
BannerSize.FULL_BANNER
全宽横幅广告,适合平板设备,尺寸:468x60
BannerSize.LEADERBOARD
超宽横幅广告,适合平板设备,尺寸:728x90
展示
回调
销毁
示例
原生广告
加载
监听
BeesNativeAdListener 说明:
原生广告监听器
方法名称
方法说明
onAdDisplayFailed(@NonNull AdsError adsError)
广告展示失败
onAdImpression()
广告曝光回调
onAdClicked()
广告点击回调
展示
创建原生广告视图层级
显示广告并绑定原生广告控件
销毁
示例
开屏广告
加载
监听
回调说明:
方法名称
方法说明
onAdDisplayed()
广告展示成功
onAdDisplayFailed(@NonNull AdsError adsError)
广告展示失败
onAdImpression()
广告曝光回调
onAdClicked()
广告点击回调
onAdHidden()
广告隐藏回调
展示
示例
插屏广告
加载
监听
回调说明:
方法名称
方法说明
onAdDisplayed()
广告展示成功
onAdDisplayFailed(@NonNull AdsError adsError)
广告展示失败
onAdImpression()
广告曝光回调
onAdClicked()
广告点击回调
onAdHidden()
广告隐藏回调
展示
示例
激励广告
加载
监听
回调说明:
方法名称
方法说明
onAdDisplayed()
广告展示成功
onAdDisplayFailed(@NonNull AdsError adsError)
广告展示失败
onAdImpression()
广告曝光回调
onAdUserRewarded()
广告奖励回调
onAdClicked()
广告点击回调
onAdHidden()
广告隐藏回调
展示
示例
插页式激励广告
加载
监听
回调说明:
方法名称
方法说明
onAdDisplayed()
广告展示成功
onAdDisplayFailed(@NonNull AdsError adsError)
广告展示失败
onAdImpression()
广告曝光回调
onAdUserRewarded()
广告奖励回调
onAdClicked()
广告点击回调
onAdHidden()
广告隐藏回调
展示
示例
插播广告
模块接入
在应用级 build.gradle 文件(通常是 app/build.gradle)中,完成插播模块接入
API 介绍
BeesMediaAdLoader.Builder
插播广告加载器构建类
方法名称
方法说明
Builder(Context context, String adTagUrl)
构造参数。adTagUrl:广告网址
setLanguage(String language)
自定义设置本地语言,参考语言区域代码默认语言:"en"
setLoadTimeout(int timeout)
自定义超时时间,单位:毫秒默认时间为 8*1000 毫秒。
setAdLabelUI(boolean showAdLabelUI)
显示 AD 标签默认隐藏
setCountdownUI(boolean showCountdownUI)
显示 UI 倒计时默认隐藏
setMuted(boolean mute)
是否请求静音广告默认静音
setPreload(boolean preload)
是否开启预加载默认开启
setContentProgressProvider(@NonNullMediaContentProgressProvider contentProgressProvider)
设置内容视频进度提供者(VAMP 广告时需要)
build()
创建插播广告对象
BeesMediaAdLoader
插播广告加载器
方法名称
方法说明
loadAd(ViewGroup container, MediaAdPlayer mediaAdPlayer)
加载广告container:展示广告所需要的容器,必传参数且不为 NULLmediaAdPlayer: 自定义播放器需实现的接口类
setAdListener(@Nullable BeesMediaAdListener listener)
设置广告监听器
setAdEventListener(@Nullable BeesMediaAdEventListener listener)
设置广告事件监听器
setAdOptionsCallback(@Nullable BeesMediaAdOptionsCallback callback)
设置广告配置回调。用于开发者在广告请求前中灵活配置各阶段设置参数。
isReady()
广告是否就绪
destroy()
广告销毁,释放资源。
BeesMediaAd
插播广告
方法名称
方法说明
String getAdTagUrl()
获取广告网址参数
MediaProgressUpdate getAdProgress()
设置广告监听器
registerFriendlyObstruction(@NonNull View view, @NonNull BeesMediaFriendlyType friendlyType, @Nullable String reason);
注册友好控件。view: 标记为友好阻碍的视图(UI 元素)friendlyType:
VIDEO_CONTROLS: 视频控件,例如播放、暂停按钮等;
CLOSE_AD: 关闭广告按钮;
NOT_VISIBLE: 不可见的 UI 元素;
OTHER: 其他类型的 UI 元素。
reason:提供详细的理由说明为什么该视图不会阻碍用户与广告互动
unregisterAllFriendlyObstructions()
移除友好控件注册
start()
广告播放
pause()
广告暂停
resume()
广告恢复
destroy()
广告销毁,释放资源。
BeesMediaAdEventListener
广告事件监听器
方法名称
方法说明
void onEvent(@NonNull Object event)
广告时间回调。event:参考 IMA 广告事件文档
BeesMediaAdOptionsCallback
广告设置回调
方法名称
方法说明
onAdsSetting(@NonNull Object configSetting)
用于开发者自定义 ImaSdkSettings设置
onAdsRequest(@NonNull Object requestSetting)
用于开发者自定义 AdsRequest 设置
onAdsRender(@NonNull Object renderSetting)
用于开发者自定义 AdsRenderingSettings 设置
BeesMediaAdListener
广告监听器
方法名称
方法说明
onAdLoadSuccess(@NonNull String adUrl)
广告加载成功回调,当加载 VMAP 广告时,会触发多次。
onAdLoadFailed(@NonNull SdkError error)
广告加载失败回调
onAdStarted()
广告开始播放
onAdPaused()
广告播放后,暂停播放
onAdResumed()
广告暂停后,继续播放
onAdCompleted()
广告播放完成
onAdAllCompleted()
广告全部播放完成
onAdError(@NonNull AdsError error)
广告出现错误
onAdSkipped()
可跳过的广告,用户点击跳过
onAdTapped()
视频区域被点击
onAdClicked()
广告被点击
onAdProgress(long progress, long duration)
广告播放进度progress: 当前播放进度 duration:广告总时长单位:毫秒
onContentPause()
视频内容暂停,开发者需在此回调中完成视频内容暂停
onContentResume()
视频内容恢复,开发者需在此回调中完成视频内容恢复
代码示例:
隐私合规
GDPR
《通用数据保护条例》(General Data Protection Regulation,GDPR)是针对欧盟(EU)和欧洲经济区(EEA)所有公民的数据保护和隐私法的法规。
参数:
参数名称
参数含义
context
上下⽂
userConsent
true: 用户同意 false: 用户不同意
CCPA
加州消费者隐私法案 (CCPA) 是美国第一项全面隐私法。 它于 2018 年 6 月末签署成为法律,向加州消费者提供各种各样的隐私权利。 受到 CCPA 管制的企业将对这些消费者履行多项义务,包括信息披露、与欧盟一般数据保护条例 (GDPR) 类似的消费者权利、“选择退出”特定数据传输的权利,以及“选择加入”未成年人要求的权利。
参数:
参数名称
参数含义
context
上下⽂
doNotSell
true: 不上报数据 false: 上报数据
COPPA、GDPR Child
美国儿童在线隐私权保护法(Children’s Online Privacy Protection Act,)主要针对在线收集 13 岁以下儿童个人信息的行为。
参数:
参数名称
参数含义
context
上下⽂
isAgeRestrictedUser
true: 是年龄受限用户 false: 不是年龄受限用户
谷歌广告内容分级
参数:
参数名称
参数含义
context
上下⽂
maxContentRating
所有受众: RequestConfiguration.MAX_AD_CONTENT_RATING_G青少年: RequestConfiguration.MAX_AD_CONTENT_RATING_T成人: RequestConfiguration.MAX_AD_CONTENT_RATING_MA需要由父母陪同观看: RequestConfiguration.MAX_AD_CONTENT_RATING_PG
调试模式
日志输出
调试模式
Last updated