zyGromoreAd


论坛示例

为帮助用户更好更快的使用插件,请访问示例说明页面

概述

插件简介

zyGromoreAd封装穿山甲GroMore平台 Android、Ios广告sdk,包含开屏、banner、插全屏、激励视频、信息流广告等功能 ,信息流插件,解决划动时会触摸误点的问题。包含穿山甲、Admob、GDT、百度、Unity、Sigmob、Klevin、Mintegral、KS等广告。

IOS 云编译最低版本为11.0,Android云编译最低版本为4.0.3。

使用插件前请先到穿山甲后台注册帐号、新建应用、添加代码位使用。插件中默认测试代码位可直接测试使用。

因谷歌广告限制 添加插件后 否则应用将不能使用 如未使用谷歌广告 填写此默认id即可 安卓需要在config.xml里配置

<meta-data name="com.google.android.gms.ads.APPLICATION_ID" value="ca-app-pub-3940256099942544~3347511713"/>  

苹果需要在widget/res/Info.plist里配置

<key>GADApplicationIdentifier</key>
<string>ca-app-pub-3940256099942544~3347511713</string>

点击进入穿山甲控制台

插件接口

adGetVersions

获取当前集成的sdk版本号

adGetVersions(callback(ret))

callback(ret)

ret:

  • 类型:JSON 对象
  • 内部字段:
{
  status:true, //调用成功
  result:"1.0",//结果
}

示例代码

var zyGromoreAd = api.require('zyGromoreAd');
zyGromoreAd.adGetVersions(function(ret){
  alert("zyGromoreAd:"+JSON.stringify(ret));
});

可用性

Android系统,ios系统

可提供的2.0.0及更高版本

adRequestPermission

设置插件所需权限可提高收益(请在必要时申请) 安卓:获取权限 苹果为:ios14以上才有的获取idfa权限(低版本自动有)

adRequestPermission(callback(ret))

callback(ret)

ret:

  • 类型:JSON 对象
  • 内部字段:
{
  status:true, //安卓不返回 苹果返回idfa值
  result:"XXXX",//结果
}

示例代码

var zyGromoreAd = api.require('zyGromoreAd');
zyGromoreAd.adRequestPermission({},function(ret){
    alert("zyGromoreAd:"+JSON.stringify(ret));
});

可用性

Android系统,ios系统

可提供的2.0.0及更高版本

adInit

初始化插件(使用前必须)

adInit({params}, callback(ret))

params

appId:

  • 类型:字符串
  • 描述:(必选项)应用id
  • 默认值:无

appName:

  • 类型:字符串
  • 描述:(可选项)应用名字
  • 默认值:demo

callback(ret)

ret:

  • 类型:JSON 对象
  • 内部字段:
{
  status:true,
  result:"初始化成功"
}

示例代码

var zyGromoreAd = api.require('zyGromoreAd');
var param = {
    appId:"90009",
    appName:"demo",
};
zyGromoreAd.adInit(param,function(ret){
    console.log("zyGromoreAd:"+JSON.stringify(ret));
    api.removeLaunchView();
    api.toast({ msg:ret.result })
});

可用性

Android系统,ios系统

可提供的2.0.0及更高版本

adShowSplash

展示开屏广告

adShowSplash({params}, callback(ret))

params

codeId:

  • 类型:字符串
  • 描述:(必选项)代码位id
  • 默认值:无

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的结果如下   				false结果则显示对应错误提示
    result:	加载中								具体错误码或原因说明
                加载成功						缓存失败
                ECPM:0
                缓存中
                缓存成功
                view添加
                展示
                点击
                跳过
                关闭
}

示例代码

var zyGromoreAd = api.require('zyGromoreAd');
var param = {
  codeId:"4000000042",//默认测试代码位
  rect:{//开屏位置 默认0即为全屏 也可自定义
        x:0,
        y:0,
        w:0,
        h:0
    },
    fixedOn:"",
    fixed:true
};
zyGromoreAd.adShowSplash(param,function(ret){
    console.log("zyGromoreAd:"+JSON.stringify(ret));
    if(ret.status){
        if(ret.result == "展示"){
            api.setFullScreen({fullScreen: true,animation:"slide"});
        }
        if(ret.result == "关闭"){
            api.setFullScreen({fullScreen: false,animation:"slide"});
        }
    }else{
        api.toast({ msg:ret.result })
    }
});

可用性

Android系统,ios系统

可提供的2.0.0及更高版本

adShowInteraction

展示插屏广告

adShowInteraction({params}, callback(ret))

params

codeId:

  • 类型:字符串
  • 描述:(必选项)代码位id
  • 默认值:无

callback(ret)

ret:

  • 类型:JSON 对象
  • 内部字段:
{
status	 true								false
result	 加载中								具体错误码或原因说明
            加载成功							缓存失败
            ECPM:0
            缓存中
            缓存成功
            view添加
            展示
            点击
            关闭

}

示例代码

var zyGromoreAd = api.require('zyGromoreAd');
var param = {
    codeId:"4000000276",//代码位
};
zyGromoreAd.adShowInteraction(param,function(ret){
    console.log("zyGromoreAd:"+JSON.stringify(ret));
    if(!ret.status){
        api.toast({ msg:ret.result })
    }
});

可用性

Android系统,ios系统

可提供的2.0.0及更高版本

adLoadRewardVideo

加载激励视频广告

adLoadRewardVideo({params}, callback(ret))

params

codeId:

  • 类型:字符串
  • 描述:(必选项)代码位id
  • 默认值:无

