ディスプレイスクリーン

Changes Display Screens settings shared by every facility in the facility's brand: the boot screen shown while screens start up, the settings new screens start with, and what templated content shows. Organisation admins only; read the current values and canEdit with display_settings_read boot_screen, screen_defaults or templated.

Actions:

• save_boot_screen: Save the boot screen. Sets the boot screen image (PNG, JPEG or WebP, up to 10 MB, from a public https imageUrl or imageBase64) and/or how it is laid out. Without an image, fit and background re-render the current one. Screens pick it up when they next start. Asks for confirmation.
• reset_boot_screen: Reset the boot screen. Removes the brand's boot screen; screens go back to the default one when they next start. Asks for confirmation.
• save_screen_defaults: Save the screen defaults. The settings a screen starts with when it is paired at one of the brand's facilities. Only the settings you pass change. Screens that are already paired keep their own settings; change those with device_inventory_write configure_screen. Asks for confirmation.
• save_templated: Save templated content settings. What templated content screens and the Schedule show: the data source name, workout names, programs in the Schedule and how far ahead, training phases and how far ahead, and Program Builder training camps (one banner per week) and how far ahead. Asks for confirmation.

施設のディスプレイスクリーングループを作成、名前変更、削除し、各グループに含めるスクリーンを設定します。グループは公開先（display_publish の targets.groupIds）およびコマンドの対象（display_screen_command の groupIds）になります。複数のスクリーン、グループ、対象を指定すると、1 回の呼び出しでそのすべてに対して実行されます。多数を対象にする前にユーザーに確認してください。

Actions:

• save: グループを保存します。作成: name（必要に応じて screenIds）。名前変更: groupId（ID または現在の名前）と name。screenIds はメンバーを置き換えます。一覧にないスクリーンはこのグループから外れますが、他のグループには残ります。
• delete: グループを削除します。グループを削除すると、そのスクリーンはグループから外れ（他のグループには残ります）、グループに公開されたコンテンツはスケジュールから削除されます。groupId が必要です。確認を求めます。

ディスプレイスクリーン用の静的 HTML アプリ（「ホスト型アプリ」）を公開します。最初に display_library_read の app_guidelines を呼び出してスクリーンサイズ、デザインルール、制限、SDK を確認し、公開後は display_screenshot でスクリーン上の結果を確認してください。複数のスクリーン、グループ、対象を指定すると、1 回の呼び出しでそのすべてに対して実行されます。多数を対象にする前にユーザーに確認してください。

Actions:

• publish: ホスト型アプリを公開します。ホスト型アプリを作成する（name + files）か、新しいバージョンを公開します（appId + files。アプリが表示されているすべての場所で公開され、rollback で元に戻せます）。publishTo を指定すると、display_publish と同様にスクリーンにも表示されます。ブランドまたは組織を対象にする場合は confirm が必要です。files が必要です。確認を求める場合があります。
• rollback: ホスト型アプリをロールバックします。以前のバージョンを、アプリが表示されているすべての場所で再び最新にします。バージョンの一覧は display_library_read の app_versions で確認できます。appId と version が必要です。

施設から参照できるディスプレイスクリーンのコンテンツライブラリを読み取ります。メディア（画像、動画）、アプリ（Web ページ、ホスト型 HTML アプリ、AIエージェントアプリ、CCTV ビュー）、プレイリストに加え、追加可能な AIエージェントアプリと CCTV ソースが含まれます。

各アイテムには display_publish とプレイリストで使う contentRef（media#…、app#…、playlist#…）があります。ownerScope は所有者（facility#、brand#、org#）を示し、コンテンツは所有者の範囲内でのみ公開できます。status が processing のメディアはまだ準備ができておらず、failed のメディアは再アップロードが必要です。frameable: false の Web ページはプレイリストでは再生できず、全画面のスクリーンとしてのみ表示できます。displayIssue があるアイテムはスクリーンでスキップされます。対象は、未公開、一時停止中、display-off、対象者限定、または Custom Apps がない AIエージェントアプリと、no-cctv、cctv-off（施設の管理者がディスプレイスクリーンの設定でスクリーンの CCTV をオンにします）、no-cameras の CCTV ビューです。

