zyTencentAd

其它接口

插件接口

init showSplashAd closeSplashAd showBannerAd closeBannerAd showInteractionAd closeInterstitialAD loadRewardVideoAd showRewardVideoAd showNativeExpressAd closeNativeExpressAd showNativeExpressAd2 closeNativeExpressAd2 setAttr

论坛示例

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

概述

插件简介

zyTencentAd封装腾讯广点通Android、Ios广告sdk，包含Banner广告、插屏广告、开屏位广告、激励视频广告、等功能。1.0.4版本之后增加增加showNativeExpressAd（原生模板）、showNativeExpressAd2（原生模板2.0）信息流插件，解决划动时会触摸误点的问题。

IOS 应用打包最低版本为9.0，Android应用打包最低版本为4.0.3。

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

点击进入广点通控制台

插件接口

getVersions

获取当前集成的sdk版本号

getVersions(callback(ret))

callback(ret)

ret：

类型：JSON 对象
内部字段：

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

示例代码

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

可用性

Android系统，ios系统

可提供的1.0.0及更高版本

init

初始化插件（使用前必须）

init({params}, callback(ret))

params

appId:

类型：字符串
描述：（必选项）应用id
默认值：api.systemType=='ios'?"1105344611":"1101152570"

channel：

类型：数字
描述：（必选项）渠道号具体设置请看其官方说明 https://developers.adnet.qq.com/doc/android/union/union_embed
默认值：999

callback(ret)

ret：

类型：JSON 对象
内部字段：

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

示例代码

var zyTencentAd = api.require('zyTencentAd');
var param = {
    appId:api.systemType=='ios'?"1105344611":"1101152570",
    channel:999
};
zyTencentAd.init(param,function(ret){
    console.log("zyTencentAd："+JSON.stringify(ret));
});

可用性

Android系统，ios系统

可提供的1.0.0及更高版本

showSplashAd

展示开屏广告

showSplashAd({params}, callback(ret))

params

setCodeId：

类型：字符串
描述：（必选项）代码位id
默认值：api.systemType=='ios'?"9040714184494018":"8863364436303842593"

//因平台差异以下参数仅android可用 ios不可设置宽高只能全屏 rect：

类型：对象
描述：（可选项）打开开屏区域全为0或不写则打开全屏
内部字段：

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

fixedOn：

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

fixed:

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

errorClose:

类型：布尔
描述：（可选项）异常时是否自动关闭广告
默认值：true

//仅苹果可用参数 logo:

类型：字符串
描述：（可选项）苹果需要展示的开屏Logo 仅支持widget、fs路径
默认值：

logoH:

类型：字符串
描述：（可选项）苹果开屏Logo从下往上的高度
默认值：200

callback(ret)

ret：

类型：JSON 对象
内部字段：

{
  status:true, //true的结果如下   false结果则显示对应错误提示
  result:"开屏广告加载中"
         "开屏广告加载成功"
         "开屏广告曝光时"
         "开屏广告展示"
         "开屏广告点击"
         "开屏广告剩余:N"
         "开屏广告倒计时结束"
         "开屏广告已关闭"
}

示例代码

var zyTencentAd = api.require('zyTencentAd');
var param = {
  setCodeId:api.systemType=='ios'?"9040714184494018":"8863364436303842593",//默认测试代码位
  //因平台差异  以下参数仅 android可用 ios不可设置宽高 只能全屏
  rect:{//开屏位置 默认0即为全屏 也可自定义
        x:0,
        y:0,
        w:0,
        h:0
    },
    fixedOn:"",
    fixed:true,
    logo:"",//开屏使用的logo(仅苹果有效) 安卓logo 请下载示例代码使用
};
zyTencentAd.showSplashAd(param,function(ret){
    console.log("zyTencentAd："+JSON.stringify(ret));
});

可用性

Android系统，ios系统

可提供的1.0.0及更高版本

closeSplashAd

关闭开屏广告

closeSplashAd(callback(ret))

callback(ret)

ret：

类型：JSON 对象
内部字段：

{
  status:true,
  result:"开屏广告已关闭"
}

示例代码

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

可用性

Android系统，ios系统

可提供的1.0.0及更高版本

showBannerAd

展示Banner广告

showBannerAd({params}, callback(ret))

params

tag：

类型：字符串
描述：（可选项）打开此banner的标识需要打开多个banner可设置不同的tag 手动close时传入对应tag即可关闭对应banner (1.0.3版本及以上版本支持)
默认值：_default

setCodeId：

类型：字符串
描述：（必选项）代码位id
默认值：api.systemType=='ios'?"1080958885885321":"4080052898050840"

rect：

类型：对象
描述：（可选项）打开开屏区域全为0或不写则打开全屏
内部字段：

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

fixedOn：

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

fixed:

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

refresh:

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

errorClose:

类型：布尔
描述：（可选项）异常时是否自动关闭广告
默认值：true

callback(ret)

ret：

类型：JSON 对象
内部字段：

{
  status:true, //true的结果如下   false结果则显示对应错误提示
  result:"banner展示"
         "banner曝光时"
         "banner点击"
         "banner由于广告点击离开APP"
         "banner广告打开浮层"
         "banner浮层关闭"
         "bannerAd已关闭"
}

