zyPangolinAd

来自于：勇可可立即使用

其它接口

getVersions requestPermissionIfNecessary

模块接口

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

论坛示例

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

概述

模块简介

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

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

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

点击进入穿山甲控制台

模块接口

getVersions

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

getVersions(callback(ret))

callback(ret)

ret：

  • 类型：JSON 对象
  • 内部字段：
  1. {
  2.   status:true, //调用成功
  3.   result:"2.5.3.2",//结果
  4. }

示例代码

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

可用性

Android系统，ios系统

可提供的1.0.0及更高版本

requestPermissionIfNecessary

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

requestPermissionIfNecessary()

示例代码

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

可用性

Android系统，ios系统

可提供的1.0.0及更高版本

init

初始化模块

init({params}, callback(ret))

params

appId：

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

appName：

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

callback(ret)

ret：

  • 类型：JSON 对象
  • 内部字段：
  1. {
  2.   status:true,
  3.   result:"初始化完成"
  4. }

示例代码

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

可用性

Android系统，ios系统

可提供的1.0.0及更高版本

showSplashAd

展示开屏广告

showSplashAd({params}, callback(ret))

params

setCodeId：

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

rect：

  • 类型：对象
  • 描述：（可选项）打开开屏区域 全为0或不写 则打开全屏
  • 内部字段：
  1. {
  2.     x:0,
  3.     y:0,
  4.     w:0,
  5.     h:0
  6. }

fixedOn：

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

fixed:

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

callback(ret)

ret：

  • 类型：JSON 对象
  • 内部字段：
  1. {
  2.   status:true, //true的结果如下   false结果则显示对应错误提示
  3.   result:"开屏广告加载中"    //回调提示如下   如点击下载则还有 下载中、下载暂停、下载失败、下载完成、安装完成
  4.          "开屏广告点击"
  5.          "开屏广告展示"
  6.          "开屏广告跳过"
  7.          "开屏广告倒计时结束"
  8.          "splashAd已关闭"
  9. }

示例代码

  1. var zyPangolinAd = api.require('zyPangolinAd');
  2. var param = {
  3.     setCodeId:"840813945",//代码位
  4.     rect:{ //开屏位置 默认0即为全屏 也可自定义
  5.         x:0,
  6.         y:0,
  7.         w:0,
  8.         h:0
  9.     },
  10.     fixedOn:"",
  11.     fixed:true
  12. };
  13. zyPangolinAd.showSplashAd(param,function(ret){
  14.     console.log("zyPangolinAd："+JSON.stringify(ret));
  15. });

可用性

Android系统，ios系统

可提供的1.0.0及更高版本

closeSplashAd

手动关闭开屏广告

closeSplashAd(callback(ret))

callback(ret)

ret：

  • 类型：JSON 对象
  • 内部字段：
  1. {
  2.   status:true,
  3.   result:"splashAd已关闭"
  4. }

示例代码

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

可用性

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 对象
  • 内部字段：
  1. {
  2.   status:true, //true的结果如下   false结果则显示对应错误提示
  3.   result:"激励视频加载中"    //回调提示如下   如点击下载则还有 下载中、下载暂停、下载失败、下载完成、安装完成
  4.          "激励视频缓存完成"
  5.          "激励视频展示"
  6.          "激励视频点击"
  7.          "激励视频关闭"
  8.          "激励视频播放完"
  9.          "激励视频奖励到位么:true|false"
  10.          "激励视频跳过"
  11. }

示例代码

  1. var zyPangolinAd = api.require('zyPangolinAd');
  2. var param = {
  3.     setCodeId:"944213566",//代码位
  4.     setOrientation:1,//必填参数，期望视频的播放方向：1竖  2横
  5.     setUserID:"user123",//用户id,必传参数
  6.     setRewardName:"金币",//奖励的名称
  7.     setRewardAmount:3,//奖励的数量
  8.     setMediaExtra:"附加参数",//附加参数，可选
  10. };
  11. zyPangolinAd.loadRewardVideoAd(param,function(ret){
  12.     console.log("zyPangolinAd："+JSON.stringify(ret));
  13. });

可用性

Android系统，ios系统

可提供的1.0.0及更高版本

showRewardVideoAd

展示激励视频

showRewardVideoAd(callback(ret))

callback(ret)

ret：

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

示例代码

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

可用性

Android系统，ios系统

可提供的1.0.0及更高版本

showBannerAd

展示Banner广告

showBannerAd({params}, callback(ret))

params

setCodeId：

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

rect：

  • 类型：对象
  • 描述：（可选项）打开开屏区域 全为0或不写 则打开全屏
  • 内部字段：
  1. {
  2.     x:0,
  3.     y:0,
  4.     w:0,
  5.     h:0
  6. }

