zyGoogleAd


其它接口
插件接口

论坛示例

为帮助用户更好更快的使用插件,论坛维护了一个示例,示例中包含示例代码供您参考。

概述

插件简介

本插件封装 封装谷歌AdMob Android、Ios广告sdk,包含Banner广告、插屏广告、激励视频广告等功能。1.0.4版本新增开屏广告,插页激励广告,信息流广告。去除旧版激励视频。有问题的可以联系我 企鹅:1161277121

使用插件前 需配置广告应用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版本号

getVersions(callback(ret))

callback(ret)

ret:

  • 类型:JSON 对象
  • 内部字段:
{
  status:true, //调用成功
  result:"afma-sdk-a-v19.7.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及更高版本

showSplashAd

打开开屏广告 (广告只能全屏展示 不能自定义高度frame)

showSplashAd({params}, callback(ret))

params

setCodeId:

  • 类型:字符串
  • 描述:(必选项)代码位id
  • 默认值:ca-app-pub-3940256099942544/3419835294

callback(ret)

ret:

  • 类型:JSON 对象
  • 内部字段:
{
  status:true, //true的结果如下   false结果则显示对应错误提示
  result:"开屏广告加载中"
         "开屏广告加载完成"
         "开屏广告展示"
         "开屏广告关闭"
}

示例代码

var zyGoogleAd = api.require('zyGoogleAd');
var param = {
    setCodeId:"ca-app-pub-3940256099942544/3419835294",//代码位
};
zyGoogleAd.showSplashAd(param,function(ret){
    console.log("zyGoogleAd:"+JSON.stringify(ret));
});

可用性

Android系统,ios系统

可提供的1.0.4及更高版本

showBannerAd

展示Banner广告

showBannerAd({params}, callback(ret))

params

tag:

  • 类型:字符串
  • 描述:(可选项)打开此banner的标识 需要打开多个banner可设置不同的tag 手动close时传入对应tag即可关闭对应banner
  • 默认值:_default

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:"banner加载中"
         "banner展示"
         "banner点击"
         "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({params}, callback(ret))

params

tag:

  • 类型:字符串
  • 描述:(可选项)打开此banner的标识
  • 默认值:_default

callback(ret)

ret:

  • 类型:JSON 对象
  • 内部字段:
{
  status:true,
  result:"bannerAd已关闭"
}

示例代码

var zyGoogleAd = api.require('zyGoogleAd');
zyGoogleAd.closeBannerAd({tag:"_default"},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:"插屏广告加载中"
         "插屏广告加载完成"
         "插屏广告展示"
         "插屏广告关闭"
}

示例代码

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:"激励视频加载中"
         "激励视频加载完成"
         "激励视频奖励发放,type:*,amount:*"
         "激励视频展示"
         "激励视频关闭"
}

示例代码

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:"展示广告|请先加载广告"
}

示例代码

var zyGoogleAd = api.require('zyGoogleAd');
zyGoogleAd.showRewardVideoAd(function(ret){
    console.log("zyGoogleAd:"+JSON.stringify(ret));
});

可用性

Android系统,ios系统

可提供的1.0.0及更高版本

loadRewardedInterstitialVideoAd

加载插页激励视频广告

loadRewardedInterstitialVideoAd({params}, callback(ret))

params

setCodeId:

  • 类型:字符串
  • 描述:(必选项)代码位id
  • 默认值:ca-app-pub-3940256099942544/5354046379

callback(ret)

ret:

  • 类型:JSON 对象
  • 内部字段:
{
  status:true, //true的结果如下   false结果则显示对应错误提示
  result:"插页激励视频加载中"
         "插页激励视频加载完成"
         "插页激励视频奖励发放,type:*,amount:*"
         "插页激励视频展示"
         "插页激励视频关闭"
}

示例代码

var zyGoogleAd = api.require('zyGoogleAd');
var param = {
    setCodeId:"ca-app-pub-3940256099942544/5354046379",//代码位
};
zyGoogleAd.loadRewardedInterstitialVideoAd(param,function(ret){
    console.log("zyGoogleAd:"+JSON.stringify(ret));
});

