评论卡片

显示屏上的社会证明:提供的总体评分和精选评论,单条显示或墙面展示。

提供的整体评分、星级和评论数,旁边是轮流显示的精选评论摘录,或同一时间分页的引用墙。短评使用大字号,长评使用较小字号;只有超过屏幕长度的评论会在词边界处缩短。黄金时段会计数评分、填充星星、引入引用面板并在每条新评论时沿其运行青色光线,背景为缓慢的推荐卡。过滤、缩短的姓名、评论时间和选择保持不变。减少动画时显示静态画面。

直播卡片

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

类别:媒体。标签:社交与观众,商店,餐厅与咖啡馆,医疗保健。

布局

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

布局:全屏。表单:横向,纵向。

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

数据与隐私

信息源:screenrig.reviews/v1。

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

属性

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

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

静态属性

名称类型默认数值和限制描述
titlestring""maxLength:60空白时使用场所名称。
minRatinginteger4最小值:1;最大值:5
maxLengthinteger220最小值:60;最大值:500较长的评论在单词边界处截断并加省略号。
intervalSecondsinteger10最小值:5;最大值:120
showSummarybooleantrue
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})?$"覆盖主文本和次要文本颜色。强调色和语义状态色保持原有功能。

动态属性

名称类型默认数值和限制描述
place对象,空值nulladditionalProperties:false评价所针对的地点;以数据源为准。
place.namestringminLength:1;maxLength:80;必填
sourcestring""maxLength:40评价的来源,例如 google;以数据源为准。
ratingnumber0最小值:0;最大值:5该地点的总体评分(满分 5 分);以数据源为准。
totalinteger0最小值:0;最大值:100000000评分所依据的评价数量;以数据源为准。
reviewsarray[]minItems:0;maxItems:50评价,与 screenrig.reviews/v1 数据源的 reviews 行相同。存在数据源时以数据源为准;否则由数据存储提供相同的行。
reviews[].authorstringmaxLength:80;必填
reviews[].ratingnumber最小值:1;最大值:5;必填
reviews[].textstringmaxLength:2000;必填
reviews[].publishedstringmaxLength:40;必填发布时间,ISO 8601瞬时。

画布示例

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

{
  "theme": "neomustard"
}
screenrig card create --type reviews --major 1 --file params.json

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

{
  "id": "reviews",
  "primitive": "card",
  "card": "crd_01EXAMPLECARD000000000",
  "layout": "full",
  "content_fit": "fill"
}

写入实时数据

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

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

{
  "place": null,
  "source": "",
  "rating": 0,
  "total": 0,
  "reviews": []
}
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":{"place":null,"source":"","rating":0,"total":0,"reviews":[]}}'