ロイヤルティカード

ポイントの獲得方法、報酬の段階、参加場所を説明します。

報酬プログラムを明確な招待状に変換:獲得率、報酬の階層、固定の参加用QRコード。オプションで提供されたポイント合計と利用可能な報酬を表示。

ライブカード

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

カテゴリ: 小売。タグ: レストランとカフェ、店舗、QRコード。

レイアウト

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

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

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

データとプライバシー

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

この共有スクリーンで承認されたポイント合計のみを表示します。

プロパティ

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

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

静的プロパティ

名前タイプデフォルト値と制限説明
showProgressbooleanfalse
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})?$"メインとセカンダリのテキスト色を上書きします。アクセントと意味的な状態色はそのまま維持されます。

動的プロパティ

名前タイプデフォルト値と制限説明
titlestring"Good things add up"maxLength:80
earnRatestring""maxLength:160
descriptionstring""maxLength:360
joinUrlstring""maxLength:2048
qrLabelstring"Join the rewards"maxLength:80
footnotestring""maxLength:240
updatedAtstring""maxLength:40
pointsinteger0最小値:0;最大値:1000000
rewardsarray[]maxItems:6
rewards[].pointsinteger最小値:1;最大値:1000000;必須
rewards[].rewardstringminLength:1;maxLength:100;必須
rewards[].detailstring""maxLength:160

キャンバス例

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

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

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

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

ライブデータを書き込む

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

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

{
  "title": "Good things add up",
  "earnRate": "",
  "description": "",
  "joinUrl": "",
  "qrLabel": "Join the rewards",
  "footnote": "",
  "updatedAt": "",
  "points": 0,
  "rewards": []
}
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":{"title":"Good things add up","earnRate":"","description":"","joinUrl":"","qrLabel":"Join the rewards","footnote":"","updatedAt":"","points":0,"rewards":[]}}'