激励视频服务器奖励验证
一. 服务器奖励介绍
-
服务器奖励（S2S)：在用户观看完视频后，TradPlus服务端会向您的服务器回调奖励信息。TradPlus Android SDK >= 7.9 和 iOS SDK >=7.5支持。
-
为保证服务器激励的准确性，建议开发者优先使用三方广告平台的服务器激励回调。对TradPlus Adx和交叉推广，可直接使用TradPlus的服务器激励回调。
二. 使用三方广告平台服务器奖励
- 1、开发者需要到三方广告平台的后台设置开发者自己服务器的回调URL地址，
- 2、开发者在代码中通过Tradplus SDK的API传入user_id （用户唯一ID）、custom_data （用户自定义数据). 这些参数最终将通过回调URL通知给开发者
- 3、当用户看完激励视频时，三方广告平台将通过设置的回调URL地址通知开发者，由开发者自行判断并下发奖励
2.1 支持透传的平台列表
user_id（用户唯一ID）可以使用账户系统或者该APP打开后 ，自动生成一个UUID，来标识该用户的唯一标识。custom_data（用户自定义数据）要根据三方要求传递信息。（不同广告平台会有不同的要求。）
| 广告平台 | 文档网址 | 说明 |
|---|---|---|
| Meta | 向 Android 应用添加奖励式视频广告 | 需要找FB开通 |
| Admob | 设置和测试服务器端验证 | 登录三方后台设置回调URL |
| Applovin | 登录三方后台设置回调URL | —— |
| Mintegral | 设置服务端回调 | 三方后台配置 |
| IronSource | Custom Parameters for Android | 三方后台配置 |
| UnityAds | Server-to-server redeem callbacks | 需要联系对方发GameId和URL,注意测试模式下不生效 |
| Vungle | Server-to-Server (S2S) Callbacks | 三方后台配置,注意测试模式下不生效 |
| AdColony | Server-Side Rewards | 三方后台配置 |
| Pangle（穿山甲） | 服务器到服务器回调 | 三方后台填写回调 URL |
| AppNext | Server-side Postback - Rewarded Video | —— |
| Ogury | Server-side reward callback | 三方后台填写回调 URL |
| Huawei | 登录三方后台设置回调URL | 三方后台填写回调 URL |
| 腾讯广告 | 服务端验证说明 | 三方后台填写回调 URL |
| Sigmob | 激励视频服务端验证（SSV） | 三方后台【广告场景】设置的下方，打开开关即开启服务端验证 |
| 快手 | 文档说明 | 三方后台填写回调 URL |
| 百度 | 文档说明 | 三方后台填写回调 URL |
| TapTap | 文档说明 | 三方后台填写回调 URL |
三. 使用 TradPlus 服务器奖励
使用流程
- 1、开发者需要在 TradPlus 后台的激励视频广告位上选择服务端奖励回调，并设置回调URL地址。
- 2、开发者需要在代码中通过TradPlus SDK的API传入UserID（用户唯一ID）、CustomData（用户自定义数据). 这些参数最终将通过回调URL通知开发者。
- 3、当用户看完激励视频时，TradPlus服务器将通过设置的回调URL地址通知开发者，由开发者自行判断并下发奖励。
服务器接入指南
- 1、开发者需要在 TradPlus 后台的激励视频广告位中打开服务器奖励，并设置开发者服务器奖励的回调URL，示例如下：
- 2、开发者的回调URL示例如下：
https://www.tp.com/onrewarded?adsource_id={adsource_id}&sign={sign}&trans_id={trans_id}
- 3、请参考以下列表，并将需要的宏拼接在回调URL中，TradPlus 服务器会用对应值替换这些宏，并以 GET 方式回调给开发者服务器：
| 参数 | 说明 |
|---|---|
| {adsource_id} | 三方广告网络的广告位ID |
| {app_id} | TradPlus 应用ID |
| {extra} | 用户自定义业务参数 |
| {network_id} | TradPlus 三方广告网络ID |
| {scene_id} | TradPlus 广告场景ID |
| {sign} | 签名信息 |
| {trans_id} | TradPlus 生成的唯一交易 ID |
| {unit_id} | TradPlus 广告位id |
| {user_id} | 用户id |
| {platform} | 应用的系统平台（1 Android, 2 iOS |
| {ts} | 回调的时间戳 |
| {package_name} | 应用包名 |
| {device_ifa} | 设备号（Android： gaid， iOS： idfa） |
| {device_idfv} | iOS idfv |
| {ip} | 用户设备 IP |
| {iso_code} | 国家编码 |
| {bucket_id} | A/B测试组 ID |
| {segment_id} | 流量分组 ID |
| {channel} | 渠道 |
| {subchannel} | 子渠道 |
| {ilrd} | TradPlus SDK 回调的展示级别数据 |
| {reward_name} | 奖励名称 |
| {reward_amount} | 奖励数量 |
- 4、sign 签名规则说明
开发者在收到 TradPlus 的服务器奖励回调时，可以通过sign对回调参数进行校验。
TradPlus 服务器按以下规则生成sign签名
sign = Sha256(SecretKey:TransId)
| 参数 | 说明 | 示例 |
|---|---|---|
| SecretKey | TradPlus 激励视频广告位生成的安全密钥 | D46C4341E83F33DB0DF2BC42816F21B7 |
| TransId | TradPlus 生成的唯一交易ID | a78f36ed-95e5-4049-9647-dfc87e6df0e1 |
sign = Sha256(D46C4341E83F33DB0DF2BC42816F21B7:a78f36ed-95e5-4049-9647-dfc87e6df0e1)
= db10d4a82a32597a101841988bbee1bf5f3ebca9a512456817e301d89c721270
- 5、开发者收到 TradPlus 的服务器奖励回调后，需给 TradPlus 服务器返回 约定参数
| 参数 | 类型 | 说明 |
|---|---|---|
| isValid | boolean | 校验结果 |
| code | int | 状态码 |
| message | string | 错误信息 |
注意： 默认返回的是一个json字符串
示例：
{
"isValid": true,
"code": 0,
"message": "ok"
}
- 6、TradPlus 服务器发起服务器激励回调后2秒内无响应则视为超时, TradPlus 默认重试3次，如果还超时，则不再向开发者回调URL发起激励回调。
四. TradPlus SDK接入
需在请求广告前调用API 设置。user_id（用户唯一ID）、custom_data（用户自定义数据)。
4.1 Android 接入
必须在请求广告前调用Map<String, Object> mLocalExtras = new HashMap<>();
mLocalExtras.put("user_id", "123");
mLocalExtras.put("custom_data", "abc");
mTpReward.setCustomParams(mLocalExtras);
mTpReward.loadAd();
4.2 Unity3D 接入
必须在请求广告前调用Dictionary<string, string> rewardedmap = new Dictionary<string, string>();
rewardedmap.Add("user_id","123");
rewardedmap.Add("custom_data", "25");
TradPlus.SetCustomParams(_rewardedVideoAdUnits,rewardedmap);
TradPlus.RequestRewardedVideo("AdUnitId");
五.ILRD参数说明
数据说明 参考 回调信息说明列表