
功能背景
为满足开发者对激励视频奖励发放强化校验的需求,GroMore 为开发者提供服务端回调功能,建议按照本文档完成配置,基于此功能开发者可在服务端对观看激励视频用户是否发放奖励进行二次校验。
GroMore 平台应用广告位粒度支持开启【服务端奖励回调】功能,开发者开启回调功能并在客户端传入参数后,用户观看激励视频过程中,开发者服务端可以收到GroMore 服务端返回的参数信息并进行奖励下发判断,GroMore 根据判断结果返回回调。
提示:服务端奖励回调非必选,是对激励视频观看进行的额外验证,仅增加一层第三方验证判断,具体的奖励发放仍然由客户端完成,GroMore 服务端只透传验证请求,不会在中间增加校验逻辑。
开发者开启服务端回调功能并完成 userID 及自定义透传参数传入后,在用户观看激励视频过程中, GroMore 服务端会拼接参数信息并访问开发者服务端向开发者确认是否发放奖励,根据开发者服务端返回的 true/false,给到开发者是/否发放奖励的回调,示意图如下。
图释:
步骤1-2:GroMore 后台开启回调功能并配置相关参数;开发者通过客户端的接口传入用户参数信息
步骤3-6:GroMore 服务端拉取信息并拼接参数访问开发者服务端回调URL,开发者自行判断是否发放奖励
步骤7-8:开发者服务端将判断结果返回GroMore 服务端,GroMore 服务端会透传给 GroMore 客户端
步骤9:GroMore 客户端给到开发者奖励回调,开发者根据回调结果进行奖励下发
注:该功能在应用广告位层级配置,如广告位已开启GroMore 的服务端回调,代码位层级不需要再单独配置各家ADN的服务端回调,重复配置可能会导致奖励发放异常,建议统一在 GroMore 侧配置。
提示:回调URL建议使用https协议的域名接口,避免穿山甲部分机房因无法正常访问ip地址的URL而无法收到回调
参数名称 | 字段含义 | 字段类型 | 说明 |
user_id | 用户id | string | 调用SDK透传,应用对用户的唯一标识 |
trans_id | 交易id | string | 完成观看的唯一交易ID,由Gromore生成 |
reward_amount | 奖励数量 | int | 媒体平台配置或调用SDK传入 |
reward_name | 奖励名称 | string | 媒体平台配置或调用SDK传入 |
mediation_rit | 代码位id | string | 代码位id |
prime_rit | 广告位id | string | 广告位ID |
adn_name | 广告网络名称 | String | 广告网络对应的名称,无数据返回null |
ecpm | ecpm | string | 获取广告ecpm价格,无数据返回null。 |
sign | 签名 | string | 由key和trans_id生成的报文签名 |
extra | 用户自定义 | string | 即customData,调用SDK传入并透传,如无需要则为空 |
字段名称 | 字段定义 | 字段类型 | 备注 |
is_verify | 校验结果 | bool | 判定结果,是否发放奖励 |
reason | 失败原因 | int | 当奖励发放失败时上传对应的错误码,并会透传给SDK客户端 |
**注意:按照SDK要求需要服务器判断的回调URL是一个get请求 默认返回的是一个json字符串
取值 | 意义 |
20000 | 校验成功 |
40001 | 请求报文解析失败 |
40002 | 奖励回调未配置 |
50001 | 请求媒体服务端失败 |
50002 | 服务端处理异常 |
【Q】在GroMore 广告位id下,我们还添加了其他广告平台的广告进代码位当中(例如快手和优量汇),那在这种情况下,是不是也不用在其他平台去配置服务器回调呢?还是说其他广告平台的广告需要我们单独去做激励视频S2S的校验判断?
【A】不需要,统一在GroMore 侧配置 ;在GroMore 的广告位id 、下面配置服务器回调,所有的广告都会统一走GroMore 的服务器回调,不需要单独在ADN平台配置服务器回调 ;如果想要单独使用ADN的服务器回调,就不需要使用GroMore 的,单独在ADN的服务器设置回调URL就可以了
【Q】激励视频服务端回调,对于服务端地址,有什么要求吗?
【A】符合对接文档要求即可,另外,不建议设置ip地址的链接,将回调地址更换为域名路径,使用ip地址可能部分穿山甲机房无法访问成功
【Q】开启了GroMore 激励回调但服务器没收到消息是什么问题?
【A】服务器回调只要设置了回调URL,GroMore 都会进行访问,一般收不到回调可能的原因是回调URL没有办法访问或拼接参数之后无法访问,可以先自行排查,如有修改回调URL,正常15分钟-30分钟左右生效
【Q】服务器接收到同一个广告多次回调请求的情况是什么原因?
【A】GroMore 在网络环境不好的情况下会有重试请求,可以根据transid做一下去重
GroMore 目前支持服务端激励回调,优先推荐使用,当配置GroMore 服务端回调功能时无需在代码位层级配置各adn的服务端回调,二者配置其一即可;如未使用GroMore 服务端激励回调功能,开发者如需要服务端回调需要在三方adn后台开启相关功能并设置相关参数,支持服务端奖励发放三方ADN说明文档如下:
Online Customer Service24/7 Online Customer Service BotManual customer service, weekdays 10~ 12 o'clock/14~ 19 o'clock