

简体中文
激励视频广告,是cpm收益最高的广告形式。
手机用户观看几十秒视频广告,在广告播放完毕后可获得应用开发商提供的奖励,而应用开发商则可以从广告平台获取不菲的广告收入。
与开屏、信息流等广告变现方式不同,激励视频收益高、但场景设计和编程工作量也较高。
激励视频广告的场景灵活多样:
激励视频还经常和邀请裂变结合在一起,应用开发者为用户设计邀请好友的奖励,让用户有动力邀请更多用户使用这个应用。
激励视频是造富神器。行业经常出现几个人的团队,月收入百万的奇迹。均是因为良好的设计了激励场景和裂变模型。
平台差异说明
App | H5 | 微信小程序 | 支付宝小程序 | 百度小程序 | 字节跳动小程序 | QQ小程序 | 快应用 | 360小程序 | 快手小程序 | 京东小程序 |
---|---|---|---|---|---|---|---|---|---|---|
√(3.4.8+) | x | √(3.4.8+) | x | x | x | x | x | x | x | x |
开通配置广告
激励视频广告组件是原生组件,层级最高,会覆盖在普通前端组件上。
<ad-rewarded-video></ad-rewarded-video>
属性说明
属性名 | 类型 | 默认值 | 说明 | 平台差异 |
---|---|---|---|---|
adpid | String|Number|Array | 广告位id,如果传入的是数组,会从索引0开始请求失败后继续下一个,适用于已配置底价的逻辑 | ||
preload | Boolean | true | 页面就绪后加载广告数据 | |
loadnext | Boolean | false | 自动加载下一条广告数据 | |
disabled | Boolean | false | 禁用默认点击行为 | |
url-callback | Object | 服务器回调透传数据 | ||
v-slot:default="{loading, error}" | 作用域插槽可以获取组件内部广告加载状态和加载错误信息 | |||
@load | EventHandle | 加载事件 | ||
@close | EventHandle | 关闭事件 | ||
@error | EventHandle | 错误事件 |
url-callback说明
字段定义 | 类型 | 字段名称 | 备注 |
---|---|---|---|
userId | String | 用户id | 调用SDK透传,应用对用户的唯一标识 |
extra | String | 自定义数据 | 调用SDK传入并透传,如无需要则为空 |
方法说明
方法名 | 说明 |
---|---|
load | 加载广告数据 |
show | 显示广告 |
注意
load
和 show
不能同时调用,在 load
过程中调用 show
会被忽略,因为数据还没加载完毕,可以在@load
完成事件中调用 show
支持重复调用 show
,调用 show
时会判断是否加载过数据,如果没有会自动加载一次,如果组件正在预载数据,调用 show
也会被忽略
推荐直接使用组件的自动加载逻辑,完全不需要手动调用 load
和 show
<template>
<view>
<ad-rewarded-video adpid="1507000689" :loadnext="true" v-slot:default="{loading, error}">
<button :disabled="loading" :loading="loading">显示广告</button>
<view v-if="error">{{error}}</view>
</ad-rewarded-video>
</view>
</template>
<template>
<view class="content">
<ad-rewarded-video adpid="1507000689" :loadnext="true" v-slot:default="{loading, error}" @load="onadload" @close="onadclose" @error="onaderror">
<button :disabled="loading" :loading="loading">显示广告</button>
<view v-if="error">{{error}}</view>
</ad-rewarded-video>
</view>
</template>
<script>
export default {
data() {
return {
}
},
methods: {
onadload(e) {
console.log('广告数据加载成功');
},
onadclose(e) {
const detail = e.detail
// 用户点击了【关闭广告】按钮
if (detail && detail.isEnded) {
// 正常播放结束
console.log("onadclose " + detail.isEnded);
} else {
// 播放中途退出
console.log("onadclose " + detail.isEnded);
}
},
onaderror(e) {
// 广告加载失败
console.log("onaderror: ", e.detail);
}
}
}
</script>
<template>
<view>
<ad-rewarded-video ref="adRewardedVideo" adpid="1507000689" :preload="false" :loadnext="false" :disabled="true"
v-slot:default="{loading, error}" @load="onadload" @close="onadclose" @error="onaderror">
<view class="ad-error" v-if="error">{{error}}</view>
</ad-rewarded-video>
<button type="primary" :disabled="isLoading" :loading="isLoading" @click="showAd">显示广告</button>
</view>
</template>
<script>
export default {
data() {
return {
isLoading: false
}
},
onReady() {
this.isLoading = true;
this.$refs.adRewardedVideo.load();
},
methods: {
showAd() {
if (this.isLoading) {
return
}
this.$refs.adRewardedVideo.show();
},
onadload(e) {
this.isLoading = false;
console.log('广告数据加载成功');
},
onadclose(e) {
const detail = e.detail
// 用户点击了【关闭广告】按钮
if (detail && detail.isEnded) {
// 正常播放结束
console.log("onClose " + detail.isEnded);
} else {
// 播放中途退出
console.log("onClose " + detail.isEnded);
}
//this.isLoading = true;
//this.$refs.adRewardedVideo.load();
},
onaderror(e) {
// 广告加载失败
console.log(e.detail);
this.isLoading = false;
}
}
}
</script>
<style>
.ad-error {
color: orangered;
margin-top: 5px;
}
</style>
<template>
<view class="content">
<ad-rewarded-video :adpid="adpids" :loadnext="true" v-slot:default="{loading, error}" @load="onadload" @close="onadclose" @error="onaderror">
<button :disabled="loading" :loading="loading">显示广告</button>
<view v-if="error">{{error}}</view>
</ad-rewarded-video>
</view>
</template>
<script>
export default {
data() {
return {
adpids: ["1507000611", "1507000611", "1507000611", "1507000611"]
}
},
methods: {
onadload(e) {
console.log('广告数据加载成功');
},
onadclose(e) {
const detail = e.detail
// 用户点击了【关闭广告】按钮
if (detail && detail.isEnded) {
// 正常播放结束
console.log("onadclose " + detail.isEnded);
} else {
// 播放中途退出
console.log("onadclose " + detail.isEnded);
}
},
onaderror(e) {
// 广告加载失败
console.log("onaderror: ", e.detail);
}
}
}
</script>
提示:3.5.1+ 增加了广告并行请求逻辑,优化分层逻辑,提升广告显示速度
getProvider()
返回值 为 string 类型
值 | 描述 |
---|---|
csj | 穿山甲 |
gdt | 腾讯优量汇(前称广点通) |
ks | 快手 |
sigmob | Sigmob |
示例代码
<template>
<view class="content">
<ad-rewarded-video ref="adRewardedVideo" adpid="1507000689" :loadnext="true" v-slot:default="{loading, error}" @load="onload">
<button :disabled="loading" :loading="loading">显示广告</button>
<view v-if="error">{{error}}</view>
</ad-rewarded-video>
</view>
</template>
<script>
export default {
data() {
return {
}
},
methods: {
onload(e) {
console.log('广告数据加载成功');
let providerName = this.$refs.adRewardedVideo.getProvider();
console.log('广告商名称::', providerName);
}
}
}
</script>
激励视频广告组件默认是隐藏的,在用户主动触发广告后进行显示。
只有在用户点击激励视频广告组件上的 关闭广告 按钮时,广告才会关闭。开发者不可控制激励视频广告组件的隐藏。
loadnext=true
时激励视频广告组件是自动拉取广告并进行更新的。在组件创建后会拉取一次广告,用户点击 关闭广告 后会去拉取下一条广告。
如果拉取失败,通过 @error
注册的回调函数会执行,回调函数的参数是一个包含错误信息的对象。
如果组件的某次自动拉取失败,此时可以调用 load()
手动重新拉取广告。
只有在用户点击激励视频广告组件上的 关闭广告 按钮时,广告才会关闭。这个事件可以通过 @close
监听。
@close
的回调函数会传入一个参数 e.detail,e.detail.isEnded 描述广告被关闭时的状态。
属性 | 类型 | 说明 |
---|---|---|
detail: { isEnded } | boolean | 视频是否是在用户完整观看的情况下被关闭的,true 表示用户是在视频播放完以后关闭的视频,false 表示用户在视频播放过程中关闭了视频 |
开发者需要根据 isEnded 判断是否视频是否播放结束,如果成功播放完毕则应该向用户发放奖励。
<template>
<view class="content">
<ad-rewarded-video adpid="1507000689" :loadnext="true" v-slot:default="{loading, error}" @close="onadclose">
<button :disabled="loading" :loading="loading">显示广告</button>
<view v-if="error">{{error}}</view>
</ad-rewarded-video>
</view>
</template>
<script>
export default {
methods: {
onadclose(e) {
const detail = e.detail
// 用户点击了【关闭广告】按钮
if (detail && detail.isEnded) {
// 正常播放结束
// 这里应该联网给予用户激励。且这段代码应该做安全保护,详见下文中的“安全注意”
console.log("onadclose " + detail.isEnded);
} else {
// 播放中途退出
console.log("onadclose " + detail.isEnded);
}
}
}
}
</script>
App平台 3.1.15+ 支持穿山甲/优量汇/快手
激励视频广告可以支持广告服务器到业务服务器的回调,用于业务系统判断是否提供奖励给观看广告的用户。配置服务器回调后,当用户成功看完广告时,广告服务器会访问配置的云函数,通知用户完成观看激励视频。
相对来讲服务器回调将更加安全,可以依赖广告平台的反作弊机制来避免用户模拟观看广告完成的事件。
如何使用
urlCallback示例
<template>
<view class="content">
<ad-rewarded-video adpid="1507000689" :url-callback="urlCallback" :loadnext="true" v-slot:default="{loading, error}">
<button :disabled="loading" :loading="loading">显示广告</button>
<view v-if="error">{{error}}</view>
</ad-rewarded-video>
</view>
</template>
<script>
export default {
data() {
return {
urlCallback: {
userId: 'testuser',
extra: 'testdata'
}
}
},
methods: {
}
}
</script>
服务器回调基于uniCloud,详细流程如下:
uniAdCallback
uniAdCallback
接收广告商服务器回调验证签名并抹平穿山甲/优量汇/快手参数差异,然后以 callFunction 方式调用用户云函数注意:
uniAdCallback
uniAD
web控制修改回调的服务空间和云函数名称,因为修改后生效需要一段时间3.6.8+ 支持微信小程序服务器回调,目前仅支持使用 uni-id 用户体系的小程序,后续支持非 uni-id 用户系统
Q: 回调为什么使用uniCloud,而不是直接配置开发者的服务器 A:
uniCloud
中的云函数 uniAdCallback
已抹平了差异,开发者按照统一的参数处理即可uniCloud
可以帮助开发者保存一份来自广告商服务器的回调数据到开发者的云数据中,以便开发者主动查询uniCloud
可以承载大并发、防DDoS攻击,无需运营人员维护字段定义 | 类型 | 字段名称 | 备注 |
---|---|---|---|
adpid | String | DCloud广告位id | |
provider | String | 广告服务商 | csj、ks、gdt、sigmob |
platform | String | 平台 | iOS、Android |
trans_id | String | 交易id | 完成观看的唯一交易ID |
user_id | String | 用户id | 调用SDK透传,应用对用户的唯一标识 |
extra | String | 自定义数据 | 调用SDK传入并透传,如无需要则为空 |
返回json数据,字段如下:
字段名称 | 说明 | 字段类型 | 备注 |
---|---|---|---|
isValid | 校验结果 | Blean | 判定结果,是否发放奖励,具体发放奖励由用户自己的业务系统决定 |
示例
exports.main = async (event, context) => {
//event为客户端上传的参数
console.log('event : ', event);
return {
"isValid": true // 将结果返给广告商服务器,暂不支持在客户端获取此返回结果,可以先将结果报错到数据,由客户端发送请求到服务器查询确认
}
};
注意事项
trans_id
相同,产生2次的可能原因有1.1 在云函数里没有向广告商的请求返回 isValid: true 1.2 服务器响应过慢
示例代码: 用户业务系统在uniCloud
'use strict';
const crypto = require('crypto');
const db = uniCloud.database();
const collectionName = "ad-callback-log"; // 如果选择了腾讯云,需要手动预创建表
class DB {
static save(data) {
return new DB().add(data);
}
add(data) {
const collection = db.collection(collectionName);
const data2 = Object.assign(data, {
ad_type: 0,
create_date: new Date()
})
return collection.add(data2);
}
}
exports.main = async (event, context) => {
//event为客户端上传的参数
console.log('event : ', event);
const {
path,
queryStringParameters
} = event;
const data = {
adpid: event.adpid,
platform: event.platform,
provider: event.provider,
trans_id: event.trans_id,
sign: event.sign,
user_id: event.user_id,
extra: event.extra,
}
// 注意::必须验签请求来源
const secret = "";// uniad 后台开通激励视频回调后生成的 Security key
const trans_id = event.trans_id;
const sign2 = crypto.createHash('sha256').update(`${secret}:${trans_id}`).digest('hex');
if (event.sign !== sign2) {
return null;
}
// 可选将回调记录保存到uniCloud,避免用户服务器没有响应时有日志可查,如果选择了保存记录需要做定时清理日志,避免日志过多影响性能
// try {
// await DB.save(data);
// } catch (e) {
// console.log(e);
// }
// 开发者在此处处理自己的回调业务,需要返回值
return null
};
示例代码: 用户业务系统不在uniCloud,通过http的方式发送数据到已有服务器
'use strict';
const crypto = require('crypto');
const db = uniCloud.database();
const DEFAUTL_TIMEOUT = 30000;
const DEFAUTL_RETRY_COUNT = 3;
const RETRY_TIMEOUT = 3000;
const ProviderType = {
CSJ: "csj",
GDT: "gdt",
KS: "ks"
};
const collectionName = "ad-callback-log"; // 如果选择了腾讯云,需要手动预创建表
class DB {
static save(data) {
return new DB().add(data);
}
add(data) {
const collection = db.collection(collectionName);
const data2 = Object.assign(data, {
ad_type: 0,
create_date: new Date()
})
return collection.add(data2);
}
}
class UserServer {
static send(url, data) {
return new UserServer().sendHttpRequest(url, data);
}
async sendHttpRequest(url, data) {
let needRetry = data.provider !== ProviderType.GDT;
let retryCount = needRetry ? DEFAUTL_RETRY_COUNT : 1;
let timeout = needRetry ? RETRY_TIMEOUT : DEFAUTL_TIMEOUT;
let result = null;
while (retryCount > 0) {
console.log("sendHttpRequest::count::" + retryCount + "::", url, data);
try {
result = await uniCloud.httpclient.request(url, {
data,
dataType: 'json',
contentType: 'json',
timeout
});
if (result.data && result.data.isValid === true) {
break;
}
} catch (e) {
console.log(e);
}
retryCount--;
}
return result;
}
}
exports.main = async (event, context) => {
//event为客户端上传的参数
console.log('event : ', event);
const {
path,
queryStringParameters
} = event;
const data = {
adpid: event.adpid,
platform: event.platform,
provider: event.provider,
trans_id: event.trans_id,
sign: event.sign,
user_id: event.user_id,
extra: event.extra,
}
// 注意::必须验签请求来源
const secret = "";// uniad 后台开通激励视频回调后生成的 Security key
const trans_id = event.trans_id;
const sign2 = crypto.createHash('sha256').update(`${secret}:${trans_id}`).digest('hex');
if (event.sign !== sign2) {
return null;
}
// 可选将回调记录保存到uniCloud,避免用户服务器没有响应时有日志可查,如果选择了保存记录需要做定时清理日志,避免日志过多影响性能
// try {
// await DB.save(data);
// } catch (e) {
// console.log(e);
// }
const url = "https://"; // 用户业务服务器地址,为了避免请求被伪造,必须使用签名的方式请求
let reuslt = await UserServer.send(url, data);
return reuslt
};
由于激励视频对应着用户奖励,可能会遇到恶意刷激励奖励但实际上并不看广告的情况。此时广告平台不给结算,但开发者却可能把激励送出去。
为了提升安全性,建议所有使用激励视频的开发者都要做如下工作来加强保护:
注: Sigmob
属于小型广告联盟,收益偏低。如有条件,还需开通优量汇,快手等广告渠道以便提高收益。
Sigmob
暂不支持打包界面的勾选,如集成需进行如下的配置变动:
Sigmob
打包需要将HBuilderX
升级到3.2.0
以上版本。
打开 manifest.json
文件,点击 “源码视图”,uni-app
在 app-plus->distribute->sdkConfigs
下添加如下内容,5+ app
在 plus->distribute->plugins
下添加如下内容:
{
"app-plus": {
"distribute": {
"sdkConfigs": {
"ad" : {
"sigmob" : {}
}
}
}
}
}
注意:如果已经存在ad节点,只需要在后面追加即可,如下
{
"app-plus": {
"distribute": {
"sdkConfigs": {
"ad" : {
"gdt" : {},
"csj" : {},
"ks" : {},
"ks-content" : {},
"sigmob" : {}
}
}
}
}
}
激励视频服务器回调业务涉及费用的部分主要是云函数的使用量、调用次数、出网流量(可选)。 接下来,我们对不同资源,分别进行费用评估。
我们按照uniCloud官网列出的按量计费规则,可以简单得出如下公式:
其中:
我们假设如下数据模型:
云函数费用分2种情况
1
次激励视频回调费用为:
云函数费用 = 资源使用量 * 0.000110592 + 调用次数 * 0.0133 / 10000
= 云函数内存(单位为G) * 云函数平均单次执行时长(单位为秒) * 调用次数 + 调用次数 * 0.0133 / 10000
= 0.5G * 0.2S * 2 * 0.000110592 + 2 * 0.0133/10000
= 0.0000221184 + 0.00000266
= 0.0000247784(元)
业务不在 uniCloud 时通过 HTTP 方式将回调数据发送到传统服务器,将产生出网流量费用
1
次激励视频回调费用为:
云函数费用 = 资源使用量 * 0.000110592 + 调用次数 * 0.0133 / 10000 + 出网流量 * 0.8
= 云函数内存(单位为G) * 云函数平均单次执行时长(单位为秒) * 调用次数 + 调用次数 * 0.0133 / 10000 + 出网流量 * 0.8
= 0.5G * 0.2S * 2 * 0.000110592 + 2 * 0.0133/10000 + 1KB * 0.8 / (1024 * 1024)
= 0.0000221184 + 0.00000266 + 7.62939453125e-7
= 0.000025541339453125(元)
注意:在实际业务中云函数费用可能会出现稍微偏高,如:开发者的服务器响应过慢时,广告商的服务器会重试,导致调用次数增加
广告回调次数 | 云函数费用(元) |
---|---|
1 | 0.0000247784 |
10 | 0.000247784 |
100 | 0.00247784 |
1000 | 0.0247784 |
10000 | 0.247784 |
广告回调次数 | 云函数费用+出网流量费用(元) |
---|---|
1 | 0.000025541339453125 |
10 | 0.00025541339453125 |
100 | 0.0025541339453125003 |
1000 | 0.025541339453125 |
10000 | 0.25541339453125 |
这个费用非常非常低,相比于广告收益,可以忽略。请开发者放心使用。
adpid
,参考测试代码,如果无法显示换个时间再试RewardedVideoAd.onLoad()
、RewardedVideoAd.onError()
、RewardedVideoAd.onClose()
等方法监听广告事件会产生多次事件回调,建议在创建广告后监听一次即可。15
,中间要有间隔时间,否则可能触发系统的反作弊策略导致流量收益下降。错误码