zyPangolinAd

来自于：勇可可立即使用

其它接口

getVersions requestPermissionIfNecessary

模块接口

init showSplashAd closeSplashAd loadRewardVideoAd showRewardVideoAd showBannerAd closeBannerAd showInteractionAd loadFullScreenVideoAd showFullScreenVideoAd showNativeExpressAd cleanNativeExpressAd showTTDrawFeedAd closeTTDrawFeedAd setAttr

论坛示例

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

概述

模块简介

zyPangolinAd封装穿山甲Android、Ios广告sdk，包含Banner广告、插屏广告、全屏视频广告、开屏位广告、激励视频广告、信息流广告等功能。

IOS 云编译最低版本为9.0，Android云编译最低版本为4.0.3。

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

点击进入穿山甲控制台

模块接口

getVersions

获取当前集成的穿山甲sdk版本号

getVersions(callback(ret))

callback(ret)

ret：

类型：JSON 对象
内部字段：

{
  status:true, //调用成功
  result:"2.5.3.2",//结果
}

示例代码

var zyPangolinAd = api.require('zyPangolinAd');
zyPangolinAd.getVersions(function(ret){
  alert("zyPangolinAd："+JSON.stringify(ret));
});

可用性

Android系统，ios系统

可提供的1.0.0及更高版本

requestPermissionIfNecessary

安卓使用模块前请求必要权限

requestPermissionIfNecessary()

示例代码

var zyPangolinAd = api.require('zyPangolinAd');
zyPangolinAd.requestPermissionIfNecessary();

可用性

Android系统，ios系统

可提供的1.0.0及更高版本

init

初始化模块

init({params}, callback(ret))

params

appId：

类型：字符串
描述：（必选项）应用id
默认值：5040813

appName：

类型：字符串
描述：（必选项）应用名
默认值：测试

directDownloadNetworkType：

类型：字符串
描述：（可选项）允许直接下载的网络状态集合，多种用英文逗号隔开 2(2G) 3(3G) 4(wifi) 5(4G5G)
默认值：如需上架应用市场的时候点击得提示才能下载这个参数就传空或不传如果需要点击直接下载的话就传 "4,5,3,2"

callback(ret)

ret：

类型：JSON 对象
内部字段：

{
  status:true,
  result:"初始化完成"
}

示例代码

var zyPangolinAd = api.require('zyPangolinAd');
var param = {
    appId:"5040813",
    appName:"测试",
    directDownloadNetworkType:"4,5,3,2"
};
zyPangolinAd.init(param,function(ret){
    console.log("zyPangolinAd："+JSON.stringify(ret));
});

可用性

Android系统，ios系统

可提供的1.0.0及更高版本

showSplashAd

展示开屏广告

showSplashAd({params}, callback(ret))

params

setCodeId：

类型：字符串
描述：（必选项）代码位id
默认值：840813945

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:"开屏广告加载中"    //回调提示如下   如点击下载则还有 下载中、下载暂停、下载失败、下载完成、安装完成
         "开屏广告点击"
         "开屏广告展示"
         "开屏广告跳过"
         "开屏广告倒计时结束"
         "splashAd已关闭"
}

示例代码

var zyPangolinAd = api.require('zyPangolinAd');
var param = {
    setCodeId:"840813945",//代码位
    rect:{ //开屏位置 默认0即为全屏 也可自定义
        x:0,
        y:0,
        w:0,
        h:0
    },
    fixedOn:"",
    fixed:true
};
zyPangolinAd.showSplashAd(param,function(ret){
    console.log("zyPangolinAd："+JSON.stringify(ret));
});

可用性

Android系统，ios系统

可提供的1.0.0及更高版本

closeSplashAd

手动关闭开屏广告

closeSplashAd(callback(ret))

callback(ret)

ret：

类型：JSON 对象
内部字段：

{
  status:true,
  result:"splashAd已关闭"
}

示例代码

var zyPangolinAd = api.require('zyPangolinAd');
zyPangolinAd.closeSplashAd(function(ret){
    console.log("zyPangolinAd："+JSON.stringify(ret));
});

