screenRIG
サインイン開始する

ライブ訪問者カード

現在サイトまたはアプリにいる人数、過去30分、トップページ、トップソース。

ライブカード

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

カテゴリ: 運用。タグ: 数値と指標、チャートとゲージ、オフィスと職場、店舗。

レイアウト

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

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

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

データとプライバシー

フィード：screenrig.visitors/v1。

フィードドキュメントは情報源の帰属を含みます。プレーヤーがカードにフィードを提供します。

プロパティ

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

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

静的プロパティ

名前タイプデフォルト値と制限説明
titlestring"Live visitors"maxLength：40
rowsinteger5最小値：1；最大値：8各リストの行数。
staleMinutesinteger10最小値：1；最大値：1440この期間より古いフィードは、どれくらい前に更新されたかを表示します。
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})?$"メインとセカンダリのテキスト色を上書きします。アクセントと意味的な状態色はそのまま維持されます。

動的プロパティ

名前タイプデフォルト値と制限説明
sitestring""maxLength：60数字が示すサイトまたはアプリ。フィードの勝利。
active整数、nullnull最小値：0；最大値：100000000現在オンラインの訪問者数。空の場合はリストの合計の大きい方を表示します。
seriesarray[]maxItems：60毎分のオンライン訪問者数、最も古い順。最後の30件を表示。
record整数、nullnull最小値：0；最大値：100000000前回の最高カウント。これを超えると記録。フィードのrecordがあればそれが勝ち。
updatedAtstring""maxLength：40数字が最後に変わったとき（ISO 8601）；フィードにfetchedAtがない場合は更新の瞬間を固定。
pagesarray[]maxItems：20トップページはscreenrig.visitors/v1フィードのpagesと同じドキュメント。フィードがある場合はそちらが優先。
pages[].pathstring""maxLength：80ページのパス（/pricing）。
pages[].titlestring""maxLength：80存在する場合、パスの代わりに表示されます。
pages[].visitorsinteger最小値：0；最大値：10000000；必須現在のページの訪問者数。
sourcesarray[]maxItems：20トップソースは、フィードのsourcesと同じドキュメントです。
sources[].namestringminLength：1；maxLength：80；必須訪問者の出所（Google、直接、ニュースレター）。
sources[].visitorsinteger最小値：0；最大値：10000000；必須このソースからの現在の訪問者数。

キャンバス例

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

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

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

{
  "id": "live-visitors",
  "primitive": "card",
  "card": "crd_01EXAMPLECARD000000000",
  "layout": "full",
  "content_fit": "fill"
}

ライブデータを書き込む

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

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

{
  "site": "",
  "active": null,
  "series": [],
  "record": null,
  "updatedAt": "",
  "pages": [],
  "sources": []
}
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":{"site":"","active":null,"series":[],"record":null,"updatedAt":"","pages":[],"sources":[]}}'