Actions:

• list: ライブラリのアイテムを一覧表示します。メディアとアプリ（ページング対応。type、kind、tag、名前で絞り込み）、または type に agent-apps を指定すると、スクリーンでの表示が許可され display_publish の content.agentAppId で公開できる AIエージェントアプリを返します。各アイテムの type は media、app、agent-app のいずれかです。
• cctv_sources: CCTV ソースを一覧表示します。display_publish の content.cctv で使う施設のカメラと共有ライブビュー、およびスクリーンでの CCTV 表示がオンかどうかを返します。施設での CCTV アクセス権が必要です。
• get: ライブラリのアイテムを取得します。contentRef で指定した 1 つのメディア、アプリ、またはプレイリストを返します。contentRef が必要です。
• usages: コンテンツの使用場所です。メディアまたはアプリを使用しているライブのスケジュール割り当てとプレイリスト（プレイリストの場合はその割り当て）を返します。使用中のコンテンツは削除できません。contentRef が必要です。
• app_versions: ホスト型アプリのバージョンを一覧表示します。display_hosted_apps_write の rollback 用に、ホスト型アプリのバージョンと現在のバージョンを返します。appId が必要です。
• app_guidelines: ホスト型アプリのガイドラインです。スクリーンサイズ、デザインルール、バンドルの制限、Display App SDK、スターターテンプレートを返します。display_hosted_apps_write の publish 用のアプリを作成する前に呼び出してください。
• check_url: Web ページを確認します。Web ページをプレイリスト内で表示できるかどうか（フレーム内表示を拒否するサイトもあります）と、表示の見え方に関するヒントを返します。フレーム内表示を拒否するページも、全画面のスクリーンとしては表示できます。url が必要です。
• playlists: プレイリストを一覧表示します。施設から参照できるプレイリスト（ページング対応）と、それぞれのアイテム（contentRef、duration、fit）を返します。

ディスプレイスクリーンのライブラリのコンテンツを追加、変更します。画像や動画のアップロード、Web ページ、AIエージェントアプリ、CCTV ビューのアプリの作成、名前、タグ、表示時間、日付の編集、未使用アイテムの削除、アプリのプレビューの更新を行えます。ホスト型 HTML アプリは display_hosted_apps_write で、プレイリストは display_playlists_write で公開します。

画像は 1920×1080（横向き）または 1080×1920（縦向き）でデザインしてください。新しいメディアは、Web 用のバージョンが作成されるまで processing の状態になります。すぐにプレイリストに追加でき、準備ができると再生されます。ownerScope: facility（既定）、brand、organisation（brand と organisation には組織全体へのアクセス権が必要です）。

Actions:

