yyAds

概述

YYAds 聚合了众多知名广告联盟,并且模块囊括了开屏、插屏、信息流、全屏视频、激励视屏、Draw、横幅等当下热门的广告样式,使用前需前往注册开发者账号并创建应用获取并应用相关信息。

在集成广告模块前需要先配置config.xml文件,配置通过云端编译生效,配置方法如下:

<feature name="yyAds">
    <param name="appId" value="请填写注册应用成功后从游易官网获取的应用ID"/>
    <param name="appName" value="您的应用名"/>
    <!-- 测试阶段打开,可以通过日志排查问题,上线时可设置为false -->
    <param name="debug" value="true"/>
    <!-- 设置渠道号,渠道号信息主要用来协助平台提升流量变现效果及您的收益,请如实填写 -->
    <param name="channel" value="5"/>
    <!-- 是否支持多进程,true支持,若项目为单进程则必须为false,若单个进程多次初始化,则会以第一次为准 -->
    <param name="supportMultiProcess" value="false"/>
</feature>

渠道号对应表

渠道号 渠道名
1 百度
2 头条
3 广点通
4 搜狗
5 其他网盟
6 Oppo
7 Vivo
8 华为
9 应用宝
10 小米
11 金立
12 百度手机助手
13 魅族
14 AppStore
999 其他

Android 广告模块最低支持到 4.1 版本, 若版本过低, 可能会导致部分功能无法使用
使用模块前请先到游易官网注册账号、新建应用、新建广告位。

模块接口

Splash模块

通过调用 loadSplashAd({params},callback(success,error)) 加载开屏广告

参数说明

params

placementId:

类型: String
描述: 广告位id(必填)

timeout:

类型: Int
描述: 开屏广告加载超时,默认3500, 单位ms

x, y:

类型: Int
描述: 开屏广告展开位置

w, h:

类型: Int
描述: 开屏广告展开大小, 传0则打开全屏
注意: 展开大小, width =屏幕宽;height需要>=75%屏幕高 ,否则会影响计费以及广告填充

calback

success:

类型: JSON对象, 包含以下字段

{
    status: "onAdShow" / "onAdClicked" / "onAdCanceled" / "onTimeOut" 
}

error:

类型: JSON对象, 包含以下字段

{
    status: "onError",
    code: 0,  //Int类型, 错误码
    msg: ""  //String类型, 错误信息
}

示例代码

yyAds = api.require('yyAds');
function showSplash(){
    var params = {
        placementId: "广告位Id",
        timeout: 3500,
        x: 0, 
        y: 0,
        w: 0,
        h: 0
    }
    yyAds.loadSplashAd(params, function(success,error){
        var result = success || error
        console.log(JSON.stringify(result))
    });
}

可用性

Android系统, 可提供的1.0.0及更高版本

通过调用 loadBannerAd(params, callback(success,error)) 加载Banner广告

参数说明

params

placementId:

类型: String
描述: 广告位id(必填)

isCarousel:

类型: Boolean
描述: 是否轮播, 默认false

x, y:

类型: Int
描述: banner广告展开位置

w, h:

类型: Int
描述: banner广告展开大小, 单位dp, w传0 获取屏幕宽度
注意: 展开大小请按照平台勾选的比例去进行请求, 若请求比例与创建广告位时选择的尺寸不一致时, 可能会出现展示异常

calback

success:

类型: JSON对象, 包含以下字段

{
    status: "onLoaded" / "onAdShow" / "onClicked" / "onClosed" / "onDislikeShow" / "onDislikeCanceled" / "onShowAdOverLay" / "onAdCloseOverLay"
}

error:

类型: JSON对象, 包含以下字段

{
    status: "onError",
    code: 0,  //Int类型, 错误码
    msg: ""  //String类型, 错误信息
}

示例代码

yyAds = api.require('yyAds');
function showBanner(){
    var params = {
        placementId: "广告位Id",
        isCarousel: true,
        x: 0, 
        y: 0,
        w: 0,
        h: 94
    }
    yyAds.loadBannerAd(params, function(success,error){
        var result = success || error
        console.log(JSON.stringify(result))
    });
}

可用性

Android系统, 可提供的1.0.0及更高版本

