gdtModule

广点通接入

开发者在使用gdtModule模块时,需要开发者自行到广点通注册为开发者。注册开发者后申请相应的appid和posId

概述

gdtModule模块,实现了IOS、安卓平台集成广点通SDK广告SDK。

initSdk

初始化sdk

initSdk({params}, callback(ret, err))

params

appId:

  • 类型:字符串
  • 描述:(必填项)指在 http://e.qq.com/dev/ 能看到的app唯一字符串

channel:

  • 类型:数字型
  • 描述:(可选项)渠道ID,参考广点通文档
  • 默认值:999

enableCollectAppInstallStatus:

  • 类型:布尔型
  • 描述:(可选项)是否开启SDK收集App安装状态
  • 默认值:false

示例代码

var demo = api.require('gdtModule');
demo.initSdk({appId:"100720253"}, function(ret, err){
    alert(JSON.stringify(ret));
});

callback(ret, err)

ret:

  • 类型:JSON对象
  • 内部字段:
{
    status: true,   //布尔型;true||false
}

err:

  • 类型:JSON对象
  • 内部字段:
{
    code : "",
    msg: ""
}

可用性

iOS、Android系统

可提供的1.0.0及更高版本

showSplashAd

显示开屏广告

showSplashAd({params}, callback(ret, err))

params

posId:

  • 类型:字符串
  • 描述:(必填项)指在 http://e.qq.com/dev/ 生成的数字串,广告位id

示例代码

var demo = api.require('gdtModule');
demo.showSplashAd({
    posId: "4080052898050840",
}, function (ret, err) {
    alert(JSON.stringify(ret) + "  " + JSON.stringify(err));
});

callback(ret, err)

ret:

  • 类型:JSON对象
  • 内部字段:
{
    status: true,   //布尔型;true||false
    evenType : '', //onADClicked
                //onADDismissed
                //onADExposure
                //onADLoaded
                //onADPresent
                //onADTick
                //onNoAD
    millisUntilFinished : '',
    expireTimestamp : ''
}

err:

  • 类型:JSON对象
  • 内部字段:
{
    code : "",
    msg: ""
}

可用性

iOS、Android系统

可提供的1.0.0及更高版本

closeSplashAd

关闭开屏广告

closeSplashAd(callback(ret, err))

示例代码

var demo = api.require('gdtModule');
demo.closeSplashAd(function (ret, err) {
    alert(JSON.stringify(ret) + "  " + JSON.stringify(err));
});

callback(ret, err)

ret:

  • 类型:JSON对象
  • 内部字段:
{
    status: true,   //布尔型;true||false
}

err:

  • 类型:JSON对象
  • 内部字段:
{
    code : "",
    msg: ""
}

可用性

iOS、Android系统

可提供的1.0.0及更高版本

startBanner

打开横幅广告

startBanner({params}, callback(ret, err))

params

rect:

  • 类型:JSON 对象
  • 描述:(必填项)模块的位置及尺寸
  • 内部字段:
{
    x: 0,   //(必填项)数字类型;模块左上角的 x 坐标(相对于所属的 Window 或 Frame);默认值:0
    y: 0,   //(必填项)数字类型;模块左上角的 y 坐标(相对于所属的 Window 或 Frame);默认值:0
    w: 320, //(必填项)数字类型;模块的宽度;默认值:所属的 Window 或 Frame 的宽度
    h: 250  //(必填项)数字类型;模块的高度;默认值:所属的 Window 或 Frame 的高度
}

fixedOn:

  • 类型:字符串
  • 描述:(可选项)模块所属 Frame 的名字,若不传则模块归属于当前 Window