• upload_media: 画像または動画をアップロードします。公開 https の url（推奨。画像は最大 25 MB、動画は最大 200 MB）、または mimeType 付きの base64（最大 20 MB）から画像や動画を追加します。対応形式は JPEG、PNG、WebP、GIF の画像と、MP4、WebM、MOV の動画です（動画は最大 1080p の H.264 MP4 に変換されます）。より大きな動画は create_video_upload を使用します。
• create_video_upload: 大きな動画のアップロードを開始します。最大 2 GB の動画が対象です。動画を登録して署名付きアップロードを返します（upload.expiresAt までに upload.headers を付けてファイルを upload.url に PUT します）。その後、その contentRef で transcode を呼び出します。name、mimeType、bytes が必要です。
• transcode: 動画を処理します。動画をスクリーン用に変換します。create_video_upload の後、失敗後の再試行、またはスクリーンで再生できない古い動画に使用します。contentRef が必要です。
• create_app: アプリを追加します。Web ページ（kind url、url を指定。フレーム内表示を確認します）、AIエージェントアプリ（kind agent-app、display_library_read の list で type agent-apps から取得した agentAppId を指定）、または CCTV ビュー（kind cctv-view、施設が所有、CCTV アクセス権が必要）を追加します。kind と name が必要です。
• update: ライブラリのアイテムを更新します。メディアやアプリの名前、タグ、表示時間、メディアの validFrom/validTo（ISO、null でクリア。期間外はスキップされます）、Web ページの url、または CCTV ビューのカメラ、ビュー、レイアウト、画質を変更します。contentRef が必要です。
• delete: ライブラリのアイテムを削除します。メディアまたはアプリを削除します。ライブのスケジュールやプレイリストで使用中の場合は削除できず、エラーにその一覧が表示されます（先に display_schedule_write の delete または display_playlists_write の save で削除してください）。contentRef が必要です。確認を求めます。
• refresh_preview: アプリのプレビューを更新します。ライブラリのプレビュー用にアプリのスクリーンショットを新しく撮影します（ページが変更された後など）。contentRef が必要です。

ディスプレイスクリーンのプレイリスト（メディアとアプリを順番にループ再生するもの）を作成、更新、削除します。変更は、そのプレイリストを表示しているすべてのスクリーンに数秒以内に反映されます。プレイリストを公開するには、display_publish で content.contentRef に "playlist#" を指定します。

Actions:

• save: プレイリストを保存します。作成: name + items（items は空でもかまいません）。更新: playlistId と、name、items、transition のいずれか。items はリスト全体を置き換えるため、すべてのアイテムを順番どおりに送信してください。
• delete: プレイリストを削除します。プレイリストを削除します。どこかで公開中の場合は削除できず、先に削除すべき割り当てがエラーに表示されます（display_schedule_write の delete）。playlistId が必要です。確認を求めます。

ディスプレイスクリーンにコンテンツを表示します。メディア、プレイリスト、アプリ、Web ページ、AIエージェントアプリ、CCTV ライブビューを、スクリーン、グループ、施設、そのブランド、またはその組織に配信します。

mode: now（既定）は対象の通常の表示内容を置き換えます。scheduled は毎週の時間枠（施設のタイムゾーン）または from から to までの期間、あるいはその両方でのみ表示します。takeover は durationMin の間（または指定時刻まで）すべてに割り込み、その後自動的に終了します（早めに停止するには display_takeover_stop を使用します）。スクリーンは、まずレイヤー（takeover > scheduled > default）、次に対象の具体性（screen > group > facility > brand > organisation）によって表示内容を決定します。

CCTV: ライブのカメラ映像は、スクリーンの近くにいる誰からも見えます。最初の呼び出しでは requiresConfirmation（コード CCTV_CONFIRMATION_REQUIRED）が返されます。ユーザーに確認してから、confirmCctv: true を付けて再度呼び出してください。施設で「ディスプレイスクリーンでの CCTV 表示を許可」がオンになっている必要があります。

公開されたコンテンツを表示するのは player モードのスクリーンのみで、それ以外は warnings に表示されます。batchId が返され、それを使って display_schedule_write の delete を実行すると公開全体を取り消せます。複数のスクリーン、グループ、対象を指定すると、1 回の呼び出しでそのすべてに対して実行されます。多数を対象にする前にユーザーに確認してください。

ディスプレイスクリーンに公開されている内容を読み取ります。1 つのスクリーンについては、特定の時刻と期間に表示する内容（継承するすべてのレイヤーと対象を解決した結果）と、そのスクリーンに届く割り当てを返します。または、グループ、施設、そのブランド、その組織に公開された割り当てを返します。

割り当て ID（as_…）とバッチ ID（bt_…）は、display_schedule_write で更新または削除する対象です。時刻は ISO 形式で、時間枠は施設のタイムゾーンです。

Actions:

