# Banner 广告接入文档

# wx.createCustomAd(Object object)

接口名与国内命名一致。具体使用方法请参考本文档。

# 功能描述

开发者可以调用 wx.createCustomAd 创建Banner 广告组件。
Banner 广告组件是一个原生组件，层级比普通组件高。Banner 广告组件默认是隐藏的，需要调用 CustomAd.show() 将其显示。如果宽度可配置，Banner 会根据开发者设置的宽度进行等比缩放，部分模板缩放后的尺寸会通过 CustomAd.onResize() 事件中提供。
目前仅支持 320×50 px 和 300×250 px 两种尺寸的 banner。

# 请求参数

• Object object

  	属性	类型	默认值	必填	说明
  	style	Object		是	Banner 广告组件的样式
  	结构属性 类型 默认值 必填 说明 left number 是 Banner 广告组件的左上角横坐标 top number 是 Banner 广告组件的左上角纵坐标 width number 是 Banner 广告组件的宽度 height number 是 Banner 广告组件的高度

# 返回值

# 属性

• Object style Banner 广告组件的样式

# 方法

# Promise CustomAd.show()

显示 Banner 广告组件

# 返回值

• Promise
  Banner 广告显示操作的结果。
  

# Promise CustomAd.hide()

隐藏 Banner 广告组件。

# 返回值

• Promise
  Banner 广告隐藏操作的结果。

# boolean CustomAd.isShow()

查询 Banner 广告组件是否显示。

# 返回值

• boolean
  Banner 广告组件是否正在显示。

# CustomAd.destroy()

销毁 Banner 广告组件。

# CustomAd.onClose(function listener)

监听 Banner 广告组件的关闭事件。

# 参数

• function listener
  Banner 广告组件的关闭事件的监听函数。

# CustomAd.offClose(function listener)

移除 Banner 广告组件的关闭事件的监听函数。

# 参数

• function listener
  onClose 传入的监听函数。不传此参数则移除所有监听函数。

# 示例代码

const listener = function (res) { console.log(res) }

CustomAd.onClose(listener)
CustomAd.offClose(listener) // 需传入与监听时同一个的函数对象

# CustomAd.onHide(function listener)

监听 Banner 广告组件的隐藏事件。

# 参数

• function listener
  Banner 广告组件的隐藏事件的监听函数。

# CustomAd.offHide(function listener)

移除 Banner 广告组件的隐藏事件的监听函数。

# 参数

• function listener
  onHide 传入的监听函数。不传此参数则移除所有监听函数。

# 示例代码

const listener = function (res) { console.log(res) }

CustomAd.onHide(listener)
CustomAd.offHide(listener) // 需传入与监听时同一个的函数对象

# CustomAd.onload(function listener)

监听 Banner 广告组件的加载事件。

# 参数

• function listener
  Banner 广告组件的加载事件的监听函数。

# CustomAd.offLoad(function listener)

移除 Banner 广告组件的加载事件的监听函数。

# 参数

• function listener
  onLoad 传入的监听函数。不传此参数则移除所有监听函数。

# 示例代码

const listener = function (res) { console.log(res) }

CustomAd.onload(listener)
CustomAd.offLoad(listener) // 需传入与监听时同一个的函数对象

# CustomAd.onResize(function listener)

监听 Banner 广告组件的尺寸变化事件。

# 参数

• function listener
  Banner 广告组件的尺寸变化事件的监听函数。

# 参数

• Object res

# CustomAd.offResize(function listener)

移除 Banner 广告组件的尺寸变化事件的监听函数。

# 参数

• function listener
  onResize 传入的监听函数。不传此参数则移除所有监听函数。

# 示例代码

const listener = function (res) { console.log(res) }

CustomAd.onResize(listener)
CustomAd.offResize(listener) // 需传入与监听时同一个的函数对象

# CustomAd.onError(function listener)

监听 Banner 广告组件的加载失败事件。

# 参数

• function listener
  Banner 广告组件的加载失败事件的监听函数。

# 参数

• Object res

# errcode的合法值

# 错误码信息与解决方案表

错误码是通过onError获取到的错误信息。调试期间，可以通过异常返回来捕获信息。可以针对异常返回加上适当的监控信息辅助排查现网情况。

# CustomAd.offError(function listener)

移除 Banner 广告组件的加载失败事件的监听函数。

# 参数

• function listener
  onError 传入的监听函数。不传此参数则移除所有监听函数。

# 示例代码

const listener = function (res) { console.log(res) }

CustomAd.onError(listener)
CustomAd.offError(listener) // 需传入与监听时同一个的函数对象