可用性

Android系统，ios系统

可提供的1.0.0及更高版本

loadRewardVideoAd

加载激励视频广告

loadRewardVideoAd({params}, callback(ret))

params

setCodeId：

类型：字符串
描述：（必选项）代码位id
默认值：944213566

setOrientation：

类型：字符串
描述：（必选项）期望视频的播放方向：1竖 2横
默认值：1

setUserID:

类型：字符串
描述：（可选项）用户id
默认值：user123

setRewardName:

类型：字符串
描述：（可选项）奖励的名称
默认值：金币

setRewardAmount:

类型：数字
描述：（可选项）奖励的数量
默认值：3

setMediaExtra:

类型：字符串
描述：（可选项）附加参数
默认值：media_extra

callback(ret)

ret：

类型：JSON 对象
内部字段：

{
  status:true, //true的结果如下   false结果则显示对应错误提示
  result:"激励视频加载中"    //回调提示如下   如点击下载则还有 下载中、下载暂停、下载失败、下载完成、安装完成
         "激励视频缓存完成"
         "激励视频展示"
         "激励视频点击"
         "激励视频关闭"
         "激励视频播放完"
         "激励视频奖励到位么:true|false"
         "激励视频跳过"
}

示例代码

var zyPangolinAd = api.require('zyPangolinAd');
var param = {
    setCodeId:"944213566",//代码位
    setOrientation:1,//必填参数，期望视频的播放方向：1竖  2横
    setUserID:"user123",//用户id,必传参数
    setRewardName:"金币",//奖励的名称
    setRewardAmount:3,//奖励的数量
    setMediaExtra:"附加参数",//附加参数，可选

};
zyPangolinAd.loadRewardVideoAd(param,function(ret){
    console.log("zyPangolinAd："+JSON.stringify(ret));
});

可用性

Android系统，ios系统

可提供的1.0.0及更高版本

showRewardVideoAd

展示激励视频

showRewardVideoAd(callback(ret))

callback(ret)

ret：

类型：JSON 对象
内部字段：

{
  status:true|false,
  result:"展示广告|请先加载广告"
}

示例代码

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

可用性

Android系统，ios系统

可提供的1.0.0及更高版本

showBannerAd

展示Banner广告

showBannerAd({params}, callback(ret))

params

tag：

类型：字符串
描述：（可选项）打开广告唯一标识标志可打开多个广告
默认值：_default

setCodeId：

类型：字符串
描述：（必选项）代码位id
默认值：940813564

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 zyPangolinAd = api.require('zyPangolinAd');
var param = {
    setCodeId:"940813564",//代码位
    rect:{//显示位置
        x:30,
        y:100,
        w:api.winWidth-60,
        h:180
    },
    fixedOn:"",
    fixed:true
};
zyPangolinAd.showBannerAd(param,function(ret){
    console.log("zyPangolinAd："+JSON.stringify(ret));
});

可用性

Android系统，ios系统

可提供的1.0.0及更高版本

closeBannerAd

手动关闭Banner广告传tag关闭应用广告

closeBannerAd(callback(ret))

callback(ret)

ret：

类型：JSON 对象
内部字段：

{
  status:true,
  result:"bannerAd已关闭"
}

示例代码

var zyPangolinAd = api.require('zyPangolinAd');
zyPangolinAd.closeBannerAd(function(ret){
    console.log("zyPangolinAd："+JSON.stringify(ret));
});

可用性

Android系统，ios系统

可提供的1.0.0及更高版本

showInteractionAd

展示插屏广告

showInteractionAd({params}, callback(ret))

params

setCodeId：

类型：字符串
描述：（必选项）代码位id
默认值：944213572

w：

类型：数字
描述：（可选项）广告宽
默认值：600

类型：数字
描述：（可选项）广告高
默认值：600

callback(ret)

ret：

类型：JSON 对象
内部字段：

