中文
登录
后可查看全部文档
GroMore/操作指南/瀑布流属性/服务端激励回调
服务端激励回调
最近更新 2024-07-26 23:21:30

背景:

为满足开发者对激励视频奖励发放加强校验的需求,GroMore为开发者提供服务端回调功能,开发者可依照此文档进行相关配置,基于此功能开发者可在服务端对观看激励视频用户是否发放奖励进行二次校验。

注意事项:

  • 融合SDK 5.1.5.0及以上版本支持该功能
  • GroMore服务端激励回调功能在应用广告位层级配置,如广告位已开启GroMore的服务端回调,代码位层级不需要再单独配置各家ADN的服务端回调,重复配置可能会导致奖励发放出现问题,推荐统一在GroMore侧配置即可


一、功能介绍

1.功能说明:

GroMore平台应用广告位粒度支持开启【服务端奖励回调】功能,开发者开启回调功能以及在客户端传入参数后,用户观看激励视频过程中,开发者服务端可以收到GroMore服务端返回的参数信息并进行奖励下发判断,依据判断结果GroMore给出回调。

注:服务器奖励回调不是必须的,是对激励视频观看进行的额外验证,只是增加一次三方的验证判断,具体的奖励发放仍然由客户端完成,GroMore服务端只透传验证请求,不会在中间添加校验逻辑。

2.交互逻辑说明

开发者开启服务端回调功能并完成userid以及自定义透传参数等传入后,在用户观看激励视频过程中, GroMore服务端会拼接参数信息并访问开发者服务端向开发者确认是否进行奖励发放,依据“开发者服务端”返回的true/false,给到开发者是/否发放奖励的回调

3.交互示意图:

图释:

步骤1-2:GroMore后台开启回调功能并配置相关参数;开发者通过客户端的接口传入用户参数信息

步骤3-6:GroMore服务端拉取信息并拼接参数访问开发者服务端回调url,开发者自行判断是否发放奖励

步骤7-8:开发者服务端将判断结果返回GroMore服务端,GroMore服务端会透传到GroMore客户端

步骤9:GroMore客户端给到开发者奖励回调,开发者根据回调结果进行奖励下发


二、使用流程

1.开启「服务端激励回调」:

  • 在GroMore后台的激励视频广告位上,开启「服务端激励回调」,并配置回调相关参数(示例见第三部分)

回调URL设置注意事项:

1.安全性考虑建议使用https协议的接口。

2.使用域名接口非ip地址接口,ip地址的url,穿山甲部分机房可能无法正常访问,导致收不到回调。

2.传入参数

  • 开发者在代码中通过融合SDK的API 传入UserID(用户唯一ID)和用户自定义数据,这些参数最终将通过回调URL 回传给开发者 (参考第三部分示例)

3.判断奖励发放

  • 用户观看完激励视频后,GroMore服务端将通过设置的回调URL 通知开发者,由开发者自行判断并下发奖励

三、回调说明&实现示例

1.回调说明:

  • GroMore会以 GET方式请求开发者的回调URL,并拼接参数回传,开发者的回调URL示例如下:https://www.gromore.com/reward/callback?user_id=1234&trans_id=qwerfdas&reward_amount=100&reward_name=rmb&prime_rit=900000000&mediation_rit=800000000&sign=sign:ebdc5645bc6245819fec2324789a363865272926cd0f8e4e88a993bd7fe3ba81&extra=anything_media_want
  • 字段说明:

参数名称

字段含义

字段类型

说明

user_id

用户id

string

调用SDK透传,应用对用户的唯一标识

trans_id

交易id

string

完成观看的唯一交易ID,由Gromore生成

reward_amount

奖励数量

int

媒体平台配置或调用SDK传入

reward_name

奖励名称

string

媒体平台配置或调用SDK传入

prime_rit

广告位id

string

广告位id

mediation_rit

代码位id

string

代码位id

sign

签名

string

GroMore服务端通过秘钥和trans_id生成的sign值

extra

用户自定义

string

即用户自定义参数,调用SDK传入并透传,如无需要则为空

  • sign签名规则说明:开发者收到GroMore服务器激励回调时,可以通过sign对参数进行校验;签名生成规则为:用trans_id 和 m-key 按照"m-key:trans_id"形式拼接为 string,用sha256 算法加密生成的string得到sign签名;m-key可通过【穿山甲媒体平台】找到【GroMore聚合管理】入口,搜索对应的广告位ID,编辑该广告位获取安全密钥即可。
  • sign签名示例:
复制
  • 约定返回参数:

字段名称

字段定义

字段类型

备注

is_verify

校验结果

bool

判定结果,是否发放奖励

reason

失败原因

int

当奖励发放失败时上传对应的错误码,并会透传给SDK客户端

**注意:按照SDK要求需要服务器判断的回调url是一个get请求 默认返回的是一个json字符串

  • 返回参数示例:
复制
  • 错误码说明:

取值

意义

20000

校验成功

40001

请求报文解析失败

40002

奖励回调未配置

50001

请求媒体服务端失败

50002

服务端处理异常

2.实现示例:

Android端:

复制

iOS端:

复制

常见问题FAQ:

【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后台开启相关功能being设置相关参数,支持服务端奖励发放三方ADN说明文档如下:


本篇目录
联系我们