• get: スクリーンのスケジュールを取得します。at（既定は現在）にスクリーンが表示する内容、from から to までのタイムライン（既定は 24 時間）、およびそのスクリーンに届くすべての割り当てを返します。screenId が必要です。
• list_assignments: 割り当てを一覧表示します。グループ（groupId）、または施設、そのブランド、その組織（target、既定は facility）に公開された割り当てを返します。ページング対応で、最近変更されたものから順に並びます。

ディスプレイスクリーンに公開されている内容を変更します。割り当てのタイミング、優先度、コンテンツの編集（必要に応じて公開全体に適用）、または 1 つの割り当てや公開全体の削除を行えます。ID は display_schedule_read で確認してください。スケジュールから削除したコンテンツはライブラリに残ります。テイクオーバーを早めに終了しつつ履歴を残すには、display_takeover_stop を使用します。

Actions:

• update: 割り当てを更新します。割り当てのタイミング（毎週の時間枠、from/to。null で日付をクリア）、優先度、コンテンツを変更します。applyToBatch を指定すると、公開のすべての対象に同じ変更を適用します。テイクオーバーは新しい終了時刻のみ変更できます。CCTV コンテンツには、ユーザーの同意後に confirmCctv が必要です。assignmentId が必要です。
• delete: スケジュールから削除します。1 つの割り当て（assignmentId）、または 1 回の公開のすべて（batchId）を削除します。スクリーンは数秒以内に、本来表示する内容に戻ります。確認を求めます。

施設のディスプレイスクリーンにライブコマンドを送信します。reload（player スクリーンがスケジュールを再取得）、identify（スクリーンの名前とコードを点滅表示し、施設内で見つけやすくする）、displayOn/displayOff（テレビのパネル）、rebootDevice（スクリーンのコンピューターを再起動。1～2 分間表示が消えます。confirm: true が必要）、osd（短いオンスクリーンメッセージ。message を指定）のいずれかです。

スクリーンは screenIds または groupIds（施設内のそのグループのすべてのスクリーン）、あるいはその両方で指定します。施設内のすべてのスクリーンを対象にするには allScreens: true を指定します（その場合、displayOn/displayOff はテンプレートコンテンツのスクリーンにも届きます）。スクリーンごとの結果が返されます。複数のスクリーン、グループ、対象を指定すると、1 回の呼び出しでそのすべてに対して実行されます。多数を対象にする前にユーザーに確認してください。

施設のディスプレイスクリーンを読み取ります。スクリーンをステータス、現在と次の表示内容とともに一覧表示する（グループ、ステータス、表示モードで絞り込み）、1 つのスクリーンの詳細とタイムラインを取得する、またはスクリーングループをそのスクリーンとともに一覧表示することができます。

表示モードはユーザーには「データソース」として表示されます。player は「ユーザー管理コンテンツ」、program-builder は「テンプレートコンテンツ」（ユーザーには必ず「テンプレートコンテンツ」と呼び、旧称は使わないでください）、url は「全画面 Web サイト（キオスクモード）」です。時刻は ISO 形式で、施設のタイムゾーンも返されます。

Actions:

• list: スクリーンを一覧表示します。施設のスクリーン（ページング対応）と、それぞれのステータス、最後のハートビート、グループ、タグ、現在と次の表示内容を返します。グループも返されます。
• get: スクリーンを取得します。1 つのスクリーンの詳細（ステータス、ハートビート、プレーヤーのバージョン、最近のエラー）と、player スクリーンの場合は指定期間に表示する内容（既定は今後 24 時間、最大 14 日）を返します。screenId が必要です。
• groups: スクリーングループを一覧表示します。施設のスクリーングループ（ページング対応）と、それぞれのスクリーンを返します。

ディスプレイスクリーンを変更します。ペアリングコードによる新しいスクリーンのペアリング、スクリーンの名前変更、グループとタグの設定、表示モード（ユーザーには「データソース」として表示）の切り替え、player スクリーンのトークンのローテーション、スクリーンまたはコンテンツの期間限定プレビューリンクの作成、スクリーンの初期化（施設から削除）を行えます。

