ライブカード
カテゴリ: イベント。タグ: イベントと会場、数字と指標。
レイアウト
この全画面カードはランドスケープまたはポートレートで画面全体を埋め、コーナー、チップ、ストリップとして配置されません。
レイアウト:フル。フォーム:ランドスケープ、ポートレート。
データとプライバシー
このカードは設定されたプロパティとライブカードデータを使用します。
プロパティ
テーマ、背景、アクセント、位置については共通プロパティを参照してください。
カードの作成時に、静的プロパティをカードの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 | 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})?$" | メインとセカンダリのテキスト色を上書きします。アクセントと意味的な状態色はそのまま維持されます。 |
動的プロパティ
| 名前 | タイプ | デフォルト | 値と制限 | 説明 |
|---|---|---|---|---|
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形式です。Primetimeはこの入札時刻から新しい入札の瞬間を再生します。 |
items[].prevBid | number | 0 | 最小値:0;最大値:1000000000 | 置き換えた最高入札額です。時刻はそこから進み、差分を表示します。 |
items[].soldAt | string | "" | maxLength:32 | ロットが売れた時刻、ISO 8601形式。closesAtで終了するロットはこの時刻に売れたことになります。Primetimeはこの時刻からSOLDを表示します。 |
footnote | string | "" | maxLength:160 | |
goalAt | string | "" | maxLength:32 | 目標達成時刻、ISO 8601形式です。Primetimeはこの時刻から全スクリーンで「GOAL MET」瞬間を再生します。 |
キャンバス例
静的プロパティを 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":""}}'