直播卡片
类别:运营。标签:数字和指标,图表和仪表,商店。
布局
此全屏卡在横屏或竖屏时填满整个屏幕,不作为角落、芯片或条带放置。
布局:全屏。表单:横向,纵向。
数据与隐私
信息源:screenrig.sales/v1。
信息源文档带有来源归属。播放器向卡片提供信息源。
仅显示收入、订单数量和每个订单的城市;绝不显示客户姓名、地址或支付详情。
属性
有关主题、背景、强调色和位置,请参见通用属性。
创建卡片时,在卡片的params中设置静态属性。其数据文档仅包含动态属性。嵌套行描述其父属性的内容。
静态属性
| 名称 | 类型 | 默认 | 数值和限制 | 描述 |
|---|---|---|---|---|
title | string | "Sales pulse" | maxLength:40 | |
currency | string | "USD" | maxLength:3 | ISO 4217 代码;以信息源为准。 |
rows | integer | 5 | 最小值:1;最大值:8 | 每个列表中的行数。 |
staleMinutes | integer | 15 | 最小值: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})?$" | 覆盖主文本和次要文本颜色。强调色和语义状态色保持原有功能。 |
动态属性
| 名称 | 类型 | 默认 | 数值和限制 | 描述 |
|---|---|---|---|---|
store | string | "" | maxLength:60 | 数字所描述的商店;数据源的胜利。 |
revenue | 数字,空值 | null | 最小值:0;最大值:1000000000000 | 今日至今的收入。 |
orders | 整数,空值 | null | 最小值:0;最大值:100000000 | 今日订单总数。 |
goal | 数字,空值 | null | 最小值:0;最大值:1000000000000 | 今日收入目标;为空时不显示目标。 |
yesterdayRevenue | 数字,空值 | null | 最小值:0;最大值:1000000000000 | 昨日此时的收入;为空时不显示对比。 |
hourly | array | [] | maxItems:24 | 屏幕所在时区今天每小时的收入,午夜开始。 |
cities | array | [] | maxItems:20 | 按城市划分的收入,与screenrig.sales/v1数据源的cities文档相同。 |
cities[].name | string | minLength:1;maxLength:60;必填 | 一个城市或地区。 | |
cities[].revenue | number | 最小值:0;最大值:1000000000;必填 | 来自该城市的今日收入。 | |
recent | array | [] | maxItems:20 | 最新订单,与数据源的recent文档相同。 |
recent[].at | string | minLength:1;maxLength:40;必填 | 订单下达时间,ISO 8601 时间点。 | |
recent[].amount | number | 最小值:0;最大值:1000000000;必填 | 订单总额。 | |
recent[].city | string | "" | maxLength:60 | 发货或放置的位置;绝非客户。 |
画布示例
将静态属性保存为 params.json 并创建卡片。结果中包含它的 crd_ ID。
{
"theme": "neomustard"
}
screenrig card create --type sales-pulse --major 1 --file params.json
将此项目添加到播放列表页面的primitives中,并用该 ID 替换示例中的 ID。发布播放列表并分配屏幕。
{
"id": "sales-pulse",
"primitive": "card",
"card": "crd_01EXAMPLECARD000000000",
"layout": "full",
"content_fit": "fill"
}
写入实时数据
创建卡片后向其写入文档,之后替换该文档即可更新屏幕,无需重新发布。卡片会按其动态属性检查每次写入,并拒绝它不接受的文档。请使用与播放列表相同的项目。
将文档保存为card-data.json。CLI直接读取文档,无需包装:
{
"store": "",
"revenue": null,
"orders": null,
"goal": null,
"yesterdayRevenue": null,
"hourly": [],
"cities": [],
"recent": []
}
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":{"store":"","revenue":null,"orders":null,"goal":null,"yesterdayRevenue":null,"hourly":[],"cities":[],"recent":[]}}'