userId:

  • 类型:字符串
  • 描述:(可选项)当前用户id 用于服务器验证
  • 默认值:空

extraData:

  • 类型:字符串
  • 描述:(可选项)附加消息 用于服务器验证
  • 默认值:空

callback(ret)

ret:

  • 类型:JSON 对象
  • 内部字段:
{
status	 true								false
result	 加载中								具体错误码或原因说明
            加载成功							缓存失败
            ECPM:0
            缓存中
            缓存成功
            展示
            点击
            奖励:true
            跳过
            关闭

}

示例代码

var zyGromoreAd = api.require('zyGromoreAd');
var param = {
    codeId:"90009001",//代码位
    userId:"",//用户id
    extraData:"",//自定义参数
};
api.showProgress({});
zyGromoreAd.adLoadRewardVideo(param,function(ret){
    console.log("zyGromoreAd:"+JSON.stringify(ret));
    if(ret.status){
        if(ret.result == "缓存成功"){
            api.hideProgress();
            //缓存成功后可以展示广告
            //moduleClick('adShowRewardVideo');
            //api.setFullScreen({fullScreen: true,animation:"slide"});
        }
        if(ret.result == "关闭"){
            api.setFullScreen({fullScreen: false,animation:"slide"});
        }
    }else{
        api.hideProgress();
        api.toast({ msg:ret.result })
    }
});

可用性

Android系统,ios系统

可提供的2.0.0及更高版本

adShowRewardVideo

展示激励视频

adShowRewardVideo(callback(ret))

callback(ret)

ret:

  • 类型:JSON 对象
  • 内部字段:
{
  status:false,
  result:	请先加载广告
                 广告过期
}

示例代码

var zyGromoreAd = api.require('zyGromoreAd');
zyGromoreAd.adShowRewardVideo(function(ret){
    console.log("zyGromoreAd:"+JSON.stringify(ret));
    if(!ret.status){
        api.toast({ msg:ret.result })
    }
});

可用性

Android系统,ios系统

可提供的2.0.0及更高版本

adLoadFullScreenVideo

加载全屏视频广告

adLoadFullScreenVideo({params}, callback(ret))

params

codeId:

  • 类型:字符串
  • 描述:(必选项)代码位id
  • 默认值:无

callback(ret)

ret:

  • 类型:JSON 对象
  • 内部字段:
{
status	 true								false
result	 加载中								具体错误码或原因说明
            加载成功							缓存失败
            ECPM:0
            缓存中
            缓存成功
            展示
            点击
            跳过
            关闭

}

示例代码

var param = {
    codeId:"90009002",//代码位
};
api.showProgress({});
zyGromoreAd.adLoadFullScreenVideo(param,function(ret){
    console.log("zyGromoreAd:"+JSON.stringify(ret));
    if(ret.status){
        if(ret.result == "缓存成功"){
            api.hideProgress();
            //缓存成功后可以展示广告
            //moduleClick('adShowFullScreenVideo');
            //api.setFullScreen({fullScreen: true,animation:"slide"});
        }
        if(ret.result == "关闭"){
            api.setFullScreen({fullScreen: false,animation:"slide"});
        }
    }else{
        api.hideProgress();
        api.toast({ msg:ret.result })
    }
});

可用性

Android系统,ios系统

可提供的2.0.0及更高版本

adShowFullScreenVideo

展示全屏视频

adShowFullScreenVideo(callback(ret))

callback(ret)

ret:

  • 类型:JSON 对象
  • 内部字段:
{
status	false
result	请先加载广告
            广告过期
}

示例代码

var zyGromoreAd = api.require('zyGromoreAd');
zyGromoreAd.adShowFullScreenVideo(function(ret){
    console.log("zyGromoreAd:"+JSON.stringify(ret));
    if(!ret.status){
        api.toast({ msg:ret.result })
    }
});

可用性

Android系统,ios系统

可提供的2.0.0及更高版本

adShowFeed

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

adShowFeed({params}, callback(ret))

params

tag:

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

codeId:

  • 类型:字符串
  • 描述:(必选项)代码位id
  • 默认值:无

rect:

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

fixedOn:

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

fixed:

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

callback(ret)

ret:

  • 类型:JSON 对象
  • 内部字段:
{
status	 true								false
result	 加载中								具体错误码加原因说明
            加载成功							加载失败
            ECPM:0
            view添加
            展示
            点击
            不喜欢
            关闭

}

示例代码

var zyGromoreAd = api.require('zyGromoreAd');
var param = {
    tag:"_default",
    codeId:"4000000075",//代码位
    rect:{
        x:0,
        y:0,
        w:360,
        h:300
    },
    fixedOn:api.frameName,
    fixed:false
};
zyGromoreAd.adShowFeed(param,function(ret){
    console.log("zyGromoreAd:"+JSON.stringify(ret));
});

可用性

Android系统,ios系统

可提供的2.0.0及更高版本

adCloseFeed

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

adCloseFeed(callback(ret))

示例代码

var zyGromoreAd = api.require('zyGromoreAd');
zyGromoreAd.adCloseFeed({tag:"all"});

可用性

Android系统,ios系统

可提供的2.0.0及更高版本

adSetAttr

重设广告的显示区域

adSetAttr({params}, callback(ret))

params

type:

  • 类型:字符串
  • 描述:(必填项)feed别为信息流类型

tag:

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

rect:

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

示例代码

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

可用性

Android系统,ios系统

可提供的2.0.0及更高版本

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