快應(yīng)用 廣告

接口聲明

{"name":"service.ad"}

導(dǎo)入模塊

import ad from '@service.ad' 或 
const ad = require('@service.ad')

接口定義

ad.getProvider()

獲取服務(wù)提供商。

參數(shù)：

無(wú)

返回值：

字符串，服務(wù)提供商的代號(hào)，如廠商的英文品牌名稱(chēng)，假如無(wú)此服務(wù)則返回空字符串

示例：

console.log(ad.getProvider())

注意：廣告的尺寸比例，無(wú)需通過(guò)接口進(jìn)行配置，但各廠商的尺寸不同，開(kāi)發(fā)的時(shí)候需要進(jìn)行區(qū)分

banner廣告

ad.createBannerAd(object)

創(chuàng)建 Banner 廣告組件，如果已經(jīng)創(chuàng)建過(guò) Banner 廣告組件，則返回已創(chuàng)建的廣告組件

參數(shù)

代碼示例：

let bannerAd = ad.createBannerAd({
    adUnitId: 'xxx',
    style:{
        left:0,
        top: 800,
        width:1080
    }
})

style的結(jié)構(gòu)

style說(shuō)明

Banner 廣告組件的尺寸會(huì)根據(jù)開(kāi)發(fā)者設(shè)置的寬度，即 style.width 進(jìn)行等比縮放，縮放的范圍是 designWidth * 50% 到 屏幕寬度。 開(kāi)發(fā)者在創(chuàng)建 BannerAd 時(shí)設(shè)置寬高，也可以在創(chuàng)建后設(shè)置，如：

  bannerAd.style.width = 1000

