zyTencentAd

来自于:勇可可立即使用

其它接口

getVersions

模块接口

init showSplashAd closeSplashAd showBannerAd closeBannerAd showInteractionAd closeInterstitialAD loadRewardVideoAd showRewardVideoAd

论坛示例

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

概述

模块简介

zyTencentAd封装腾讯广点通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:"4.11.6",//结果
  4. }

示例代码

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

可用性

Android系统,ios系统

可提供的1.0.0及更高版本

init

初始化模块(使用前必须)

init({params}, callback(ret))

params

appId:

  • 类型:字符串
  • 描述:(必选项)应用id
  • 默认值:api.systemType==’ios’?”1105344611”:”1101152570”

channel:

callback(ret)

ret:

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

示例代码

  1. var zyTencentAd = api.require('zyTencentAd');
  2. var param = {
  3. appId:api.systemType=='ios'?"1105344611":"1101152570",
  4. channel:999
  5. };
  6. zyTencentAd.init(param,function(ret){
  7. console.log("zyTencentAd:"+JSON.stringify(ret));
  8. });

可用性

Android系统,ios系统

可提供的1.0.0及更高版本

showSplashAd

展示开屏广告

showSplashAd({params}, callback(ret))

params

setCodeId:

  • 类型:字符串
  • 描述:(必选项)代码位id
  • 默认值:api.systemType==’ios’?”9040714184494018”:”8863364436303842593”

//因平台差异 以下参数仅android可用 ios不可设置宽高 只能全屏 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(不随之滚动)

errorClose:

  • 类型:布尔
  • 描述:(可选项)异常时是否自动关闭广告
  • 默认值:true

callback(ret)

ret:

  • 类型:JSON 对象
  • 内部字段:
  1. {
  2. status:true, //true的结果如下 false结果则显示对应错误提示
  3. result:"开屏广告加载中"
  4. "开屏广告加载成功"
  5. "开屏广告曝光时"
  6. "开屏广告展示"
  7. "开屏广告点击"
  8. "开屏广告剩余:N"
  9. "开屏广告倒计时结束"
  10. "开屏广告已关闭"
  11. }

示例代码

  1. var zyTencentAd = api.require('zyTencentAd');
  2. var param = {
  3. setCodeId:api.systemType=='ios'?"9040714184494018":"8863364436303842593",//默认测试代码位
  4. //因平台差异 以下参数仅 android可用 ios不可设置宽高 只能全屏
  5. rect:{//开屏位置 默认0即为全屏 也可自定义
  6. x:0,
  7. y:0,
  8. w:0,
  9. h:0
  10. },
  11. fixedOn:"",
  12. fixed:true,
  13. errorClose:true//异常时是否自动关闭广告 默认true
  14. };
  15. zyTencentAd.showSplashAd(param,function(ret){
  16. console.log("zyTencentAd:"+JSON.stringify(ret));
  17. });

可用性

Android系统,ios系统

可提供的1.0.0及更高版本

closeSplashAd

关闭开屏广告

closeSplashAd(callback(ret))

callback(ret)

ret:

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

示例代码

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

可用性

Android系统,ios系统

可提供的1.0.0及更高版本

showBannerAd

展示Banner广告

showBannerAd({params}, callback(ret))

params

setCodeId:

  • 类型:字符串
  • 描述:(必选项)代码位id
  • 默认值:api.systemType==’ios’?”1080958885885321”:”4080052898050840”

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(不随之滚动)

refresh:

  • 类型:数字
  • 描述:(可选项)设置刷新频率,为0或30~120之间的数字,单位为 s,0标识不自动轮播
  • 默认值:30

errorClose:

  • 类型:布尔
  • 描述:(可选项)异常时是否自动关闭广告
  • 默认值:true

callback(ret)

ret:

  • 类型:JSON 对象
  • 内部字段:
  1. {
  2. status:true, //true的结果如下 false结果则显示对应错误提示
  3. result:"banner展示"
  4. "banner曝光时"
  5. "banner点击"
  6. "banner由于广告点击离开APP"
  7. "banner广告打开浮层"
  8. "banner浮层关闭"
  9. "bannerAd已关闭"
  10. }

示例代码

  1. var param = {
  2. setCodeId:api.systemType=='ios'?"1080958885885321":"4080052898050840",//默认测试代码位
  3. rect:{//显示位置
  4. x:20,
  5. y:100,
  6. w:api.winWidth-40,
  7. h:70
  8. },
  9. fixedOn:api.frameName,
  10. fixed:false,
  11. refresh:0,//设置刷新频率,为0或30~120之间的数字,单位为 s,0标识不自动轮播,默认30S
  12. errorClose:true,//异常时是否自动关闭模块 默认true
  13. };
  14. zyTencentAd.showBannerAd(param,function(ret){
  15. console.log("zyTencentAd:"+JSON.stringify(ret));
  16. });

可用性

Android系统,ios系统

可提供的1.0.0及更高版本

closeBannerAd

手动关闭Banner广告

closeBannerAd(callback(ret))

callback(ret)

ret:

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

示例代码

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

