adhub

来自于:adhub 立即使用


模块方法


模块概述

adhub模块是由adhub提供的广告接入模块,封装了广告的接入和加载。用户可以使用该模块完成广告的接入和加载,并实现广告收益。使用前请先与adhub联系,或去adhub官网注册获取appid和spaceid

注意,使用Android模块编译时需要勾选升级环境。


模块方法接口描述


adhubInit

adhub模块初始化 adhubInit({appid:”xxx”});

appid:

  • 类型:字符型
  • 默认值:无
  • 描述:在adhub平台申请的应用的唯一ID

示例:

  1. adhub.adhubInit({appid:"277"});

方法可用性

支持Android3.0,iOS7.0及以上系统。

showSplashAd

展示开屏广告 showSplashAd({spaceid:”xxx”},resultCallback);

spaceid:

  • 类型:字符型
  • 默认值:无
  • 描述:在adhub平台申请的应用广告位的ID

resultCallback(ret ,err)

ret:

  • 类型:json对象

内部字段:

{

  1. msg //成功的提示信息

}

err:

  • 类型:json对象

内部字段:

{ errorCode: //广告获取失败的错误码 }

示例:

  1. adhub.showSplashAd({spaceid:"974"});

方法可用性

支持Android3.0,iOS7.0及以上系统。

showBannerAd

展示横幅广告 showBannerAd({spaceid:”xxx”,centerY:”xxx”},resultCallback);

spaceid:

  • 类型:字符型
  • 默认值:无
  • 描述:在adhub平台申请的应用广告位的ID

centerY:

  • 类型:整形
  • 默认值:0
  • 描述:横幅广告Y轴向下偏移的位置,默认在顶部

resultCallback(ret ,err)

ret:

  • 类型:json对象

内部字段:

{

  1. msg //成功的提示信息

}

err:

  • 类型:json对象

内部字段:

{

  1. errorCode //广告获取失败的错误码

}

示例:

  1. adhub.showBannerAd({spaceid:"942",centerY:"0"})

方法可用性

支持Android3.0,iOS7.0及以上系统。

closeBannerAd

关闭当前页面横幅广告(一个页面只允许一个横幅广告出现) closeBannerAd();

示例:

  1. adhub.closeBannerAd();

方法可用性

支持Android3.0,iOS7.0及以上系统。

showInsertAd

展示插屏广告 showInsertAd({spaceid:”946”},resultCallback);

spaceid:

  • 类型:字符型
  • 默认值:无
  • 描述:在adhub平台申请的应用广告位的ID

    resultCallback(ret ,err)

    ret:

  • 类型:json对象

内部字段:

{

  1. msg //成功的提示信息

}

err:

  • 类型:json对象

内部字段:

{

  1. errorCode //广告获取失败的错误码

}

示例:

  1. adhub.showInsertAd({spaceid:"946"});

方法可用性

支持Android3.0,iOS7.0及以上系统。

showRewardVideoAd

展示激励视频广告 showRewardVideoAd({spaceid:”978”},resultCallback);

spaceid:

  • 类型:字符型
  • 默认值:无
  • 描述:在adhub平台申请的应用广告位的ID

    resultCallback(ret ,err)

    ret:

  • 类型:json对象

内部字段:

{

  1. msg //成功的提示信息

}

err:

  • 类型:json对象

内部字段:

{

  1. errorCode //广告获取失败的错误码

}s

示例:

  1. adhub.showRewardVideoAd({spaceid:"978"})

方法可用性

支持Android3.0,iOS7.0及以上系统。

showNativeAd

加载原生广告(原生广告就是广告只是将广告的内容返回给开发者,由开发者自己去决定怎么展示返回的广告素材内容) showNativeAd({spaceid:”979”},resultCallback)

spaceid:

  • 类型:字符型
  • 默认值:无
  • 描述:在adhub平台申请的应用广告位的ID

resultCallback(ret ,err)

ret:

  • 类型:json对象

内部字段:

{

  1. imageurl //广告图片素材的URL地址
  2. impurl //广告素材的展示曝光地址
  3. clickurl //广告素材的点击曝光地址
  4. pageurl //广告素材的点击跳转地址

}

err:

  • 类型:json对象

内部字段:

{

  1. errorCode //广告获取失败的错误码

}

示例:

  1. var resultCallback = function(ret, err){
  2. document.getElementById("image").src=ret["imageurl"];
  3. document.getElementById("image").addEventListener("click", function() {
  4. var obj=ret["clickurl"]
  5. adhub.sendTracker({urls:obj})
  6. var pageurl=ret["pageurl"]
  7. adhub.jumpLandingPage({pageurl:pageurl})
  8. });
  9. var obj=ret["impurl"]
  10. adhub.sendTracker({urls:obj})
  11. };
  12. adhub.showNativeAd({spaceid:"979"},resultCallback);

方法可用性

支持Android3.0以上。iOS参考下面iOS的原生

sendTracker

发送曝光事件 sendTracker({urls:”xxx”});(仅限原生广告)

urls:

  • 类型:json字符串
  • 默认值:无
  • 描述:在原生native广告回调中通过”clickurl”或者”impurl”获取的json字符串

示例:

  1. var resultCallback = function(ret, err){
  2. document.getElementById("image").src=ret["imageurl"];
  3. document.getElementById("image").addEventListener("click", function() {
  4. var obj=ret["clickurl"]
  5. adhub.sendTracker({urls:obj}) //此处调用发送点击事件
  6. var pageurl=ret["pageurl"]
  7. adhub.jumpLandingPage({pageurl:pageurl})
  8. });
  9. var obj=ret["impurl"]
  10. adhub.sendTracker({urls:obj}) //此处调用发送曝光事件
  11. };
  12. adhub.showNativeAd({spaceid:"979"},resultCallback);

方法可用性

支持Android3.0以上。

jumpLandingPage

跳转landingpage页面 jumpLandingPage({pageurl:”xxx”});(仅限原生广告)

pageurl:

  • 类型:json字符串
  • 默认值:无
  • 描述:在原生native广告回调中通过”pageurl”获取的json字符串

示例:

  1. var resultCallback = function(ret, err){
  2. document.getElementById("image").src=ret["imageurl"];
  3. document.getElementById("image").addEventListener("click", function() {
  4. var obj=ret["clickurl"]
  5. adhub.sendTracker({urls:obj})
  6. var pageurl=ret["pageurl"]
  7. adhub.jumpLandingPage({pageurl:pageurl}) //此处调用,点击广告图片的时候进行跳转
  8. });
  9. var obj=ret["impurl"]
  10. adhub.sendTracker({urls:obj})
  11. };
  12. adhub.showNativeAd({spaceid:"979"},resultCallback);

方法可用性

支持Android3.0以上。

原生广告iOS

showNativeAd ## iOS版本

加载原生广告

  1. index: 原生广告被点击时,需要点击曝光,当有多个原生广告位时,index为曝光的是那一个广告位。index从callback回调里面获取
  2. 原生广告请求成功后会返回 jsonString, 开发者可以自行解析并展示原生相关信息。
  3. 开发者需要再原生广告页面的角落添加 “广告” 字样。
  4. 用户点击原生广告时需要开发者调用sendTracker并传递从callback回调里面获取的index。

showNativeAd({spaceid:”979”},resultCallback)

spaceid:

  • 类型:字符型
  • 默认值:无
  • 描述:在adhub平台申请的应用广告位的ID

callback(ret,err)

ret :

  1. - 类型:JSON对象
  2. - 内部字段:

{

  1. msg //提示信息
  2. nativeData //广告素材信息

nativeData 字段:仅限于原生广告时才会返回此字段 { “Images”: // 图片数组 “Texts”: // 文本数组 “index” : // 若请求多次原生,index记录当前请求原生广告数据信息,需要在调用点击曝光时回传给SDK。 } }

示例代码:

  1. function showNativeAd () {
  2. var demo = api.require('adhub');
  3. demo.showNativeAd({
  4. spaceid: "940"
  5. }, function(ret, err) {
  6. if (ret) {
  7. alert(JSON.stringify(ret));
  8. }
  9. });
  10. }

方法可用性

支持iOS7.0以上。

sendTracker## iOS版本

发送曝光事件 sendTracker({index:”xxx”});(仅限原生广告)

index:

  • 类型:整型
  • 默认值:无
  • 描述: 若请求多次原生,index记录当前请求原生广告数据信息,需要在调用点击曝光时回传给SDK。

示例代码:

  1. function sendTracker () {
  2. var demo = api.require('adhub');
  3. demo.sendTracker({
  4. index:0
  5. });
  6. }

方法可用性

支持iOS7.0以上。

错误码定义

错误码数字码描述
ERROR_CODE_INTERNAL_ERROR0无效的请求
ERROR_CODE_INVALID_REQUEST1广告请求成功,但没有广告素材内容
ERROR_CODE_NETWORK_ERROR2网络错误
ERROR_CODE_NO_FILL3广告服务器返回了错误信息
ERROR_CODE_NOT_READY_TO_REQUEST4内部错误
ERROR_CODE_INVALID_ARGUMENT5无效的参数