激励视频广告

1. 介绍

1.1 集成建议

(1) 展示广告：

• 展示前判断isAdReady()是否准备好，准备好后再调用show进行广告展示；若未准备好则发起广告加载，等待广告加载成功；如果需要在加载成功的回调（onRewardedVideoAdLoaded）中展示广告，必须先判断当前应用在前台才能执行展示方法，否则有可能会引起广告在应用外展示或者无法正常展示的情况；

(2) 广告预加载：

• 请提前调用加载方法进行广告的请求（比如在应用启动就开始加载广告），以便需要触发广告时可以快速展示
• 在广告展示后，onRewardedVideoAdPlayStart的回调中无需isAdReady判断，直接调用load进行预加载 （有助于提升优先级比较高的广告源的展示量）

 

2. API说明

2.1 广告加载

ATRewardVideoAd: RewardedVideo广告的加载类

 

2.2 本地参数

ATAdConst.KEY：LocalExtra本地参数预定义Key取值

 

广告加载：

//注意：广告对象必须要全局引用，如果广告对象是临时变量会导致广告加载过程中有可能被回收，无法接收广告事件回调
ATRewardVideoAd mRewardVideoAd;
private void loadAd() {
    if (mRewardVideoAd == null) {
        mRewardVideoAd = new ATRewardVideoAd(this, rewardTakuPlacementID);
    }
    String userid = "test_userid_001";
    String userdata = "test_userdata_001";
    Map localMap = new HashMap<>();
    localMap.put(ATAdConst.KEY.USER_ID, userid);
    localMap.put(ATAdConst.KEY.USER_CUSTOM_DATA, userdata);
    //Load时传自定义参数，在广告源填充之后自定义参数会保存起来，在展示时回传。适用场景:传入会话信息做防作弊类似
    mRewardVideoAd.setLocalExtra(localMap);
    mRewardVideoAd.load();
}

Load时传自定义参数，在广告源填充之后自定义参数会跟广告源缓存一起保存起来。如果希望在展示时传入自定义参数，请更新Taku SDK v6.3.10及以上版本。

 

2.3 广告对象

ATRewardVideoAd:

ATAdStatusInfo：广告位的状态对象

 

2.4 广告展示

ATRewardVideoAd:

 

广告展示：

private void showAd() {
    /*
     为了统计场景到达率，相关信息可查阅 "https://help.takuad.com/docs/1RWLAv"
     在满足广告触发条件时调用“进入广告场景”方法，比如：
     ** 广告场景是在清理结束后弹出广告，则在清理结束时调用；
     * 1、先调用 "entryAdScenario"
     * 2、在调用 "isAdReady" 是否可展示
     * 3、最后调用 "show" 展示
     * 4、scenario 传入场景id后台场景管理才会有数据显示
     */            
       ATRewardVideoAd.entryAdScenario("your rv placementID", "your scenarioID");
    if (mRewardVideoAd.isAdReady()) {
        mRewardVideoAd.show(activity，"your scenarioID");
    }
} 

 

展示时传入自定义参数：

Taku SDK v6.3.10及以上开始支持开发者在展示时传入自定义参数，展示时传入的自定义参数跟Load时传入的自定义参数相互独立。展示时传入自定义参数可以在Taku SDK回调信息中返回，同时Taku的服务端激励回调也支持返回展示时传入的自定义参数。

 

2.5广告监听

ATRewardVideoAd:

 

ATRewardVideoListener：RewardedVideo广告的事件回调监听:

广告监听：

//注意：广告对象必须要全局引用，如果广告对象是临时变量会导致广告加载过程中有可能被回收，无法接收广告事件回调
        mRewardVideoAd.setAdListener(new ATRewardVideoListener() {
            @Override
            public void onRewardedVideoAdLoaded() {
            }
            @Override
            public void onRewardedVideoAdFailed(AdError adError) {
                //注意：禁止在此回调中执行广告的加载方法进行重试，否则会引起很多无用请求且可能会导致应用卡顿
                //AdError，请参考 https://docs.takuad.com/#/zh-cn/android/android_doc/android_test?id=aderror
                Log.e(TAG, "onRewardedVideoAdFailed:" + adError.getFullErrorInfo());
            }
            @Override
            public void onRewardedVideoAdPlayStart(ATAdInfo adInfo) {
                //ATAdInfo可区分广告平台以及获取广告平台的广告位ID等
                //请参考 https://docs.takuad.com/#/zh-cn/android/android_doc/android_sdk_callback_access?id=callback_info

                //建议在此回调中调用load进行广告的加载，方便下一次广告的展示（不需要调用isAdReady()）
                mRewardVideoAd.load();
            }
            @Override
            public void onRewardedVideoAdPlayEnd(ATAdInfo atAdInfo) {
            }
            @Override
            public void onRewardedVideoAdPlayFailed(AdError adError, ATAdInfo atAdInfo) {
                //AdError，请参考 https://docs.takuad.com/#/zh-cn/android/android_doc/android_test?id=aderror
                Log.e(TAG, "onRewardedVideoAdPlayFailed:" + adError.getFullErrorInfo());
            }
            @Override
            public void onRewardedVideoAdClosed(ATAdInfo atAdInfo) {
            }
            @Override
            public void onReward(ATAdInfo atAdInfo) {
                //建议在此回调中下发奖励，一般在onRewardedVideoAdClosed之前回调
            }
            @Override
            public void onRewardedVideoAdPlayClicked(ATAdInfo atAdInfo) {
            }
        });

 

