适用于数字标牌屏幕的实时访客卡片

直播卡片

此卡由浏览器绘制，使用与播放器相同的代码，带示例数据。

类别：运营。标签：数字和指标，图表和仪表，办公室和工作场所，商店。

布局

此全屏卡在横屏或竖屏时填满整个屏幕，不作为角落、芯片或条带放置。

布局：全屏。表单：横向，纵向。

卡片布局、主题和发布。浏览卡片。

数据与隐私

信息源：screenrig.visitors/v1。

信息源文档带有来源归属。播放器向卡片提供信息源。

属性

有关主题、背景、强调色和位置，请参见通用属性。

创建卡片时，在卡片的params中设置静态属性。其数据文档仅包含动态属性。嵌套行描述其父属性的内容。

静态属性

名称	类型	默认	数值和限制	描述
`title`	string	`"Live visitors"`	maxLength：`40`
`rows`	integer	`5`	最小值：`1`；最大值：`8`	每个列表中的行数。
`staleMinutes`	integer	`10`	最小值：`1`；最大值：`1440`	超过此时间的源显示上次更新时间。
`backgroundColor`	字符串，空值	`null`	模式：`"^#[0-9A-Fa-f]{6}([0-9A-Fa-f]{2})?$"`	用纯色 CSS 顺序覆盖卡片背景和底板。#RRGGBBAA 提供透明度。背景无则优先。
`textColor`	字符串，空值	`null`	模式：`"^#[0-9A-Fa-f]{6}([0-9A-Fa-f]{2})?$"`	覆盖主文本和次要文本颜色。强调色和语义状态色保持原有功能。

动态属性

名称	类型	默认	数值和限制	描述
`site`	string	`""`	maxLength：`60`	数字所描述的网站或应用；数据源的胜利。
`active`	整数，空值	`null`	最小值：`0`；最大值：`100000000`	当前在线访客。为空时显示列表中较大的总数。
`series`	array	`[]`	maxItems：`60`	每分钟在线访客，最早的优先；绘制最近30个。
`record`	整数，空值	`null`	最小值：`0`；最大值：`100000000`	之前的最佳计数；超过它即为记录。内容提要存在时显示其`record`胜利。
`updatedAt`	string	`""`	maxLength：`40`	数字最后变更时间（ISO 8601）；当数据源无 fetchedAt 时锚定更新时间。
`pages`	array	`[]`	maxItems：`20`	热门页面，与screenrig.visitors/v1数据源的`pages`相同。数据源存在时优先显示。
`pages[].path`	string	`""`	maxLength：`80`	页面路径（/pricing）。
`pages[].title`	string	`""`	maxLength：`80`	存在时替代路径显示。
`pages[].visitors`	integer		最小值：`0`；最大值：`10000000`；必填	当前页面上的访客。
`sources`	array	`[]`	maxItems：`20`	顶级来源，与源的文档相同`sources`。
`sources[].name`	string		minLength：`1`；maxLength：`80`；必填	访客来源（Google、直接访问、通讯）。
`sources[].visitors`	integer		最小值：`0`；最大值：`10000000`；必填	当前来自此来源的访客。

画布示例

将静态属性保存为 params.json 并创建卡片。结果中包含它的 crd_ ID。

{
  "theme": "neomustard"
}

screenrig card create --type live-visitors --major 1 --file params.json

将此项目添加到播放列表页面的primitives中，并用该 ID 替换示例中的 ID。发布播放列表并分配屏幕。

{
  "id": "live-visitors",
  "primitive": "card",
  "card": "crd_01EXAMPLECARD000000000",
  "layout": "full",
  "content_fit": "fill"
}

写入实时数据

创建卡片后向其写入文档，之后替换该文档即可更新屏幕，无需重新发布。卡片会按其动态属性检查每次写入，并拒绝它不接受的文档。请使用与播放列表相同的项目。

将文档保存为card-data.json。CLI直接读取文档，无需包装：

{
  "site": "",
  "active": null,
  "series": [],
  "record": null,
  "updatedAt": "",
  "pages": [],
  "sources": []
}

screenrig card data put crd_01EXAMPLECARD000000000 --file card-data.json

或直接调用 API。API 将相同文档包装在 document 字段中。智能体令牌已指定其项目，因此不发送项目头；若发送 ScreenRig-Project，必须与令牌项目匹配。通过环境提供 API 授权；详见 API 认证。

curl --request PUT "https://api.screenrig.ai/api/cards/crd_01EXAMPLECARD000000000/data" \
  --header "Authorization: Bearer $SCREENRIG_TOKEN" \
  --header "Content-Type: application/json" \
  --data '{"document":{"site":"","active":null,"series":[],"record":null,"updatedAt":"","pages":[],"sources":[]}}'