# full-screen 霸屏运营位
# 介绍
霸屏运营位,支持针对不同运营位配置多个霸屏,会依据优先级依次展示霸屏。同一运营位,每日仅展示一个霸屏。
# 使用指南
# 一般用法
<tms-full-screen/>
# api
| 属性 | 类型 | 默认值 | 必填 | 说明 |
|---|---|---|---|---|
| containerId | String | 是 | 霸屏运营位ID,用于区分不同位置的霸屏 | |
| extraParam | Object | 否 | 扩展参数,用于获取满足特定条件的霸屏 | |
| confPath | String | /${client}/components/fullscreen/${containerId} | 否 | 用于配置霸屏数据的配置项路径 |
| bind:display | eventhandle | 否 | 霸屏展现 | |
| bind:click | eventhandle | 否 | 点击霸屏 |
# 霸屏配置能力
基于运营平台的配置能力,调用方可自主配置不同霸屏的适用情况。每一个霸屏运营位(containerId)都对应一个独立的运营配置路径,默认路径为:/${client}/components/fullscreen/${containerId}。用于需要在该路径下配置霸屏数据。
在获取霸屏数据时,会按如下规则组装配置参数:
const defaultLoc = { province, city, cityCode, adCode };
const extendAttrs = {
...defaultLoc, // 默认位置信息
...extraParam, // 外部传入的扩展参数
hostAppId, // 宿主APP ID(可能是一个Native APP appId,或wechat,或unknown)
appEnterScene, // 打开小程序时的场景值,值等于wx.getEnterOptions().scene
containerId, // 霸屏运营位ID
}
目前霸屏的主要配置能力如下:
- 位置信息 - 可以获取用户实时位置并传递
province、city、cityCode、adCode4个参数 如果调用方对位置参数有自定义设定规则,可以在extraParam中传递上述4个字段来覆盖默认值 - 宿主信息 -
hostAppId指定了宿主信息。主要用于配置在非微信环境下打开小程序时的运营位,如腾讯地图、企业微信等场景下 - 打开小程序时的场景值 -
appEnterScene指定了打开小程序时的场景值,值等于wx.getEnterOptions().scene - 自定义扩展参数 - 调用方可以通过
extraParam来传入其他扩展参数
# bind:display 霸屏展现事件数据结构
假定display事件的回调方法函数参数为res,以下为res.detail的数据结构:
| 属性 | 类型 | 说明 |
|---|---|---|
| id | String | 正在展现霸屏的ID |
| name | String | 霸屏名称 |
| imageUrl | String | 霸屏图 |
| linkType | String | 霸屏链接类型;mp-小程序,embeddedMp-半屏小程序,web-网页,none-空(点击后什么都不做),空字符串-同none |
| link | String | 链接 |
| mpAppId | String | 小程序appId,打开其他小程序时使用此参数 |
| containerId | String | 霸屏运营位ID |
# bind:click 点击霸屏事件数据结构
假定click事件的回调方法函数参数为res,以下为res.detail的数据结构:
| 属性 | 类型 | 说明 |
|---|---|---|
| id | String | 正在展现霸屏的ID |
| name | String | 霸屏名称 |
| imageUrl | String | 霸屏图 |
| linkType | String | 霸屏链接类型;mp-小程序,web-网页,none-空(点击后什么都不做),空字符串-同none |
| link | String | 链接 |
| mpAppId | String | 小程序appId,打开其他小程序时使用此参数 |
| containerId | String | 霸屏运营位ID |
| clickAction | String | 用户行为;open-点击霸屏主体,打开链接,close-点击关闭按钮 |
