广告-开放能力-快游戏-快游戏

注意

该功能依赖鲸鸿动能SDK提供服务，鲸鸿动能SDK可能会收集用户的个人数据。请在快游戏中使用该功能之前，告知用户将收集个人数据，并引导用户阅读相应的隐私政策。

接口定义

展开

接口	描述
consent接口
qg.setUnderAgeOfPromise(boolean underAgeOfPromise)	设置未达到法定承诺年龄用户的标记。
qg.requestConsentUpdate(Object object)	请求用户意见更新状态。
qg.setConsentStatus(number consentStatus)	设置用户意见。
qg.setTagForChildProtection(number childProtection)	设置儿童保护标签。
qg.setTagForUnderAgeOfPromise(number underAgeOfPromiseStr)	设置广告是否按适合未达到法定承诺年龄用户的方式来处理广告请求的标识。
qg.setAdContentClassification(string adContentClassification)	设置广告内容分级上限。
qg.setNonPersonalizedAd(number personalizedAd)	设置是否请求非个性化广告。
原生广告接口
qg.createNativeAd(Object object)	创建 native 广告组件，如果已经创建过 native 广告组件，则返回已创建的广告组件。
nativeAd.load()	拉取广告数据。
nativeAd.reportAdShow()	上报广告曝光，一个广告只有一次上报有效，adId 为 load 方法获取的广告数据的 adId 字段。
nativeAd.reportAdClick()	上报广告点击，一个广告只有一次上报有效，adId 为 load 方法获取的广告数据的 adId 字段。
nativeAd.onLoad(function callback)	设置广告加载成功回调。
nativeAd.offLoad()	移除原生广告加载成功监听。
nativeAd.onError(function callback)	监听原生广告错误事件。
nativeAd.offError()	移除原生广告加载错误监听。
nativeAd.setTagForChildProtection(number childProtection)	设置儿童保护标签。
nativeAd.setTagForUnderAgeOfPromise(number underAgeOfPromiseStr)	设置面向未达到法定承诺年龄用户标签。
nativeAd.setAdContentClassification(string adContentClassification)	设置广告内容分级上限。
nativeAd.setNonPersonalizedAd(number personalizedAd)	设置是否请求非个性化广告。
nativeAd.startDownload(Object object)	去广告落地页下载原生广告对应的应用
nativeAd.showDownloadButton(Object object)	显示控件按钮，adId为load方法获取的广告数据的adId字段。
nativeAd.hideDownloadButton(Object object)	隐藏控件按钮，adId为load方法获取的广告数据的adId字段。
nativeAd.destroy()	销毁原生广告。
激励视频广告接口
qg.createRewardedVideoAd(Object object)	创建激励视频广告。
rewardedVideoAd.load()	手动拉取广告，用于刷新广告。
rewardedVideoAd.show()	激励视频广告组件默认是隐藏的，调用 show 方法展示广告。
rewardedVideoAd.onLoad(function callback)	设置广告加载成功回调。
rewardedVideoAd.offLoad()	移除激励视频广告加载成功监听。
rewardedVideoAd.onClose(function callback)	监听激励视频广告关闭事件。只有在用户主动关闭激励视频广告时，广告才会关闭。
rewardedVideoAd.offClose()	移除激励视频广告关闭监听。
rewardedVideoAd.onError(function callback)	监听激励视频广告加载错误事件。
rewardedVideoAd.offError()	移除激励视频广告加载错误监听。
rewardedVideoAd.setTagForChildProtection(number childProtection)	设置儿童保护标签。
rewardedVideoAd.setTagForUnderAgeOfPromise(number underAgeOfPromiseStr)	设置面向未达到法定承诺年龄用户标签。
rewardedVideoAd.setAdContentClassification(string adContentClassification)	设置广告内容分级上限。
rewardedVideoAd.setNonPersonalizedAd(number personalizedAd)	设置是否请求非个性化广告。
rewardedVideoAd.destroy()	销毁激励视频广告。
Banner广告
qg.createBannerAd(Object object)	创建 Banner 广告组件，如果已经创建过 Banner 广告组件，则返回已创建的广告组件。
bannerAd.show()	加载展示banner广告。
bannerAd.hide()	隐藏 banner 广告。
bannerAd.onError(function callback)	监听 banner 广告错误事件。
bannerAd.offError()	移除 banner 广告错误监听。
bannerAd.onLoad(function callback)	监听 banner 广告加载事件。
bannerAd.offLoad()	移除 banner 广告加载事件。
bannerAd.onClose(function callback)	监听 banner 广告关闭事件。
bannerAd.offClose()	移除 banner 广告关闭事件
bannerAd.destroy()	销毁 banner 广告。
插屏广告接口
qg.createInterstitialAd(Object object)	增加插屏广告的内容。
interstitialAd.load()	加载插屏视频广告。
interstitialAd.show()	显示插屏视频广告。
interstitialAd.onLoad(function callback)	监听插屏广告加载事件。
interstitialAd.offLoad()	移除插屏广告加载事件。
interstitialAd.onError(function callback)	监听插屏广告错误事件。
interstitialAd.offError()（1078+）	移除插屏广告错误监听。
interstitialAd.onClose(function callback)	监听插屏广告关闭事件。
interstitialAd.offClose()	移除插屏广告关闭事件。
interstitialAd.onClick(function callback)	监听插屏广告点击事件。
interstitialAd.offClick()	移除插屏广告点击监听。
interstitialAd.destroy()	销毁插屏广告。

qg.setUnderAgeOfPromise(boolean underAgeOfPromise)（1077+）

描述
设置未达到法定承诺年龄用户的标记。
参数
展开
参数

类型

必填(M)/选填(O)

说明
underAgeOfPromise

boolean

M

true表示对未达到法定承诺年龄用户的标记。
false表示对已达到法定承诺年龄用户的标记。
示例代码
收起
自动换行
深色代码主题
复制
```
qg.setUnderAgeOfPromise(true)
```

