积分墙
一、集成建议
主要介绍在项目中如何集成 TradPlus SDK的积分墙广告: V8.1.0.1 Android, V7.9.0 iOS开始支持积分墙。
注意事项
- （1）禁止在
onOfferWallAdFailed回调中执行广告加载的方法，否则会引起多个无用请求。 - （2）禁止在
onAdLoaded回调中直接执行广告展示的方法。SDK有广告会过期自动补充功能。如果在onAdLoaded回调中执行showAd()，开发者会无法精准控制广告展示的时机。
二.API说明
1.加载类API
- 初始化广告位、请求广告
| 方法 | 说明 |
|---|---|
| TradPlus.LoadOfferWallPluginsForAdUnits("AdUnitId"); | 初始化广告位。 仅初始化时调用一次。 |
| TradPlus.RequestOfferWall("AdUnitId"); | 加载广告。 |
| TradPlus.HasOfferWall("AdUnitId"); | 检查是否有可用广告。 true表明有可用广告。 |
- 展示广告(方法一)
| 方法 | 说明 |
|---|---|
| TradPlus.OfferWallEntryAdScenario("AdUnitId"); | 进入广告场景。 |
| TradPlus.ShowOfferWall("AdUnitId"); | 展示广告 |
- 展示广告(方法二)
| 方法 | 说明 |
|---|---|
| TradPlus.OfferWallEntryAdScenario("AdUnitId","sceneId"); | 进入广告场景，并传入sceneId广告场景ID |
| TradPlus.ShowOfferWall("AdUnitId","sceneId"); | 展示广告并设置广告场景ID 使用该方法必须调用 TradPlus.OfferWallEntryAdScenario("AdUnitId","sceneId")。 |
- 查询
| 方法 | 说明 |
|---|---|
| TradPlus.GetCurrencyBalance("AdUnitId"); | 查询总额 |
| TradPlus.SpendCurrency("AdUnitId"); | 消耗积分 |
| TradPlus.AwardCurrency("AdUnitId"); | 增加积分 |
- 设置UserId
更多了解可以参考官方用户ID介绍
// 请求广告后调用，才能设置成功
TradPlus.SetOfferWallUserId("AdUnitId","userId");
- 参数说明
| 参数 | 说明 |
|---|---|
| 广告位ID adUnitId | TradPlus后台创建。应用管理——添加应用——添加广告位。注意广告类型创建错误会导致 广告展示失败，例如用标准原生的广告位去请求激励视频广告。 |
| 广告场景ID sceneId | TradPlus后台创建。应用管理—— 广告场景。具体如何使用，请看广告场景的调用时机和用途说明。 |
2.监听回调API
- 监听回调中的参数说明
| 参数 | 说明 |
|---|---|
| TPAdInfo | 广告位ID、三方广告平台、ecpm等信息，具体请参考回调信息说明。 |
| errorMsg | 广告请求失败、广告展示失败的错误信息，具体请参考错误码、错误信息说明。 |
- 广告位维度回调监听
| 方法 | 参数 | 说明 |
|---|---|---|
| OnOfferWallAdLoaded | string tpAdInfo | 广告加载成功。 |
| OnOfferWallAdFailed | string adUnitId ， string errorMsg | 广告加载失败。 |
| OnOfferWallAdImpression | string tpAdInfo | 广告展示。 |
| OnOfferWallAdClicked | string tpAdInfo | 广告被点击。 |
| OnOfferWallAdClosed | string tpAdInfo | 广告被关闭。 |
| OnOfferWallAdReward | string tpAdInfo | 广告奖励回调。 |
- 广告源维度回调监听 (可选)
| 方法 | 参数 | 说明 |
|---|---|---|
| OnOfferWallAdAllLoaded | bool isSuccess， string adUnitId | 广告位的状态。loadAd()完毕后用于判断是否有可用广告；true表明有可用广告，false表明没有可用广告。 |
| OneOfferWallLayerLoadFailed | string tpAdInfo， string errorMsg | 后台配置多个广告源，每个广告源加载失败后会都会回调一次。 |
| OneOfferWallLayerStartLoad | string tpAdInfo | 后台配置多个广告源，每个广告源加载成功后会都会回调一次。 |
| OneOfferWallLayerStartLoad | string tpAdInfo | 每层waterfall 向三方广告源发起请求前，触发的回调。 |
| OnOfferWallAdStartLoad | string adUnitId | 每次调用load方法时返回的回调。 |
| OnOfferWallAdShowFailed | string tpAdInfo， string errorMsg | 展示失败。 Android V8.2.0.1开始支持。 iOS V7.9.0开始支持 |
- 积分监听
| 方法 | 参数 | 说明 |
|---|---|---|
| OnAwardCurrencySuccess | string amount， string msg | 增加积分成功 |
| OnSpendCurrencySuccess | string amount， string msg | 消耗积分成功 |
| OnCurrencyBalanceSuccess | string amount， string msg | 查询积分成功 |
| OnAwardCurrencyFailed | string msg | 增加积分失败 |
| OnSpendCurrencyFailed | string msg | 消耗积分失败 |
| OnCurrencyBalanceFailed | string msg | 查询积分失败 |
| OnSetUserIdSuccess | string adunitId | 设置UserID成功。 Android V8.2.0.1开始支持。 |
| OnSetUserIdSuccess | string adunitId | 设置UserID成功。 Android V8.2.0.1开始支持。 |
| OnSetUserIdFailed | string error | 设置UserID失败 。 Android V8.2.0.1开始支持。 |
三.示例代码
// 1、初始化广告位，广告位ID在TradPlus后台创建
TradPlus.OfferWallEntryAdScenario("AdUnitId");
// 2、加载广告
TradPlus.RequestOfferWall("AdUnitId");
// 3、判断是否有可用广告
if (TradPlus.HasOfferWall("AdUnitId"))
{
// 4、展示
TradPlus.ShowOfferWall("AdUnitId");
}