pangleAD

立即使用

init openSplashAd closeSplashAd openRewardedAd openBannerAd closeBannerAd openInteractionAd openFullScreenVideoAd

概述

本模块封装了穿山甲广告SDK

注意：本模块 iOS 平台上最低适配系统版本为 iOS 9.0

init

初始化

init(params,callback(ret))

params

appID:

  • 参数：字符串类型
  • 描述：应用id

callback(ret)

ret:

  • 类型：JSON 对象
  • 内部字段：
{
    status: true ,          //布尔类型；是否成功，true|false
}

示例代码

var pangleAD = api.require('pangleAD');
var params = {
  appID:''
};
pangleAD.init(params,function(ret) {
    api.alert(ret);
});

可用性

iOS系统，android系统

可提供的1.0.0及更高版本

openSplashAd

打开开屏广告

openSplashAd(params,callback(ret))

params

slotID：

  • 类型：字符串
  • 描述：广告标识符

tolerateTimeout：

  • 类型：数字
  • 描述：（可选项）超时时间，单位秒（仅iOS支持）
  • 默认：3

rect:

  • 类型：JSON对象
  • 描述：(可选项）位置及长宽
{
      x: 0,    //（可选项）数字类型；播放画面 x 坐标（相对于所属的 Window 或 Frame）；默认值：0
      y: 0,    //（可选项）数字类型；播放画面 y 坐标（相对于所属的 Window 或 Frame）；默认值：0
      w: 320,  //（可选项）数字类型；iOS支持设置'auto'；播放画面宽（相对于所属的 Window 或 Frame）；默认值：屏幕宽度
      h: 300,  //（可选项）数字类型；iOS支持设置'auto'；播放画面高（相对于所属的 Window 或 Frame）；默认值：屏幕高度
}

fixedOn：

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

fixed:

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

callback(ret)

ret:

  • 类型：JSON对象
  • 内部字段：
{
      eventType:''  //字符串类型；事件回调，取值范围如下：
                    //splashAdDidLoad:成功加载初始广告素材
                    //splashAdDidFail:广告素材加载失败
                    //splashAdWillVisible:将显示初始广告位
                    //splashAdDidClick:单击启动广告
                    //splashAdDidClose:关闭首播广告（仅iOS支持）     
                    //splashAdWillClose:初始广告即将关闭（仅iOS支持）
                    //splashAdDidClickSkip:单击spalashAd跳过按钮
                    //splashAdCountdownToZero:spalashAd倒数等于0

}

示例代码

var pangleAD = api.require('pangleAD');
pangleAD.openSplashAd({
  slotID:''
},function(ret) {
    api.alert({ msg:JSON.stringify(ret)});
});

可用性

iOS系统，android系统

可提供的1.0.0及更高版本

closeSplashAd

关闭开屏广告

closeSplashAd()

示例代码

var pangleAD = api.require('pangleAD');
pangleAD.closeSplashAd();

可用性

iOS系统，android系统

可提供的1.0.0及更高版本

openRewardedAd

打开激励视频广告

openRewardedAd(params,callback(ret))

params

slotID：

  • 类型：字符串
  • 描述：广告标识符

userID:

  • 类型：字符串
  • 描述：（可选项）用户id

rewardName:

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

rewardAmount:

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

extra:

  • 类型：字符串
  • 描述：（可选项）附加参数

callback(ret)

ret:

  • 类型：JSON对象
  • 内部字段：
{
     eventType:'',//字符串类型；事件回调，取值范围如下：
                                //rewardedVideoAdDidLoad:视频广告素材成功加载
                            //rewardedVideoAdDidFail:视频广告素材加载失败
                            //rewardedVideoAdDidDownLoadVideo:视频下载完成
                            //rewardedVideoAdViewRenderSuccess:成功渲染（仅iOS支持）
                            //rewardedVideoAdViewRenderFail:渲染失败（仅iOS支持）
                            //rewardedVideoAdWillVisible:视频广告将要显示（仅iOS支持）
                            //rewardedVideoAdDidVisible:视频广告已经显示
                            //rewardedVideoAdWillClose:视频广告即将关闭（仅iOS支持）
                            //rewardedVideoAdDidClose:视频广告已经关闭
                            //rewardedVideoAdDidClick:点击视频广告
                            //rewardedVideoAdDidClickSkip:用户单击跳过按钮
                            //rewardedVideoAdDidPlayFinish:视频广告播放完成
                            //rewardedVideoAdDidPlayError:视频广告发生错误时
                             //rewardedVideoAdServerRewardDidSucceed:异步请求的服务器验证成功，开发者需要在此回调中进行奖励发放
                                 //rewardedVideoAdServerRewardDidFail:异步请求的服务器验证失败（仅iOS支持）
                                 //rewardedVideoAdCallback:激励视频的广告类型回掉（仅iOS支持）
                                 //rewardVerify:奖励验证回调（仅android支持）
           nativeExpressVideoType:0, //数字类型；rewardedVideoAdCallback 返回   （仅iOS支持）     
                                                 //0:video + endcard
                                                 //1:video + playable
                                                 //2: pure playable   
          verify:{                 //JSON对象类型；奖励验证数据  eventType为rewardVerify时返回
              rewardVerify:, //布尔类型；是否有效
              rewardAmount:, //数字类型；奖励梳理
              rewardName:'', //字符串类型；奖励名称
              code:,         //数字类型；错误码
              msg:'',         //字符串类型；错误信息
          }




}

示例代码

var pangleAD = api.require('pangleAD');
pangleAD.openRewardedAd({
  slotID:''
},function(ret) {
    api.alert({ msg:JSON.stringify(ret)});
});

可用性

iOS系统，android系统

可提供的1.0.0及更高版本

openBannerAd

打开Banner广告

openBannerAd(params,callback(ret))

params

slotID：

  • 类型：字符串
  • 描述：广告标识符

rect:

  • 类型：JSON对象
  • 描述：(可选项）位置及长宽
{
      x: 0,    //（可选项）数字类型；播放画面 x 坐标（相对于所属的 Window 或 Frame）；默认值：0
      y: 0,    //（可选项）数字类型；播放画面 y 坐标（相对于所属的 Window 或 Frame）；默认值：0
      w: 320,  //（可选项）数字类型；iOS支持设置'auto'；播放画面宽（相对于所属的 Window 或 Frame）；默认值：屏幕宽度
      h: 300,  //（可选项）数字类型；iOS支持设置'auto'；播放画面高（相对于所属的 Window 或 Frame）；默认值：屏幕高度
}

fixedOn：

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

fixed:

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

callback(ret)

ret:

  • 类型：JSON对象
  • 内部字段：
{
      eventType:'', //字符串类型；事件回调，取值范围如下：
                                    //viewDidLoad:加载成功
                    //loadFail:加载失败
                    //viewRenderSuccess:渲染成功
                    //viewRenderFail:渲染失败
                    //viewWillBecomVisible:当显示新的广告时回掉此字段
                    //viewDidClick:广告被点击
                    //didRemoved:【重要】若开发者收到此回调，代表穿山甲会主动关闭掉广告，广告移除后需要开发者对界面进行适配s (仅iOS支持)
                    //adShow:广告显示（仅android支持）

}

示例代码

var pangleAD = api.require('pangleAD');
pangleAD.openBannerAd({
  slotID:''
},function(ret) {
    api.alert({ msg:JSON.stringify(ret)});
});

可用性

iOS系统，android系统

可提供的1.0.0及更高版本

closeBannerAd

关闭Banner广告

closeBannerAd()

示例代码

var pangleAD = api.require('pangleAD');
pangleAD.closeBannerAd();

可用性

iOS系统，android系统

可提供的1.0.0及更高版本

openInteractionAd

打开插屏广告

openInteractionAd(params,callback(ret))

params

slotID：

  • 类型：字符串
  • 描述：广告标识符

size:

  • 类型：JSON对象
  • 描述：(可选项）长宽
{

      w: 320,  //（可选项）数字类型；iOS支持设置'auto'；播放画面宽（相对于所属的 Window 或 Frame）；默认值：屏幕宽度
      h: 300,  //（可选项）数字类型；iOS支持设置'auto'；播放画面高（相对于所属的 Window 或 Frame）；默认值：屏幕高度
}

callback(ret)

ret:

  • 类型：JSON对象
  • 内部字段：
{
      eventType:''  //字符串类型；事件回调，取值范围如下：
                    //didLoad:广告素材已成功加载
                    //didFail:广告素材加载失败
                    //renderSuccess:渲染成功
                    //renderFail:渲染失败
                    //willVisible:模版插屏广告即将展示
                    //didClick:广告被点击
                    //willClose:广告即将关闭（仅iOS支持）
                    //didClose:广告已经关闭（仅iOS支持）

}

示例代码

var pangleAD = api.require('pangleAD');
pangleAD.openInteractionAd({
  slotID:''
},function(ret) {
    api.alert({ msg:JSON.stringify(ret)});
});

可用性

iOS系统，android系统

可提供的1.0.0及更高版本

openFullScreenVideoAd

加载全屏广告

openFullScreenVideoAd(params,callback(ret))

params

slotID：

  • 类型：字符串
  • 描述：广告标识符

callback(ret)

ret:

  • 类型：JSON对象
  • 内部字段：
{
      eventType:'', //字符串类型；事件回调，取值范围如下：
                    //didLoad:广告素材已成功加载
                    //didFail:广告素材加载失败
                    //viewRenderSuccess:渲染成功（仅iOS支持）
                    //viewRenderFail:渲染失败（仅iOS支持）
                    //didDownLoadVideo:视频下载完成
                    //willVisible:模版全屏广告即将展示（仅iOS支持）
                    //didVisible:模版全屏广告已经展示
                    //didClick:广告被点击
                                 //didClickSkip:点击跳过按钮
                                 //willClose:广告将要关闭（仅iOS支持）
                                 //didClose:广告已经关闭
                                //didPlayFinish:广告播放完成
                             //didPlayError:广告播放完成失败（仅iOS支持）
                               //callback:全屏视频的广告类型回掉（仅iOS支持）
           nativeExpressVideoAdType:0 //数字类型；rewardedVideoAdCallback 返回（仅iOS支持）        
                                                 //0:video + endcard
                                                 //1:video + playable
                                                 //2: pure playable  



}

示例代码

var pangleAD = api.require('pangleAD');
pangleAD.openFullScreenVideoAd({
  slotID:''
},function(ret) {
    api.alert({ msg:JSON.stringify(ret)});
});

可用性

iOS系统，android系统

可提供的1.0.0及更高版本