参数	类型	必填(M)/选填(O)	说明
underAgeOfPromise	boolean	M	true表示对未达到法定承诺年龄用户的标记。 false表示对已达到法定承诺年龄用户的标记。

qg.requestConsentUpdate(Object object)（1077+）

描述
请求用户意见更新状态。

参数

展开

参数	类型	必填(M)/选填(O)	说明
success	function	O	请求用户意见更新状态成功，请参见success回调函数参数。
fail	function	O	请求用户意见更新状态失败。
complete	function	O	若有函数传入，将在成功、失败后调用该函数。

success回调函数参数

展开

参数	类型	说明
consentStatus	number	用户意见状态。 0：用户已同意接收个性化广告与非个性化广告。 1：用户已同意仅接收非个性化广告。 2：用户既未同意接收也未拒绝接收个性化广告或非个性化广告。
isNeedConsent	boolean	是否需要用户确认意见。取值为false，表明可以向鲸鸿动能SDK请求个性化广告。取值为true，表明用户在欧洲经济区内或其他敏感地区，需进一步确认用户意见。
AdProviderList	array	广告技术提供商信息列表。AdProvider对象结构详见AdProvider参数。

参数

类型

说明

consentStatus

number

用户意见状态。

0：用户已同意接收个性化广告与非个性化广告。
1：用户已同意仅接收非个性化广告。
2：用户既未同意接收也未拒绝接收个性化广告或非个性化广告。

isNeedConsent

boolean

是否需要用户确认意见。

取值为false，表明可以向鲸鸿动能SDK请求个性化广告。
取值为true，表明用户在欧洲经济区内或其他敏感地区，需进一步确认用户意见。

AdProviderList

array

广告技术提供商信息列表。AdProvider对象结构详见AdProvider参数。

AdProvider参数

展开

参数	定义
id	广告技术提供商的ID。
name	广告技术提供商的名称。
serviceArea	广告技术提供商的服务地。
privacyPolicyUrl	广告技术提供商的隐私政策链接URL。

示例代码

收起
自动换行
深色代码主题
复制
qg.requestConsentUpdate({
  success: function(data) {
    console.log('requestConsentUpdate success data ' + JSON.stringify(data))
  },
  fail: function(data) {
    console.log('requestConsentUpdate fail data ' + JSON.stringify(data))
  },
  complete: function() {},
})

qg.setConsentStatus(number consentStatus)（1077+）

描述
设置用户意见。

参数

展开

参数	类型	必填(M)/选填(O)	说明
consentStatus	number	M	用户意见。 0：PERSONALIZED 用户已同意接收个性化广告与非个性化广告。 1：NON_PERSONALIZED 用户已同意仅接收非个性化广告。 2：UNKNOWN 用户既未同意接收也未拒绝接收个性化广告或非个性化广告。

参数

类型

必填(M)/选填(O)

说明

consentStatus

number

用户意见。

0：PERSONALIZED 用户已同意接收个性化广告与非个性化广告。
1：NON_PERSONALIZED 用户已同意仅接收非个性化广告。
2：UNKNOWN 用户既未同意接收也未拒绝接收个性化广告或非个性化广告。

示例代码
收起
自动换行
深色代码主题
复制
```
qg.setConsentStatus(1)
```

qg.setTagForChildProtection(number childProtection) (1078+)

描述
设置儿童保护标签。

参数

展开

参数	类型	必填(M)/选填(O)	说明
childProtection	number	M	儿童保护标签。 -1：您不希望表明您的广告内容是否需要符合COPPA的规定。 0：表明您的广告内容不需要符合COPPA的规定。 1：表明您的广告内容需要符合COPPA的规定（该广告请求无法获取到任何广告）。

参数

类型

必填(M)/选填(O)

说明

childProtection

number

儿童保护标签。

-1：您不希望表明您的广告内容是否需要符合COPPA的规定。
0：表明您的广告内容不需要符合COPPA的规定。
1：表明您的广告内容需要符合COPPA的规定（该广告请求无法获取到任何广告）。

示例代码
收起
自动换行
深色代码主题
复制
```
qg.setTagForChildProtection(1)
```

qg.setTagForUnderAgeOfPromise(number underAgeOfPromiseStr) (1078+)

描述
设置广告是否按适合未达到法定承诺年龄用户的方式来处理广告请求的标识。

参数

展开

参数	类型	必填(M)/选填(O)	说明
underAgeOfPromiseStr	number	M	是否按适合未达到法定承诺年龄用户的方式来处理广告请求。 -1: 表明您尚未指定是否按适合未达到法定承诺年龄用户的方式来处理广告请求。 0: 表明您不希望按适合未达到法定承诺年龄用户的方式来处理广告请求。 1: 表明您希望按适合未达到法定承诺年龄用户的方式来处理广告请求。

参数

类型

必填(M)/选填(O)

说明

underAgeOfPromiseStr

number

是否按适合未达到法定承诺年龄用户的方式来处理广告请求。

-1: 表明您尚未指定是否按适合未达到法定承诺年龄用户的方式来处理广告请求。
0: 表明您不希望按适合未达到法定承诺年龄用户的方式来处理广告请求。
1: 表明您希望按适合未达到法定承诺年龄用户的方式来处理广告请求。

示例代码
收起
自动换行
深色代码主题
复制
```
qg.setTagForUnderAgeOfPromise(1)
```

qg.setAdContentClassification(string adContentClassification) (1078+)

描述
设置广告内容分级上限。

参数

展开

参数	类型	必填(M)/选填(O)	说明
adContentClassification	string	M	广告内容类型。 W：适合幼儿及以上年龄段观众的内容。 PI：适合少儿及以上年龄段观众的内容。 J：适合青少年及以上年龄段观众的内容。 A：仅适合成人观众的内容。

参数

类型

必填(M)/选填(O)

说明

adContentClassification

string

广告内容类型。