fixed:

  • 类型:布尔
  • 描述:((可选项)模块是否随所属 Window 或 Frame 滚动
  • 默认值:true(不随之滚动)

posId:

  • 类型:字符串
  • 描述:(必填项)指在 http://e.qq.com/dev/ 生成的数字串,广告位id

backgroundColor:

  • 类型:字符串
  • 描述:(可选项)背景色(如:#000000)

示例代码

var demo = api.require('gdtModule');
demo.startBanner({
    rect: {
        x: 0,
        y: 150,
        w: 'auto',
        h: 50,
    },
    posId: "4080052898050840",
    fixedOn: api.frameName,
    fixed: true
}, function (ret, err) {
    alert(JSON.stringify(ret) + "  " + JSON.stringify(err));
});

callback(ret, err)

ret:

  • 类型:JSON对象
  • 内部字段:
{
    status: true,   //布尔型;true||false
    evenType : '',//onNoAD
                //onADReceive
                //onADOpenOverlay
                //onADLeftApplication
                //onADExposure
                //onADClosed
                //onADCloseOverlay
                //onADClicked
}

err:

  • 类型:JSON对象
  • 内部字段:
{
    code : "",
    msg: ""
}

可用性

iOS、Android系统

可提供的1.0.0及更高版本

hideBanner

隐藏横幅广告

hideBanner(callback(ret, err))

示例代码

var demo = api.require('gdtModule');
demo.hideBanner(function (ret, err) {
    alert(JSON.stringify(ret) + "  " + JSON.stringify(err));
});

callback(ret, err)

ret:

  • 类型:JSON对象
  • 内部字段:
{
    status: true,   //布尔型;true||false
}

err:

  • 类型:JSON对象
  • 内部字段:
{
    code : "",
    msg: ""
}

可用性

iOS、Android系统

可提供的1.0.0及更高版本

showBanner

显示横幅广告

showBanner(callback(ret, err))

示例代码

var demo = api.require('gdtModule');
demo.showBanner(function (ret, err) {
    alert(JSON.stringify(ret) + "  " + JSON.stringify(err));
});

callback(ret, err)

ret:

  • 类型:JSON对象
  • 内部字段:
{
    status: true,   //布尔型;true||false
}

err:

  • 类型:JSON对象
  • 内部字段:
{
    code : "",
    msg: ""
}

可用性

iOS、Android系统

可提供的1.0.0及更高版本

closeBanner

关闭横幅广告

closeBanner(callback(ret, err))

示例代码

var demo = api.require('gdtModule');
demo.closeBanner(function (ret, err) {
    alert(JSON.stringify(ret) + "  " + JSON.stringify(err));
});

callback(ret, err)

ret:

  • 类型:JSON对象
  • 内部字段:
{
    status: true,   //布尔型;true||false
}

err:

  • 类型:JSON对象
  • 内部字段:
{
    code : "",
    msg: ""
}

可用性

iOS、Android系统

可提供的1.0.0及更高版本

showInterstitial

显示插屏广告

showInterstitial({params}, callback(ret, err))

params

posId:

  • 类型:字符串
  • 描述:(必填项)指在 http://e.qq.com/dev/ 生成的数字串,广告位id

示例代码

var demo = api.require('gdtModule');
demo.showInterstitial({
    posId: "4080052898050840",
}, function (ret, err) {
    alert(JSON.stringify(ret) + "  " + JSON.stringify(err));
});

callback(ret, err)

ret:

  • 类型:JSON对象
  • 内部字段:
{
    status: true,   //布尔型;true||false
    evenType : '',//onNoAD
                //onVideoCached
                //onADReceive
                //onADOpened
                //onADLeftApplication
                //onADExposure
                //onADClosed
                //onADClicked
}

err:

  • 类型:JSON对象
  • 内部字段:
{
    code : "",
    msg: ""
}

可用性

iOS、Android系统

可提供的1.0.0及更高版本

closeInterstitial

关闭插屏广告

closeInterstitial(callback(ret, err))

示例代码

var demo = api.require('gdtModule');
demo.closeInterstitial(function (ret, err) {
    alert(JSON.stringify(ret) + "  " + JSON.stringify(err));
});

callback(ret, err)

ret:

  • 类型:JSON对象
  • 内部字段:
{
    status: true,   //布尔型;true||false
}

err:

  • 类型:JSON对象
  • 内部字段:
{
    code : "",
    msg: ""
}

可用性

iOS、Android系统

可提供的1.0.0及更高版本

loadRewardVideoAd

加载激励视频广告

loadRewardVideoAd({params}, callback(ret, err))

params

posId:

  • 类型:字符串
  • 描述:(必填项)指在 http://e.qq.com/dev/ 生成的数字串,广告位id

userId:

  • 类型:字符串
  • 描述:(可选项) 表来标识应用侧唯一用户。

示例代码

var demo = api.require('gdtModule');
demo.loadRewardVideoAd({
    posId: "4080052898050840",
}, function (ret, err) {
    alert(JSON.stringify(ret) + "  " + JSON.stringify(err));
});

callback(ret, err)

ret:

  • 类型:JSON对象
  • 内部字段:
{
    status: true,   //布尔型;true||false
    evenType : '',//onADClick
                //onADClose
                //onADExpose
                //onADLoad
                //onADShow
                //onNoAD
                //onReward
                //onVideoCached
                //onVideoComplete
}

err:

  • 类型:JSON对象
  • 内部字段:
{
    code : "",
    msg: ""
}

可用性

iOS、Android系统

可提供的1.0.0及更高版本

showRewardVideoAd

显示激励视频广告

showRewardVideoAd(callback(ret, err))

示例代码

var demo = api.require('gdtModule');
demo.showRewardVideoAd(function (ret, err) {
    alert(JSON.stringify(ret) + "  " + JSON.stringify(err));
});

callback(ret, err)

ret:

  • 类型:JSON对象
  • 内部字段:
{
    status: true,   //布尔型;true||false
}

err:

  • 类型:JSON对象
  • 内部字段:
{
    code : "",
    msg: ""
}

可用性

iOS、Android系统

可提供的1.0.0及更高版本

loadNativeVideoAd1

加载原生广告1.0

loadNativeVideoAd1({params}, callback(ret, err))

params

posId:

  • 类型:字符串
  • 描述:(必填项)指在 http://e.qq.com/dev/ 生成的数字串,广告位id

adWidth:

  • 类型:数字型
  • 描述:(必填项)广告宽度
  • 默认值:340

adHeight:

  • 类型:数字型
  • 描述:(必填项)广告高度
  • 默认值:-2

示例代码

var demo = api.require('gdtModule');
demo.loadNativeVideoAd1({
    posId: "4080052898050840",
}, function (ret, err) {
    alert(JSON.stringify(ret) + "  " + JSON.stringify(err));
});

callback(ret, err)

ret:

  • 类型:JSON对象
  • 内部字段:
{
    status: true,   //布尔型;true||false
    evenType : '',//onADClicked
                //onADCloseOverlay
                //onADClosed
                //onADExposure
                //onADLeftApplication
                //onADLoaded
                //onADOpenOverlay
                //onRenderFail
                //onRenderSuccess
                //onNoAD
    adEvenType : ''//onVideoCached
                //onVideoComplete
                //onVideoError
                //onVideoInit
                //onVideoLoading
                //onVideoPageClose
                //onVideoPageOpen
                //onVideoPause
                //onVideoReady
                //onVideoStart
}

err:

  • 类型:JSON对象
  • 内部字段:
{
    code : "",
    msg: ""
}

可用性

iOS、Android系统

可提供的1.0.0及更高版本

closeNativeVideoAd1

关闭原生广告1.0

closeNativeVideoAd1(callback(ret, err))

示例代码

var demo = api.require('gdtModule');
demo.closeNativeVideoAd1(function (ret, err) {
    alert(JSON.stringify(ret) + "  " + JSON.stringify(err));
});

callback(ret, err)

ret:

  • 类型:JSON对象
  • 内部字段:
{
    status: true,   //布尔型;true||false
}

err:

  • 类型:JSON对象
  • 内部字段:
{
    code : "",
    msg: ""
}

可用性

iOS、Android系统

可提供的1.0.0及更高版本

fullScreenInterstitial

全屏插屏广告

fullScreenInterstitial({params}, callback(ret, err))

params

posId:

  • 类型:字符串
  • 描述:(必填项)指在 http://e.qq.com/dev/ 生成的数字串,广告位id

示例代码

var demo = api.require('gdtModule');
demo.fullScreenInterstitial({
    posId: "4080052898050840",
}, function (ret, err) {
    alert(JSON.stringify(ret) + "  " + JSON.stringify(err));
});

callback(ret, err)

ret:

  • 类型:JSON对象
  • 内部字段:
{
    status: true,   //布尔型;true||false
    evenType : '',//onNoAD
                //onVideoCached
                //onADReceive
                //onADOpened
                //onADLeftApplication
                //onADExposure
                //onADClosed
                //onADClicked
}

err:

  • 类型:JSON对象
  • 内部字段:
{
    code : "",
    msg: ""
}

可用性

Android系统

可提供的1.0.0及更高版本

setExtraUserData

通过此接口传入地理位置信息或微信openid信息

setExtraUserData({params}, callback(ret, err))

params

lng:

  • 类型:字符串
  • 描述:(可选项)实时的地理位置经度,值为字符串格式的经度值,比如 "116.67765"

lat:

  • 类型:字符串
  • 描述:(可选项)实时的地理位置纬度,值为字符串格式的纬度值,比如 "39.365678"

locTime:

  • 类型:字符串
  • 描述:(可选项)实时的地理位置获取时间,值为字符串格式的 Unix 时间戳,单位秒,比如,"1639450944"

wxOpenId:

  • 类型:字符串
  • 描述:(可选项)微信授权登录后返回的 openid,值为字符串格式

示例代码

var demo = api.require('gdtModule');
demo.setExtraUserData({
    ......
}, function(ret, err){
    alert(JSON.stringify(ret));
});

callback(ret)

ret:

  • 类型:JSON对象
  • 内部字段:
{
    status: true,   //布尔型;true||false
}

可用性

Android系统

可提供的1.0.0及更高版本

是否仍需要帮助? 请保持联络!
最后更新于 2024/05/20