Skip to main content

激励视频

一.需要实现的抽象方法#

  • 开发者只需要继承TPRewardAdapter并重写相关方法:
    • 开发者调用TP SDK的loadAd() API时,会调用到自定义Adapter的loadCustomAd()方法
    • 开发者调用TP SDK的isReady() API时,会调用到自定义Adapter的isReady()方法
    • 开发者调用TP SDK的showAd(Activity activity, String sceneId) API时,会依次调用到自定义Adapter的isReady()showAd()方法
抽象方法参数说明返回值作用
loadCustomAd()context 上下文; userParams 本地配置参数;tpParams 服务器下发参数Context;Map;Map用于获取服务器下发和本地配置的参数,实现自定义广告的加载逻辑
showAd()----------实现展示自定义广告的逻辑
isReady()-----boolean用于展示广告前判断自定义广告是否过期
clean()----------用于释放资源
getNetworkVersion()-----String自定义三方广告的版本号
getNetworkName()-----String自定义三方广告的名称

二.激励视频广告事件回调#

(1)mLoadAdapterListener实现广告事件的回调

方法说明
loadAdapterLoadFailed(TPError)实现广告事件的加载失败回调。TPError见下面介绍。
loadAdapterLoaded(TPBaseAd)实现广告事件加载成功回调,该类型直接传null

(2)mShowListener实现展示广告事件的回调

方法说明
onAdVideoStart()实现广告事件的展示回调。
onAdVideoEnd()实现广告事件的关闭回调。
onAdVideoError(TPError)实现广告事件的展示失败回调。TPError 方法setTpErrorCode,设置三方的ErrorCode错误码;
onAdVideoClicked()实现广告事件的点击回调。
onReward()实现广告事件奖励回调。

三.其他API说明#

  • TPError方法
TPError tpError = new TPError(NETWORK_NO_FILL);
tpError.setErrorCode(adError.getErrorCode() +"");
tpError.setErrorMessage(adError.getErrorMessage());
TPError方法说明
setTpErrorCode()设置三方的ErrorCode错误码。
setErrorMessage()设置三方的ErrorMsg错误信息。
NETWORK_NO_FILL自定义广告平台NOFILL。
ADAPTER_CONFIGURATION_ERROR自定义广告平台服务器下发参数错误。
SHOW_FAILED自定义广告平台展示失败。
  • loadCustomAd()中本地配置参数常量
常量说明
AppKeyManager.GDPR_CONSENTGDPR,了解更多见隐私规范,下同
AppKeyManager.KEY_GDPR_CHILDGDPRChild,GDPR儿童
AppKeyManager.KEY_COPPACOPPA,美国儿童在线隐私权保护法
AppKeyManager.KEY_CCPACCPA,加州消费者隐私法案

四.示例代码#