W：适合幼儿及以上年龄段观众的内容。
PI：适合少儿及以上年龄段观众的内容。
J：适合青少年及以上年龄段观众的内容。
A：仅适合成人观众的内容。

示例代码
收起
自动换行
深色代码主题
复制
```
qg.setAdContentClassification('W')
```

qg.setNonPersonalizedAd(number personalizedAd) (1078+)

描述
设置是否请求非个性化广告。
参数
展开
参数

类型

必填(M)/选填(O)

说明
personalizedAd

number

M

非个性化广告标记。

0：请求个性化广告与非个性化广告。
1：请求非个性化广告。
示例代码
收起
自动换行
深色代码主题
复制
```
qg.setNonPersonalizedAd(1)
```

参数	类型	必填(M)/选填(O)	说明
personalizedAd	number	M	非个性化广告标记。 0：请求个性化广告与非个性化广告。 1：请求非个性化广告。

qg.createNativeAd(Object object)（1075+）

描述
创建 native 广告组件，如果已经创建过 native 广告组件，则返回已创建的广告组件。

参数

展开

参数	类型	必填(M)/选填(O)	说明
adUnitId	string	M	原生广告位标识。
success	function	O	接口调用成功的回调函数，code为0时表示成功。
fail	function	O	接口调用失败的回调函数，返回失败原因。
complete	function	O	若有函数传入，将在成功、失败后调用该函数。

返回值
原生广告组件。

示例代码

收起
自动换行
深色代码主题
复制
let nativeAd = qg.createNativeAd({
    adUnitId: 'xxx',
    success: (code) => {
        console.log("loadNativeAd loadNativeAd : success");
    },
    fail: (data, code) => {
        console.log("loadNativeAd loadNativeAd fail: " + data + "," + code);
    },
    complete: () => {
        console.log("loadNativeAd loadNativeAd : complete");
    }
});

nativeAd.load()（1075+）

描述
拉取广告数据，成功回调 onLoad，失败回调 onError。

说明
华为目前每次调用返回一条广告数据。
参数
展开
参数

类型

必填(M)/选填(O)

说明

channelExtras

Object

O

扩展参数，详情请参见channelExtras参数。
- channelExtras参数
  展开
  参数
  
  类型
  
  必填(M)/选填(O)
  
  说明
  
  customerChannel
  
  string
  
  O
  
  广告的启动渠道，取值范围为0~100。

参数	类型	必填(M)/选填(O)	说明
channelExtras	Object	O	扩展参数，详情请参见channelExtras参数。

参数	类型	必填(M)/选填(O)	说明
customerChannel	string	O	广告的启动渠道，取值范围为0~100。

示例代码

收起
自动换行
深色代码主题
复制
nativeAd.onLoad((data) => {
  console.info('ad data loaded: ' + JSON.stringify(data))
  this.adItemData = data.adList[0]
})
nativeAd.load({
  "channelExtras": { 
    "customerChannel": "1"
  } 
})

nativeAd.reportAdShow()（1075+）

描述
上报广告曝光，一个广告只有一次上报有效，adId 为 load 方法获取的广告数据的 adId 字段。
参数
展开
参数

类型

必填(M)/选填(O)

说明

adId

string

M

广告信息标识，由onload回调返回。
示例代码
收起
自动换行
深色代码主题
复制
```
nativeAd.reportAdShow({
    adId: "xxx"
})
```

参数	类型	必填(M)/选填(O)	说明
adId	string	M	广告信息标识，由onload回调返回。

nativeAd.reportAdClick()（1075+）

描述
上报广告点击，一个广告只有一次上报有效，adId 为 load 方法获取的广告数据的 adId 字段。
参数
展开
参数

类型

必填(M)/选填(O)

说明

adId

string

M

广告信息标识，由onload回调返回。
示例代码
收起
自动换行
深色代码主题
复制
```
nativeAd.reportAdClick({
    adId: "xxx",
})
```

参数	类型	必填(M)/选填(O)	说明
adId	string	M	广告信息标识，由onload回调返回。

nativeAd.onLoad(function callback)（1075+）

描述
设置广告加载成功回调。

参数

展开

参数	类型	必填(M)/选填(O)	说明
callback	function	M	广告加载完成触发执行的函数，回调数据为包含广告列表的对象{adList: xxx}，请参见callback回调函数参数。

callback回调函数参数

展开

参数	类型	说明
adList	array	广告详细信息，详细内容参见item参数。

item参数

展开

参数	类型	说明
adId	string	广告标识，用于上报曝光与点击。
title	string	广告标题。
source(1077+)	string	广告来源。
icon	string	推广应用的Icon图标。
imgUrlList	array	广告图片。
videoUrlList	array	广告视频。
videoRatio(1078+)	array	广告视频宽高比。
logoUrl	string	广告标签图片。说明华为目前仅返回空字符串""
clickBtnTxt	string	点击按钮文本描述。
creativeType	number	获取广告类型，取值说明如下： 1：文字 2：大图片 3：大图文 4：GIF 6：视频文 7：小图文 8：三小图文 9：视频 10：图标（文） 103：大图文带下载按钮 106：视频文带下载按钮 107：小图文带下载按钮 108：三小图文带下载按钮 102：大图片带下载按钮 101：文字带下载按钮 110：图标（文）带下载按钮说明华为类型取值和联盟有所不同。
interactionType	number	获取广告点击之后的交互类型，取值说明如下： 0：无 1：浏览类 2：下载类 3：浏览器（下载中间页广告） 4：打开应用首页 5：打开应用详情页说明华为当前始终返回为0。
appName	string	应用包名。
versionName	string	应用版本号。
developerName	string	应用的运营者信息。
appDetailUrl	string	应用介绍页面对应的H5地址，建议通过qg.openDeeplink打开网页。
permissionUrl	string	应用的权限声明页面对应的H5地址，建议通过qg.openDeeplink打开网页。
privacyUrl	string	应用的隐私链接，建议通过qg.openDeeplink打开网页。

