Skip to main content

服务器展示收益API(S2S)说明

一、TradPlus 服务器展示收益API的使用说明#

服务器展示收益API(S2S):,TradPlus服务端会向您的服务器回调展示收益信息。TradPlus Android SDK >= 8.1.0.1 和 iOS SDK >= 7.8 支持。

二、SDK端设置#

必须在请求广告前调用
HashMap<String, String> customMap = new HashMap<>();
customMap.put("user_id", "123");
customMap.put("custom_data", "abc");
SegmentUtils.initCustomMap(customMap);//设置APP维度的规则

三、服务器展示收益API使用流程#

1、服务器展示使用流程#

开发者需要在 TradPlus 后台的广告位上选择服务端展示回调,并设置回调URL地址.

  • (1)开发者需要在代码中通过TradPlus SDK的API传入UserID(用户唯一ID)、ExtraData(用户业务参数). 这些参数最终将通过回调URL通知开发者
  • (2)当广告展示时,TradPlus服务器将通过设置的回调URL地址通知开发者

2、开发者的服务器展示接入指南#

  • (1)开发者需要 TradPlus 后台的创建广告位时打开服务器展示回调,设置开发者服务器展示的回调URL,示例如下:
https://www.tp.com/onrewarded
  • (2) 开发者的回调URL示例如下:
https://www.tp.com/impression?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}子渠道
{ecpm}ecpm,单位:美元
{ecpm_cny}ecpm,单位:人民币
{ecpm_precision}ecpm 精度。
"publisher_defined":开发者在TradPlus后台为广告源定义的eCPM;
"estimated":开发者在后台开启广告源的自动价格功能后,TradPlus根据历史数据预估的eCPM(交叉推广的eCPM也属于该类型)
"exact":bidding实时价格。

4、sign 签名规则说明#

开发者在收到 TradPlus 的服务器展示回调时,可以通过sign对回调参数进行校验。

TradPlus 服务器按以下规则生成sign签名

sign = Sha256(SecretKey:TransId)
参数说明示例
SecretKeyTradPlus 广告位生成的安全密钥D46C4341E83F33DB0DF2BC42816F21B7
TransIdTradPlus 生成的唯一交易 IDa78f36ed-95e5-4049-9647-dfc87e6df0e1
sign = Sha256(D46C4341E83F33DB0DF2BC42816F21B7:a78f36ed-95e5-4049-9647-dfc87e6df0e1) = db10d4a82a32597a101841988bbee1bf5f3ebca9a512456817e301d89c721270

5、开发者回调URL收到 TradPlus 的服务器展示回调后,需给 TradPlus 服务器返回 约定参数#

参数类型说明
isValidboolean校验结果
codeint状态码
messagestring错误信息

注意: 默认返回的是一个json字符串

示例:

{
"isValid": true,
"code": 0,
"message": "ok"
}

6、TradPlus 服务器发起服务器展示回调后2秒内无响应则视为超时, TradPlus 默认重试3次,如果还超时,则不再向开发者回调URL发起展示回调。#