Skip to main content

积分墙

1、请求广告#

using TradplusSDK.Api;
//流量分组
Dictionary<string, string> customMap = {};
//local自定义Map,仅Android支持
Dictionary<string, string> localParams = {};
//设置附加参数 extra
TPOfferwallExtra extra = new TPOfferwallExtra();
extra.customMap = customMap;
extra.localParams = localParams;
//请求广告
TradplusOfferwall.Instance().LoadOfferwallAd("在TP平台创建的广告位ID", extra);

参数说明

unitId:TradPlus后台创建的广告位ID#
  • 开发者需正确填入,例如:unitId设置前后有空格,均会导致广告因拉不到配置而请求失败。
TPOfferwallExtra:额外参数#
  • customMap:设置流量分组 相关属性参数
  • localParams:设置本地参数。仅Android支持。个别广告平台特殊需要设定的参数。

2、检查是否有可用广告#

  • 建议开发者展示广告前,调用该API判断是否有可用广告,有广告再调用show方法
  • true表示有可用广告,false表示暂时无可用广告
bool isReady = TradplusOfferwall.Instance().OfferwallAdReady("在TP平台创建的广告位ID");

3、进入广告场景#

TradplusOfferwall.Instance().EntryOfferwallAdScenario("在TP平台创建的广告位ID", "sceneId");

参数说明

sceneId :广告场景ID (推荐)#
  • 开发者可在在TradPlus后台创建,位置如下:应用管理--广告场景。
  • 进入广告场景时传入sceneId,展示广告时也需传入sceneId,否则会影响统计。

4、展示广告#

//调用展示前先判断是否有广告
bool isReady = TradplusOfferwall.Instance().OfferwallAdReady("在TP平台创建的广告位ID");
if(isReady)
{
//展示广告
TradplusOfferwall.Instance().ShowOfferwallAd("在TP平台创建的广告位ID", "sceneId");
}

5、其他API#

调用这些API时 需要设置 对应回调监听来获取结果

  • 设置UserId

用户切换账号时设置,UserId跟后面的积分API绑定, 在首次加载成功后设置。

//设置回调监听
TradplusOfferwall.Instance().OnOfferwallSetUserIdFinish += OnSetUserIdFinish;
void OnSetUserIdFinish(string adunit, bool isSuccess)
{
// isSuccess 返回true,表示用户名设置成功
// isSuccess 返回false,表示用户名设置失败
}
//设置用户ID
TradplusOfferwall.Instance().SetUserId("在TP平台创建的广告位ID", "offerwall_userid");
  • 获取当前用户的积分余额
//设置回调监听
TradplusOfferwall.Instance().OnCurrencyBalanceSuccess += OnCurrencyBalanceSuccess;
TradplusOfferwall.Instance().OnCurrencyBalanceFailed += OnCurrencyBalanceFailed;
void OnCurrencyBalanceSuccess(string adunit, int amount, string msg)
{
// 查询成功 amount:用户当前积分数量
}
void OnCurrencyBalanceFailed(string adunit, string msg)
{
// 查询失败
}
//设置用户ID
TradplusOfferwall.Instance().GetCurrencyBalance("在TP平台创建的广告位ID");
  • 消费积分 例:用积分兑换道具时使用
//设置回调监听
TradplusOfferwall.Instance().OnSpendCurrencySuccess += OnSpendCurrencySuccess;
TradplusOfferwall.Instance().OnSpendCurrencyFailed += OnSpendCurrencyFailed;
void OnSpendCurrencySuccess(string adunit, int amount, string msg)
{
//抵扣成功 amount:用户当前积分数量
}
void OnSpendCurrencyFailed(string adunit, string msg)
{
//抵扣失败
}
//count :消费的积分数量(int)
TradplusOfferwall.Instance().SpendBalance("在TP平台创建的广告位ID", count);
  • 应用主动奖励积分
//设置回调监听
TradplusOfferwall.Instance().OnAwardCurrencySuccess += OnAwardCurrencySuccess;
TradplusOfferwall.Instance().OnAwardCurrencyFailed += OnAwardCurrencyFailed;
void OnAwardCurrencySuccess(string adunit, int amount, string msg)
{
//增加成功 amount:用户当前积分数量
}
void OnAwardCurrencyFailed(string adunit, string msg)
{
//增加失败
}
//count :奖励的积分数量(int)
TPOfferWallManager.awardBalance(unitId, count);

6、监听回调#

参数说明

常用回调#

// 广告加载成功
TradplusOfferwall.Instance().OnOfferwallLoaded += OnlLoaded;
// 广告加载失败
TradplusOfferwall.Instance().OnOfferwallLoadFailed += OnLoadFailed;
// 广告展示成功
TradplusOfferwall.Instance().OnOfferwallImpression += OnImpression;
//广告展示失败
TradplusOfferwall.Instance().OnOfferwallShowFailed += OnShowFailed;
//广告点击
TradplusOfferwall.Instance().OnOfferwallClicked += OnClicked;
//广告关闭
TradplusOfferwall.Instance().OnOfferwallClosed += OnClosed;
//每层waterfall加载失败时回调
TradplusOfferwall.Instance().OnOfferwallOneLayerLoadFailed += OnOneLayerLoadFailed;
void OnlLoaded(string adunit, Dictionary<string, object> adInfo)
{
// 广告加载成功
}
void OnLoadFailed(string adunit, Dictionary<string, object> error)
{
// 广告加载失败
}
void OnImpression(string adunit, Dictionary<string, object> adInfo)
{
// 广告展示成功
}
void OnShowFailed(string adunit, Dictionary<string, object> adInfo, Dictionary<string, object> error)
{
//广告展示失败
}
void OnClicked(string adunit, Dictionary<string, object> adInfo)
{
//广告点击
}
void OnClosed(string adunit, Dictionary<string, object> adInfo)
{
//广告关闭
}
void OnOneLayerLoadFailed(string adunit, Dictionary<string, object> adInfo, Dictionary<string, object> error)
{
//每层waterfall加载失败时回调
}

广告源维度回调监听(可选)#

//每次调用load方法时返回的回调
TradplusOfferwall.Instance().OnOfferwallStartLoad += OnStartLoad;
//每层waterfall开始加载时回调
TradplusOfferwall.Instance().OnOfferwallOneLayerStartLoad += OnOneLayerStartLoad;
//每层waterfall加载成功时回调
TradplusOfferwall.Instance().OnOfferwallOneLayerLoaded += OnOneLayerLoaded;
//加载流程结束
TradplusOfferwall.Instance().OnOfferwallAllLoaded += OnAllLoaded;
//调用load之后如果收到此回调,说明广告位仍处于加载状态,无法触发新的一轮广告加载。V1.0.5 新增回调
TradplusOfferwall.Instance().OnOfferwallIsLoading += OnAdIsLoading;
void OnStartLoad(string adunit, Dictionary<string, object> adInfo)
{
//每次调用load方法时返回的回调
}
void onAdIsLoading(string unitId)
{
//调用load之后如果收到此回调,说明广告位仍处于加载状态,无法触发新的一轮广告加载。V1.0.5 新增回调
}
void OnOneLayerStartLoad(string adunit, Dictionary<string, object> adInfo)
{
//每层waterfall开始加载时回调
}
void OnOneLayerLoaded(string adunit, Dictionary<string, object> adInfo)
{
//每层waterfall加载成功时回调
}
void OnAllLoaded(string adunit, bool isSuccess)
{
//加载流程结束
// isSuccess 返回true,表示此次请求,有广告源加载成功
// isSuccess 返回false,表示此次请求,广告位adUnitId下所有广告源加载失败
}