示例代码

收起
自动换行
深色代码主题
复制
nativeAd.onLoad((data) => {
 console.info('ad data loaded: ' + JSON.stringify(data))
 this.adItemData = data.adList[0]
})

nativeAd.offLoad()（1075+）

描述
移除原生广告加载成功监听。
示例代码
收起
自动换行
深色代码主题
复制
```
nativeAd.offLoad();
```

nativeAd.onError(function callback)（1075+）

描述
监听原生广告错误事件。

参数

展开

参数	类型	必填(M)/选填(O)	说明
callback	function	M	广告加载出错时触发执行的函数，回调数据为包含错误码和错误描述的对象，请参见callback回调函数参数。

callback回调函数参数
展开
参数

类型

说明

errCode

number

错误码。

errMsg

string

错误信息。

参数	类型	说明
errCode	number	错误码。
errMsg	string	错误信息。

示例代码

收起
自动换行
深色代码主题
复制
nativeAd.onError((e) => {
  console.error('load ad error:' + JSON.stringify(e));
  const errCode = e.errCode
  const errMsg = e.errMsg
})

nativeAd.offError()（1075+）

描述
移除原生广告加载错误监听。

示例代码
收起
自动换行
深色代码主题
复制
```
nativeAd.offError()
```

nativeAd.setTagForChildProtection(number childProtection)（1077+）

描述
设置儿童保护标签。

参数

展开

参数	类型	必填(M)/选填(O)	说明
childProtection	number	M	儿童保护标签。 -1：您不希望表明您的广告内容是否需要符合COPPA的规定。 0：表明您的广告内容不需要符合COPPA的规定。 1：表明您的广告内容需要符合COPPA的规定（该广告请求无法获取到任何广告）。

参数

类型

必填(M)/选填(O)

说明

childProtection

number

儿童保护标签。

-1：您不希望表明您的广告内容是否需要符合COPPA的规定。
0：表明您的广告内容不需要符合COPPA的规定。
1：表明您的广告内容需要符合COPPA的规定（该广告请求无法获取到任何广告）。

示例代码
收起
自动换行
深色代码主题
复制
```
nativeAd.setTagForChildProtection(1)
```

nativeAd.setTagForUnderAgeOfPromise(number underAgeOfPromiseStr)（1077+）

描述
设置面向未达到法定承诺年龄用户。

参数

展开

参数	类型	必填(M)/选填(O)	说明
underAgeOfPromiseStr	number	M	未达到法定承诺年龄用户的设置。 -1: 表明您尚未指定广告请求是否要符合未达到法定承诺年龄用户的广告标准。 0: 表明您不希望广告请求符合未达到法定承诺年龄用户的广告标准。 1: 表明您希望广告请求符合未达到法定承诺年龄用户的广告标准

参数

类型

必填(M)/选填(O)

说明

underAgeOfPromiseStr

number

未达到法定承诺年龄用户的设置。

-1: 表明您尚未指定广告请求是否要符合未达到法定承诺年龄用户的广告标准。
0: 表明您不希望广告请求符合未达到法定承诺年龄用户的广告标准。
1: 表明您希望广告请求符合未达到法定承诺年龄用户的广告标准

示例代码
收起
自动换行
深色代码主题
复制
```
nativeAd.setTagForUnderAgeOfPromise(1)
```

nativeAd.setAdContentClassification(string adContentClassification)（1077+）

描述
设置广告内容分级上限。

参数

展开

参数	类型	必填(M)/选填(O)	说明
adContentClassification	string	M	广告内容类型。 W：适合幼儿及以上年龄段观众的内容。 PI：适合少儿及以上年龄段观众的内容。 J：适合青少年及以上年龄段观众的内容。 A：仅适合成人观众的内容。

参数

类型

必填(M)/选填(O)

说明

adContentClassification

string

广告内容类型。

W：适合幼儿及以上年龄段观众的内容。
PI：适合少儿及以上年龄段观众的内容。
J：适合青少年及以上年龄段观众的内容。
A：仅适合成人观众的内容。

示例代码
收起
自动换行
深色代码主题
复制
```
nativeAd.setAdContentClassification('W')
```

nativeAd.setNonPersonalizedAd(number personalizedAd)（1077+）

描述
设置是否请求非个性化广告。
参数
展开
参数

类型

必填(M)/选填(O)

说明
personalizedAd

number

M

非个性化广告标记。

0：请求个性化广告与非个性化广告。
1：请求非个性化广告。
示例代码
收起
自动换行
深色代码主题
复制
```
nativeAd.setNonPersonalizedAd(1)
```

参数	类型	必填(M)/选填(O)	说明
personalizedAd	number	M	非个性化广告标记。 0：请求个性化广告与非个性化广告。 1：请求非个性化广告。

nativeAd.startDownload(Object object) (1078+)

描述
- 若待下载应用未安装，将跳转到对应的广告落地页，用户决策是否手动下载安装应用。
- 若待下载应用已安装，将跳转到对应的广告落地页，用户决策是否手动打开应用。
参数
展开
参数

类型

必填(M)/选填(O)

说明

adId

string

M

广告信息标识，由onload回调返回。
返回值
展开
返回值

类型

说明

0

number

调用方法成功标识。

-1

number

由于参数错误导致方法失败标识，如素材为非应用下载类广告。

参数	类型	必填(M)/选填(O)	说明
adId	string	M	广告信息标识，由onload回调返回。

返回值	类型	说明
0	number	调用方法成功标识。
-1	number	由于参数错误导致方法失败标识，如素材为非应用下载类广告。

示例代码

收起
自动换行
深色代码主题
复制
const resultCode = nativeAd.startDownload({
    adId: "xxx"
})
console.log('startDownloadresultCode = ' + resultCode );

nativeAd.showDownloadButton(Object object)（1115+）

描述
显示控件按钮。

参数

展开