可用性

Android系统,ios系统

可提供的1.0.4及更高版本

showRewardedInterstitialVideoAd

展示插页激励视频广告

showRewardedInterstitialVideoAd(callback(ret))

callback(ret)

ret:

  • 类型:JSON 对象
  • 内部字段:
{
  status:true|false,
  result:"展示广告|请先加载广告"
}

示例代码

var zyGoogleAd = api.require('zyGoogleAd');
zyGoogleAd.showRewardedInterstitialVideoAd(function(ret){
    console.log("zyGoogleAd:"+JSON.stringify(ret));
});

可用性

Android系统,ios系统

可提供的1.0.4及更高版本

showNativeExpressAd

展示信息流广告(注意插件打开之后会返回插件高度请参考demo重新设置广告区域)

showNativeExpressAd({params}, callback(ret))

params

tag:

  • 类型:字符串
  • 描述:(可选项)唯一广告标识
  • 默认值:_default

setCodeId:

  • 类型:字符串
  • 描述:(必选项)代码位id
  • 默认值:ca-app-pub-3940256099942544/2247696110

rect:

  • 类型:对象
  • 描述:(可选项)打开展示区域
  • 内部字段:
{
    x:0,
    y:0,
    w:0,
    h:600
}

fixedOn:

  • 类型:字符串类型
  • 描述:(可选项)插件视图添加到指定 frame 的名字(只指 frame,传 window 无效)
  • 默认值:插件依附于当前 window

fixed:

  • 类型:布尔
  • 描述:(可选项)插件是否不随所属 window 或 frame 滚动
  • 默认值:true(不随之滚动)

callback(ret)

ret:

  • 类型:JSON 对象
  • 内部字段:
{
  status:true, //true的结果如下   false结果则显示对应错误提示
  result:"信息流广告加载中"
         "view已添加"
         "信息流展示"
         "信息流点击"
         "信息流已关闭"
}

示例代码

var zyGoogleAd = api.require('zyGoogleAd');
var param = {
    tag:"_default",
    setCodeId:"ca-app-pub-3940256099942544/2247696110",//代码位
    rect:{
        x:0,
        y:0,
        w:360,
        h:300
    },
    fixedOn:api.frameName,
    fixed:false
};
zyGoogleAd.showNativeExpressAd(param,function(ret){
    console.log("zyGoogleAd:"+JSON.stringify(ret));
});

可用性

Android系统,ios系统

可提供的1.0.4及更高版本

closeNativeExpressAd

关闭信息流 传入tag 默认关闭_default 传 all清除所有

closeNativeExpressAd(callback(ret))

示例代码

var zyGoogleAd = api.require('zyGoogleAd');
zyGoogleAd.closeNativeExpressAd({tag:"all"});

可用性

Android系统,ios系统

可提供的1.0.4及更高版本

setAttr

重设广告的显示区域

setAttr({params}, callback(ret))

params

type:

  • 类型:字符串
  • 描述:(必填项)banner、nativeExpres 分别为banner、信息流两种类型

tag:

  • 类型:字符串
  • 描述:(必填项)唯一广告标识

rect:

  • 类型:对象
  • 描述:(必填项)重设展示区域
  • 内部字段:
{
    x:0,
    y:0,
    w:0,
    h:0
}

示例代码

var zyGoogleAd = api.require('zyGoogleAd');
setTimeout(function(){
    for(var i = 0; i < openAds.length; i++){
        var divOff = $api.offset($api.byId("myAddPage" + openAds[i].id));
        zyGoogleAd.setAttr({
            type:openAds[i].type,
            tag:openAds[i].tag,
            rect:{//重新显示位置
                x:divOff.l,
                y:divOff.t,
                w:divOff.w,
                h:divOff.h
            },
        });
    }
},0);

可用性

Android系统,ios系统

可提供的1.0.4及更高版本

是否仍需要帮助? 请保持联络!
最后更新于 2024/02/22