fixedOn：

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

fixed:

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

callback(ret)

ret：

  • 类型：JSON 对象
  • 内部字段：
  1. {
  2.   status:true, //true的结果如下   false结果则显示对应错误提示
  3.   result:"banner加载中"    //回调提示如下   如点击下载则还有 下载中、下载暂停、下载失败、下载完成、安装完成
  4.          "banner点击"
  5.          "banner展示"
  6.          "不喜欢,点击:"
  7.          "点击取消"
  8.          "bannerAd已关闭"
  9. }

示例代码

  1. var zyPangolinAd = api.require('zyPangolinAd');
  2. var param = {
  3.     setCodeId:"940813564",//代码位
  4.     rect:{//显示位置
  5.         x:30,
  6.         y:100,
  7.         w:api.winWidth-60,
  8.         h:180
  9.     },
  10.     fixedOn:"",
  11.     fixed:true
  12. };
  13. zyPangolinAd.showBannerAd(param,function(ret){
  14.     console.log("zyPangolinAd："+JSON.stringify(ret));
  15. });

可用性

Android系统，ios系统

可提供的1.0.0及更高版本

closeBannerAd

手动关闭Banner广告

closeBannerAd(callback(ret))

callback(ret)

ret：

  • 类型：JSON 对象
  • 内部字段：
  1. {
  2.   status:true,
  3.   result:"bannerAd已关闭"
  4. }

示例代码

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

可用性

Android系统，ios系统

可提供的1.0.0及更高版本

showInteractionAd

展示插屏广告

showInteractionAd({params}, callback(ret))

params

setCodeId：

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

w：

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

h:

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

callback(ret)

ret：

  • 类型：JSON 对象
  • 内部字段：
  1. {
  2.   status:true, //true的结果如下   false结果则显示对应错误提示
  3.   result:"插屏广告加载中"    //回调提示如下   如点击下载则还有 下载中、下载暂停、下载失败、下载完成、安装完成
  4.          "插屏广告消失"
  5.          "插屏广告点击"
  6.          "插屏广告展示"
  7. }

示例代码

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

可用性

Android系统，ios系统

可提供的1.0.0及更高版本

loadFullScreenVideoAd

加载全屏视频广告

loadFullScreenVideoAd({params}, callback(ret))

params

setCodeId：

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

setOrientation：

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

callback(ret)

ret：

  • 类型：JSON 对象
  • 内部字段：
  1. {
  2.   status:true, //true的结果如下   false结果则显示对应错误提示
  3.   result:"全屏视频加载中"    //回调提示如下   如点击下载则还有 下载中、下载暂停、下载失败、下载完成、安装完成
  4.          "全屏视频缓存完成"
  5.          "全屏视频展示"
  6.          "全屏视频点击"
  7.          "全屏视频关闭"
  8.          "全屏视频播放完"
  9.          "全屏视频跳过"
  10. }

示例代码

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

可用性

Android系统，ios系统

可提供的1.0.0及更高版本

showFullScreenVideoAd

展示全屏视频

showFullScreenVideoAd(callback(ret))

callback(ret)

ret：

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

示例代码

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

可用性

Android系统，ios系统

可提供的1.0.0及更高版本

showNativeExpressAd

展示信息流广告

showNativeExpressAd({params}, callback(ret))

params

setCodeId：

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

rect：

  • 类型：对象
  • 描述：（可选项）打开展示区域
  • 内部字段：
  1. {
  2.     x:0,
  3.     y:0,
  4.     w:0,
  5.     h:300
  6. }

fixedOn：

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

fixed:

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

callback(ret)

ret：

  • 类型：JSON 对象
  • 内部字段：
  1. {
  2.   status:true, //true的结果如下   false结果则显示对应错误提示
  3.   result:"信息流广告加载中"    //回调提示如下   如点击下载则还有 下载中、下载暂停、下载失败、下载完成、安装完成
  4.          "信息流点击"
  5.          "信息流展示"
  6.          "信息流已关闭"
  7. }

示例代码

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

可用性

Android系统，ios系统

可提供的1.0.7及更高版本

cleanNativeExpressAd

清空信息流广告(清除所有打开的信息流广告 适用于刷新列表页面时 清空所有广告 再加载)

cleanNativeExpressAd(callback(ret))

callback(ret)

ret：

  • 类型：JSON 对象
  • 内部字段：
  1. {
  2.   status:true,
  3.   result:"清除缓存成功"
  4. }

示例代码

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

可用性

Android系统，ios系统

可提供的1.0.7及更高版本