参数	类型	必填(M)/选填(O)	说明
adId	string	M	原生广告位标识，由nativeAd.load()接口回调返回的adId。
style	Object	M	控件样式，详情请参见style参数。
success	function	O	接口调用成功的回调函数，code为0时表示成功。
fail	function	O	接口调用失败的回调函数。
complete	function	O	若有函数传入，将在成功、失败后调用该函数。

style参数

展开

参数	类型	必填(M)/选填(O)	说明
left	number	M	控件展示左上角横坐标，单位：px。
top	number	M	控件展示左上角纵坐标，单位：px。
width	number	O	控件宽度，单位：px。
fixedWidth	boolean	O	是否固定宽度： true。若文字长度超过width宽度时，先尝试缩小文字，缩小到9sp仍然显示不全时，对文字进行截断。 false。控件宽度由文字长度决定，且同时满足minWidth和maxWidth。默认为false。
minWidth	number	O	控件最小宽度，单位：px。
maxWidth	number	O	控件最大宽度，单位：px。
heightType	string	O	控件高度： normal：40dp。 short：28dp。默认为normal。
textSize	number	O	文字大小，单位：px。
font	string	O	字体。
horizontalPadding	number	O	左右内边距，单位：px。
cornerRadius	number	O	按钮圆角半径，单位：px。
normalTextColor	string	O	常规样式字体颜色，例如#005BBA。
normalBackground	string	O	常规样式按钮背景颜色，例如#0D000000。
pressedColor	string	O	常规样式按钮按压颜色，例如#1A000000。
normalStroke	number	O	常规样式按钮描边宽度，单位：px。
normalStrokeCorlor	string	O	常规样式按钮描边颜色，例如#0D000000。
processingTextColor	string	O	处理中样式字体颜色，例如#000000。
processingBackground	string	O	处理中样式按钮背景颜色，例如#00000000。
processingColor	string	O	处理中样式按钮进度颜色，例如#33007dff。
processingStroke	number	O	处理中样式按钮描边宽度，单位：px。
processingStrokeCorlor	string	O	处理中样式按钮描边颜色，例如#33007dff。
installingTextColor	string	O	安装中样式字体颜色，例如#005BBA。
installingBackground	string	O	安装中样式按钮背景颜色，例如#0D000000。
installingStroke	number	O	安装中样式按钮描边宽度，单位：px。
installingStrokeCorlor	string	O	安装中样式按钮描边颜色，例如#0D000000。

示例代码

收起
自动换行
深色代码主题
复制
this.nativeAd.showDownloadButton({
                adId : "1**345",
                style : {
                    left:300,
                    top:500,
                    heightType:'short',
                    width:300,
                    fixedWidth:true,
                    minWidth:200,
                    maxWidth:500,
                    textSize:50,
                    horizontalPadding:50,
                    cornerRadius:22,
                    normalTextColor:'#FFFFFF',
                    normalBackground:'#5291FF',
                    pressedColor:'#0A59F7',
                    normalStroke:5,
                    normalStrokeCorlor:'#FF000000',
                    processingTextColor:'#5291FF',
                    processingBackground:'#0F000000',
                    processingColor:'#000000',
                    processingStroke:10,
                    processingStrokeCorlor:'#0A59F7',
                    installingTextColor:'#000000',
                    installingBackground:'#FFFFFF',
                    installingStroke:15,
                    installingStrokeCorlor:'#5291FF'
                },
                success: (code) => {
                    console.log("showDownloadButton: success");
                },
                fail: (data, code) => {
                    console.log("showDownloadButton fail: " + data + "," + code);
                },
                complete: () => {
                    console.log("showDownloadButton : complete");
                }
            });

nativeAd.hideDownloadButton(Object object)（1115+）

描述
隐藏控件按钮。

参数

展开

参数	类型	必填(M)/选填(O)	说明
adId	string	M	原生广告位标识，由nativeAd.load()接口回调返回。
success	function	O	接口调用成功的回调函数，code为0时表示成功。
fail	function	O	接口调用失败的回调函数。
complete	function	O	若有函数传入，将在成功、失败后调用该函数。

示例代码

收起
自动换行
深色代码主题
复制
nativeAd.hideDownloadButton({
                  adId : "1**345",
                  success: (code) => {
                      console.log("hideDownloadButton: success");
                 },
                  fail: (data, code) => {
                      console.log(" hideDownloadButton fail: " + data + "," + code);
                  },
                  complete: () => {
                      console.log("hideDownloadButton : complete");
                  }
});

nativeAd.destroy()（1075+）

描述
销毁原生广告。
示例代码
收起
自动换行
深色代码主题
复制
```
nativeAd.destroy();
```

qg.createRewardedVideoAd(Object object)（1075+）

描述
创建激励视频广告，同一个 adUnitId，如果已经创建，会复用之前的对象，创建后会加载广告素材，该方法返回的是一个单例，该实例仅对当前场景有效，不允许跨场景使用。

参数

展开

参数	类型	必填(M)/选填(O)	说明
adUnitId	string	M	激励视频广告位标识。
multiton	boolean	O	是否启用多例模式，默认为false（1077+）。
success	function	O	成功回调，code为0时表示成功。
fail	function	O	失败回调，返回失败原因。
complete	function	O	若有函数传入，将在成功、失败后调用该函数。

返回值
激励视频广告组件。

示例代码

收起
自动换行
深色代码主题
复制
let rewardedVideoAd = qg.createRewardedVideoAd({
    adUnitId: 'xxx',
    success: (code) => {
        console.log("ad demo : loadAndShowVideoAd createRewardedVideoAd: success");
    },
    fail: (data, code) => {
        console.log("ad demo : loadAndShowVideoAd createRewardedVideoAd fail: " + data + "," + code);
    },
    complete: () => {
        console.log("ad demo : loadAndShowVideoAd createRewardedVideoAd complete");
    }
});

rewardedVideoAd.load()（1075+）

