ttAd

立即使用

init splash banner bannerExp interaction interactionExp rewardVideo fullScreenVideo close

论坛示例

为帮助用户更好更快的使用模块，论坛维护了一个示例，示例中包含示例代码、知识点讲解、注意事项等，供您参考。

概述

ttAd 封装了今日头条旗下穿山甲sdk，包括banner广告，插屏广告，开屏广告，激励广告，全屏广告等

步骤：先到穿山甲官网https://partner.oceanengine.com/union/media/login/注册账户，创建App应用，创建代码位

Android 需要升级环境编译

init

初始化网盟 sdk。

init()

params

appId

  • 类型：字符串
  • 描述：（必须）必选参数，设置应用的AppId

appName

  • 类型：字符串
  • 描述：（必须）必选参数，设置应用名称

callback(ret, err)

ret：

  • 类型：JSON对象
  • 内部字段：
  2.     {    
  3.         cmd:"init",
  4.         data:'success'
  5.     }

示例代码

  2.     var param = {
  3.         appId:'5001121',
  4.         appName:'穿山甲广告',
  5.     };
  6.     var ttAd = api.require('ttAd');
  7.     ttAd.init(param, function(ret, err){ });

可用性

Android系统，IOS系统

可提供的1.0.0及更高版本

splash

开屏广告建议为用户在进入 App 时展示的全屏广告。

splash()

params

codeId

  • 类型：字符串
  • 描述：广告代码位

callback(ret, err)

ret：

  • 类型：JSON对象
  • 内部字段：
  3.     {    
  4.         cmd:"splash",
  5.         data:'success'
  6.     }

示例代码

  2.     var param={codeId:'801121648'}
  3.     var ttAd = api.require('ttAd');
  4.     ttAd.splash(param,function(ret,err){})

可用性

Android系统，IOS系统

可提供的1.0.0及更高版本

banner

Banner 广告

banner()

params

codeId

  • 类型：字符串
  • 描述：广告代码位