插屏广告模块

通过调用 loadInterstitialAd(params, function(success,error)) 加载插屏广告

参数说明

params

placementId:

类型: String
描述: 广告位id(必填)

isVertical:

类型: Boolean
描述: 是否为竖屏插屏, true表示竖屏插屏, false表示横屏插屏, 请与平台申请广告位时的配置填写一致

calback

success:

类型: JSON对象, 包含以下字段

{
    status: "onAdLoaded" / "onAdCached" / "onAdShow" / "onAdClicked" / "onAdClosed" / "onVideoComplete"
}

error:

类型: JSON对象, 包含以下字段

{
    status: "onError",
    code: 0,  //Int类型, 错误码
    msg: ""  //String类型, 错误信息
}

示例代码

yyAds = api.require('yyAds');
function showInterstitial(){
    var params = {
        placementId: "广告位Id",
        isVertical: true
    }
    yyAds.loadInterstitialAd(params, function(success,error){
        var result = success || error
        console.log(JSON.stringify(result))
    });
}

可用性

Android系统, 可提供的1.0.0及更高版本

全屏视频广告模块

通过调用 loadFullscreenVideoAd(params, function(success,error)) 加载全屏视频广告

参数说明

params

placementId:

类型: String
描述: 广告位id(必填)

isVertical:

类型: Boolean
描述: 是否为竖屏插屏, true表示竖屏插屏, false表示横屏插屏, 请与平台申请广告位时的配置填写一致

calback

success:

类型: JSON对象, 包含以下字段

{
    status: "onAdLoaded" / "onAdCached" / "onAdShow" / "onAdClicked" / "onAdSkipped" / "onAdComplete" / "onAdClosed" 
}

error:

类型: JSON对象, 包含以下字段

{
    status: "onError",
    code: 0,  //Int类型, 错误码
    msg: ""  //String类型, 错误信息
}

示例代码

yyAds = api.require('yyAds');
function showFullscreenVideo(){
    var params = {
        placementId: "广告位id",
        isVertical: true
    }
    yyAds.loadFullscreenVideoAd(params, function(success,error){
        var result = success || error
        console.log({msg: JSON.stringify(result)})
    });
}

可用性

Android系统, 可提供的1.0.0及更高版本

激励视频广告模块

通过调用 loadRewardVideoAd(params, function(success,error)) 加载激励视频广告

参数说明

params

placementId:

类型: String
描述: 广告位id(必填)

userId:

类型: String
描述: 设置用户ID, 服务端透传信息,若未设置服务端回调,可忽略

customData:

类型: String
描述: 设置自定义数据,服务端透传信息,若未设置服务端回调,可忽略

scenes:

类型: String
描述: 设置广告场景, (只在游易创意模板2广告位生效,请与平台选择保持一致,其他模板广告位可忽略)

orientation:

类型: Int
描述: 设置广告展示方向数据,传 1: 代表竖屏, 2: 代表横屏, 请与平台申请广告位时配置保持一致

calback

success:

类型: JSON对象, 包含以下字段

{
    status: "onADComplete" / "onADLoaded" / "onADShow" / "onClosed" / "onReward" / "onSKipVideo" / "onVideoBarClick" / "onVideoCached"
}

status 返回 onReward 时还会拼接以下字段
onReward 字段说明

字段 说明
verify 是否有效, 开发者可通过此参数决定是否发放奖励
rewardAmount 奖励数量,平台创建广告位时配置的数值
rewardName 奖励名称,平台创建广告位时配置的数值
errorCode 附加码
errorMsg 附加信息
map 游易创意模板2广告位,服务端验证参数

error:

类型: JSON对象, 包含以下字段

{
    status: "onError",
    code: 0,  //Int类型, 错误码
    msg: ""  //String类型, 错误信息
}

示例代码

yyAds = api.require('yyAds');
function showRewardVideo(){
    var params = {
        placementId: "广告位id",
        userId: "",
        customData: "",
        scenes: "",
        orientation: 1
    }
    yyAds.loadRewardVideoAd(params, function(success,error){
        var result = success || error
        console.log({msg: JSON.stringify(result)})
    });
}

可用性