/*
* 激励视频类型需要继承TPRewardAdapter,并重写以下几个方法
* loadCustomAd() 用于获取服务器下发和本地配置的参数,实现自定义广告平台的加载逻辑
* showAd() 实现展示自定义广告平台激励视频的逻辑
* isReady() 用于展示广告前判断自定义广告是否过期
* clean() 用于释放资源
* getNetworkVersion() 自定义三方源的版本号
* getNetworkName 自定义三方源的名称
* */
public class FacebookInterstitialVideoAdapter extends TPRewardAdapter {
private RewardedVideoAd mRewardedVideoAd;
private String mPlacementId;
private static final String TAG = "FacebookRewardedVideo";
@Override
public void loadCustomAd(final Context context,
final Map<String, Object> userParams,
final Map<String, String> tpParams) {
// tpParams 获取从服务器端下发的字段
if (tpParams.size() > 0 && tpParams.containsKey("placemntId")) {
mPlacementId = tpParams.get("placemntId");
} else {
/*
* mLoadAdapterListener在oadCustomAd重写时同步生成
* 回调方法loadAdapterLoaded :广告加载成功
* 回调方法loadAdapterLoadFailed :广告加载失败
* 构造TPError方法,ADAPTER_CONFIGURATION_ERROR 服务器下发参数错误
* 方法setTpErrorCode 设置三方的ErrorCode错误码
* 方法setErrorMessage 设置三方的ErrorMsg错误信息
*
* */
if (mLoadAdapterListener != null) {
mLoadAdapterListener.loadAdapterLoadFailed(new TPError(ADAPTER_CONFIGURATION_ERROR));
}
return;
}
// userParams 获取从本地配置的参数
// 例如:海外源需要设置CCPA和COPPA,具体接入参考文档,高级功能-隐私规范部分
FacebookInitializeHelper.setUserParams(userParams,mLoadAdapterListener);
//初始化SDK
FacebookInitializeHelper.initialize(context);
//创建三方广告位对象
mRewardedVideoAd = new RewardedVideoAd(context, mPlacementId);
//设置FB监听,并set监听回调
RewardedVideoAdListener rewardedVideoAdListener = new RewardedVideoAdListener() {
@Override
public void onRewardedVideoCompleted() {
Log.i(TAG, "onRewardedVideoCompleted: ");
//使用mShowListener实现广告事件的奖励回调
if (mShowListener != null) {
mShowListener.onReward();
}
}
@Override
public void onError(Ad ad, AdError adError) {
Log.i(TAG, "onError: code :" + adError.getErrorCode() + " , msg:" + adError.getErrorMessage());
if (mLoadAdapterListener != null) {
TPError tpError = new TPError(NETWORK_NO_FILL);
tpError.setErrorCode(adError.getErrorCode() +"");
tpError.setErrorMessage(adError.getErrorMessage());
mLoadAdapterListener.loadAdapterLoadFailed(tpError);
}
}
@Override
public void onAdLoaded(Ad ad) {
if (mRewardedVideoAd == null) {
return;
}
Log.i(TAG, "onAdLoaded: ");
if (mLoadAdapterListener != null) {
//使用mLoadAdapterListener,实现广告事件加载成功回调
mLoadAdapterListener.loadAdapterLoaded(null);
}
}
@Override
public void onAdClicked(Ad ad) {
Log.i(TAG, "onAdClicked: ");
//使用mShowListener实现广告事件的点击回调
if (mShowListener != null) {
mShowListener.onAdClicked();
}
}
@Override
public void onLoggingImpression(Ad ad) {
Log.i(TAG, "onLoggingImpression: ");
//使用mShowListener实现广告事件的展示回调
if (mShowListener != null) {
mShowListener.onAdVideoStart();
}
}
@Override
public void onRewardedVideoClosed() {
Log.i(TAG, "onRewardedVideoClosed: ");
//使用mShowListener实现广告事件的关闭回调
if (mShowListener != null) {
mShowListener.onAdVideoEnd();
}
}
};
// 请求广告
RewardedVideoAd.RewardedVideoAdLoadConfigBuilder rewardedVideoAdLoadConfigBuilder = mRewardedVideoAd.buildLoadAdConfig().withAdListener(rewardedVideoAdListener);
mRewardedVideoAd.loadAd(rewardedVideoAdLoadConfigBuilder.build());
}
@Override
public void showAd() {
/*
* mShowListener在showAd()重写时生成,用户实现调用show()后的事件回调
* 回调方法onAdVideoStart :广告开始展示
* 回调方法onAdVideoEnd :广告关闭
* 回调方法onAdVideoError :广告展示失败 ,参数一:ErrorCode错误码;参数2:ErrorMsg错误信息
* 回调方法onAdVideoClicked :广告被点击
* 回调方法onReward :广告奖励
* */
if (mRewardedVideoAd != null && mRewardedVideoAd.isAdLoaded()) {
mRewardedVideoAd.show();
}else {
if (mShowListener != null) {
mShowListener.onAdVideoError(new TPError(SHOW_FAILED));
}
}
}
@Override
public void clean() {
super.clean();
// 释放资源
if (mRewardedVideoAd != null) {
mRewardedVideoAd.destroy();
mRewardedVideoAd = null;
}
}
@Override
public boolean isReady() {
// 用于判断广告是否过期
if (mRewardedVideoAd != null) {
return mRewardedVideoAd.isAdInvalidated();
}
return false;
}
@Override
public String getNetworkVersion() {
// 自定义三方广告源的版本号
return BuildConfig.VERSION_NAME;
}
@Override
public String getNetworkName() {
// 自定义三方广告源的名称
return "audience-network";
}
}