可用性

Android系统,ios系统

可提供的1.0.0及更高版本

showInteractionAd

展示插屏广告

showInteractionAd({params}, callback(ret))

params

setCodeId:

  • 类型:字符串
  • 描述:(必选项)代码位id
  • 默认值:api.systemType==’ios’?”6050298509489032”:”1050691202717808”

isMaskLayer:

  • 类型:布尔
  • 描述:(可选项)是否有遮罩层 此参数仅android有效
  • 默认值:true

autoPlayPolicy:

  • 类型:数字
  • 描述:(可选项)视频自动播放条件 0仅wifi自动播放 1始终自动播放 2从不自动播放 ios只有0和1
  • 默认值:1

autoPlayMuted:

  • 类型:布尔
  • 描述:(可选项)播放视频时是否静音
  • 默认值:true

detailPageMuted:

  • 类型:布尔
  • 描述:(可选项)详情页的视频是否静音
  • 默认值:false

fullScreen:

  • 类型:布尔
  • 描述:(可选项)是否全屏视频
  • 默认值:false

errorClose:

  • 类型:布尔
  • 描述:(可选项)异常时是否自动关闭广告
  • 默认值:true

callback(ret)

ret:

  • 类型:JSON 对象
  • 内部字段:
  1. {
  2. status:true, //true的结果如下 false结果则显示对应错误提示
  3. result:"ECPM价格:-1"
  4. "interstitialAD展示"
  5. "interstitialAD曝光时"
  6. "interstitialAD点击"
  7. "interstitialAD由于广告点击离开APP"
  8. "interstitialAD视频下载中"
  9. "interstitialAD视频开始播放"
  10. "interstitialAD视频暂停"
  11. "interstitialAD视频播放结束"
  12. "interstitialAD进入视频落地页"
  13. "interstitialAD退出视频落地页"
  14. "interstitialAD已关闭"
  15. }

示例代码

  1. var zyTencentAd = api.require('zyTencentAd');
  2. var param = {
  3. setCodeId:api.systemType=='ios'?"6050298509489032":"1050691202717808",//默认测试代码位
  4. isMaskLayer:true,//是否有遮罩 默认true 仅android有效
  5. autoPlayPolicy:1,//视频自动播放条件 0仅wifi自动播放 1始终自动播放 2从不自动播放 ios只有0和1
  6. autoPlayMuted:true,//视频是否静音 默认true
  7. detailPageMuted:true,//详情视频是否静音 默认false
  8. fullScreen:false,//是否全屏视频 默认false
  9. errorClose:true,//异常时是否自动关闭模块 默认true
  10. };
  11. zyTencentAd.showInteractionAd(param,function(ret){
  12. console.log("zyTencentAd:"+JSON.stringify(ret));
  13. });

可用性

Android系统,ios系统

可提供的1.0.0及更高版本

closeInterstitialAD

关闭插屏广告

closeInterstitialAD(callback(ret))

callback(ret)

ret:

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

示例代码

  1. var zyTencentAd = api.require('zyTencentAd');
  2. zyTencentAd.closeInterstitialAD(function(ret){
  3. console.log("zyTencentAd:"+JSON.stringify(ret));
  4. });

可用性

Android系统,ios系统

可提供的1.0.0及更高版本

loadRewardVideoAd

加载激励视频广告

loadRewardVideoAd({params}, callback(ret))

params

setCodeId:

  • 类型:字符串
  • 描述:(必选项)代码位id
  • 默认值:api.systemType==’ios’?”9070098640008762”:”6040295592058680”,

autoPlayMuted:

  • 类型:布尔
  • 描述:(可选项)视频是否静音
  • 默认值:false

callback(ret)

ret:

  • 类型:JSON 对象
  • 内部字段:
  1. {
  2. status:true, //true的结果如下 false结果则显示对应错误提示
  3. result:"激励视频加载成功"
  4. "ECPM价格:-1"
  5. "激励视频缓存完成"
  6. "激励视频展示"
  7. "激励视频曝光"
  8. "激励视频激励发放"
  9. "激励视频点击"
  10. "激励视频播放完"
  11. "激励视频关闭"
  12. }

示例代码

  1. var zyTencentAd = api.require('zyTencentAd');
  2. var param = {
  3. setCodeId:api.systemType=='ios'?"9070098640008762":"6040295592058680",//默认测试代码位
  4. autoPlayMuted:true,//视频是否静音 默认false
  5. };
  6. zyTencentAd.loadRewardVideoAd(param,function(ret){
  7. console.log("zyTencentAd:"+JSON.stringify(ret));
  8. });

可用性

Android系统,ios系统

可提供的1.0.0及更高版本

showRewardVideoAd

展示激励视频

showRewardVideoAd(callback(ret))

callback(ret)

ret:

  • 类型:JSON 对象
  • 内部字段:
  1. {
  2. status:true|false,
  3. result:"展示激励视频|请先加载激励视频|激励视频已展示过,请重新请求|激励视频广告已过期"
  4. }

示例代码

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

可用性

Android系统,ios系统

可提供的1.0.0及更高版本