描述
手动拉取广告，用于刷新广告，成功回调onLoad，失败回调onError。

说明
请求广告频率太高可能回调onError。

参数
展开
参数

类型

必填(M)/选填(O)

说明

channelExtras

Object

O

扩展参数，详情请参见channelExtras参数。
- channelExtras参数
  展开
  参数
  
  类型
  
  必填(M)/选填(O)
  
  说明
  
  customerChannel
  
  string
  
  O
  
  广告的启动渠道，取值范围为0~100。

参数	类型	必填(M)/选填(O)	说明
channelExtras	Object	O	扩展参数，详情请参见channelExtras参数。

参数	类型	必填(M)/选填(O)	说明
customerChannel	string	O	广告的启动渠道，取值范围为0~100。

示例代码

收起
自动换行
深色代码主题
复制
rewardedVideoAd.onLoad(() => {
  console.log('ad loaded.')
})
rewardedVideoAd.load({
  "channelExtras": { 
    "customerChannel": "1"
  } 
})

rewardedVideoAd.show()（1075+）

描述
激励视频广告组件默认是隐藏的，调用 show 方法展示广告，失败回调 onError。

示例代码

收起
自动换行
深色代码主题
复制
rewardedVideoAd.onError((e) => {
  console.error('load ad error:' + JSON.stringify(e));
  const errCode = e.errCode
  const errMsg = e.errMsg
})
rewardedVideoAd.show()

rewardedVideoAd.onLoad(function callback)（1075+）

描述
设置广告加载成功回调。

参数
展开
参数

类型

必填(M)/选填(O)

说明

callback

function

M

广告加载完成触发执行的函数。

参数	类型	必填(M)/选填(O)	说明
callback	function	M	广告加载完成触发执行的函数。

示例代码

收起
自动换行
深色代码主题
复制
rewardedVideoAd.onLoad(() => {
  console.log('ad loaded.')
})

rewardedVideoAd.offLoad()（1075+）

描述
移除激励视频广告加载成功监听。

示例代码
收起
自动换行
深色代码主题
复制
```
rewardedVideoAd.offLoad();
```

rewardedVideoAd.onClose(function callback)（1075+）

描述
监听激励视频广告关闭事件。只有在用户主动关闭激励视频广告时，广告才会关闭。

参数

展开

参数	类型	说明
callback	function	广告关闭时触发执行的函数，回调参数为{isEnded: xxx}。

callback回调函数参数

展开

参数	类型	说明
isEnded	boolean	视频是否是在用户完整观看的情况下被关闭的。 true 表示用户是在视频播放完以后关闭的 false 表示用户在视频播放过程中关闭的

参数

类型

说明

isEnded

boolean

视频是否是在用户完整观看的情况下被关闭的。

true 表示用户是在视频播放完以后关闭的
false 表示用户在视频播放过程中关闭的

示例代码

收起
自动换行
深色代码主题
复制
rewardedVideoAd.onClose((res) => {
  console.log('ad onClose: ' + res.isEnded)
})

rewardedVideoAd.offClose()（1075+）

描述
移除激励视频广告关闭监听。

示例代码
收起
自动换行
深色代码主题
复制
```
rewardedVideoAd.offClose();
```

rewardedVideoAd.onError(function callback)（1075+）

描述
监听激励视频广告错误事件。

参数
展开
参数

类型

必填(M)/选填(O)

说明

callback

function

M

广告加载出错时触发执行的函数，回调数据为包含错误码和错误描述的对象。
- callback回调函数参数
  展开
  参数
  
  类型
  
  说明
  
  errCode
  
  number
  
  错误码。
  
  errMsg
  
  string
  
  错误信息。

参数	类型	必填(M)/选填(O)	说明
callback	function	M	广告加载出错时触发执行的函数，回调数据为包含错误码和错误描述的对象。

参数	类型	说明
errCode	number	错误码。
errMsg	string	错误信息。

示例代码

收起
自动换行
深色代码主题
复制
rewardedVideoAd.onError((e) => {
  console.error('load ad error:' + JSON.stringify(e));
  const errCode = e.errCode
  const errMsg = e.errMsg
})

rewardedVideoAd.offError()（1075+）

描述
移除激励视频广告加载错误监听。

示例代码
收起
自动换行
深色代码主题
复制
```
rewardedVideoAd.offError();
```

rewardedVideoAd.setTagForChildProtection(number childProtection)（1077+）

描述
设置儿童保护标签。

参数

展开

参数	类型	必填(M)/选填(O)	说明
childProtection	number	M	儿童保护标签。 -1：您不希望表明您的广告内容是否需要符合COPPA的规定。 0：表明您的广告内容不需要符合COPPA的规定。 1：表明您的广告内容需要符合COPPA的规定（该广告请求无法获取到任何广告）。

参数

类型

必填(M)/选填(O)

说明

childProtection

number

儿童保护标签。

-1：您不希望表明您的广告内容是否需要符合COPPA的规定。
0：表明您的广告内容不需要符合COPPA的规定。
1：表明您的广告内容需要符合COPPA的规定（该广告请求无法获取到任何广告）。

示例代码
收起
自动换行
深色代码主题
复制
```
rewardedVideoAd.setTagForChildProtection(1)
```

rewardedVideoAd.setTagForUnderAgeOfPromise(number underAgeOfPromiseStr)（1077+）

描述
设置面向未达到法定承诺年龄用户。

参数

展开

参数	类型	必填(M)/选填(O)	说明
underAgeOfPromiseStr	number	M	未达到法定承诺年龄用户的设置。 -1: 表明您尚未指定广告请求是否要符合未达到法定承诺年龄用户的广告标准。 0: 表明您不希望广告请求符合未达到法定承诺年龄用户的广告标准。 1: 表明您希望广告请求符合未达到法定承诺年龄用户的广告标准。

参数

类型

必填(M)/选填(O)

说明

underAgeOfPromiseStr

number