表示モード: player（「ユーザー管理コンテンツ」）、url（「全画面 Web サイト（キオスクモード）」。url を指定、https のみ）、program-builder（「テンプレートコンテンツ」。ユーザーには必ず「テンプレートコンテンツ」と呼び、旧称は使わないでください）。モードを変更するとスクリーンがすぐに再読み込みされ、メンバーに見える内容が変わるため、ユーザーの確認が必要です。

Actions:

• update: スクリーンを更新します。スクリーンの名前、グループ（ID または名前。現在のグループを置き換えます）、タグ（置き換えます）、表示モードのいずれかを設定します。モードを変更すると、最初に requiresConfirmation が返されます。screenId が必要です。確認を求める場合があります。
• rotate_token: スクリーンのトークンをローテーションします。player スクリーンに新しいトークンを発行して再読み込みします。古いトークンは使えなくなります。スクリーンのプレーヤー URL が漏洩した可能性がある場合に使用します。screenId が必要です。確認を求めます。
• create_preview_link: プレビューリンクを作成します。スクリーンの表示内容やコンテンツの見え方を、必要に応じて将来の時刻で表示するリンク（期間限定）です。リンクを知っていれば誰でも、有効期限まで閲覧できます。
• reset: スクリーンを初期化します。スクリーンを施設から削除して初期化します。電源がオフのスクリーンは次にオンラインになったときに初期化され、ペアリングページを表示します。confirmName には、ユーザーが入力したとおりのスクリーン名を指定します。デバイス管理が必要です。screenId と confirmName が必要です。確認を求めます。
• pair: 新しいスクリーンをペアリングします。ペアリングページに表示される 6 文字のコードで新しいスクリーンを施設に追加し、再読み込みします。ディスプレイスクリーンのみの施設では player で開始します。テンプレートコンテンツもある施設では mode で選択します（既定は program-builder）。デバイス管理が必要です。pairingCode と name が必要です。確認を求めます。

ディスプレイスクリーンに現在表示されている内容をキャプチャして画像を返します。公開後に自分の作業（レイアウト、文字サイズ、見切れやスクロールがないこと）を確認するのに使用します。スクリーンの応答を最大 15 秒待ち、オフラインのスクリーンはタイムアウトします。JPEG のポータル URL も返されます（サインインしたユーザーのみ閲覧可能、10 分間保持）。

スクリーンショットにはライブ CCTV や映り込んだメンバーが含まれる場合があります。会話の外では共有しないでください。

