プロモカード

大きな写真、名前、テーマ独自のタグに価格、終了までのカウントダウン、QRコード:メニューボードの期間限定オファーまたは注目アイテム。

ライブカード

このカードはブラウザでプレーヤーと同じコードで描画され、サンプルデータを使用します。

カテゴリ: 飲食。タグ: レストランとカフェ、店舗、価格と料金、カウントダウンとタイマー、QRコード。

レイアウト

この全画面カードはランドスケープまたはポートレートで画面全体を埋め、コーナー、チップ、ストリップとして配置されません。

レイアウト:フル。フォーム:ランドスケープ、ポートレート。

カードレイアウト、テーマ、公開。カードを閲覧。

データとプライバシー

このカードは設定されたプロパティとライブカードデータを使用します。

プロパティ

テーマ、背景、アクセント、位置については共通プロパティを参照してください。

カードの作成時に、静的プロパティをカードのparamsに設定します。データドキュメントは動的プロパティのみを保持します。ネストされた行は親プロパティの内容を説明します。

静的プロパティ

名前タイプデフォルト値と制限説明
currencystring"$"maxLength:3
unitstring""maxLength:8価格の後に表示されます。例:/lb または each。
timeZone文字列、nullnull
backgroundColor文字列、nullnullパターン:"^#[0-9A-Fa-f]{6}([0-9A-Fa-f]{2})?$"カードの背景とプレートをフラットなCSS順序の色で上書きします。#RRGGBBAAは不透明度を指定します。background noneが優先されます。
textColor文字列、nullnullパターン:"^#[0-9A-Fa-f]{6}([0-9A-Fa-f]{2})?$"メインとセカンダリのテキスト色を上書きします。アクセントと意味的な状態色はそのまま維持されます。

動的プロパティ

名前タイプデフォルト値と制限説明
headlinestring"Smoky double stack"maxLength:120大きなアイテムまたはオファーです。
sublinestring"Two beef patties, melted cheddar and our house sauce."maxLength:200
badgestring"Limited time"maxLength:24
price数値、nullnull最小値:0価格なしのプロモーションの場合は空欄のままにしてください。
was数値、nullnull最小値:0旧価格(取り消し線付き)。割引額が計算されます。
imagestring""maxLength:200写真:プロジェクトのメディア参照(media:<id>)。空欄でテーマのタイルを表示。
ends文字列、nullnullオフセット付きのISO 8601、またはtimeZoneのローカルYYYY-MM-DDTHH:MM。終了までのカウントダウンを表示します。
qrstring""maxLength:2000QRコードが開くアドレス。空の場合はコードなし。
ctastring"Scan to order"maxLength:80QRコードの横の行です。

キャンバス例

静的プロパティを params.json として保存し、カードを作成します。結果にはその crd_ ID が含まれます。

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

このアイテムをプレイリストページのprimitivesに追加し、サンプルの ID をその ID に置き換えます。プレイリストを公開してスクリーンに割り当ててください。

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

ライブデータを書き込む

カードを作成した後にドキュメントを書き込み、画面を再公開せずに更新するには置き換えます。カードは書き込みのたびに動的プロパティと照合し、受け付けないドキュメントは拒否します。プレイリストと同じプロジェクトを使用してください。

ドキュメントを card-data.json として保存します。CLIはラッパーなしでドキュメント自体を読み取ります。

{
  "headline": "Smoky double stack",
  "subline": "Two beef patties, melted cheddar and our house sauce.",
  "badge": "Limited time",
  "price": null,
  "was": null,
  "image": "",
  "ends": null,
  "qr": "",
  "cta": "Scan to order"
}
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":{"headline":"Smoky double stack","subline":"Two beef patties, melted cheddar and our house sauce.","badge":"Limited time","price":null,"was":null,"image":"","ends":null,"qr":"","cta":"Scan to order"}}'