zyGoogleAd
其它接口
模块接口
init showBannerAd closeBannerAd showInteractionAd loadRewardVideoAd showRewardVideoAd loadOldRewardVideoAd showOldRewardVideoAd
论坛示例
为帮助用户更好更快的使用模块,论坛维护了一个示例,示例中包含示例代码供您参考。
概述
模块简介
本模块封装 封装谷歌AdMob Android、Ios广告sdk,包含Banner广告、插屏广告、激励视频广告、旧版激励视频广告等功能。
使用模块前 需配置广告应用id 具体请看论坛示例截图。
安卓先在config.xml中配置meta-data
<meta-data name="com.google.android.gms.ads.APPLICATION_ID" value="ca-app-pub-3940256099942544~3347511713"/>
苹果在widget://res目录下添加Info.plist 可新建记事本重命名 并添加
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE plist PUBLIC "-//Apple//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd">
<plist version="1.0">
<dict>
<key>GADApplicationIdentifier</key>
<string>ca-app-pub-3940256099942544~1458002511</string>
</dict>
</plist>
IOS 云编译最低版本为9.0,Android云编译最低版本为4.1.2。
使用模块前请先到谷歌AdMob后台注册帐号、新建应用、添加代码位使用。模块中默认测试代码位可直接测试使用。
(注) 因访问谷歌需要科学上网才行 如果没有 但想开发的朋友 可以联系我 企鹅:1161277121 获取临时科学上网办法。
模块接口
getVersions
获取当前集成的谷歌AdMob sdk版本号 (ios与android 保持同步)
getVersions(callback(ret))
callback(ret)
ret:
- 类型:JSON 对象
- 内部字段:
{
status:true, //调用成功
result:"19.1.0",//结果
}
示例代码
var zyGoogleAd = api.require('zyGoogleAd');
zyGoogleAd.getVersions(function(ret){
alert("zyGoogleAd:"+JSON.stringify(ret));
});
可用性
Android系统,ios系统
可提供的1.0.0及更高版本
init
初始化模块 (因广告应用id在config和Info.plist中配置,这里只做初始化操作 可以把方法放到index.html中,只用调用一次)
init(callback(ret))
callback(ret)
ret:
- 类型:JSON 对象
- 内部字段:
{
status:true,
result:"初始化完成"
}
示例代码
var zyGoogleAd = api.require('zyGoogleAd');
var param = {
};
zyGoogleAd.init(param,function(ret){
console.log("zyGoogleAd:"+JSON.stringify(ret));
});
可用性
Android系统,ios系统
可提供的1.0.0及更高版本
showBannerAd
展示Banner广告
showBannerAd({params}, callback(ret))
params
setCodeId:
- 类型:字符串
- 描述:(必选项)代码位id
- 默认值:ca-app-pub-3940256099942544/6300978111
rect:
- 类型:对象
- 描述:(可选项)打开开屏区域 全为0或不写 则打开全屏
- 内部字段:
{
x:0,
y:0,
w:0,
h:0
}
fixedOn:
- 类型:字符串类型
- 描述:(可选项)模块视图添加到指定 frame 的名字(只指 frame,传 window 无效)
- 默认值:模块依附于当前 window
fixed:
- 类型:布尔
- 描述:(可选项)模块是否不随所属 window 或 frame 滚动
- 默认值:true(不随之滚动)
callback(ret)
ret:
- 类型:JSON 对象
- 内部字段:
{
status:true, //true的结果如下 false结果则显示对应错误提示
result:"bannerAd加载中"
"bannerAd展示"
"bannerAd打开页面"
"bannerAd可被关闭了"
"bannerAd点击离开本应用"
}
示例代码
var zyGoogleAd = api.require('zyGoogleAd');
var param = {
setCodeId:"ca-app-pub-3940256099942544/6300978111",//代码位
rect:{//显示位置
x:0,
y:40,
w:api.winWidth,
h:100
},
fixedOn:"",
fixed:true
};
zyGoogleAd.showBannerAd(param,function(ret){
console.log("zyGoogleAd:"+JSON.stringify(ret));
});
可用性
Android系统,ios系统
可提供的1.0.0及更高版本
closeBannerAd
关闭Banner广告
closeBannerAd(callback(ret))
callback(ret)
ret:
- 类型:JSON 对象
- 内部字段:
{
status:true,
result:"bannerAd已关闭"
}
示例代码
var zyGoogleAd = api.require('zyGoogleAd');
zyGoogleAd.closeBannerAd(function(ret){
console.log("zyGoogleAd:"+JSON.stringify(ret));
});
可用性
Android系统,ios系统
可提供的1.0.0及更高版本
showInteractionAd
展示插屏广告
showInteractionAd({params}, callback(ret))
params
setCodeId:
- 类型:字符串
- 描述:(必选项)代码位id
- 默认值:ca-app-pub-3940256099942544/1033173712
callback(ret)
ret:
- 类型:JSON 对象
- 内部字段:
{
status:true, //true的结果如下 false结果则显示对应错误提示
result:"interactionAd加载中"
"interactionAd展示"
"interactionAd打开页面"
"interactionAd点击离开本应用"
"interactionAd关闭"
}
示例代码
var zyGoogleAd = api.require('zyGoogleAd');
var param = {
setCodeId:"ca-app-pub-3940256099942544/1033173712",//代码位
};
zyGoogleAd.showInteractionAd(param,function(ret){
console.log("zyGoogleAd:"+JSON.stringify(ret));
});
可用性
Android系统,ios系统
可提供的1.0.0及更高版本
loadRewardVideoAd
加载激励视频广告
loadRewardVideoAd({params}, callback(ret))
params
setCodeId:
- 类型:字符串
- 描述:(必选项)代码位id
- 默认值:ca-app-pub-3940256099942544/5224354917
callback(ret)
ret:
- 类型:JSON 对象
- 内部字段:
{
status:true, //true的结果如下 false结果则显示对应错误提示
result:"rewardVideoAd加载中"
"rewardVideoAD加载完成"
"rewardVideoAD奖励发放,type:*,amount:*"
"rewardVideoAD打开页面"
"rewardVideoAD关闭"
}
示例代码
var zyGoogleAd = api.require('zyGoogleAd');
var param = {
setCodeId:"ca-app-pub-3940256099942544/5224354917",//代码位
};
zyGoogleAd.loadRewardVideoAd(param,function(ret){
console.log("zyGoogleAd:"+JSON.stringify(ret));
});
可用性
Android系统,ios系统
可提供的1.0.0及更高版本
showRewardVideoAd
展示激励视频
showRewardVideoAd(callback(ret))
callback(ret)
ret:
- 类型:JSON 对象
- 内部字段:
{
status:true|false,
result:"rewardVideoAD展示|请先加载激励视频"
}
示例代码
var zyGoogleAd = api.require('zyGoogleAd');
zyGoogleAd.showRewardVideoAd(function(ret){
console.log("zyGoogleAd:"+JSON.stringify(ret));
});
可用性
Android系统,ios系统
可提供的1.0.0及更高版本
loadOldRewardVideoAd
加载(旧版)激励视频广告
loadOldRewardVideoAd({params}, callback(ret))
params
setCodeId:
- 类型:字符串
- 描述:(必选项)代码位id
- 默认值:ca-app-pub-3940256099942544/5224354917
callback(ret)
ret:
- 类型:JSON 对象
- 内部字段:
{
status:true, //true的结果如下 false结果则显示对应错误提示
result:"oldRewardVideoAd加载中"
"oldRewardVideoAD加载完成"
"oldRewardVideoAD奖励发放,type:*,amount:*"
"oldRewardVideoAD打开页面"
"oldRewardVideoAD关闭"
"oldRewardVideoAD奖励完成"
"oldRewardVideoAD点击离开本应用"
"oldRewardVideoAD开始播放"
}
示例代码
var zyGoogleAd = api.require('zyGoogleAd');
var param = {
setCodeId:"ca-app-pub-3940256099942544/5224354917",//代码位
};
zyGoogleAd.loadOldRewardVideoAd(param,function(ret){
console.log("zyGoogleAd:"+JSON.stringify(ret));
});
可用性
Android系统,ios系统
可提供的1.0.0及更高版本
showOldRewardVideoAd
展示(旧版)激励视频
showOldRewardVideoAd(callback(ret))
callback(ret)
ret:
- 类型:JSON 对象
- 内部字段:
{
status:true|false,
result:"oldRewardVideoAD展示|请先加载旧版激励视频"
}
示例代码
var zyGoogleAd = api.require('zyGoogleAd');
zyGoogleAd.showOldRewardVideoAd(function(ret){
console.log("zyGoogleAd:"+JSON.stringify(ret));
});
可用性
Android系统,ios系统
可提供的1.0.0及更高版本