{
  status:true, //true的结果如下   false结果则显示对应错误提示
  result:"插屏广告加载中"    //回调提示如下   如点击下载则还有 下载中、下载暂停、下载失败、下载完成、安装完成
         "插屏广告消失"
         "插屏广告点击"
         "插屏广告展示"
}

示例代码

var zyPangolinAd = api.require('zyPangolinAd');
var param = {
    setCodeId:"944213572",//代码位
    w:200,//根据穿山甲广告定义的比例 设置这里的宽高比
    h:300,
};
zyPangolinAd.showInteractionAd(param,function(ret){
    console.log("zyPangolinAd："+JSON.stringify(ret));
});

可用性

Android系统，ios系统

可提供的1.0.0及更高版本

loadFullScreenVideoAd

加载全屏视频广告

loadFullScreenVideoAd({params}, callback(ret))

params

setCodeId：

类型：字符串
描述：（必选项）代码位id
默认值：944213570

setOrientation：

类型：字符串
描述：（必选项）期望视频的播放方向：1竖 2横
默认值：1

callback(ret)

ret：

类型：JSON 对象
内部字段：

{
  status:true, //true的结果如下   false结果则显示对应错误提示
  result:"全屏视频加载中"    //回调提示如下   如点击下载则还有 下载中、下载暂停、下载失败、下载完成、安装完成
         "全屏视频缓存完成"
         "全屏视频展示"
         "全屏视频点击"
         "全屏视频关闭"
         "全屏视频播放完"
         "全屏视频跳过"
}

示例代码

var zyPangolinAd = api.require('zyPangolinAd');
var param = {
    setCodeId:"944213570",
    setOrientation:1,
};
zyPangolinAd.loadFullScreenVideoAd(param,function(ret){
    console.log("zyPangolinAd："+JSON.stringify(ret));
});

可用性

Android系统，ios系统

可提供的1.0.0及更高版本

showFullScreenVideoAd

展示全屏视频

showFullScreenVideoAd(callback(ret))

callback(ret)

ret：

类型：JSON 对象
内部字段：

{
  status:true|false,
  result:"展示广告|请先加载广告"
}

示例代码

var zyPangolinAd = api.require('zyPangolinAd');
zyPangolinAd.showFullScreenVideoAd(function(ret){
    console.log("zyPangolinAd："+JSON.stringify(ret));
});

可用性

Android系统，ios系统

可提供的1.0.0及更高版本

showNativeExpressAd

展示信息流广告

showNativeExpressAd({params}, callback(ret))

params

setCodeId：

类型：字符串
描述：（必选项）代码位id
默认值：945172090

rect：

类型：对象
描述：（可选项）打开展示区域
内部字段：

{
    x:0,
    y:0,
    w:0,
    h:300
}

fixedOn：

类型：字符串类型
描述：（可选项）模块视图添加到指定 frame 的名字（只指 frame，传 window 无效）
默认值：模块依附于当前 window

fixed:

类型：布尔
描述：（可选项）模块是否不随所属 window 或 frame 滚动
默认值：true（不随之滚动）

callback(ret)

ret：

类型：JSON 对象
内部字段：

{
  status:true, //true的结果如下   false结果则显示对应错误提示
  result:"信息流广告加载中"    //回调提示如下   如点击下载则还有 下载中、下载暂停、下载失败、下载完成、安装完成
         "信息流点击"
         "信息流展示"
         "信息流已关闭"
}

示例代码

var zyPangolinAd = api.require('zyPangolinAd');
var param = {
    setCodeId:"945172090",//代码位
    rect:{ //开屏位置 默认0即为全屏 也可自定义
        x:30,
        y:100,
        w:api.winWidth-60,
        h:180
    },
    fixedOn:api.frameName,
    fixed:false,
    customStyle:true,//是否使用新的关闭广告样式  仅安卓有效
};
zyPangolinAd.showNativeExpressAd(param,function(ret){
    console.log("zyPangolinAd："+JSON.stringify(ret));
});

可用性

Android系统，ios系统

可提供的1.0.7及更高版本

