ライブカード
カテゴリ: 飲食。タグ: 学校とキャンパス、レストランとカフェ。
レイアウト
この全画面カードはランドスケープまたはポートレートで画面全体を埋め、コーナー、チップ、ストリップとして配置されません。
レイアウト:フル。フォーム:ランドスケープ、ポートレート。
データとプライバシー
フィード:screenrig.lunch/v1。
フィードドキュメントは情報源の帰属を含みます。プレーヤーがカードにフィードを提供します。
プロパティ
テーマ、背景、アクセント、位置については共通プロパティを参照してください。
カードの作成時に、静的プロパティをカードのparamsに設定します。データドキュメントは動的プロパティのみを保持します。ネストされた行は親プロパティの内容を説明します。
静的プロパティ
| 名前 | タイプ | デフォルト | 値と制限 | 説明 |
|---|---|---|---|---|
title | string | "" | maxLength:40 | 空は学校給食(学校朝食、学校おやつ)と読み取ります。 |
school | string | "" | maxLength:60 | タイトルの横に表示されます。フィードの学校名が空の場合に表示されます。 |
meal | string | "lunch" | "breakfast", "lunch", "snack" | |
count | integer | 4 | 最小値:1;最大値:6 | 特集日の後に表示される日数です。 |
showAllergens | boolean | true | アレルゲンと食事のマークおよびそのキー。 | |
timeZone | 文字列、null | null | ||
backgroundColor | 文字列、null | null | パターン:"^#[0-9A-Fa-f]{6}([0-9A-Fa-f]{2})?$" | カードの背景とプレートをフラットなCSS順序の色で上書きします。#RRGGBBAAは不透明度を指定します。background noneが優先されます。 |
textColor | 文字列、null | null | パターン:"^#[0-9A-Fa-f]{6}([0-9A-Fa-f]{2})?$" | メインとセカンダリのテキスト色を上書きします。アクセントと意味的な状態色はそのまま維持されます。 |
動的プロパティ
| 名前 | タイプ | デフォルト | 値と制限 | 説明 |
|---|---|---|---|---|
days | array | [] | minItems:0;maxItems:31 | 日別メニュー。フィード(screenrig.lunch/v1)が存在する場合は優先されます。そうでなければデータストアが同じ行を提供します。 |
days[].date | string | maxLength:10;必須 | スクリーンのゾーン内のYYYY-MM-DD。 | |
days[].closed | boolean | false | この日は食事なし(休日、学校なし)。 | |
days[].note | string | maxLength:80 | その日のイベントとして表示されます:ピザの日、または休校の理由。 | |
days[].items | array | maxItems:12 | 順番の食事。最初のアイテムがメインディッシュです。 | |
days[].items[].name | string | minLength:1;maxLength:60;必須 | ||
days[].items[].allergens | array | maxItems:10 | 乳、卵、魚、甲殻類、木の実、ピーナッツ、小麦、大豆、ごま。それぞれ2文字のマークで表示されます。 | |
days[].items[].diet | string | "vegetarian", "vegan" | VまたはVGマークを表示します。 | |
days[].meals | array | maxItems:4 | フィードのその日の食事;カードの食事は1つを選びます。食事がない場合はその日の項目が使用されます。 | |
days[].meals[].kind | string | "breakfast"、"lunch"、"snack";必須 | ||
days[].meals[].items | array | maxItems:12;必須 | ||
days[].meals[].items[].name | string | minLength:1;maxLength:60;必須 | ||
days[].meals[].items[].allergens | array | maxItems:10 | 乳、卵、魚、甲殻類、木の実、ピーナッツ、小麦、大豆、ごま。それぞれ2文字のマークで表示されます。 | |
days[].meals[].items[].diet | string | "vegetarian", "vegan" | VまたはVGマークを表示します。 |
キャンバス例
静的プロパティを params.json として保存し、カードを作成します。結果にはその crd_ ID が含まれます。
{
"theme": "neomustard"
}
screenrig card create --type school-lunch --major 1 --file params.json
このアイテムをプレイリストページのprimitivesに追加し、サンプルの ID をその ID に置き換えます。プレイリストを公開してスクリーンに割り当ててください。
{
"id": "school-lunch",
"primitive": "card",
"card": "crd_01EXAMPLECARD000000000",
"layout": "full",
"content_fit": "fill"
}
ライブデータを書き込む
カードを作成した後にドキュメントを書き込み、画面を再公開せずに更新するには置き換えます。カードは書き込みのたびに動的プロパティと照合し、受け付けないドキュメントは拒否します。プレイリストと同じプロジェクトを使用してください。
ドキュメントを card-data.json として保存します。CLIはラッパーなしでドキュメント自体を読み取ります。
{
"days": []
}
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":{"days":[]}}'