當(dāng) style.width 小于 designWidth 50% 時(shí)，會(huì)取作 designWidth 50%。 當(dāng) style.width 大于屏幕寬度時(shí)，會(huì)取作屏幕寬度。 在組件內(nèi)部會(huì)以此值為基準(zhǔn)，根據(jù) Banner 廣告的標(biāo)準(zhǔn)尺寸，進(jìn)行縮放。 每當(dāng)縮放發(fā)生且縮放后的尺寸不同時(shí)，通過(guò) BannerAd.onResize() 注冊(cè)的回調(diào)函數(shù)就會(huì)執(zhí)行?；卣{(diào)函數(shù)的參數(shù)是一個(gè)包含 BannerAd 縮放后的寬和高的對(duì)象。BannerAd 的 style.realWidth 和 style.realHeight 到經(jīng)過(guò)縮放后的寬和高。

bannerAd.onResize(res => {
    console.log(res.width, res.height)
    console.log(bannerAd.style.realWidth, bannerAd.style.realHeight)
})

Banner廣告不設(shè)置位置，默認(rèn)在屏幕底部。

返回值

Banner廣告組件

Promise bannerAd.show()

加載展示 banner 廣告，出錯(cuò)的時(shí)候回調(diào) onError，分為加載和展示兩個(gè)階段，加載成功回調(diào) onLoad

返回值

Promise

banner 廣告顯示操作的結(jié)果

Promise bannerAd.hide()

隱藏 banner 廣告

返回值

Promise

banner 廣告隱藏操作的結(jié)果

bannerAd.onError(function callback)

監(jiān)聽(tīng) banner 廣告錯(cuò)誤事件

代碼示例：

bannerAd.onError((err)=>{
    console.log(err)
})

err:Object錯(cuò)誤參數(shù)，其他廣告類(lèi)型相同

bannerAd.offError(function callback)

移除 banner 廣告錯(cuò)誤監(jiān)聽(tīng)

bannerAd.onLoad(function callback)

監(jiān)聽(tīng) banner 廣告加載事件，多個(gè)素材，每次加載新素材，都會(huì)進(jìn)入這個(gè)回調(diào)

bannerAd.offLoad(function callback)

移除 banner 廣告展示監(jiān)聽(tīng)

bannerAd.onClose(function callback)

監(jiān)聽(tīng) banner 廣告關(guān)閉事件

bannerAd.offClose(function callback)

移除 banner 關(guān)閉回調(diào)

bannerAd.onResize(function callback)

監(jiān)聽(tīng) banner 廣告尺寸變化事件

參數(shù)

function callback

banner 廣告尺寸變化事件的回調(diào)函數(shù)

回調(diào)參數(shù)

Object res：

bannerAd.offResize(function callback)

取消監(jiān)聽(tīng) banner 廣告尺寸變化事件

參數(shù)

function callback

banner 廣告尺寸變化事件的回調(diào)函數(shù)，可以為空

bannerAd.destroy()

銷(xiāo)毀 banner 廣告

插屏廣告

ad.createInterstitialAd(object)

創(chuàng)建插屏廣告組件，同一個(gè) adUnitId，如果已經(jīng)創(chuàng)建，并且未 destroy，會(huì)復(fù)用之前的對(duì)象，創(chuàng)建后會(huì)加載廣告素材，素材創(chuàng)建后會(huì)自動(dòng)拉取

參數(shù)

代碼示例：

let interstitialAd = ad.createInterstitialAd({
  adUnitId: 'xxx'
})

返回值

插屏廣告組件

interstitialAd.show()

插屏廣告組件默認(rèn)是隱藏的，調(diào)用 show 方法展示廣告。

返回值

Promise

插屏廣告顯示操作的結(jié)果。

interstitialAd.onLoad(function callback)

監(jiān)聽(tīng)視頻廣告加載成功事件

代碼示例：

interstitialAd.onLoad(()=> {
  console.log("插屏廣告加載成功");
  interstitialAd.show();
})

interstitialAd.offLoad(function callback)

移除插屏廣告加載成功監(jiān)聽(tīng)

interstitialAd.onClose(function callback)

監(jiān)聽(tīng)插屏廣告隱藏事件

interstitialAd.offClose(function callback)

移除插屏廣告隱藏監(jiān)聽(tīng)

interstitialAd.onError(function callback)

監(jiān)聽(tīng)插屏廣告出錯(cuò)事件

代碼示例：

interstitialAd.onError((err)=> {
  console.log(err);
})

interstitialAd.offError(function callback)

移除插屏廣告出錯(cuò)監(jiān)聽(tīng)

interstitialAd.destroy()

銷(xiāo)毀插屏廣告組件

原生廣告

ad.createNativeAd(object)

創(chuàng)建 native 廣告組件，如果已經(jīng)創(chuàng)建過(guò) native 廣告組件，則返回已創(chuàng)建的廣告組件

參數(shù)

代碼示例：

let nativeAd = ad.createNativeAd({
    adUnitId: 'xxx'
})

返回值

原生廣告組件

nativeAd.load()

拉取廣告數(shù)據(jù)，成功回調(diào) onLoad，失敗回調(diào) onError

nativeAd.reportAdShow()

上報(bào)廣告曝光，一個(gè)廣告只有一次上報(bào)有效，adId 為 load 方法獲取的廣告數(shù)據(jù)的 adId 字段

參數(shù)

代碼示例：

nativeAd.reportAdShow({
    adId: "xxx"
})

nativeAd.reportAdClick()

上報(bào)廣告點(diǎn)擊，一個(gè)廣告只有一次上報(bào)有效，adId 為 load 方法獲取的廣告數(shù)據(jù)的 adId 字段

參數(shù)

代碼示例：

nativeAd.reportAdClick({
    adId: "xxx"
})

nativeAd.onLoad(function callback)

設(shè)置廣告加載成功回調(diào)

參數(shù)

返回廣告數(shù)據(jù) adList 是一個(gè) Array 對(duì)象，其中 item 數(shù)據(jù)格式為：

代碼示例：

nativeAd.onLoad(function(res) {
  console.log("原生廣告加載" , res.adList)
})

nativeAd.offLoad(function callback)

移除原生廣告加載成功監(jiān)聽(tīng)

nativeAd.onError(function callback)

監(jiān)聽(tīng)原生廣告錯(cuò)誤事件

代碼示例：

nativeAd.onError((err)=>{
  console.log(err)
})

nativeAd.offError(function callback)

移除原生廣告錯(cuò)誤監(jiān)聽(tīng)

nativeAd.destroy()

銷(xiāo)毀原生廣告

激勵(lì)視頻廣告

激勵(lì)視頻廣告組件是由客戶端原生的圖片、文本、視頻控件組成的，層級(jí)最高，會(huì)覆蓋在普通組件上，該方法返回的是一個(gè)單例，該實(shí)例僅對(duì)當(dāng)前頁(yè)面有效，不允許跨頁(yè)面使用。

ad.createRewardedVideoAd(object)

創(chuàng)建激勵(lì)視頻廣告組件，該廣告頁(yè)面單例，不允許跨頁(yè)面使用。

參數(shù)

代碼示例：

let rewardedVideoAd = ad.createRewardedVideoAd({
    adUnitId: 'xxx'
})

返回值

激勵(lì)視頻廣告組件

rewardedVideoAd.load()

加載激勵(lì)視頻廣告。

返回值

Promise

激勵(lì)視頻廣告顯示操作的結(jié)果。

rewardedVideoAd.show()

顯示激勵(lì)視頻廣告。激勵(lì)視頻廣告將從屏幕下方推入。

返回值

Promise

激勵(lì)視頻廣告顯示操作的結(jié)果。

rewardedVideoAd.onLoad(function callback)

監(jiān)聽(tīng)激勵(lì)視頻廣告加載事件。

參數(shù)

function callback

激勵(lì)視頻廣告加載事件的回調(diào)函數(shù)

rewardedVideoAd.offLoad(function callback)

取消監(jiān)聽(tīng)激勵(lì)視頻廣告加載事件

參數(shù)

function callback

激勵(lì)視頻廣告加載事件的回調(diào)函數(shù)

rewardedVideoAd.onClose(function callback)

監(jiān)聽(tīng)用戶點(diǎn)擊關(guān)閉廣告 按鈕的事件

參數(shù)

function callback

rewardedVideoAd.offClose(function callback)

取消監(jiān)聽(tīng)用戶點(diǎn)擊?關(guān)閉廣告?按鈕的事件

參數(shù)

function callback

用戶點(diǎn)擊?關(guān)閉廣告?按鈕的事件的回調(diào)函數(shù)

rewardedVideoAd.onError(function callback)

監(jiān)聽(tīng)激勵(lì)視頻錯(cuò)誤事件。

參數(shù)

function callback

激勵(lì)視頻錯(cuò)誤事件的回調(diào)函數(shù)

rewardedVideoAd.offError(function callback)

取消監(jiān)聽(tīng)激勵(lì)視頻廣告錯(cuò)誤

參數(shù)

function callback

激勵(lì)視頻錯(cuò)誤事件的回調(diào)函數(shù)

錯(cuò)誤碼信息

錯(cuò)誤碼是通過(guò)onError獲取到的錯(cuò)誤信息。errCode返回值如下表：

后臺(tái)運(yùn)行限制

禁止使用。 后臺(tái)運(yùn)行詳細(xì)用法參見(jiàn) 后臺(tái)運(yùn)行腳本。

支持明細(xì)