Reads Display Screens settings for a facility: the fallback slate, polling and nightly reload, CCTV on screens; the screen power schedule (with the next days' on/off times); automations (brightness, bell volume, check-in power, round timer state); the brand's boot screen, screen defaults and templated content settings; and, with templated content, the scheduled program dates and the templated schedule.

Actions:

• settings: Get facility display settings. The fallback slate (message, background, logo, facility name), polling interval, nightly reload time and whether CCTV may be shown on screens.
• power_schedule: Get the power schedule. When screens turn on and off: the saved schedule (or the older automations' equivalent), the facility time zone and the on/off times for the next 7 days.
• power_schedule_preview: Preview a power schedule. The on/off times a schedule would give over the next 7 days, without saving it. Needs schedule.
• automations: Get display automations. Automatic brightness (day/night levels and triggers), bell volume levels and schedule (decimal hours, 6.5 = 06:30), check-in power, and the round timer state, for one or several facilities. usesGlobalDefaults is true until the facility saves its own.
• boot_screen: Get the brand's boot screen. The image the facility's brand shows while screens start up (fit, background, image URLs) and whether you can change it (organisation admins).
• screen_defaults: Get the brand's screen defaults. The settings a screen starts with when it is paired at one of the brand's facilities (orientation, screen mirroring, session timer, speaker control, duress monitoring, camera restreaming, Wi-Fi support) and whether you can change them (organisation admins). Screens that are already paired keep their own settings; see device_inventory_read for those.
• templated: Get the brand's templated content settings. What templated content screens and the Schedule show for the facility's brand (source name, workout names, programs and training phases, look-ahead days) and whether you can change it (organisation admins).
• program_dates: List scheduled program dates. The dates with a workout program, from the start of this month to the brand's look-ahead. Needs templated content (Program Builder) at the facility.
• templated_schedule: Get the templated schedule. Programs and training phases between two dates (YYYY-MM-DD, at most 62 days), as the brand shows them. Needs templated content (Program Builder) at the facility. Needs from, to.

施設のディスプレイスクリーンの設定を変更します。代替画面、ポーリングと夜間の再読み込み、「ディスプレイスクリーンでの CCTV 表示を許可」、スクリーンの電源スケジュール、自動化（明るさ、ベルの音量、チェックイン時の電源）が対象です。指定しなかったフィールドは現在の値を維持します。ブランド全体の設定（起動画面、テンプレートコンテンツ）は display_brand_settings_write で変更します。

Actions:

• save_settings: 施設のディスプレイ設定を保存します。何もスケジュールされていないときに表示する代替画面、ポーリング間隔（30～300 秒）、夜間の再読み込み時刻（HH:mm）、allowCctv を設定します。allowCctv をオンにするには、ユーザーの確認と、CCTV アクセス権を持つ施設の管理者が必要です。確認を求める場合があります。
• save_power_schedule: 電源スケジュールを保存します。スクリーンがオン/オフになるタイミングを変更します。指定したフィールドは保存済みのスケジュールにマージされます。今後 7 日間のオン/オフ時刻を返します。先に display_settings_read の power_schedule_preview で確認してください。schedule が必要です。
• save_automations: ディスプレイ自動化を保存します。明るさの自動調整、ベルの音量、チェックイン時の電源の設定を変更します。以降、施設はグローバルの既定値ではなく独自の設定を使用します。

実行中のディスプレイスクリーンのテイクオーバーを今すぐ終了します。対象は、1 回の公開（display_publish の batchId）、指定した対象（既定: 施設全体に公開されたテイクオーバー）、または allScreens を指定した場合は施設、そのスクリーン、またはそのグループに公開されたすべてのテイクオーバーです。ブランドと組織のテイクオーバーは batchId でのみ停止できます。スクリーンは数秒以内にスケジュール済みまたは既定のコンテンツに戻り、停止した件数が返されます。複数のスクリーン、グループ、対象を指定すると、1 回の呼び出しでそのすべてに対して実行されます。多数を対象にする前にユーザーに確認してください。

テンプレートコンテンツのスクリーン（display_screens_read で表示モードが「テンプレートコンテンツ」のもの）を操作します。その日のワークアウトプログラムを読み込むか、ラウンドタイマーを操作します。ユーザー管理コンテンツと全画面 Web サイトのスクリーンには影響しません。

Actions:

• load_program: ワークアウトプログラムを読み込みます。1 つまたは複数の施設のすべてのテンプレートコンテンツのスクリーンに、施設のデータソースから指定日（YYYY-MM-DD、既定は今日）のワークアウトプログラムを読み込みます。スクリーンは数秒以内に再読み込みされます。今日または別の日のワークアウトを表示するとき、またはスクリーンに誤った内容が表示されているときに使用します。複数の施設を対象にする場合は confirm が必要です。確認を求める場合があります。
• clock: ラウンドタイマーを操作します。テンプレートコンテンツのスクリーンでラウンドタイマーの再生、一時停止、再開始、停止、ラウンドの音のミュートとミュート解除、ベルの音量の設定（setvolume で volume 0～100）、または状態の取得を行います。施設でテンプレートコンテンツが必要です。command が必要です。