# ad-drama

uni-app x 短剧插件:uni.createDramaAd API 与 ad-drama 组件(独立运行,不依赖其他插件)

ad-drama 组件是短剧广告的组件模式接入方式:组件挂载即自动加载短剧模块,适合快速接入短剧广告。

与 API 模式(uni.createDramaAd)的区别:组件模式直接使用渠道提供的短剧首页界面(含推荐、榜单等内容分发),无需自行搭建短剧列表页;API 模式则自行搭建列表页,可深度定制样式与业务。

开通配置广告

开通广告步骤详情

Tips

  • 标准基座不支持测试短剧功能。
  • 使用短剧组件需要先开通穿山甲广告。开通问题请咨询:uni-ad交流群。
  • 标准基座不包含短剧运行时,需制作自定义基座后运行,否则报错 -5020。

# 配置文件

在穿山甲后台 内容输出->接入管理 找到需要接入内容SDK的应用,点击"下载SDK参数配置",然后将SDK配置文件(例如 sdk_setting_file.json)拷贝到项目的 assets 文件夹下。

文件下载之后重命名为:gm_SDK_Setting.json,然后将文件放到项目根目录的nativeResources->android->assets目录下。 完整配置说明与错误码见 uni.createDramaAd。

# 兼容性 ?

Web 微信小程序 支付宝小程序 Android iOS HarmonyOS
x x x 5.31 x x

# 属性

名称 类型 默认值 兼容性 描述
adpid string ""
短剧广告位id,在uniAD官网申请广告位
free number 1
初始可免费观看的剧集数
lock number 1
单次激励视频可解锁的剧集数
urlCallback any null
服务端回调透传参数(userId/extra),激励发放时透传服务器校验
url-callback any null
@load (event: UniNativeViewEvent) => void
短剧加载成功的回调
@error (e:UniDramaErrorEvent) => void
短剧加载失败的回调
@click (event: UniNativeViewEvent) => void
点击短剧的回调
@close (event: UniNativeViewEvent) => void
短剧关闭的回调

# 事件

# UniDramaErrorEvent

# UniDramaErrorEvent 的属性值
名称 类型 必填 描述
detail IUniDramaError 是
名称 类型 必备 描述
errCode number 是 错误码
- -5001 广告位标识adpid为空,请传入有效的adpid
- -5002 无效的广告位标识adpid,请使用正确的adpid
- -5003 广告位未开通广告,请在广告平台申请并确保已审核通过
- -5004 无广告模块,打包时请配置要使用的广告模块
- -5005 广告加载失败,请稍后重试
- -5006 广告已经展示过了,请重新加载
- -5007 广告不可用或已过期,请重新请求
- -5008 广告不可用或已过期,请重新请求
- -5009 广告类型不符,请检查后再试
- -5011 打包或开通的渠道,不支持此类型广告
- -5013 广告播放失败,请重新加载
- -5020 短剧运行时加载异常,请使用包含短剧运行时的自定义基座
errSubject string 是 统一错误主题(模块)名称
data any 否 错误信息中包含的数据
cause Error 否 源错误信息,可以包含多个错误,详见SourceError
errMsg string 是
bubbles boolean 是 是否冒泡
cancelable boolean 是 是否可以取消
type string 是 事件类型
target UniElement 否 触发事件的组件
currentTarget UniElement 否 当前组件
timeStamp Long 是 事件发生时的时间戳
# UniDramaErrorEvent 的方法
名称 类型 必填 描述
stopPropagation () => void 是 阻止当前事件的进一步传播
preventDefault () => void 是 阻止当前事件的默认行为

# 子组件

不可以嵌套组件

# Tips

  • 短剧广告仅支持 Android 平台。

# 参见