适用于数字标牌屏幕的捐赠者墙卡片

直播卡片

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

类别：人员。标签：识别，活动和场馆，医疗保健，学校和校园。

布局

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

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

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

数据与隐私

此卡使用其配置的属性和实时卡数据。

匿名礼物显示匿名标签；其名称永不显示。

属性

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

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

静态属性

名称	类型	默认	数值和限制	描述
`title`	string	`"Our supporters"`	maxLength：`40`
`sponsorsLabel`	string	`"With thanks to our sponsors"`	maxLength：`40`
`showAmounts`	boolean	`false`		当礼物有金额时，显示在捐赠者姓名下方。
`currency`	string	`"$"`	maxLength：`3`
`anonymousLabel`	string	`"Anonymous"`	minLength：`1`；maxLength：`30`
`sort`	string	`"alphabetical"`	`"alphabetical"`, `"listed"`	按字母顺序：同级内 A 到 Z，匿名礼物排最后。列出：按给出顺序。
`perPage`	integer	`12`	最小值：`4`；最大值：`40`	大致表示完整视图一页能容纳多少名称；页面均衡分布。
`pageSeconds`	integer	`14`	最小值：`6`；最大值：`60`
`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})?$"`	覆盖主文本和次要文本颜色。强调色和语义状态色保持原有功能。

动态属性

名称	类型	默认	数值和限制	描述
`tiers`	array	`[]`	minItems：`0`；maxItems：`6`	按层级排序，最高层级优先。第一层级字体最大。
`tiers[].name`	string		minLength：`1`；maxLength：`30`；必填
`tiers[].label`	string	`""`	maxLength：`30`	等级含义，显示在名称旁：$10,000及以上。
`tiers[].donors`	array		minItems：`0`；maxItems：`200`；必填
`tiers[].donors[].name`	string	`""`	maxLength：`60`
`tiers[].donors[].anonymous`	boolean	`false`		显示匿名标签代替姓名；姓名绝不显示。
`tiers[].donors[].amount`	number		最小值：`0`；最大值：`1000000000`	礼物。当墙上的showAmounts开启时显示在名称下方。
`tiers[].donors[].note`	string	`""`	maxLength：`60`	名字下方的一行：纪念 Ruth Bell。
`sponsors`	array	`[]`	minItems：`0`；maxItems：`8`	仅文本的赞助商名称。
`footnote`	string	`""`	maxLength：`160`

画布示例

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

{
  "theme": "neomustard"
}

screenrig card create --type donor-wall --major 1 --file params.json

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

{
  "id": "donor-wall",
  "primitive": "card",
  "card": "crd_01EXAMPLECARD000000000",
  "layout": "full",
  "content_fit": "fill"
}

写入实时数据

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

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

{
  "tiers": [],
  "sponsors": [],
  "footnote": ""
}

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":{"tiers":[],"sponsors":[],"footnote":""}}'