未达到法定承诺年龄用户的设置。

-1: 表明您尚未指定广告请求是否要符合未达到法定承诺年龄用户的广告标准。
0: 表明您不希望广告请求符合未达到法定承诺年龄用户的广告标准。
1: 表明您希望广告请求符合未达到法定承诺年龄用户的广告标准。

示例代码
收起
自动换行
深色代码主题
复制
```
rewardedVideoAd.setTagForUnderAgeOfPromise(1)
```

rewardedVideoAd.setAdContentClassification(string adContentClassification)（1077+）

描述
设置广告内容分级上限。

参数

展开

参数	类型	必填(M)/选填(O)	说明
adContentClassification	string	M	广告内容类型。 W：适合幼儿及以上年龄段观众的内容。 PI：适合少儿及以上年龄段观众的内容。 J：适合青少年及以上年龄段观众的内容。 A：仅适合成人观众的内容。

参数

类型

必填(M)/选填(O)

说明

adContentClassification

string

广告内容类型。

W：适合幼儿及以上年龄段观众的内容。
PI：适合少儿及以上年龄段观众的内容。
J：适合青少年及以上年龄段观众的内容。
A：仅适合成人观众的内容。

示例代码
收起
自动换行
深色代码主题
复制
```
rewardedVideoAd.setAdContentClassification('W')
```

rewardedVideoAd.setNonPersonalizedAd(number personalizedAd)（1077+）

描述
设置是否请求非个性化广告。

参数
展开
参数

类型

必填(M)/选填(O)

说明
personalizedAd

number

M

非个性化广告标记。

0：请求个性化广告与非个性化广告。
1：请求非个性化广告。

参数	类型	必填(M)/选填(O)	说明
personalizedAd	number	M	非个性化广告标记。 0：请求个性化广告与非个性化广告。 1：请求非个性化广告。

示例代码
收起
自动换行
深色代码主题
复制
```
rewardedVideoAd.setNonPersonalizedAd(1)
```

rewardedVideoAd.destroy()（1075+）

描述
销毁激励视频广告。
示例代码
收起
自动换行
深色代码主题
复制
```
rewardedVideoAd.destroy();
```

qg.createBannerAd(Object object)（1078+）

描述
创建 Banner 广告组件，如果已经创建过 Banner 广告组件，则返回已创建的广告组件。

参数

展开

参数	类型	必填(M)/选填(O)	说明
adUnitId	string	M	Banner 广告位标识。
style	object	M	Banner 广告组件的样式，详细内容参见“参数”。
adIntervals	number	O	广告自动刷新的间隔时间，单位为秒，参数值30 ~ 120之间（如果不传入此参数 Banner 广告不会自动刷新），建议设置为60。该参数只有首次调用该接口时传入有效，如果首次未设置，后续再调用接口设置无效，除非调用bannerAd.destroy()销毁广告后，重新创建新的广告。

参数

类型

必填(M)/选填(O)

说明

adUnitId

string

Banner 广告位标识。

style

object

Banner 广告组件的样式，详细内容参见“参数”。

adIntervals

number

广告自动刷新的间隔时间，单位为秒，参数值30 ~ 120之间（如果不传入此参数 Banner 广告不会自动刷新），建议设置为60。

该参数只有首次调用该接口时传入有效，如果首次未设置，后续再调用接口设置无效，除非调用bannerAd.destroy()销毁广告后，重新创建新的广告。

style参数

展开

参数	类型	必填	说明
top	number	M	banner 广告组件的左上角纵坐标。
left	number	M	banner 广告组件的左上角横坐标。
width	number	M	banner 广告组件的宽度，单位：dp。
height	number	M	banner 广告组件的高度，单位：dp。

广告组件宽高设置值限制如下表所示。

展开

宽	高	说明
360	57	普通Banner广告，适用于1080*170px的广告素材。
360	144	大型Banner广告，适用于1080*432px的广告素材。
160	600	中国大陆地区不支持。
300	250	中国大陆地区不支持。
320	100	中国大陆地区不支持。
320	50	中国大陆地区不支持。
468	60	中国大陆地区不支持。
728	90	中国大陆地区不支持。
-1	-2	根据屏幕宽高度自动匹配。

返回值

Banner广告组件 bannerAd。通过bannerAd.style可以获取广告的真实宽高，其返回值如下表所示。

展开

参数名	类型	说明
top	number	banner 广告组件的左上角纵坐标。
left	number	banner 广告组件的左上角横坐标。
width	number	banner 广告组件的宽度，单位dp。
height	number	banner 广告组件的高度，单位dp。
realWidth	number	banner 广告组件的真实宽度，单位px。
realHeight	number	banner 广告组件的真实高度，单位px。

示例代码

收起
自动换行
深色代码主题
复制
let bannerAd = qg.createBannerAd({
    adUnitId: 'testw6vs28auh3',
    style:{
        top:20,
        left:20,
        height:57,
        width:360
    }
})

bannerAd.show() （1078+）

描述
加载展示banner广告，出错的时候回调 onError，分为加载和展示两个阶段，加载成功回调onLoad。
参数
展开
参数

类型

必填(M)/选填(O)

说明

channelExtras

Object

O

扩展参数，详情请参见channelExtras参数。
- channelExtras参数
  展开
  参数
  
  类型
  
  必填(M)/选填(O)
  
  说明
  
  customerChannel
  
  string
  
  O
  
  广告的启动渠道，取值范围为0~100。

参数	类型	必填(M)/选填(O)	说明
channelExtras	Object	O	扩展参数，详情请参见channelExtras参数。

参数	类型	必填(M)/选填(O)	说明
customerChannel	string	O	广告的启动渠道，取值范围为0~100。

示例代码

收起
自动换行
深色代码主题
复制
bannerAd.show({
  "channelExtras": { 
    "customerChannel": "1"
  } 
})

bannerAd.hide() （1078+）