rect

  • 类型：JSON 对象
  • 描述：（必须）广告位置及尺寸
  • 内部字段：
  • {
    • x: 0, //（可选项）数字类型；模块左上角的 x 坐标（相对于所属的 Window 或 Frame）；默认：0
    • y: 0, //（可选项）数字类型；模块左上角的 y 坐标（相对于所属的 Window 或 Frame）；默认：0
    • w: 320, //（可选项）数字类型；模块的宽度；默认：所属的 Window 或 Frame 的宽度
    • h: 300 //（可选项）数字类型；模块的高度；默认：w的3/4 }

callback(ret, err)

ret：

  • 类型：JSON对象
  • 内部字段：
  3.     {    
  4.         cmd:"banner",
  5.         data:'success'//如果pdf文档没有做目录，则会返回来失败
  6.     }

示例代码

  2.     var param = {
  3.         codeId:'901121987',
  4.         rect:{x:0,y:0,w:api.winWidth,h:200}
  5.     };
  6.     var ttAd = api.require('ttAd');
  7.     ttAd.banner(param,function(ret,err){})

可用性

Android系统，IOS系统

可提供的1.0.0及更高版本

bannerExp

个性化模板 Banner 广告

bannerExp()

params

codeId

  • 类型：字符串
  • 描述：广告代码位

rect

  • 类型：JSON 对象
  • 描述：（必须）广告位置及尺寸
  • 内部字段：

  • {

    • x: 0, //（可选项）数字类型；模块左上角的 x 坐标（相对于所属的 Window 或 Frame）；默认：0
    • y: 0, //（可选项）数字类型；模块左上角的 y 坐标（相对于所属的 Window 或 Frame）；默认：0
    • w: 320, //（可选项）数字类型；模块的宽度；默认：所属的 Window 或 Frame 的宽度
    • h: 300 //（可选项）数字类型；模块的高度；默认：w的3/4
  • }

callback(ret, err)

ret：

  • 类型：JSON对象
  • 内部字段：
  3.     {    
  4.         cmd:"bannerExp",
  5.         data:'success'
  6.     }

示例代码

  2.     var param = {
  3.         codeId:'901121246',
  4.         rect:{x:0,y:0,w:api.winWidth,h:200}
  5.     };
  6.     var ttAd = api.require('ttAd');
  7.     ttAd.bannerExp(param,function(ret,err){})

可用性

Android系统，IOS系统

可提供的1.0.0及更高版本

interaction

插屏广告

interaction()

params

codeId

  • 类型：字符串
  • 描述：广告代码位

callback(ret, err)

ret：

  • 类型：JSON对象
  • 内部字段：
  3.     {    
  4.         cmd:"interaction",
  5.         data:'success'
  6.     }

示例代码

  2.     var param = {
  3.         codeId:'901121725',
  4.         rect:{x:0,y:0,w:api.winWidth,h:200}
  5.     };
  6.     var ttAd = api.require('ttAd');
  7.     ttAd.interaction(param,function(ret,err){})

可用性

Android系统，IOS系统

可提供的1.0.0及更高版本

interactionExp

个性化模板插屏

interactionExp()

params

codeId

  • 类型：字符串
  • 描述：广告代码位

rect

  • 类型：JSON 对象
  • 描述：（必须）广告位置及尺寸
  • 内部字段：

  • {

    • x: 0, //（可选项）数字类型；模块左上角的 x 坐标（相对于所属的 Window 或 Frame）；默认：0
    • y: 0, //（可选项）数字类型；模块左上角的 y 坐标（相对于所属的 Window 或 Frame）；默认：0
    • w: 320, //（可选项）数字类型；模块的宽度；默认：所属的 Window 或 Frame 的宽度
    • h: 300 //（可选项）数字类型；模块的高度；默认：w的3/4
  • }

callback(ret, err)

ret：

  • 类型：JSON对象
  • 内部字段：
  3.     {    
  4.         cmd:"interactionExp",
  5.         data:'success'
  6.     }

示例代码

  2.     var param = {
  3.         codeId:'901121417',
  4.         rect:{x:0,y:0,w:api.winWidth,h:200}
  5.     };
  6.     var ttAd = api.require('ttAd');
  7.     ttAd.interactionExp(function(ret,err){})

可用性

Android系统，IOS系统

可提供的1.0.0及更高版本

rewardVideo

激励视频广告，该广告的效果为观看完毕视频广告，发放奖励给用户。

rewardVideo()

params

codeId

  • 类型：字符串
  • 描述：激励视频广告代码位

rName

  • 类型：字符串
  • 描述：奖励的名称

rAmount

  • 类型：数值型
  • 描述：奖励的数量

userId

  • 类型：字符串
  • 描述：用户id

extra

  • 类型：字符串
  • 描述：附加参数，可选

callback(ret, err)

ret：

  • 类型：JSON对象
  • 内部字段：
  3.     {    
  4.         cmd:"rewardVideo",
  5.         data:'success'
  6.     }

示例代码

  2.     var param={
  3.         codeId:'901121365',
  4.         rName:'金币',
  5.         rAmount:3,
  6.         userId:'user123',
  7.         extra:'media_extra'
  8.     }
  9.     var ttAd = api.require('ttAd');
  10.     ttAd.rewardVideo(param,function(ret,err){})

可用性

Android系统，IOS系统

可提供的1.0.0及更高版本

fullScreenVideo

全屏视频是全屏展示视频广告的广告形式，用户可选择在不同场景插入对应广告

fullScreenVideo()

params

codeId

  • 类型：字符串
  • 描述：全屏视频广告代码位

callback(ret, err)

ret：

  • 类型：JSON对象
  • 内部字段：
  3.     {    
  4.         cmd:"fullScreenVideo",
  5.         data:'success'
  6.     }

示例代码

  2.     var param={
  3.         codeId:'901121375',
  4.     }
  5.     var ttAd = api.require('ttAd');
  6.     ttAd.fullScreenVideo(function(ret,err){})

可用性

Android系统，IOS系统

可提供的1.0.0及更高版本

close

移除所有广告视图，释放内存。

close()

callback(ret, err)

ret：

  • 类型：JSON对象
  • 内部字段：
  3.     {    
  4.         cmd:"close",
  5.         data:'success'
  6.     }

示例代码

  2.     var ttAd = api.require('ttAd');
  3.     ttAd.close(function(ret,err){})

可用性

Android系统，IOS系统

可提供的1.0.0及更高版本