直播卡片
类别:活动。标签:活动和场地,数字和指标。
布局
此全屏卡在横屏或竖屏时填满整个屏幕,不作为角落、芯片或条带放置。
布局:全屏。表单:横向,纵向。
数据与隐私
此卡使用其配置的属性和实时卡数据。
属性
有关主题、背景、强调色和位置,请参见通用属性。
创建卡片时,在卡片的params中设置静态属性。其数据文档仅包含动态属性。嵌套行描述其父属性的内容。
静态属性
| 名称 | 类型 | 默认 | 数值和限制 | 描述 |
|---|---|---|---|---|
title | string | "Silent auction" | maxLength:40 | |
currency | string | "$" | maxLength:3 | 每个金额前的符号。 |
goal | number | 0 | 最小值:0;最大值:1000000000 | 筹款金额。0 表示无目标的总额。 |
sort | string | "lot" | "lot", "closing", "bid" | 批次:保持给定顺序;关闭:先显示即将关闭的批次,关闭的批次排最后;竞价:先显示最高竞价。 |
perPage | integer | 6 | 最小值:3;最大值:10 | |
pageSeconds | integer | 10 | 最小值:4;最大值:60 | |
soonMinutes | integer | 15 | 最小值:1;最大值:240 | 拍卖将在关闭前此分钟数内结束。 |
showBidders | boolean | true | 在每个拍卖品上显示最高出价者的竞拍牌。 | |
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})?$" | 覆盖主文本和次要文本颜色。强调色和语义状态色保持原有功能。 |
动态属性
| 名称 | 类型 | 默认 | 数值和限制 | 描述 |
|---|---|---|---|---|
raised | number | 0 | 最小值:0;最大值:1000000000 | 累计总分,当超过拍卖品最高出价(票券、捐赠)时显示。为 0 时使用最高出价总和。 |
closesAt | string | "" | maxLength:32 | 竞价结束时间,ISO 8601格式。无独立closesAt的批次也在此时结束。 |
items | array | [] | minItems:0;maxItems:60 | |
items[].lot | 字符串,整数 | 批号或代码;留空则显示批次在列表中的位置。 | ||
items[].name | string | minLength:1;maxLength:120;必填 | ||
items[].bid | number | 0 | 最小值:0;最大值:1000000000 | 最高出价。0表示尚无出价。 |
items[].opening | number | 0 | 最小值:0;最大值:1000000000 | 开盘价,显示至第一笔出价。 |
items[].bids | integer | 0 | 最小值:0;最大值:100000 | 该拍卖品的出价次数。 |
items[].bidder | string | "" | maxLength:12 | 最高出价者的拍卖牌号或首字母。 |
items[].closesAt | string | "" | maxLength:32 | 此批次关闭时,采用 ISO 8601 格式。 |
items[].status | string | "open" | "open", "closed", "sold", "withdrawn" | 关闭且已结束竞价;撤回则隐藏该批次。 |
items[].image | string | "" | maxLength:200 | 批次照片的项目媒体引用。 |
items[].bidAt | string | "" | maxLength:32 | 拍卖品最新最高出价的时间点,ISO 8601。黄金时段从此时间点播放新出价时刻。 |
items[].prevBid | number | 0 | 最小值:0;最大值:1000000000 | 它替代的最高出价;时刻从中滚动并显示差异。 |
items[].soldAt | string | "" | maxLength:32 | 拍卖品成交的时间点,ISO 8601;通过其closesAt关闭的拍卖品即在此时成交。黄金时段从此时间点标记为已售出。 |
footnote | string | "" | maxLength:160 | |
goalAt | string | "" | maxLength:32 | 目标达成的时间点,ISO 8601。黄金时段从此时间点播放目标达成时刻,所有屏幕同时显示。 |
画布示例
将静态属性保存为 params.json 并创建卡片。结果中包含它的 crd_ ID。
{
"theme": "neomustard"
}
screenrig card create --type auction-board --major 1 --file params.json
将此项目添加到播放列表页面的primitives中,并用该 ID 替换示例中的 ID。发布播放列表并分配屏幕。
{
"id": "auction-board",
"primitive": "card",
"card": "crd_01EXAMPLECARD000000000",
"layout": "full",
"content_fit": "fill"
}
写入实时数据
创建卡片后向其写入文档,之后替换该文档即可更新屏幕,无需重新发布。卡片会按其动态属性检查每次写入,并拒绝它不接受的文档。请使用与播放列表相同的项目。
将文档保存为card-data.json。CLI直接读取文档,无需包装:
{
"raised": 0,
"closesAt": "",
"items": [],
"footnote": "",
"goalAt": ""
}
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":{"raised":0,"closesAt":"","items":[],"footnote":"","goalAt":""}}'