Skip to main content

1、激励视频

一、集成建议#

主要介绍在Android项目中如何集成 TradPlus SDK的激励视频:

  • (1)激励视频广告一般是全屏的15-30s的视频,调用时机是在给用户奖励或者获得某些特定物品时展示广告;当用户看完广告,开发者可以在OnRewardedVideoAdReward 回调中下发奖励发放给用户。目前TP不支持服务器回调(S2S)的激励下发机制,但是可以使用广告平台的服务器回调功能,请参考激励视频服务器激励(S2S)说明
  • (2)激励视频广告是三方广告平台提供的activity,一般不支持做定制或者修改。创建广告位对象和展示广告的时候需要传Activity。
  • (3)激励视频广告一般需要预加载,在需要展示激励视频前判断HasRewardedVideo()是否准备好,准备好后可以调ShowRewardedVideo ()
  • (4)自动加载功能是TradPlus独有的针对部分需要频繁展示广告的场景做的自动补充和过期重新加载的功能,推荐在广告场景触发较多的场景下使用。更多了解,请看自动加载功能介绍

注意事项#

  • (1)禁止在OnRewardedVideoAdFailed回调中执行广告加载的方法,否则会引起多个无用请求。
  • (2)禁止在OnRewardedVideoAdLoaded回调中直接执行广告展示的方法。SDK有自动加载和广告会过期自动补充功能。如果在OnRewardedVideoAdLoaded回调中执行ShowRewardedVideo(),开发者会无法精准控制广告展示的时机。
  • (3)开发请根据附录1:SDK日志查看与分析错误码、错误信息说明排查广告请求失败的原因

二、API说明#

2.1 加载类API#

  • 初始化广告位、请求广告
方法说明
TradPlus.LoadRewardedVideoPluginsForAdUnits("AdUnitId");初始化广告位。
仅初始化时调用一次。
TradPlus.RequestRewardedVideo("AdUnitId", isAutoLoad);加载广告并设置自动加载模式。isAutoLoad, 传true开启自动加载,false关闭。
TradPlus.HasRewardedVideo("AdUnitId");检测是否有可用广告。
自动加载模式下,HasRewardedVideo()false会自动加载广告。
  • 展示广告
方法说明
TradPlus.ShowRewardedVideo("AdUnitId");展示广告(方法一)
自动加载模式下,有可用广告直接展示,没有会自动加载。
TradPlus.RewardedVideoEntryAdScenario("AdUnitId");进入广告场景(可选)
TradPlus.ShowRewardedVideo("AdUnitId","sceneId");展示广告并设置广告场景ID(方法二)
使用该方法必须调用TradPlus.RewardedVideoEntryAdScenario("AdUnitId","sceneId")
自动加载模式下,有可用广告直接展示。没有会自动加载。
TradPlus.RewardedVideoEntryAdScenario("AdUnitId","sceneId");进入广告场景,并传入sceneId广告场景ID。(可选)
  • 参数说明
参数说明
广告位ID adUnitIdTradPlus后台创建。应用管理——添加应用——添加广告位。注意广告类型创建错误会导致广告展示失败,例如用标准原生的广告位去请求激励视频广告。
广告场景ID sceneIdTradPlus后台创建。应用管理—— 广告场景。具体如何使用,请看广告场景的调用时机和用途说明
自动加载模式 isAutoLoadtrue开启,false 关闭。
开启自动加载模式后无需调用RequestRewardedVideo ()
开启后,会在哪些时机请求广告请看自动加载功能说明

2.2 监听回调API#

  • 广告位维度回调监听 V6.4.5新增API
方法参数说明
TradPlusManager.OnRewardedVideoAdLoadedstring tpAdInfo广告加载成功。
TradPlusManager.OnRewardedVideoAdFailedstring adUnitId ,string errorMsg广告加载失败。
TradPlusManager.OnRewardedVideoAdImpressionstring tpAdInfo广告被展示,老版本API为 TradPlusManager.OnRewardedVideoShownEvent
TradPlusManager.OnRewardedVideoAdClickedstring tpAdInfo广告被点击,老版本API为 TradPlusManager.OnRewardedVideoClickedEvent
TradPlusManager.OnRewardedVideoAdClosedstring tpAdInfo广告被关闭,老版本API为TradPlusManager.OnRewardedVideoDismissedEvent
TradPlusManager.OnRewardedVideoAdRewardstring tpAdInfo广告奖励回调,老版本API为TradPlusManager.OnRewardedVideoReceivedRewardEvent
TradPlusManager.OnRewardedVideoAdVideoErrorstring tpAdInfo,string errorMsg广告播放失败。
V7.3.0新增回调参数 errorMsg
TradPlusManager.OnAdPlayAgainRewardstring tpAdInfo“再看一次”奖励回调。
V7.4.0新增,目前仅快手和头条国内支持(需要申请)
  • 广告源维度回调监听 (可选) V6.4.5新增API
方法参数说明
TradPlusManager.OnRewardedVideoAdAllLoadedbool isSuccess,string adUnitId广告位的状态。
loadAd()完毕后用于判断是否有可用广告;
true表明有可用广告,false表明没有可用广告。
老版本API为TradPlusManager.OnRewardedVideoAllLoadedEvent
TradPlusManager.OneRewardedVideoLayerLoadFailedstring tpAdInfo,string errorMsg后台配置多个广告源,每个广告源加载失败后会都会回调一次。
老版本API为TradPlusManager.OnRewardedVideoFailedEvent
TradPlusManager.OneRewardedVideoLayerLoadedstring tpAdInfo后台配置多个广告源,每个广告源加载成功后会都会回调一次。
老版本API为TradPlusManager.OnRewardedVideoLoadedEvent
~~TradPlusManager.OnRewardedVideoLoadAdStart ~~string tpAdInfo请求广告后,广告开始加载。
V7.9.0 废弃
TradPlusManager.OneRewardedVideoLayerStartLoadstring tpAdInfo每层waterfall 向三方广告源发起请求前,触发的回调。
V7.9.0 新增回调
TradPlusManager.OnRewardedVideoAdStartLoadstring adUnitId每次调用load方法时返回的回调,包含自动加载等触发时机。
V7.9.0 新增回调
TradPlusManager.OnRewardedVideoBiddingStartstring tpAdInfoBidding开始加载。
TradPlusManager.OnRewardedVideoBiddingEndstring tpAdInfo,string errorMsgBidding加载完成。
V7.3.0新增回调参数 errorMsg
  • 监听回调中的参数说明
参数说明
TPAdInfo广告位ID、三方广告平台、ecpm等信息,具体请参考回调信息说明
errorMsg广告请求失败、广告展示失败的错误信息,具体请参考错误码、错误信息说明

三、示例代码#

// 1、初始化广告位。仅调用一次。
TradPlus.LoadRewardedVideoPluginsForAdUnits("AdUnitId");
// 2、加载广告。广告位ID在TradPlus后台创建。
// 自动reload模式,true 开启 ,false 关闭。
TradPlus.RequestRewardedVideo("AdUnitId",true);
// 3、判断是否有可用广告
if (TradPlus.HasRewardedVideo("AdUnitId"))
{
// 4、展示
TradPlus.ShowRewardedVideo("AdUnitId");
}