描述
隐藏 banner 广告。
示例代码
收起
自动换行
深色代码主题
复制
```
bannerAd.hide();
```

bannerAd.onError(function callback)（1078+）

描述
监听 banner 广告错误事件。

返回值
Object类型。

展开
参数

类型

必填(M)/选填(O)

说明

errMsg

string

M

错误信息。

errCode

number

M

错误码。

参数	类型	必填(M)/选填(O)	说明
errMsg	string	M	错误信息。
errCode	number	M	错误码。

示例代码
收起
自动换行
深色代码主题
复制
```
bannerAd.onError((err)=>{
    console.log(err)
})
```

bannerAd.offError() （1078+）

描述
移除 banner 广告错误监听。
示例代码
收起
自动换行
深色代码主题
复制
```
bannerAd.offError();
```

bannerAd.onLoad(function callback) （1078+）

描述
监听 banner 广告加载事件。
参数
展开
参数

类型

必填(M)/选填(O)

说明

callback

function

M

广告加载完成触发执行的函数。

参数	类型	必填(M)/选填(O)	说明
callback	function	M	广告加载完成触发执行的函数。

示例代码

收起
自动换行
深色代码主题
复制
bannerAd.onLoad(() => {
    console.log('ad loaded.');
});

bannerAd.offLoad() （1078+）

描述
移除 banner 广告加载事件。
示例代码
收起
自动换行
深色代码主题
复制
```
bannerAd.offLoad();
```

bannerAd.onClose(function callback) （1078+）

描述
监听 banner 广告关闭事件。
参数
展开
参数

类型

必填(M)/选填(O)

说明

callback

function

M

广告关闭触发执行的函数。

参数	类型	必填(M)/选填(O)	说明
callback	function	M	广告关闭触发执行的函数。

示例代码

收起
自动换行
深色代码主题
复制
bannerAd.onClose(() => {
    console.log('ad closed.');
});

bannerAd.offClose() （1078+）

描述
移除 banner 广告关闭事件。
示例代码
收起
自动换行
深色代码主题
复制
```
bannerAd.offClose();
```

bannerAd.destroy() （1078+）

描述
销毁 banner 广告。
示例代码
收起
自动换行
深色代码主题
复制
```
bannerAd.destroy();
```

qg.createInterstitialAd(Object object)（1078+）

描述
创建 Interstitial 广告组件，如果已经创建过 Interstitial 广告组件，则返回已创建的广告组件。

参数
展开
参数

类型

必填(M)/选填(O)

说明

adUnitId

String

M

Interstitial 广告位标识。

示例代码

收起
自动换行
深色代码主题
复制
let interstitialAd = qg.createInterstitialAd({
    adUnitId: 'xxxx'
})

interstitialAd.load()（1078+）

描述
加载插屏视频广告。

参数
展开
参数

类型

必填(M)/选填(O)

说明

channelExtras

Object

O

扩展参数，详情请参见channelExtras参数。
- channelExtras参数
  展开
  参数
  
  类型
  
  必填(M)/选填(O)
  
  说明
  
  customerChannel
  
  string
  
  O
  
  广告的启动渠道，取值范围为0~100。

示例代码

收起
自动换行
深色代码主题
复制
interstitialAd.load({
  "channelExtras": { 
    "customerChannel": "1"
  } 
})

interstitialAd.show()（1078+）

描述
显示插屏视频广告。

示例代码
收起
自动换行
深色代码主题
复制
```
interstitialAd.show();
```

interstitialAd.onLoad(function callback)（1078+）

描述
监听插屏广告加载事件。

示例代码

收起
自动换行
深色代码主题
复制
interstitialAd.onLoad(function (data) {
    console.log('onLoad data ' + JSON.stringify(data));
});

interstitialAd.offLoad()（1078+）

描述
移除插屏广告加载事件。

示例代码
收起
自动换行
深色代码主题
复制
```
interstitialAd.offLoad();
```

interstitialAd.onError(function callback)（1078+）

描述
监听插屏广告错误事件。

返回值
展开
参数

类型

说明

errMsg

string

错误信息。

errCode

number

错误码。

示例代码

收起
自动换行
深色代码主题
复制
interstitialAd.onError((err)=>{
    console.log(err)
})

interstitialAd.offError()（1078+）

描述
移除插屏广告错误监听。

示例代码
收起
自动换行
深色代码主题
复制
```
interstitialAd.offError();
```

interstitialAd.onClose(function callback)（1078+）

描述
监听插屏广告关闭事件。

示例代码

收起
自动换行
深色代码主题
复制
interstitialAd.onClose(()=>{
    console.log('interstitialAd closed');
})

interstitialAd.offClose()（1078+）

描述
移除插屏广告关闭事件。

示例代码
收起
自动换行
深色代码主题
复制
```
interstitialAd.offClose();
```

interstitialAd.onClick(function callback)（1078+）

描述
监听插屏广告点击事件。

示例代码

收起
自动换行
深色代码主题
复制
interstitialAd.onClick(()=>{
    console.log('interstitialAd clicked');
})

interstitialAd.offClick()（1078+）

描述
移除插屏广告点击监听。

示例代码
收起
自动换行
深色代码主题
复制
```
interstitialAd.offClick();
```

interstitialAd.destroy() （1078+）

描述
销毁插屏广告。

示例代码
收起
自动换行
深色代码主题
复制
```
interstitialAd.destroy()
```

错误码

错误码为通过onError获取的错误信息。

展开

错误码	说明
200	通用错误。
202	参数错误。
1001	无效的广告请求，如未设置广告位ID、Banner广告尺寸无效等。
1002	横幅广告过期或者横幅广告任务下架。
1003	内部错误。
1004	广告请求成功，但是服务器没有返回可用的广告素材。
1100	广告正在请求中，不能重复发起请求。
1102	API版本不在广告服务支持范围内。
1104	由于网络连接错误导致广告请求失败。
2000	HMS Core版本过低，不支持设置AppInfo。