2.6 其他监听

ATRewardVideoExListener： 继承自ATRewardVideoListener，方法同ATRewardVideoListener，额外回调说明如下：

 

ATAppDownloadListener：（仅中国区SDK支持）下载状态的事件回调监听
目前仅支持以下平台：穿山甲

 

3. 示例代码

//注意：广告对象必须要全局引用，如果广告对象是临时变量会导致广告加载过程中有可能被回收，无法接收广告事件回调
ATRewardVideoAd mRewardVideoAd;
private void loadAd() {
    if (mRewardVideoAd == null) {
        mRewardVideoAd = new ATRewardVideoAd(this, rewardTakuPlacementID);
        mRewardVideoAd.setAdListener(new ATRewardVideoListener() {
            @Override
            public void onRewardedVideoAdLoaded() {
            }
            @Override
            public void onRewardedVideoAdFailed(AdError adError) {
                //注意：禁止在此回调中执行广告的加载方法进行重试，否则会引起很多无用请求且可能会导致应用卡顿
                //AdError，请参考 https://docs.takuad.com/#/zh-cn/android/android_doc/android_test?id=aderror
                Log.e(TAG, "onRewardedVideoAdFailed:" + adError.getFullErrorInfo());
            }
            @Override
            public void onRewardedVideoAdPlayStart(ATAdInfo adInfo) {
                //ATAdInfo可区分广告平台以及获取广告平台的广告位ID等
                //请参考 https://docs.takuad.com/#/zh-cn/android/android_doc/android_sdk_callback_access?id=callback_info

                //建议在此回调中调用load进行广告的加载，方便下一次广告的展示（不需要调用isAdReady()）
                mRewardVideoAd.load();
            }
            @Override
            public void onRewardedVideoAdPlayEnd(ATAdInfo atAdInfo) {
            }
            @Override
            public void onRewardedVideoAdPlayFailed(AdError adError, ATAdInfo atAdInfo) {
                //AdError，请参考 https://docs.takuad.com/#/zh-cn/android/android_doc/android_test?id=aderror
                Log.e(TAG, "onRewardedVideoAdPlayFailed:" + adError.getFullErrorInfo());
            }
            @Override
            public void onRewardedVideoAdClosed(ATAdInfo atAdInfo) {
            }
            @Override
            public void onReward(ATAdInfo atAdInfo) {
                //建议在此回调中下发奖励，一般在onRewardedVideoAdClosed之前回调
            }
            @Override
            public void onRewardedVideoAdPlayClicked(ATAdInfo atAdInfo) {
            }
        });
    }
    String userid = "test_userid_001";
    String userdata = "test_userdata_001";
    Map localMap = new HashMap<>();
    localMap.put(ATAdConst.KEY.USER_ID, userid);
    localMap.put(ATAdConst.KEY.USER_CUSTOM_DATA, userdata);
    //Load时传自定义参数，在广告源填充之后自定义参数会保存起来，在展示时回传。适用场景:传入会话信息做防作弊类似
    mRewardVideoAd.setLocalExtra(localMap);
    mRewardVideoAd.load();
}
private void showAd() {
    /*
     为了统计场景到达率，相关信息可查阅 "https://docs.takuad.com/#/zh-cn/android/NetworkAccess/scenario/scenario"
     在满足广告触发条件时调用“进入广告场景”方法，比如：
     ** 广告场景是在清理结束后弹出广告，则在清理结束时调用；
     * 1、先调用 "entryAdScenario"
     * 2、在调用 "isAdReady" 是否可展示
     * 3、最后调用 "show" 展示
     * 4、scenario 传入场景id后台场景管理才会有数据显示
     */            
       ATRewardVideoAd.entryAdScenario("your rv placementID", "your scenarioID");
    if (mRewardVideoAd.isAdReady()) {
        mRewardVideoAd.show(activity，"your scenarioID");
    }
} 

详细激励视频广告示例代码请参考：Demo的RewardVideoAdActivity类