ライブカード
カテゴリ: 運用。タグ: 数値と指標、チャートとゲージ、店舗。
レイアウト
この全画面カードはランドスケープまたはポートレートで画面全体を埋め、コーナー、チップ、ストリップとして配置されません。
レイアウト:フル。フォーム:ランドスケープ、ポートレート。
データとプライバシー
フィード:screenrig.sales/v1。
フィードドキュメントは情報源の帰属を含みます。プレーヤーがカードにフィードを提供します。
収益、注文数、各注文の都市のみ表示します。顧客名、住所、支払い情報は決して表示しません。
プロパティ
テーマ、背景、アクセント、位置については共通プロパティを参照してください。
カードの作成時に、静的プロパティをカードのparamsに設定します。データドキュメントは動的プロパティのみを保持します。ネストされた行は親プロパティの内容を説明します。
静的プロパティ
| 名前 | タイプ | デフォルト | 値と制限 | 説明 |
|---|---|---|---|---|
title | string | "Sales pulse" | maxLength:40 | |
currency | string | "USD" | maxLength:3 | ISO 4217コード。フィードのものを使用。 |
rows | integer | 5 | 最小値:1;最大値:8 | 各リストの行数。 |
staleMinutes | integer | 15 | 最小値:1;最大値:1440 | この期間より古いフィードは、どれくらい前に更新されたかを表示します。 |
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})?$" | メインとセカンダリのテキスト色を上書きします。アクセントと意味的な状態色はそのまま維持されます。 |
動的プロパティ
| 名前 | タイプ | デフォルト | 値と制限 | 説明 |
|---|---|---|---|---|
store | string | "" | maxLength:60 | 数字が示す店舗。フィードの勝利。 |
revenue | 数値、null | null | 最小値:0;最大値:1000000000000 | 今日これまでの収益。 |
orders | 整数、null | null | 最小値:0;最大値:100000000 | 本日の注文数。 |
goal | 数値、null | null | 最小値:0;最大値:1000000000000 | 今日の収益目標。空の場合は目標なしを表示。 |
yesterdayRevenue | 数値、null | null | 最小値:0;最大値:1000000000000 | 昨日の同時刻の収益。空の場合は比較なしを表示。 |
hourly | array | [] | maxItems:24 | スクリーンのタイムゾーンでの今日の各時間の収益。午前0時から。 |
cities | array | [] | maxItems:20 | 都市別収益。同じドキュメントはscreenrig.sales/v1フィードのcitiesです。 |
cities[].name | string | minLength:1;maxLength:60;必須 | 都市または地域。 | |
cities[].revenue | number | 最小値:0;最大値:1000000000;必須 | 都市からの今日の収益。 | |
recent | array | [] | maxItems:20 | 最新の注文です。フィードのrecentと同じ文書です。 |
recent[].at | string | minLength:1;maxLength:40;必須 | 注文が行われたとき、ISO 8601の瞬間。 | |
recent[].amount | number | 最小値:0;最大値:1000000000;必須 | 注文合計。 | |
recent[].city | string | "" | maxLength:60 | 出荷先または設置場所。顧客ではない。 |
キャンバス例
静的プロパティを params.json として保存し、カードを作成します。結果にはその crd_ ID が含まれます。
{
"theme": "neomustard"
}
screenrig card create --type sales-pulse --major 1 --file params.json
このアイテムをプレイリストページのprimitivesに追加し、サンプルの ID をその ID に置き換えます。プレイリストを公開してスクリーンに割り当ててください。
{
"id": "sales-pulse",
"primitive": "card",
"card": "crd_01EXAMPLECARD000000000",
"layout": "full",
"content_fit": "fill"
}
ライブデータを書き込む
カードを作成した後にドキュメントを書き込み、画面を再公開せずに更新するには置き換えます。カードは書き込みのたびに動的プロパティと照合し、受け付けないドキュメントは拒否します。プレイリストと同じプロジェクトを使用してください。
ドキュメントを card-data.json として保存します。CLIはラッパーなしでドキュメント自体を読み取ります。
{
"store": "",
"revenue": null,
"orders": null,
"goal": null,
"yesterdayRevenue": null,
"hourly": [],
"cities": [],
"recent": []
}
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":{"store":"","revenue":null,"orders":null,"goal":null,"yesterdayRevenue":null,"hourly":[],"cities":[],"recent":[]}}'