Android系统, 可提供的1.0.0及更高版本

信息流广告

通过调用 loadNativeStreamAd(params, function(success,error)) 加载信息流视频广告

参数说明

params

placementId:

类型: String
描述: 广告位id(必填)

w, h:

类型: Int
描述: 信息流广告展开大小, 单位dp, w传0 获取屏幕宽度, h传0 高度自适应

calback

success:

类型: JSON对象, 包含以下字段

{
    status: "onAdLoaded", 
}

error:

类型: JSON对象, 包含以下字段

{
    status: "onError",
    code: 0,  //Int类型, 错误码
    msg: ""  //String类型, 错误信息
}

status 返回 onAdLoaded 时调用 renderNativeStream(layoutParams,function(success,error)) 渲染广告

layoutParams

x, y:

类型: Int
描述: 信息流广告展开位置

calback

success:

类型: JSON对象, 包含以下字段

{
    status: "onAdClicked" / "onAdClosed" / "onAdShow" / "onRenderSuccess" / "onVideoAdLoad" / "onVideoAdStartPlay" / "onVideoAdPaused" / "onVideoAdComplete" 
}

error:

类型: JSON对象, 包含以下字段

{
    status: "onRenderFailed" / "onVideoAdError" ,
    code: 0,  //Int类型, 错误码
    msg: ""  //String类型, 错误信息
}

示例代码

yyAds = api.require('yyAds');
function showNativeStream(){
    var params = {
        placementId: "广告位id",
        w: 0,
        h: 0,
    }
    yyAds.loadNativeStreamAd(params,function(success,error){
        var result = success || error
        var status = result["status"]
        yyAds.log({msg: JSON.stringify(result)})
        if(status === "onAdLoaded"){
            alert('获取成功');
            renderNativeStream()
        }
    });
}
function renderNativeStream(){
    var layoutParams = {
            x: 0,
            y: 0,
    }
    yyAds.renderNativeStream(layoutParams, function(success,error){
        var result = success || error
        console.log({msg: JSON.stringify(result)})
    });
}

可用性

Android系统, 可提供的1.0.0及更高版本

Draw信息流

通过调用 loadDrawNativeStreamAd(params, function(success,error)) 加载信Draw息流视频广告

参数说明

params

placementId:

类型: String
描述: 广告位id(必填)

w, h:

类型: Int
描述: 信息流广告展开大小, 单位dp, w传0 获取屏幕宽度, h传0 获取屏幕高度

calback

success:

类型: JSON对象, 包含以下字段

{
    status: "onAdLoaded" 
}

error:

类型: JSON对象, 包含以下字段

{
    status: "onError",
    code: 0,  //Int类型, 错误码
    msg: ""  //String类型, 错误信息
}

status 返回 onAdLoaded 时调用 renderDrawStream(layoutParams,function(success,error)) 渲染广告

layoutParams

x, y:

类型: Int
描述: Draw信息流广告展开位置

calback

success:

类型: JSON对象, 包含以下字段

{
    status: "onAdClicked" / "onAdClosed" / "onAdShow" / "onRenderSuccess" / "onVideoAdLoad" / "onVideoAdStartPlay" / "onVideoAdPaused" / "onVideoAdComplete" 
}

error:

类型: JSON对象, 包含以下字段

{
    status: "onRenderFailed" / "onVideoAdError" / "noData",
    code: 0,  //Int类型, 错误码
    msg: ""  //String类型, 错误信息
}

示例代码

yyAds = api.require('yyAds');
function showNativeStream(){
    var params = {
        placementId: "广告位id",
        w: 0,
        h: 0,
    }
    yyAds.loadNativeStreamAd(params,function(success,error){
        var result = success || error
        var status = result["status"]
        yyAds.log({msg: JSON.stringify(result)})
        if(status === "onAdLoaded"){
            alert('获取成功');
            renderNativeStream()
        }
    });
}
function renderNativeStream(){
    var layoutParams = {
            x: 0,
            y: 0,
    }
    yyAds.renderNativeStream(layoutParams, function(success,error){
        var result = success || error
        console.log({msg: JSON.stringify(result)})
    });
}

可用性

Android系统, 可提供的1.0.0及更高版本