原生自渲染广告
版本 | 时间 | 信息 |
---|---|---|
1.0.0 | 2019-07-23 | 原生自渲染广告说明 |
1 广告介绍
1.1 简介
H5原生自渲染广告,是由开发者获取广告素材(图片、标题、描述)进行自渲染,优量汇提供广告曝光和点击API。
1.2 广告属性
属性 | 内容 |
---|---|
支持平台 | H5 |
播放尺寸 | 自定义 |
广告素材 | 图片、标题、描述 |
提供API | 拉取广告API、曝光API、点击API |
2 接入步骤
2.1 接入准备
准备阶段,请先访问:“h5广告位创建流程” ,完成广告位创建。
2.2 接入H5 SDK
具体的H5 SDK接入方式请访问:“H5 SDK接入流程”,完成H5 SDK接入。
2.3 声明原生自渲染广告
H5 SDK接入完成后,按下列顺序即可调用模板广告API。
- 请先在联盟平台(adnet.qq.com)广告位准备好:
placement_id
,app_id
- 页面中全局申明
window.TencentGDT = window.TencentGDT || [];
- 初始化API
TencentGDT.push({
placement_id: '11**99', // 广告位id
app_id: '11**99', // appid
type: 'native',
count: 1, //拉取广告的数量,选填,默认是3,最高支持10
onComplete: function(res) {
if (res && res.ret === true) {
// 此次回调中没有广告信息,开发者自行决定是否填充自己的广告
let data = res.data[0] // 第0条广告
} else {
// 加载广告API,当广告使用完成,或无广告,可使用loadAd再次拉取广告
// 注意:拉取广告频率每分钟不要超过20次,否则会被广告接口过滤,影响广告位填充率
setTimeout(function() {
TencentGDT.NATIVE.loadAd(placement_id)
}, 3000)
}
}
});
API说明:
参数 | 类型 | 必要 | 说明 |
---|---|---|---|
placement_id | String | 必填 | 广告位id |
app_id | String | 必填 | |
type | String | 必填 | 广告类型,请填写 "native" |
count | Number | 选填 | 拉取广告数量,默认为3,最高支持10 |
onComplete | Function | 选填 | 广告数据回调方法,当广告每一次请求,都会通过回调触达开发者。 |
2.4 拉取广告
当开发者需要使用广告数据时,调用
loadAd
,数据会通过onComplete回调中返回广告数据。
- 接口API:
loadAd方法需要在广告初始化onComplete后调用,否则会报找不到此方法。
window.TencentGDT.NATIVE.loadAd(placement_id);
- 请求字段:
名称 | 类型 | 必填 | 限制 | 描述 |
---|---|---|---|---|
placement_id | string | 是 | 无 | 广告位ID,由广告·优量汇平台生成 |
2.5 曝光上报
广告满足有效曝光条件(曝光曝光面积==50%,并且停留时长>=1s)时,需要进行曝光上报。
- 接口API:
window.TencentGDT.NATIVE.doExpose(obj);
- 请求字段: obj参数为
Object
类型,包含内容如下表所示:
名称 | 类型 | 必填 | 限制 | 描述 |
---|---|---|---|---|
container | string | 是 | 无 | 展示广告的Document元素ID |
advertisement_id | string | 是 | 无 | 广告ID |
placement_id | string | 是 | 无 | 广告位ID |
traceid | string | 是 | 无 | 广告跟踪id |
2.6 点击上报
当广告被有效点击后,需要调用点击上报接口,进行点击上报
注意: 点击上报中的各项参数请如实填写,如果不进行广告的点击上报或上报错误,则将会影响此原生广告位的收入!
- 请求接口:
window.TencentGDT.NATIVE.doClick(obj);
- 请求字段: obj参数为
Object
类型,包含内容如下表所示
名称 | 类型 | 必填 | 限制 | 描述 |
---|---|---|---|---|
container | string | 是 | 无 | 展示广告的Document元素ID |
s | object | 是 | key和value均需用引号包裹 | 点击坐标信息,需要进行:encodeURIComponent 详细介绍如下表 |
advertisement_id | string | 是 | 无 | 广告ID |
placement_id | string | 是 | 无 | 广告位ID |
traceid | string | 是 | 无 | 广告跟踪id |
s字段为object
类型,包含内容如下表所示:
名称 | 类型 | 必填 | 限制 | 描述 |
---|---|---|---|---|
down_x | string | 是 | 无 | 按下横坐标,以广告左上角为原点 |
down_y | string | 是 | 无 | 按下纵坐标,以广告左上角为原点 |
up_x | string | 是 | 无 | 弹起横坐标,以广告左上角为原点 |
up_y | string | 是 | 无 | 弹起纵坐标,以广告左上角为原点 |
全文完