English
Log In
You can then view all documents
GroMore/功能使用说明/激励视频回调
激励视频回调
Last updated 2022-07-25 10:58:54

一、功能介绍

指用户在观看完激励视频后,开发者可以根据服务端返回信息判断是否下发奖励。


  • MSDK>=3310版本时,可以使用Gromore服务器激励回调功能;
  • MSDK<3230 或 MSDK-3300时,仅支持使用第三方ADN服务器激励回调;

二、第三方广告平台使用流程

1、使用说明

开发者需要在第三方广告平台设置开发者自己服务器的回调URL地址,当用户看完激励视频时,广告平台将通过设置的回调URL地址通知开发者,由开发者自行判断并下发奖励。

当前支持服务端奖励发放的广告平台如下:

2、Android

加载广告时通过透传CustomData字段,customData为激励视频服务端验证时的自定义数据。

设置方式如下,根据自己要设置服务器回调的adn进行设置。

3、iOS

开发者可以在激励视频广告加载中通过ABURewardedVideoModel对象配置自定义参数,自定义参数将传递给开发者服务器;

当激励视频播放完成后,GroMore将通过回调URL地址通知到开发者服务器,由开发者自行判断是否下发奖励;

最终结果将通过如下接口回调到给移动端开发者。

三、GroMore使用流程

  • 注意事项:
    • GroMore v3230版本开始支持GroMore的服务端验证,3300版本不包含此功能;
    • 开启Gromore的服务端验证功能后,请不要在第三方ADN重复配置这些代码位的服务端验证,否则可能会导致奖励发放出现问题;

    1、使用流程

    开发者可根据自身使用场景选择是否使用GroMore服务端奖励发放逻辑,使用流程如下:

    1. 开发者需要Gromore平台的激励视频广告位上打开服务器激励,并设置回调URL地址;
    1. 开发者需要在代码中通过MSDK的API传入UserID(用户唯一ID)和UserCustomData(用户自定义数据),这些参数最终将通过回调URL回传给开发者;
    1. 当用户看完激励视频时,Gromore将通过设置的回调URL地址通知开发者,由开发者自行判断并下发奖励,实现事例如下:

    Android端:

    iOS端:

    2、平台配置流程

    • 新广告位:新建激励视频广告位时,开启「服务端激励回调」按钮,完成相关设置填写并保存;
    • 已创建广告位:在应用详情页内,对已创建广告位进入「编辑广告位」界面,开启「服务端激励回调」,完成相关设置填写并保存;


    四、服务端数据说明

    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 按照"key:trans_id"形式拼接为 string,用sha256 算法加密生成的string得到sign签名;

    m-key可通过【穿山甲媒体平台】找到【GroMore聚合管理】入口,搜索对应的广告位ID,编辑该广告位获取安全密钥即可:

    签名示例:

    • 约定返回参数:

    字段名称

    字段定义

    字段类型

    备注

    is_verify

    校验结果

    bool

    判定结果,是否发放奖励

    reason

    失败原因

    int

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

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

    示例:

    • 错误码说明:

    取值

    意义

    20000

    校验成功

    40001

    请求报文解析失败

    40002

    奖励回调未配置

    50001

    请求媒体服务端失败

    50002

    服务端处理异常


    Contents
    Contact us