ライブカード
カテゴリ: 人。タグ: 認識、イベントと会場、医療、学校とキャンパス。
レイアウト
この全画面カードはランドスケープまたはポートレートで画面全体を埋め、コーナー、チップ、ストリップとして配置されません。
レイアウト:フル。フォーム:ランドスケープ、ポートレート。
データとプライバシー
このカードは設定されたプロパティとライブカードデータを使用します。
匿名のギフトは匿名ラベルを表示し、名前は決して表示しません。
プロパティ
テーマ、背景、アクセント、位置については共通プロパティを参照してください。
カードの作成時に、静的プロパティをカードの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 | フルビューの1ページに表示される名前の概数。ページは均等に分割されます。 |
pageSeconds | integer | 14 | 最小値:6;最大値:60 | |
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})?$" | メインとセカンダリのテキスト色を上書きします。アクセントと意味的な状態色はそのまま維持されます。 |
動的プロパティ
| 名前 | タイプ | デフォルト | 値と制限 | 説明 |
|---|---|---|---|---|
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 | 名前の下の一行:ルース・ベルを偲んで。 |
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":""}}'