cleanNativeExpressAd

清空信息流广告(清除所有打开的信息流广告适用于刷新列表页面时清空所有广告再加载) 也可以传入tag关闭某一个广告 tag在show的回调返回或者show时传入tag参数

cleanNativeExpressAd(callback(ret))

callback(ret)

ret：

类型：JSON 对象
内部字段：

{
  status:true,
  result:"清除缓存成功"
}

示例代码

var zyPangolinAd = api.require('zyPangolinAd');
zyPangolinAd.cleanNativeExpressAd(function(ret){
    console.log("zyPangolinAd："+JSON.stringify(ret));
});

可用性

Android系统，ios系统

可提供的1.0.7及更高版本

showTTDrawFeedAd

展示Draw信息流广告(视频信息流广告)

showTTDrawFeedAd({params}, callback(ret))

params

tag：

类型：字符串
描述：（可选项）唯一广告标识
默认值：_default

setCodeId：

类型：字符串
描述：（必选项）代码位id
默认值：945172091

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:"Draw信息流广告加载中"    //回调提示如下   如点击下载则还有 下载中、下载暂停、下载失败、下载完成、安装完成
         "Draw信息流点击"
         "Draw信息流展示"
         "DrawFeedAd已关闭"
}

示例代码

var zyPangolinAd = api.require('zyPangolinAd');
var param = {
    setCodeId:"945172091",//代码位
    rect:{ // 默认0即为全屏 也可自定义
        x:0,
        y:0,
        w:0,
        h:600
    },
    fixedOn:api.frameName,
    fixed:false,
    setCanInterruptVideoPlay:true,//视频是否可以点击暂停
};
zyPangolinAd.showTTDrawFeedAd(param,function(ret){
    console.log("zyPangolinAd："+JSON.stringify(ret));
});

可用性

Android系统，ios系统

可提供的1.1.0及更高版本

closeTTDrawFeedAd

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

closeTTDrawFeedAd(callback(ret))

示例代码

var zyPangolinAd = api.require('zyPangolinAd');
zyPangolinAd.closeTTDrawFeedAd({tag:"all"});

可用性

Android系统，ios系统

可提供的1.1.0及更高版本

setAttr

重设广告的显示区域

setAttr({params}, callback(ret))

params

type：

类型：字符串
描述：（必填项）banner、drawFeed、nativeExpress 分别为banner、draw信息流、信息流三种类型

tag：

类型：字符串
描述：（必填项）唯一广告标识

rect：

类型：对象
描述：（必填项）重设展示区域
内部字段：

{
    x:0,
    y:0,
    w:0,
    h:0
}

示例代码

var zyPangolinAd = api.require('zyPangolinAd');
setTimeout(function(){
    for(var i = 0; i < openAds.length; i++){
        var divOff = $api.offset($api.byId("myAddPage" + openAds[i].id));
        zyPangolinAd.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.1.2及更高版本

APICloud

模块开发

端API

设备访问

功能扩展

界面布局

导航菜单

开放SDK

云服务对接

小程序模块

H5模块

前端框架

UI模块引擎

云API

技术专题

开发工具

下载

微信公众号适配

七天培训课教程

其他

Faq

开放平台接入指南

自定义加速域名

云主机

入门教程

部署与管理

常见FAQ

zyPangolinAd

论坛示例

概述

模块接口

getVersions

callback(ret)

示例代码

可用性

requestPermissionIfNecessary

示例代码

可用性

init

params

callback(ret)

示例代码

可用性

showSplashAd

params

callback(ret)

示例代码

可用性

closeSplashAd

callback(ret)

示例代码

可用性

loadRewardVideoAd

params

callback(ret)

示例代码

可用性

showRewardVideoAd

callback(ret)

示例代码

可用性

showBannerAd

params

callback(ret)

示例代码

可用性

closeBannerAd

callback(ret)

示例代码

可用性

showInteractionAd

params

callback(ret)

示例代码

可用性

loadFullScreenVideoAd

params

callback(ret)

示例代码

可用性