English
Log In
You can then view all documents
GroMore/操作指南/瀑布流属性/服务端激励回调
服务端激励回调
Last updated 2024-05-27 18:00:46

一、功能介绍

  • 开启「服务端激励回调」后,开发者可在用户观看完激励视频后,收到GroMore服务端返回的信息,并根据相应信息判断是否下发奖励。

注意事项:

  • 融合SDK 5.1.5.0及以上版本支持该功能;
  • GroMore的「服务端激励回调」与三方ADN的「服务端激励回调」二选一配置即可,否则会导致下发奖励出现问题。


二、GroMore 使用流程

1. 交互示意图

2. 使用流程

2.1 开启「服务端激励回调」

  • 在GroMore后台的激励视频广告位上,开启「服务端激励回调」,并配置相关参数

2.2 传入参数

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

2.3 判断奖励发放

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

2.4 实现示例

  • Android端
复制
  • iOS端
复制

3. 服务端数据说明

  • 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

由key和trans_id生成的报文签名

extra

用户自定义

string

即customData,调用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

服务端处理异常


三、三方ADN 使用流程

1. 使用说明

2. 使用示例

  • Android端:加载广告时通过透传CustomData字段,customData为激励视频服务端验证时的自定义数据;
  • 设置方式如下,根据自己要设置服务器回调的ADN进行设置。
复制
  • iOS端:开发者可以在激励视频广告加载中通过ABURewardedVideoModel对象配置自定义参数,自定义参数将传递给开发者服务器;
  • 当激励视频播放完成后,GroMore将通过回调URL地址通知到开发者服务器,由开发者自行判断是否下发奖励;最终结果将通过如下接口回调到给移动端开发者。
复制


Contents
Contact us