English
Log In
You can then view all documents
Installation/常见问题接入指南说明/广告配置说明详解/激励视频交互方式简介&奖励方法说明
激励视频交互方式简介&奖励方法说明
Last updated 2024-09-12 16:43:47

背景

为满足开发者对激励视频奖励发放逻辑处理,穿山甲广告变现(以下简称CSJ)为开发者提供了客户端和服务端回调校验功能,开发者可遵循此文档进行相关配置和开发,基于此功能开发者可对满足奖励发放条件的用户进行发放奖励。


一、激励视频交互

激励视频是一种由用户主动选择且通过观看广告内容获取奖励的广告类型,一般使用在游戏复活、签到看广告领取积分、看广告获取三日会员等场景下。

穿山甲激励视频的交互方式分为:纯视频纯试玩视频+试玩三种方式。开发者不需要单独申请每种交互方式,默认三种交互方式混出。


二、奖励发放条件

纯视频:

一般视频时长为5~60s,30s以上的视频播放到30s时会显示“跳过”按钮。低于30s的激励视频观看达到90%即会回调奖励验证接口,高于30s激励视频观看到第27s的时候即会回调奖励验证接口

视频+试玩:

一般视频时长为5~60s,30s以上的视频播放到30s时会显示“跳过”按钮。低于30s的激励视频观看达到90%即会回调奖励验证接口,高于30s激励视频观看到第27s的时候即会回调奖励验证接口,在试玩界面是否有交互不会影响奖励的发放。

纯试玩:

在纯试玩界面有用户操作并且停留时间达到25s才可以领取奖励。用户需要同时满足这两个条件才可以触发穿山甲的奖励回调。

三、奖励回调方法说明

客户端回调的优势:对接简单、高效,通过接口回调结果在客户端完成奖励是否发放即可。

服务端回调的优势:开发者可在服务端进行二次校验,支持透传参数到服务器 。

开发者不管使用服务端验证还是客户端验证都可以通过奖励验证回调方法进行奖励发放。

3.1客户端回调

3.1.1说明

1、穿山甲根据“奖励发放条件”,直接给到开发者客户端是否发放奖励的回调,故对接相对简单。

2、奖励验证回调涵盖目前所有激励视频播放异常的场景,包括非用户主动操作导致的视频无法完成播放。


3.1.2接口说明

iOS端:模板渲染激励视频

依据返回的verify(YES/NO)为依据进行激励视频的发放处理

复制

//Andriod端

复制

3.2服务端回调

3.2.1说明

1、服务器回调模式不是必须的,只是增加了一次第三方服务器的验证判断。具体的奖励发放由客户端完成。

2、穿山甲服务端只是透传验证请求,不会在中间过程添加校验逻辑。为了保障开发者利益和用户体验,开发者可以在验证环节增加自己的校验逻辑。

3、开发者在平台开启回调功能( 开启参考 3.2.2 说明),当用户观看时长满足“ 奖励发放条件 ”,先通过“穿山甲服务端”访问“开发者服务端”向开发者确认是否进行奖励发放,再依据“开发者服务端”返回的 true/false,在客户端给出是/否发放奖励

(iOS:nativeExpressRewardedVideoAdServerRewardDidSucceed ;Android: onRewardArrived ) 回调给开发者反馈奖励是否可以发放,具体交互示意如下:


图释:

步骤1-2:CSJ平台开启回调功能并配置回调地址;开发者通过客户端的BURewardedVideoModel/AdSlot接口传入用户参数信息

步骤3-6:CSJ服务端拉取信息并拼接参数访问开发者服务端回调URL,开发者自行判断是否发放奖励,服务端判断过程可根据需求添加sign签名验证逻辑。

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

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

复制

3.2.2 开启流程

  • 在CSJ后台激励视频代码位,点击编辑 ,开启「服务端激励回调」 ,并配置回调相关参数

回调URL设置注意事项:

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

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

3.2.3回调方式说明

  • 穿山甲服务器会以 GET 方式请求开发者的回调链接(开发者可自行拼接内部唯一标识字段),并拼接以下参数回传:user_id=%s&trans_id=%s&reward_name=%s&reward_amount=%d&extra=%s&sign=%s

字段名称

字段定义

字段类型

备注

sign

签名

string

签名

user_id

tagid

string

调用 SDK 透传

trans_id

交易

string

完成观看的唯一交易 ID

reward_amount

奖励数量

int

媒体平台创建代码位时配置的数值

reward_name

奖励名称

sting

媒体平台创建代码位时配置的名称

extra

Extra

string

调用 SDK 传入并透传,如无需要则为空

3.2.4签名生成方式

  • 生成方式

appSecurityKey: 您在穿山甲媒体平台新建奖励视频代码位获取到的密钥

transId:交易 id

复制

Python 示例:

复制
  • sign签名规则说明:开发者收到CSJ服务器激励回调时,可以通过sign对参数进行校验;签名生成规则为:用trans_id 和Security Key 按照"SecurityKey:trans_id"形式拼接为 string,用sha256 算法加密生成的string得到sign签名;Security Key可通过代码位编辑页面找到。


3.2.5约定返回参数

字段名称

字段定义

字段类型

备注

isValid

校验结果

bool

判定结果,是否发放奖励

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

示例:

复制

3.2.6 接口说明

Android端:

复制

iOS端:

复制


Contents
Contact us