示例代码

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

可用性

Android系统，ios系统

可提供的1.0.0及更高版本

closeBannerAd

手动关闭Banner广告

closeBannerAd(callback(ret))

callback(ret)

ret：

类型：JSON 对象
内部字段：

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

示例代码

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

可用性

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 对象
内部字段：

{
  status:true, //true的结果如下   false结果则显示对应错误提示
  result:"ECPM价格:-1"
         "interstitialAD展示"
         "interstitialAD曝光时"
         "interstitialAD点击"
         "interstitialAD由于广告点击离开APP"
         "interstitialAD视频下载中"
         "interstitialAD视频开始播放"
         "interstitialAD视频暂停"
         "interstitialAD视频播放结束"
         "interstitialAD进入视频落地页"
         "interstitialAD退出视频落地页"
         "interstitialAD已关闭"
}

示例代码

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

可用性

Android系统，ios系统

可提供的1.0.0及更高版本

closeInterstitialAD

关闭插屏广告

closeInterstitialAD(callback(ret))

callback(ret)

ret：

类型：JSON 对象
内部字段：

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

示例代码

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

可用性

Android系统，ios系统

可提供的1.0.0及更高版本

loadRewardVideoAd

加载激励视频广告

loadRewardVideoAd({params}, callback(ret))

params

setCodeId：

类型：字符串
描述：（必选项）代码位id
默认值：api.systemType=='ios'?"9070098640008762":"6040295592058680",

autoPlayMuted:

类型：布尔
描述：（可选项）视频是否静音
默认值：false

setUserID:

类型：字符串
描述：（可选项）当前用户id 用于服务器验证
默认值：空

setMediaExtra:

类型：字符串
描述：（可选项）附加消息用于服务器验证
默认值：空

callback(ret)

ret：

类型：JSON 对象
内部字段：

{
  status:true, //true的结果如下   false结果则显示对应错误提示
  result:"激励视频加载成功"
         "ECPM价格:-1"
         "激励视频缓存完成"
         "激励视频展示"
         "激励视频曝光"
         "激励视频激励发放"
         "激励视频点击"
         "激励视频播放完"
         "激励视频关闭"
}

示例代码

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

可用性

Android系统，ios系统

可提供的1.0.0及更高版本

showRewardVideoAd

展示激励视频

showRewardVideoAd(callback(ret))

callback(ret)

ret：

类型：JSON 对象
内部字段：

{
  status:true|false,
  result:"展示激励视频|请先加载激励视频|激励视频已展示过，请重新请求|激励视频广告已过期"
}

示例代码

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

可用性

Android系统，ios系统

可提供的1.0.0及更高版本

showNativeExpressAd

展示信息流广告

showNativeExpressAd({params}, callback(ret))

params

tag：

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

setCodeId：

类型：字符串
描述：（必选项）代码位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, //true的结果如下   false结果则显示对应错误提示
  result:"信息流广告加载中" 
         "信息流广告点击"
         "信息流广告展示"
         "信息流已关闭"
}

示例代码

var zyTencentAd = api.require('zyTencentAd');
var param = {
    tag:"123",
    setCodeId:"6090892202222287",//代码位
    rect:{
        x:0,
        y:0,
        w:360,
        h:300
    },
    fixedOn:api.frameName,
    fixed:false
};
zyTencentAd.showNativeExpressAd(param,function(ret){
    console.log("zyTencentAd："+JSON.stringify(ret));
});

可用性

Android系统，ios系统

可提供的1.0.4及更高版本

closeNativeExpressAd

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

closeNativeExpressAd(callback(ret))

示例代码

var zyTencentAd = api.require('zyTencentAd');
zyTencentAd.closeNativeExpressAd({tag:"all"});

可用性

Android系统，ios系统

可提供的1.0.4及更高版本

showNativeExpressAd2

展示信息流2.0广告

showNativeExpressAd2({params}, callback(ret))

params

tag：

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

setCodeId：

类型：字符串
描述：（必选项）代码位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, //true的结果如下   false结果则显示对应错误提示
  result:"信息流广告2加载中" 
         "信息流广告2点击"
         "信息流广告2曝光时"
         "信息流2已关闭"
}

示例代码

var zyTencentAd = api.require('zyTencentAd');
var param = {
    tag:"123",
    setCodeId:"9081114683610806",//代码位
    rect:{
        x:0,
        y:0,
        w:360,
        h:300
    },
    fixedOn:api.frameName,
    fixed:false
};
zyTencentAd.showNativeExpressAd2(param,function(ret){
    console.log("zyTencentAd："+JSON.stringify(ret));
});

可用性

Android系统，ios系统

可提供的1.0.4及更高版本

closeNativeExpressAd2

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

closeNativeExpressAd2(callback(ret))

示例代码

var zyTencentAd = api.require('zyTencentAd');
zyTencentAd.closeNativeExpressAd2({tag:"all"});

可用性

Android系统，ios系统

可提供的1.0.4及更高版本

setAttr

重设广告的显示区域

setAttr({params}, callback(ret))

params

type：

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

tag：

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

rect：

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

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

示例代码

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

是否仍需要帮助？请保持联络！

最后更新于 2024/04/24