zyTencentAd
来自于:勇可可立即使用
其它接口
模块接口
init showSplashAd closeSplashAd showBannerAd closeBannerAd showInteractionAd closeInterstitialAD loadRewardVideoAd showRewardVideoAd
论坛示例
为帮助用户更好更快的使用模块,论坛维护了一个示例,示例中包含示例代码供您参考。
概述
模块简介
zyTencentAd封装腾讯广点通Android、Ios广告sdk,包含Banner广告、插屏广告、开屏位广告、激励视频广告等功能。
IOS 云编译最低版本为9.0,Android云编译最低版本为4.0.3。
使用模块前请先到腾讯广点通后台注册帐号、新建应用、添加代码位使用。模块中默认测试代码位可直接测试使用。
模块接口
getVersions
获取当前集成的sdk版本号
getVersions(callback(ret))
callback(ret)
ret:
- 类型:JSON 对象
- 内部字段:
{
status:true, //调用成功
result:"4.11.6",//结果
}
示例代码
var zyTencentAd = api.require('zyTencentAd');
zyTencentAd.getVersions(function(ret){
alert("zyTencentAd:"+JSON.stringify(ret));
});
可用性
Android系统,ios系统
可提供的1.0.0及更高版本
init
初始化模块(使用前必须)
init({params}, callback(ret))
params
appId:
- 类型:字符串
- 描述:(必选项)应用id
- 默认值:api.systemType==’ios’?”1105344611”:”1101152570”
channel:
- 类型:数字
- 描述:(必选项)渠道号 具体设置请看其官方说明 https://developers.adnet.qq.com/doc/android/union/union_embed
- 默认值:999
callback(ret)
ret:
- 类型:JSON 对象
- 内部字段:
{
status:true,
result:"初始化完成"
}
示例代码
var zyTencentAd = api.require('zyTencentAd');
var param = {
appId:api.systemType=='ios'?"1105344611":"1101152570",
channel:999
};
zyTencentAd.init(param,function(ret){
console.log("zyTencentAd:"+JSON.stringify(ret));
});
可用性
Android系统,ios系统
可提供的1.0.0及更高版本
showSplashAd
展示开屏广告
showSplashAd({params}, callback(ret))
params
setCodeId:
- 类型:字符串
- 描述:(必选项)代码位id
- 默认值:api.systemType==’ios’?”9040714184494018”:”8863364436303842593”
//因平台差异 以下参数仅android可用 ios不可设置宽高 只能全屏 rect:
- 类型:对象
- 描述:(可选项)打开开屏区域 全为0或不写 则打开全屏
- 内部字段:
{
x:0,
y:0,
w:0,
h:0
}
fixedOn:
- 类型:字符串类型
- 描述:(可选项)模块视图添加到指定 frame 的名字(只指 frame,传 window 无效)
- 默认值:模块依附于当前 window
fixed:
- 类型:布尔
- 描述:(可选项)模块是否不随所属 window 或 frame 滚动
- 默认值:true(不随之滚动)
errorClose:
- 类型:布尔
- 描述:(可选项)异常时是否自动关闭广告
- 默认值:true
callback(ret)
ret:
- 类型:JSON 对象
- 内部字段:
{
status:true, //true的结果如下 false结果则显示对应错误提示
result:"开屏广告加载中"
"开屏广告加载成功"
"开屏广告曝光时"
"开屏广告展示"
"开屏广告点击"
"开屏广告剩余:N"
"开屏广告倒计时结束"
"开屏广告已关闭"
}
示例代码
var zyTencentAd = api.require('zyTencentAd');
var param = {
setCodeId:api.systemType=='ios'?"9040714184494018":"8863364436303842593",//默认测试代码位
//因平台差异 以下参数仅 android可用 ios不可设置宽高 只能全屏
rect:{//开屏位置 默认0即为全屏 也可自定义
x:0,
y:0,
w:0,
h:0
},
fixedOn:"",
fixed:true,
errorClose:true//异常时是否自动关闭广告 默认true
};
zyTencentAd.showSplashAd(param,function(ret){
console.log("zyTencentAd:"+JSON.stringify(ret));
});
可用性
Android系统,ios系统
可提供的1.0.0及更高版本
closeSplashAd
关闭开屏广告
closeSplashAd(callback(ret))
callback(ret)
ret:
- 类型:JSON 对象
- 内部字段:
{
status:true,
result:"开屏广告已关闭"
}
示例代码
var zyTencentAd = api.require('zyTencentAd');
zyTencentAd.closeSplashAd(function(ret){
console.log("zyTencentAd:"+JSON.stringify(ret));
});
可用性
Android系统,ios系统
可提供的1.0.0及更高版本
showBannerAd
展示Banner广告
showBannerAd({params}, callback(ret))
params
setCodeId:
- 类型:字符串
- 描述:(必选项)代码位id
- 默认值:api.systemType==’ios’?”1080958885885321”:”4080052898050840”
rect:
- 类型:对象
- 描述:(可选项)打开开屏区域 全为0或不写 则打开全屏
- 内部字段:
{
x:0,
y:0,
w:0,
h:0
}
fixedOn:
- 类型:字符串类型
- 描述:(可选项)模块视图添加到指定 frame 的名字(只指 frame,传 window 无效)
- 默认值:模块依附于当前 window
fixed:
- 类型:布尔
- 描述:(可选项)模块是否不随所属 window 或 frame 滚动
- 默认值:true(不随之滚动)
refresh:
- 类型:数字
- 描述:(可选项)设置刷新频率,为0或30~120之间的数字,单位为 s,0标识不自动轮播
- 默认值:30
errorClose:
- 类型:布尔
- 描述:(可选项)异常时是否自动关闭广告
- 默认值:true
callback(ret)
ret:
- 类型:JSON 对象
- 内部字段:
{
status:true, //true的结果如下 false结果则显示对应错误提示
result:"banner展示"
"banner曝光时"
"banner点击"
"banner由于广告点击离开APP"
"banner广告打开浮层"
"banner浮层关闭"
"bannerAd已关闭"
}
示例代码
var param = {
setCodeId:api.systemType=='ios'?"1080958885885321":"4080052898050840",//默认测试代码位
rect:{//显示位置
x:20,
y:100,
w:api.winWidth-40,
h:70
},
fixedOn:api.frameName,
fixed:false,
refresh:0,//设置刷新频率,为0或30~120之间的数字,单位为 s,0标识不自动轮播,默认30S
errorClose:true,//异常时是否自动关闭模块 默认true
};
zyTencentAd.showBannerAd(param,function(ret){
console.log("zyTencentAd:"+JSON.stringify(ret));
});
可用性
Android系统,ios系统
可提供的1.0.0及更高版本
closeBannerAd
手动关闭Banner广告
closeBannerAd(callback(ret))
callback(ret)
ret:
- 类型:JSON 对象
- 内部字段:
{
status:true,
result:"bannerAd已关闭"
}
示例代码
var zyTencentAd = api.require('zyTencentAd');
zyTencentAd.closeBannerAd(function(ret){
console.log("zyTencentAd:"+JSON.stringify(ret));
});
可用性
Android系统,ios系统
可提供的1.0.0及更高版本
showInteractionAd
展示插屏广告
showInteractionAd({params}, callback(ret))
params
setCodeId:
- 类型:字符串
- 描述:(必选项)代码位id
- 默认值:api.systemType==’ios’?”6050298509489032”:”1050691202717808”
isMaskLayer:
- 类型:布尔
- 描述:(可选项)是否有遮罩层 此参数仅android有效
- 默认值:true
autoPlayPolicy:
- 类型:数字
- 描述:(可选项)视频自动播放条件 0仅wifi自动播放 1始终自动播放 2从不自动播放 ios只有0和1
- 默认值:1
autoPlayMuted:
- 类型:布尔
- 描述:(可选项)播放视频时是否静音
- 默认值:true
detailPageMuted:
- 类型:布尔
- 描述:(可选项)详情页的视频是否静音
- 默认值:false
fullScreen:
- 类型:布尔
- 描述:(可选项)是否全屏视频
- 默认值:false
errorClose:
- 类型:布尔
- 描述:(可选项)异常时是否自动关闭广告
- 默认值:true
callback(ret)
ret:
- 类型:JSON 对象
- 内部字段:
{
status:true, //true的结果如下 false结果则显示对应错误提示
result:"ECPM价格:-1"
"interstitialAD展示"
"interstitialAD曝光时"
"interstitialAD点击"
"interstitialAD由于广告点击离开APP"
"interstitialAD视频下载中"
"interstitialAD视频开始播放"
"interstitialAD视频暂停"
"interstitialAD视频播放结束"
"interstitialAD进入视频落地页"
"interstitialAD退出视频落地页"
"interstitialAD已关闭"
}
示例代码
var zyTencentAd = api.require('zyTencentAd');
var param = {
setCodeId:api.systemType=='ios'?"6050298509489032":"1050691202717808",//默认测试代码位
isMaskLayer:true,//是否有遮罩 默认true 仅android有效
autoPlayPolicy:1,//视频自动播放条件 0仅wifi自动播放 1始终自动播放 2从不自动播放 ios只有0和1
autoPlayMuted:true,//视频是否静音 默认true
detailPageMuted:true,//详情视频是否静音 默认false
fullScreen:false,//是否全屏视频 默认false
errorClose:true,//异常时是否自动关闭模块 默认true
};
zyTencentAd.showInteractionAd(param,function(ret){
console.log("zyTencentAd:"+JSON.stringify(ret));
});
可用性
Android系统,ios系统
可提供的1.0.0及更高版本
closeInterstitialAD
关闭插屏广告
closeInterstitialAD(callback(ret))
callback(ret)
ret:
- 类型:JSON 对象
- 内部字段:
{
status:true,
result:"interstitialAD已关闭"
}
示例代码
var zyTencentAd = api.require('zyTencentAd');
zyTencentAd.closeInterstitialAD(function(ret){
console.log("zyTencentAd:"+JSON.stringify(ret));
});
可用性
Android系统,ios系统
可提供的1.0.0及更高版本
loadRewardVideoAd
加载激励视频广告
loadRewardVideoAd({params}, callback(ret))
params
setCodeId:
- 类型:字符串
- 描述:(必选项)代码位id
- 默认值:api.systemType==’ios’?”9070098640008762”:”6040295592058680”,
autoPlayMuted:
- 类型:布尔
- 描述:(可选项)视频是否静音
- 默认值:false
callback(ret)
ret:
- 类型:JSON 对象
- 内部字段:
{
status:true, //true的结果如下 false结果则显示对应错误提示
result:"激励视频加载成功"
"ECPM价格:-1"
"激励视频缓存完成"
"激励视频展示"
"激励视频曝光"
"激励视频激励发放"
"激励视频点击"
"激励视频播放完"
"激励视频关闭"
}
示例代码
var zyTencentAd = api.require('zyTencentAd');
var param = {
setCodeId:api.systemType=='ios'?"9070098640008762":"6040295592058680",//默认测试代码位
autoPlayMuted:true,//视频是否静音 默认false
};
zyTencentAd.loadRewardVideoAd(param,function(ret){
console.log("zyTencentAd:"+JSON.stringify(ret));
});
可用性
Android系统,ios系统
可提供的1.0.0及更高版本
showRewardVideoAd
展示激励视频
showRewardVideoAd(callback(ret))
callback(ret)
ret:
- 类型:JSON 对象
- 内部字段:
{
status:true|false,
result:"展示激励视频|请先加载激励视频|激励视频已展示过,请重新请求|激励视频广告已过期"
}
示例代码
var zyTencentAd = api.require('zyTencentAd');
zyTencentAd.showRewardVideoAd(function(ret){
console.log("zyTencentAd:"+JSON.stringify(ret));
});
可用性
Android系统,ios系统
可提供的1.0.0及更高版本