# 微信小程序广告对接文档
# 一、使用说明
# 1、引入插件
使用插件前,使用者要在app.json中声明需要使用的插件,例如:
{
"plugins": {
"coral-adv": {
"version": "1.0.7",
"provider": "wx0e203209e27b1e66"
}
}
}
说明:以上只是示例代码,实际version请留意开发者广告插件的更新通知
# 2、自定义组件
在 json 文件中定义需要引入的自定义组件时,使用 plugin:// 协议指明插件的引用名和自定义组件名,例如:
{
"usingComponents": {
"coral-adv": "plugin://coral-adv/adv"
}
}
# 3、广告类型
# Banner广告
<coral-adv appid="产品id" type="{{1}}"></coral-adv>
# 格子广告
<coral-adv appid="产品id" type="{{3}}"></coral-adv>
# 激励视频广告
Page({
data: {
isshow: false // 默认必须为false
},
showAdv: function () {
this.setData({
isshow: true,
});
},
finishedCb: function (e) {
wx.showToast({
title: '观看完成'
icon: 'none'
});
this.setData({
isshow: false,
});
},
quitCb: function (e) {
this.setData({
isshow: false,
});
}
});
<button bindtap="showAdv">播放激励视频广告</button>
<coral-adv appid="产品id" type="{{2}}" isshow="{{isshow}}" bind:finishedCb="finishedCb" bind:quitCb="quitCb"></coral-adv>
# 插屏广告
Page({
data: {
isshow: false // 默认必须为false
},
onLoad() {
setTimeout(() => {
this.setData({
isshow: true,
});
}, 5000)
}
});
<coral-adv appid="产品id" type="{{4}}" isshow="{{isshow}}"></coral-adv>
如果进入页面需要展示插屏广告,建议5s后显示最佳
# 二、属性说明
| 参数 | 类型 | 必填 | 默认值 | 说明 |
|---|---|---|---|---|
| appid | string | 是 | 无 | 产品id(由运营提供) |
| type | number | 是 | 无 | 广告类型(1表示Banner广告,2表示激励视频广告,3表示格子广告,4表示插屏广告) |
| target | number | 否 | 4 | 广告用途(场景) |
| isshow | boolean | 否 | false | 是否显示广告位(当广告类型为激励视频或插屏时,需动态改变show达到显示的效果,不能直接初始化为true) |
| finishedCb | function | 否 | 无 | 当广告类型为激励视频时有效,广告观看完成后的回调函数 |
| quitCb | function | 否 | 无 | 当广告类型为激励视频时有效,广告观看中途退出后的回调函数 |