OpenAPI YAMLOpenAPI JSON問題 YAMLAPI の概要
このグループには 16 件のオペレーションがあり、api/openapi.yaml から生成されています。パス、アクション、認証で絞り込めます。各エンドポイントには入力が一覧され、展開するとリクエストテンプレートとレスポンスコードを確認できます。テンプレートには、ご自身の値とスキーマに適合する本文が必要です。
大文字のプレースホルダーをあなたの値に置き換えます。JSONリクエストの場合、request.jsonのスキーマに合うボディを保存します。Cookie例は認証済みセッションのローカルCookieジャーを使用します。
プレイリスト
プレイリスト V2 一覧
広告スロットページを公開する可能性のあるバージョン管理されたプレイリストリスト。v1リストはフィルタリングせずにversion_requiredを持つ広告文書のページを拒否します。
ページはlistPlaylistsのように新しい順で、1ページあたり最大200件、8MiBのplaylist保存容量に達すると少なくなります。next_cursorは最後に返された行の位置で、さらに行がある場合はafterとして同じフィルターで次ページに渡します。最後のページではnext_cursorはnullです。library=trueを指定すると、代わりに組織のライブラリのプレイリストを一覧します(読み取り専用。スケジュールに組み込むか、そのテンプレートから作成できます)。
パラメーター
| 名前 | 送信する | 必須? | 説明 |
|---|---|---|---|
| ScreenRig-Project | ヘッダー | オプション | 1リリースの間非推奨。JWTプロジェクトの権限と整合性が必要。Deprecation と Warning ヘッダーを追加。トークン交換なし。 |
| library | クエリ | オプション | true を指定すると、このプロジェクトの代わりに組織のライブラリプロジェクトを一覧します。その項目はここでは読み取り専用で、library true が付きます。ライブラリのない組織や、ライブラリプロジェクト自身で true を指定すると、何も一覧されません。 |
| 以降 | クエリ | オプション | 同じリストの前のページの next_cursor。同じフィルター付き。省略時は最新行から開始。カーソルでない値は invalid_request。 |
リクエストテンプレートとレスポンス
curl --request GET --header 'Authorization: Bearer [SCREENRIG_TOKEN]' --cookie cookies.txt --cookie-jar cookies.txt 'https://screenrig.ai/api/playlists'レスポンス
| ステータス | 意味 | 本文とヘッダー |
|---|---|---|
| 200 | 広告スロットページの結合を含むプレイリスト。 | PlaylistV2List(application/json) |
| デフォルト | 安定した RFC 9457 問題応答。421 server_draining は Retry-After 1秒、500 not_ready または dependency_unavailable は 5秒、500 manifest_degraded は 60秒を持ちます。ハンドラーがより具体的な値を設定していない場合。 | 問題 (application/problem+json) |
プレイリストV2を作成
広告スロットページの結合の作成エントリ。最大16の広告スロットページ、少なくとも1つの表示されない通常ページ、および異なるページでの1つのスロット定義の再利用はサーバーチェックのままです。参照解決とDNSもサーバーチェックです。
ダッシュボードセッション(ページエディター)はプレイリストを提案ではなく即時に公開して作成し、その人物の操作として記録します。プロジェクトのオーナーか承認できるメンバーが必要です(それ以外は approver_required)。レビュー待ちのメディアを指定すると media_pending_review (409) になります(エージェントの即時書き込みでは承認されます)。
Player ウェブアプリでフレーム化できない iframe ページを含む書き込みも保存されます。応答に警告(PlaylistWarning)が含まれ、ページごとに playlist.iframe_framing_refused イベントがプロジェクトのログに追加されます。
iframe の src、fallback_src、またはアプリケーションの params が、プレイリストを表示するスクリーンにないスクリーントークン({screen.field.NAME} など、プリミティブスキーマにあるもの)を読み取る書き込みも、そのようなスクリーンを最初の20件挙げた screen_fact_missing 警告を返します。それらのスクリーンのマニフェストからはそのプリミティブが除外されます。
Google スライド、ドキュメント、スプレッドシートのリンク(共有、ウェブに公開、埋め込み)または Microsoft 365 の OneDrive や SharePoint の埋め込みリンクである iframe の src または fallback_src は、スクリーン向けに再構築されて保存されます。スライドはループし、リンクの delayms をページの長さに制限して進み、ドキュメント、スプレッドシート、Word、Excel は 5 分ごとに再読み込みされます。
src または fallback_src に貼り付けられた <iframe> 埋め込みコードは、その src が読み取られます。閲覧者にサインインを求めるファイルは document_not_shared (400) で拒否され、その errors[0].field はその src または fallback_src で、詳細には変更すべき共有設定が示されます。
パラメーター
| 名前 | 送信する | 必須? | 説明 |
|---|---|---|---|
| ScreenRig-Project | ヘッダー | オプション | 1リリースの間非推奨。JWTプロジェクトの権限と整合性が必要。Deprecation と Warning ヘッダーを追加。トークン交換なし。 |
| Screenrig-Review-Note | ヘッダー | オプション | オプションの提案者メモ。レビュークラスの書き込み時に送信され、パーセントエンコードされたUTF-8(JavaScriptのencodeURIComponentが書くもの)です。サーバーはパーセントデコードします(無効なエスケープは400 invalid_request)。デコードされたメモはプレーンテキストで、トリム後最大280文字、制御文字なし(そうでなければ400 invalid_request)。 書き込みが1になるとレビューに保存されます。ライブ適用時は無視されます。 |
| Idempotency-Key | ヘッダー | オプション | 新規操作のために省略します。再試行の重複排除にキーを供給し再利用してください。CLIがキーを自動管理します。 |
リクエストテンプレートとレスポンス
curl --request POST --header 'Authorization: Bearer [SCREENRIG_TOKEN]' --cookie cookies.txt --cookie-jar cookies.txt --header 'Content-Type: application/json' --data '@request.json' 'https://screenrig.ai/api/playlists'レスポンス
| ステータス | 意味 | 本文とヘッダー |
|---|---|---|
| 202 | 書き込みはレビューになり、ユーザーの承認を待っています(docs/reviews.md)。これは提案アクセスの場合、または任意のアクセスレベルで保護されたスクリーンフォルダー内のスクリーンに及ぶ場合で、後者は2人目の承認者が決定します(docs/screen-scope.md)。ユーザーは review.url のダッシュボードで承認、拒否、または変更を依頼します。 Idempotency-Key のリプレイは同じ本文を返します。 | ReviewPending(application/json) |
| 201 | 広告スロットページを含むプレイリスト。 | PlaylistV2(application/json) |
| 402 | feature_not_in_plan — フィールドの宣言、プリミティブのロック、フィールドを宣言するプレイリストの変更はプレイリストテンプレートであり、プロジェクトのプランには含まれていません。required_plan が、含まれるプランを示します。テンプレートからのプレイリストの作成は常に許可されます。 2台以上のディスプレイのフォーマット(ビデオウォール)は Plus に含まれます。領域のフォーマットと、フォーマットのないプレイリストは、すべてのプランで利用できます。問題には、機能、プロジェクトのプラン、required_plan が示されます。 | 問題 (application/problem+json) |
| デフォルト | 安定した RFC 9457 問題応答。421 server_draining は Retry-After 1秒、500 not_ready または dependency_unavailable は 5秒、500 manifest_degraded は 60秒を持ちます。ハンドラーがより具体的な値を設定していない場合。 | 問題 (application/problem+json) |
プレイリスト V2 を取得
パラメーター
| 名前 | 送信する | 必須? | 説明 |
|---|---|---|---|
| ScreenRig-Project | ヘッダー | オプション | 1リリースの間非推奨。JWTプロジェクトの権限と整合性が必要。Deprecation と Warning ヘッダーを追加。トークン交換なし。 |
| ID | パス | 必須 |
リクエストテンプレートとレスポンス
curl --request GET --header 'Authorization: Bearer [SCREENRIG_TOKEN]' --cookie cookies.txt --cookie-jar cookies.txt 'https://screenrig.ai/api/playlists/RESOURCE_ID'レスポンス
| ステータス | 意味 | 本文とヘッダー |
|---|---|---|
| 200 | 広告スロットページを含むプレイリスト。 | PlaylistV2(application/json) |
| デフォルト | 安定した RFC 9457 問題応答。421 server_draining は Retry-After 1秒、500 not_ready または dependency_unavailable は 5秒、500 manifest_degraded は 60秒を持ちます。ハンドラーがより具体的な値を設定していない場合。 | 問題 (application/problem+json) |
プレイリストV2を更新
広告スロットページのユニオンを受け入れるバージョン管理された更新。If-Matchはプレイリストリビジョンを含みます。
ダッシュボードセッション(ページエディター)はプレイリストを提案ではなく即時に公開して置き換え、その人物の操作として記録します。プロジェクトのオーナーか承認できるメンバー(それ以外は approver_required)と If-Match(ない場合は invalid_request)が必要です。まだ人物が承認していないプレイリストは、patchPlaylistStructure と同じく playlist_not_approved (409) です。ページがレビュー待ちのメディアを指定すると media_pending_review (409) です。
Player ウェブアプリでフレーム化できない iframe ページを含む書き込みも保存されます。応答に警告(PlaylistWarning)が含まれ、ページごとに playlist.iframe_framing_refused イベントがプロジェクトのログに追加されます。
iframe の src、fallback_src、またはアプリケーションの params が、プレイリストを表示するスクリーンにないスクリーントークン({screen.field.NAME} など、プリミティブスキーマにあるもの)を読み取る書き込みも、そのようなスクリーンを最初の20件挙げた screen_fact_missing 警告を返します。それらのスクリーンのマニフェストからはそのプリミティブが除外されます。
Google スライド、ドキュメント、スプレッドシートのリンク(共有、ウェブに公開、埋め込み)または Microsoft 365 の OneDrive や SharePoint の埋め込みリンクである iframe の src または fallback_src は、スクリーン向けに再構築されて保存されます。スライドはループし、リンクの delayms をページの長さに制限して進み、ドキュメント、スプレッドシート、Word、Excel は 5 分ごとに再読み込みされます。
src または fallback_src に貼り付けられた <iframe> 埋め込みコードは、その src が読み取られます。閲覧者にサインインを求めるファイルは document_not_shared (400) で拒否され、その errors[0].field はその src または fallback_src で、詳細には変更すべき共有設定が示されます。
パラメーター
| 名前 | 送信する | 必須? | 説明 |
|---|---|---|---|
| ScreenRig-Project | ヘッダー | オプション | 1リリースの間非推奨。JWTプロジェクトの権限と整合性が必要。Deprecation と Warning ヘッダーを追加。トークン交換なし。 |
| Screenrig-Review-Note | ヘッダー | オプション | オプションの提案者メモ。レビュークラスの書き込み時に送信され、パーセントエンコードされたUTF-8(JavaScriptのencodeURIComponentが書くもの)です。サーバーはパーセントデコードします(無効なエスケープは400 invalid_request)。デコードされたメモはプレーンテキストで、トリム後最大280文字、制御文字なし(そうでなければ400 invalid_request)。 書き込みが1になるとレビューに保存されます。ライブ適用時は無視されます。 |
| ID | パス | 必須 | |
| If-Match | ヘッダー | オプション | オプションの正のリソースリビジョン。現在のリソースを書き込む場合は省略します。提供された古いリビジョンはrevision_conflictです。 |
| Idempotency-Key | ヘッダー | オプション | 新規操作のために省略します。再試行の重複排除にキーを供給し再利用してください。CLIがキーを自動管理します。 |
リクエスト本文フィールド
| フィールド | 説明 |
|---|---|
| name(必須、文字列) | minLength: 1 maxLength: 120 |
| fields(任意、PlaylistTemplateFields) | フィールドを宣言するとプレイリストはテンプレートになります。ページが読み取るすべてのトークンは正しい型の宣言済みフィールドを指し、すべてのフィールドが読み取られる必要があります。フィールドのないプレイリストはトークンを読み取りません。テンプレートは画面に表示されません(playlist_is_template)。fields を含まない PUT はフィールドを保持し、null または空の配列は削除します。 |
| ページ(必須、配列) | 1つのプレイリストのページは合計で最大1024のメディア参照に解決されます。by:idsセレクターは長さをカウントします。by:all、by:tag、by:folder定義はカタログサイズに関係なく32参照を予約します。実際のループスナップショットは合計1024メディア参照に制限されます。どちらかの予算を超えると422 invalid at path pagesになります。 |
| audio(任意、PlaylistAudioWrite) | オプションのプレイリストサウンドトラック:ページが変わる間連続再生される順序付き準備済みオーディオ(MP3)メディア(docs/playlist-audio.md)。ページ変更は停止や再起動をしません。PUTはプレイリスト全体を置き換えるため、audioを省略するとサウンドトラックが削除されます。 |
| format(任意、PlaylistFormat) | プレイリストが作成される対象:ビデオウォール (PlaylistWallFormat) または領域 (PlaylistRegionFormat) のどちらか一方で、両方ではありません。フォーマットのないプレイリストは、ページとして任意のスクリーンにバインドされる通常のプレイリストです。 |
リクエストテンプレートとレスポンス
curl --request PUT --header 'Authorization: Bearer [SCREENRIG_TOKEN]' --cookie cookies.txt --cookie-jar cookies.txt --header 'Content-Type: application/json' --data '@request.json' 'https://screenrig.ai/api/playlists/RESOURCE_ID'レスポンス
| ステータス | 意味 | 本文とヘッダー |
|---|---|---|
| 202 | 書き込みはレビューになり、ユーザーの承認を待っています(docs/reviews.md)。これは提案アクセスの場合、または任意のアクセスレベルで保護されたスクリーンフォルダー内のスクリーンに及ぶ場合で、後者は2人目の承認者が決定します(docs/screen-scope.md)。ユーザーは review.url のダッシュボードで承認、拒否、または変更を依頼します。 Idempotency-Key のリプレイは同じ本文を返します。 | ReviewPending(application/json) |
| 200 | プレイリストを更新しました。 | PlaylistV2(application/json) |
| 402 | feature_not_in_plan — フィールドの宣言、プリミティブのロック、フィールドを宣言するプレイリストの変更はプレイリストテンプレートであり、プロジェクトのプランには含まれていません。required_plan が、含まれるプランを示します。テンプレートからのプレイリストの作成は常に許可されます。 プレイリスト自身のものとは異なるビデオウォールのフォーマット(2台以上のディスプレイ)の設定は Plus に含まれます。問題には、機能、プロジェクトのプラン、required_plan が示されます。 | 問題 (application/problem+json) |
| デフォルト | 安定した RFC 9457 問題応答。421 server_draining は Retry-After 1秒、500 not_ready または dependency_unavailable は 5秒、500 manifest_degraded は 60秒を持ちます。ハンドラーがより具体的な値を設定していない場合。 | 問題 (application/problem+json) |
パッチプレイリスト
指定された最上位フィールド(name、pages、audio、format、fields)のみを変更します。省略したフィールドは同じトランザクションのスナップショットから保持されます。指定した pages、audio、format は値全体を置き換え、audio を null にするとサウンドトラックが、format を null にするとフォーマットが削除されます。ネストされた配列の要素はマージされません。
承認済みプレイリストの名前のみの編集は、変更されていないコンテンツや古い保存ページ形式の再検証や再解決を行いません。提供されたコンテンツとオーディオ/ページキューの関係は検証されます。If-Matchはオプションで改訂を保護し、同一のパッチは無操作であり、冪等な再試行は元の応答を再生します。
Propose アクセスとレビューポリシーは PUT と同様です。指定された pages に Player ウェブアプリでフレーム化できない iframe ページがある場合の警告も含みます。PUT は引き続き文書全体を置き換えます。
パラメーター
| 名前 | 送信する | 必須? | 説明 |
|---|---|---|---|
| ScreenRig-Project | ヘッダー | オプション | 1リリースの間非推奨。JWTプロジェクトの権限と整合性が必要。Deprecation と Warning ヘッダーを追加。トークン交換なし。 |
| Screenrig-Review-Note | ヘッダー | オプション | オプションの提案者メモ。レビュークラスの書き込み時に送信され、パーセントエンコードされたUTF-8(JavaScriptのencodeURIComponentが書くもの)です。サーバーはパーセントデコードします(無効なエスケープは400 invalid_request)。デコードされたメモはプレーンテキストで、トリム後最大280文字、制御文字なし(そうでなければ400 invalid_request)。 書き込みが1になるとレビューに保存されます。ライブ適用時は無視されます。 |
| ID | パス | 必須 | |
| If-Match | ヘッダー | オプション | オプションの正のリソースリビジョン。現在のリソースを書き込む場合は省略します。提供された古いリビジョンはrevision_conflictです。 |
| Idempotency-Key | ヘッダー | オプション | 新規操作のために省略します。再試行の重複排除にキーを供給し再利用してください。CLIがキーを自動管理します。 |
リクエスト本文フィールド
| フィールド | 説明 |
|---|---|
| name(任意、文字列) | minLength: 1 maxLength: 120 |
| ページ(任意、配列) | |
| fields(任意、inline) | |
| audio(任意、インライン) | |
| format(任意、インライン) |
リクエストテンプレートとレスポンス
curl --request PATCH --header 'Authorization: Bearer [SCREENRIG_TOKEN]' --header 'Content-Type: application/json' --data '@request.json' 'https://screenrig.ai/api/playlists/RESOURCE_ID'レスポンス
| ステータス | 意味 | 本文とヘッダー |
|---|---|---|
| 202 | 書き込みはレビューになり、ユーザーの承認を待っています(docs/reviews.md)。これは提案アクセスの場合、または任意のアクセスレベルで保護されたスクリーンフォルダー内のスクリーンに及ぶ場合で、後者は2人目の承認者が決定します(docs/screen-scope.md)。ユーザーは review.url のダッシュボードで承認、拒否、または変更を依頼します。 Idempotency-Key のリプレイは同じ本文を返します。 | ReviewPending(application/json) |
| 200 | プレイリストを更新しました。ETagにリビジョンが含まれます。 | PlaylistV2(application/json) |
| 402 | feature_not_in_plan — フィールドの宣言、プリミティブのロック、フィールドを宣言するプレイリストの変更はプレイリストテンプレートであり、プロジェクトのプランには含まれていません。required_plan が、含まれるプランを示します。テンプレートからのプレイリストの作成は常に許可されます。 プレイリスト自身のものとは異なるビデオウォールのフォーマット(2台以上のディスプレイ)の設定は Plus に含まれます。問題には、機能、プロジェクトのプラン、required_plan が示されます。 | 問題 (application/problem+json) |
| デフォルト | 安定した RFC 9457 問題応答。421 server_draining は Retry-After 1秒、500 not_ready または dependency_unavailable は 5秒、500 manifest_degraded は 60秒を持ちます。ハンドラーがより具体的な値を設定していない場合。 | 問題 (application/problem+json) |
プレイリストV2削除
認証済みプロジェクトが所有するプレイリストを削除済みとして記録します。アーカイブ済みまたは保留中のものを含むいずれかの画面が、そのプレイリストを既定、スケジュール、または割り込み表示に使用している間、画面フォルダーが既定として使用している間、またはキャンペーンが再生している間は、resource_conflict (409) で拒否されます。
ダッシュボードセッションは削除も可能です。createPlaylistV2 と updatePlaylistV2 でプレイリストを作成・置き換えし、patchPlaylistStructure で構造を変更します。
パラメーター
| 名前 | 送信する | 必須? | 説明 |
|---|---|---|---|
| ScreenRig-Project | ヘッダー | オプション | 1リリースの間非推奨。JWTプロジェクトの権限と整合性が必要。Deprecation と Warning ヘッダーを追加。トークン交換なし。 |
| ID | パス | 必須 | |
| If-Match | ヘッダー | オプション | オプションの正のリソースリビジョン。現在のリソースを書き込む場合は省略します。提供された古いリビジョンはrevision_conflictです。 |
| Idempotency-Key | ヘッダー | オプション | 新規操作のために省略します。再試行の重複排除にキーを供給し再利用してください。CLIがキーを自動管理します。 |
リクエストテンプレートとレスポンス
curl --request DELETE --header 'Authorization: Bearer [SCREENRIG_TOKEN]' --cookie cookies.txt --cookie-jar cookies.txt 'https://screenrig.ai/api/playlists/RESOURCE_ID'レスポンス
| ステータス | 意味 | 本文とヘッダー |
|---|---|---|
| 204 | プレイリストはトゥームストーン済み。 | 本文なし |
| 409 | 安定した RFC 9457 問題応答。421 server_draining は Retry-After 1秒、500 not_ready または dependency_unavailable は 5秒、500 manifest_degraded は 60秒を持ちます。ハンドラーがより具体的な値を設定していない場合。 | 問題 (application/problem+json) |
| デフォルト | 安定した RFC 9457 問題応答。421 server_draining は Retry-After 1秒、500 not_ready または dependency_unavailable は 5秒、500 manifest_degraded は 60秒を持ちます。ハンドラーがより具体的な値を設定していない場合。 | 問題 (application/problem+json) |
パッチプレイリスト構造
サインインした人はプレイリストの構造(名前、ページの順序、残すページ、各ページの進行と表示)を変更します。pagesは完全な新しい順序で、保存済みのページを省略すると削除され、プレイリストにないIDや重複IDはpages[i].idでinvalid_requestです。
保持されたページのキャンバス、トランジション、audio_cue、プリミティブおよびコメントは常に保存されたものです:ボディにそれらのメンバーはなく、他のメンバーは拒否されます。
保持されたページは保存されたplaylistと同じ解決と検証を経るため、その間に削除されたメディアアイテムは拒否され(resource_conflict)、playlistは最大16の広告スロットページとaudio_endキューを持つ通常のページを1つ保持します。advanceはページのadvanceを置き換えます(広告スロットページはなし);visibilityはオブジェクト時にページのvisibilityを置き換え、null時に削除し、省略時に保持します。
プレイリストを保存された状態のまま変更することは操作なしとみなされます。If-Match はプレイリストのリビジョンを保持し、必須です(欠如時は invalid_request、古い場合は revision_conflict)。書き込みはプレイリストを表示しているすべてのスクリーンに即時反映され、playlist.updated の人物に帰属します。提案ではないため、応答は決して 202 になりません。
まだ誰も承認していないプレイリスト(approved_revision 0)は playlist_not_approved (409) で拒否されます。先にそのレビューを決定してください。プロジェクト内の別のプレイリストが使っている名前は resource_conflict です。ダッシュボードのセッションのみ。エージェントは patchPlaylist でプレイリストを変更し、ページの表示内容は updatePlaylistV2 で人が変更します。
他の書き込みと同様、応答には警告(PlaylistWarning)が含まれます。その中には、プレイリストを表示するスクリーンが、ページの iframe の src またはアプリケーションの params が読み取る値を持たない場合の screen_fact_missing があります。本文は最大64 KiB です。
パラメーター
| 名前 | 送信する | 必須? | 説明 |
|---|---|---|---|
| ID | パス | 必須 | |
| If-Match | ヘッダー | 必須 | プレイリストの現在のリビジョン、引用符付きまたは素のまま(最後に読み取ったETag)。古いリビジョンはrevision_conflictとcurrent_revisionです。 |
| Idempotency-Key | ヘッダー | オプション | 新規操作のために省略します。再試行の重複排除にキーを供給し再利用してください。CLIがキーを自動管理します。 |
リクエスト本文フィールド
| フィールド | 説明 |
|---|---|
| name(任意、文字列) | minLength: 1 maxLength: 120 |
| ページ(任意、配列) | 再生順に残るすべてのページ。プレイリストが保持しないID、または2回リストされたIDはpages[i].idでinvalid_requestです。結果はプレイリストのルールを満たす必要があります:可視性なしの通常ページが少なくとも1つ、広告スロットページは最大16、audio_endページはaudio_cueを保持。 |
リクエストテンプレートとレスポンス
curl --request PATCH --cookie cookies.txt --cookie-jar cookies.txt --header 'If-Match: "REVISION"' --header 'Content-Type: application/json' --data '@request.json' 'https://screenrig.ai/api/playlists/RESOURCE_ID/structure'レスポンス
| ステータス | 意味 | 本文とヘッダー |
|---|---|---|
| 200 | 現在保存されているプレイリスト。ETagにリビジョンが含まれます。 | PlaylistV2(application/json);ヘッダー:ETag |
| 402 | feature_not_in_plan — フィールドの宣言、プリミティブのロック、フィールドを宣言するプレイリストの変更はプレイリストテンプレートであり、プロジェクトのプランには含まれていません。required_plan が、含まれるプランを示します。テンプレートからのプレイリストの作成は常に許可されます。 | 問題 (application/problem+json) |
| 409 | playlist_not_approved — プレイリストに承認済みバージョンがありません。resource_conflict — 名前が使用中、またはメディアアイテムや保持されたページ名が準備できていません。 | 問題 (application/problem+json) |
| 412 | revision_conflict — If-Match が古くなっています。エラーの current_revision に現在のリビジョンが含まれます。 | 問題 (application/problem+json) |
| デフォルト | 安定した RFC 9457 問題応答。421 server_draining は Retry-After 1秒、500 not_ready または dependency_unavailable は 5秒、500 manifest_degraded は 60秒を持ちます。ハンドラーがより具体的な値を設定していない場合。 | 問題 (application/problem+json) |
プレイリストのリビジョン一覧
The playlist's revisions, newest first: each revision a write stored (a create, a replace, a patch, a structure change, an applied review, a promote) with its name, its page count, the kind of change and who made it.
History begins with the revision a playlist held when revision history was first recorded: until its next write the list holds that revision alone, with change baseline. Revisions are kept for as long as the playlist is. At most 50 per page; next_cursor while more remain, null on the last page.
パラメーター
| 名前 | 送信する | 必須? | 説明 |
|---|---|---|---|
| ScreenRig-Project | ヘッダー | オプション | 1リリースの間非推奨。JWTプロジェクトの権限と整合性が必要。Deprecation と Warning ヘッダーを追加。トークン交換なし。 |
| ID | パス | 必須 | |
| 以降 | クエリ | オプション | 同じリストの前のページの next_cursor。同じフィルター付き。省略時は最新行から開始。カーソルでない値は invalid_request。 |
リクエストテンプレートとレスポンス
curl --request GET --header 'Authorization: Bearer [SCREENRIG_TOKEN]' --cookie cookies.txt --cookie-jar cookies.txt 'https://screenrig.ai/api/playlists/RESOURCE_ID/revisions'レスポンス
| ステータス | 意味 | 本文とヘッダー |
|---|---|---|
| 200 | プレイリストのリビジョン(新しい順)。 | PlaylistRevisionList(application/json) |
| デフォルト | 安定した RFC 9457 問題応答。421 server_draining は Retry-After 1秒、500 not_ready または dependency_unavailable は 5秒、500 manifest_degraded は 60秒を持ちます。ハンドラーがより具体的な値を設定していない場合。 | 問題 (application/problem+json) |
プレイリストのリビジョンを取得
One revision of the playlist and the playlist as it stood at that revision: its name, pages, soundtrack and format, with revision set to this one. A revision the playlist never had, or one from before its history began, is not_found.
パラメーター
| 名前 | 送信する | 必須? | 説明 |
|---|---|---|---|
| ScreenRig-Project | ヘッダー | オプション | 1リリースの間非推奨。JWTプロジェクトの権限と整合性が必要。Deprecation と Warning ヘッダーを追加。トークン交換なし。 |
| ID | パス | 必須 | |
| リビジョン | パス | 必須 | プレイリストのリビジョン(listPlaylistRevisions が付ける番号)。 |
リクエストテンプレートとレスポンス
curl --request GET --header 'Authorization: Bearer [SCREENRIG_TOKEN]' --cookie cookies.txt --cookie-jar cookies.txt 'https://screenrig.ai/api/playlists/RESOURCE_ID/revisions/REVISION'レスポンス
| ステータス | 意味 | 本文とヘッダー |
|---|---|---|
| 200 | そのリビジョンと、そのリビジョン時点のプレイリスト。 | PlaylistRevisionDetail(application/json) |
| デフォルト | 安定した RFC 9457 問題応答。421 server_draining は Retry-After 1秒、500 not_ready または dependency_unavailable は 5秒、500 manifest_degraded は 60秒を持ちます。ハンドラーがより具体的な値を設定していない場合。 | 問題 (application/problem+json) |
プレイリストのリビジョンを昇格
Makes an earlier revision current again by copying it forward: its pages, soundtrack and format become a new revision, the current one plus one, whose change is promoted and restored_from names the revision copied. The playlist keeps its current name, earlier revisions stay as they were, and every screen that shows the playlist updates as for any other write.
If-Match is required and names the current revision (invalid_request when absent, revision_conflict when stale). The pages are resolved again as a structure change resolves them: a selector matches today's media, and media or a web app the revision named that is gone or not ready refuses the promote with the problem a write would get.
内容が現在の内容と同じリビジョンは何も変更せず、現在のプレイリストを返します。ライブで公開できる認証情報(書き込みがレビュー提案になる認証情報は不可)、またはプロジェクトオーナーか承認できるメンバーのダッシュボードセッション(approver_required)が必要です。まだ誰も承認していないプレイリストは playlist_not_approved(409)になります。
他の書き込みと同様、応答には警告(PlaylistWarning)が含まれます。その中には、プロモートされたページの iframe の src またはアプリケーションの params が読み取る値を、プレイリストを表示するスクリーンが持たない場合の screen_fact_missing があります。
パラメーター
| 名前 | 送信する | 必須? | 説明 |
|---|---|---|---|
| ScreenRig-Project | ヘッダー | オプション | 1リリースの間非推奨。JWTプロジェクトの権限と整合性が必要。Deprecation と Warning ヘッダーを追加。トークン交換なし。 |
| ID | パス | 必須 | |
| リビジョン | パス | 必須 | プレイリストのリビジョン(listPlaylistRevisions が付ける番号)。 |
| If-Match | ヘッダー | オプション | オプションの正のリソースリビジョン。現在のリソースを書き込む場合は省略します。提供された古いリビジョンはrevision_conflictです。 |
| Idempotency-Key | ヘッダー | オプション | 新規操作のために省略します。再試行の重複排除にキーを供給し再利用してください。CLIがキーを自動管理します。 |
リクエストテンプレートとレスポンス
curl --request POST --header 'Authorization: Bearer [SCREENRIG_TOKEN]' --cookie cookies.txt --cookie-jar cookies.txt 'https://screenrig.ai/api/playlists/RESOURCE_ID/revisions/REVISION/promote'レスポンス
| ステータス | 意味 | 本文とヘッダー |
|---|---|---|
| 200 | コピーしたリビジョンが現在のものになったプレイリスト。ETag にそのリビジョンが入ります。 | PlaylistV2(application/json) |
| 402 | feature_not_in_plan — フィールドの宣言、プリミティブのロック、フィールドを宣言するプレイリストの変更はプレイリストテンプレートであり、プロジェクトのプランには含まれていません。required_plan が、含まれるプランを示します。テンプレートからのプレイリストの作成は常に許可されます。 | 問題 (application/problem+json) |
| デフォルト | 安定した RFC 9457 問題応答。421 server_draining は Retry-After 1秒、500 not_ready または dependency_unavailable は 5秒、500 manifest_degraded は 60秒を持ちます。ハンドラーがより具体的な値を設定していない場合。 | 問題 (application/problem+json) |
プレイリストの値を更新
テンプレートから作成したプレイリストのフィールド値を設定(null で消去)し、テンプレートの現在のリビジョンからページを作り直します。値は作成時と同様に検証され、それ以降にテンプレートへ加えたブランド変更がこのコピーに反映されます。値を送らなければ、コピーを最新の状態にするだけです。
他のプレイリストの書き込みと同じレビュークラスです。オーナーまたは承認できるメンバー(ダッシュボードセッション)と Manage 認証情報は即時に書き込み、アップローダーは自分のプレイリストとフォルダーに限り、Propose では変更が確認依頼になります(202)。テンプレートから作成されていないプレイリストは invalid_request です。If-Match は任意です。
パラメーター
| 名前 | 送信する | 必須? | 説明 |
|---|---|---|---|
| ScreenRig-Project | ヘッダー | オプション | 1リリースの間非推奨。JWTプロジェクトの権限と整合性が必要。Deprecation と Warning ヘッダーを追加。トークン交換なし。 |
| Screenrig-Review-Note | ヘッダー | オプション | オプションの提案者メモ。レビュークラスの書き込み時に送信され、パーセントエンコードされたUTF-8(JavaScriptのencodeURIComponentが書くもの)です。サーバーはパーセントデコードします(無効なエスケープは400 invalid_request)。デコードされたメモはプレーンテキストで、トリム後最大280文字、制御文字なし(そうでなければ400 invalid_request)。 書き込みが1になるとレビューに保存されます。ライブ適用時は無視されます。 |
| ID | パス | 必須 | |
| If-Match | ヘッダー | オプション | オプションの正のリソースリビジョン。現在のリソースを書き込む場合は省略します。提供された古いリビジョンはrevision_conflictです。 |
| Idempotency-Key | ヘッダー | オプション | 新規操作のために省略します。再試行の重複排除にキーを供給し再利用してください。CLIがキーを自動管理します。 |
リクエスト本文フィールド
| フィールド | 説明 |
|---|---|
| values(必須、オブジェクト) | フィールド名と値の対応。null を指定するとオプションのフィールドが消去されます。指定しないフィールドは値が保持されます。 |
リクエストテンプレートとレスポンス
curl --request PATCH --header 'Authorization: Bearer [SCREENRIG_TOKEN]' --cookie cookies.txt --cookie-jar cookies.txt --header 'Content-Type: application/json' --data '@request.json' 'https://screenrig.ai/api/playlists/RESOURCE_ID/values'レスポンス
| ステータス | 意味 | 本文とヘッダー |
|---|---|---|
| 202 | 書き込みはレビューになり、ユーザーの承認を待っています(docs/reviews.md)。これは提案アクセスの場合、または任意のアクセスレベルで保護されたスクリーンフォルダー内のスクリーンに及ぶ場合で、後者は2人目の承認者が決定します(docs/screen-scope.md)。ユーザーは review.url のダッシュボードで承認、拒否、または変更を依頼します。 Idempotency-Key のリプレイは同じ本文を返します。 | ReviewPending(application/json) |
| 200 | 更新されたプレイリスト。ETag にリビジョンが含まれます。 | PlaylistV2(application/json) |
| デフォルト | 安定した RFC 9457 問題応答。421 server_draining は Retry-After 1秒、500 not_ready または dependency_unavailable は 5秒、500 manifest_degraded は 60秒を持ちます。ハンドラーがより具体的な値を設定していない場合。 | 問題 (application/problem+json) |
プレイリストのインスタンスを一覧表示
テンプレートから作成したプレイリスト(名前順、最大1000件)。それぞれのページの作成元のテンプレートのリビジョンと、テンプレートに新しいリビジョンがあるかどうかを示します。
パラメーター
| 名前 | 送信する | 必須? | 説明 |
|---|---|---|---|
| ScreenRig-Project | ヘッダー | オプション | 1リリースの間非推奨。JWTプロジェクトの権限と整合性が必要。Deprecation と Warning ヘッダーを追加。トークン交換なし。 |
| ID | パス | 必須 |
リクエストテンプレートとレスポンス
curl --request GET --header 'Authorization: Bearer [SCREENRIG_TOKEN]' --cookie cookies.txt --cookie-jar cookies.txt 'https://screenrig.ai/api/playlists/RESOURCE_ID/instances'レスポンス
| ステータス | 意味 | 本文とヘッダー |
|---|---|---|
| 200 | インスタンス。 | PlaylistInstanceList(application/json) |
| デフォルト | 安定した RFC 9457 問題応答。421 server_draining は Retry-After 1秒、500 not_ready または dependency_unavailable は 5秒、500 manifest_degraded は 60秒を持ちます。ハンドラーがより具体的な値を設定していない場合。 | 問題 (application/problem+json) |
プレイリストテンプレートを展開
これらの値でテンプレートからプレイリストを作成した場合のページを、すべてのプレイリストのルールで検証して返します。計算のみで、何も保存されません。
パラメーター
| 名前 | 送信する | 必須? | 説明 |
|---|---|---|---|
| ScreenRig-Project | ヘッダー | オプション | 1リリースの間非推奨。JWTプロジェクトの権限と整合性が必要。Deprecation と Warning ヘッダーを追加。トークン交換なし。 |
| ID | パス | 必須 |
リクエスト本文フィールド
| フィールド | 説明 |
|---|---|
| values(任意、オブジェクト) |
リクエストテンプレートとレスポンス
curl --request POST --header 'Authorization: Bearer [SCREENRIG_TOKEN]' --cookie cookies.txt --cookie-jar cookies.txt --header 'Content-Type: application/json' --data '@request.json' 'https://screenrig.ai/api/playlists/RESOURCE_ID/expand'レスポンス
| ステータス | 意味 | 本文とヘッダー |
|---|---|---|
| 200 | ページ。 | PlaylistExpanded(application/json) |
| デフォルト | 安定した RFC 9457 問題応答。421 server_draining は Retry-After 1秒、500 not_ready または dependency_unavailable は 5秒、500 manifest_degraded は 60秒を持ちます。ハンドラーがより具体的な値を設定していない場合。 | 問題 (application/problem+json) |
プレイリストページを追加
承認済みプレイリストに、他のページを送らずに1ページを追加します。末尾に追加するか、before で指定したページの前に追加します。
プレイリストがすでに持つページは保存されたまま維持され、新しいページとともに1回でもう一度検証されます。そのため、ページ間のルール(1〜100ページ、表示条件のない通常ページ1つ、広告枠ページ16、メディア参照1024)は結果に対して適用されます。ルール違反は field 付きの invalid_request になります(IDが使用済みの場合は page.id、ページを指していない場合は before)。
プレイリストのページの有効期間は、ページ自身の表示条件(from、until、windows、data)で、各スクリーンのタイムゾーンで評価され、until は含みません。
レビュークラス:提案ではその変更がレビュー(202)になります。同じ提案者による同じプレイリストの後続のページ変更は、ライブのリビジョンに基づいている間は保留中のレビューに追加されるため、連続する変更が互いを置き換えることはなく、承認はすべてを適用するか、何も適用しません(プレイリストが先に進んでいた場合は review_stale)。別の提案者によるページ変更の保留中のレビューは追加も置き換えもされず、変更は resource_conflict(409)で待機します。
管理の場合、またはオーナーか承認できるメンバーのダッシュボードセッションからの場合(それ以外は approver_required)、即時に公開されます。If-Match は任意で、指定する場合はライブのリビジョンである必要があります。まだ誰も承認していないプレイリストは playlist_not_approved (409) になります。
アップローダー(docs/uploaders.md)は、自分のフォルダーのメディアページを自分のプレイリストの1つに追加することだけができます(それ以外は outside_upload_scope)。提案のアップローダーメンバーがレビューの提案者になります(kind person)。
パラメーター
| 名前 | 送信する | 必須? | 説明 |
|---|---|---|---|
| ScreenRig-Project | ヘッダー | オプション | 1リリースの間非推奨。JWTプロジェクトの権限と整合性が必要。Deprecation と Warning ヘッダーを追加。トークン交換なし。 |
| Screenrig-Review-Note | ヘッダー | オプション | オプションの提案者メモ。レビュークラスの書き込み時に送信され、パーセントエンコードされたUTF-8(JavaScriptのencodeURIComponentが書くもの)です。サーバーはパーセントデコードします(無効なエスケープは400 invalid_request)。デコードされたメモはプレーンテキストで、トリム後最大280文字、制御文字なし(そうでなければ400 invalid_request)。 書き込みが1になるとレビューに保存されます。ライブ適用時は無視されます。 |
| ID | パス | 必須 | |
| If-Match | ヘッダー | オプション | オプションの正のリソースリビジョン。現在のリソースを書き込む場合は省略します。提供された古いリビジョンはrevision_conflictです。 |
| Idempotency-Key | ヘッダー | オプション | 新規操作のために省略します。再試行の重複排除にキーを供給し再利用してください。CLIがキーを自動管理します。 |
リクエスト本文フィールド
| フィールド | 説明 |
|---|---|
| page(必須、PlaylistPageWriteV2) | |
| before(任意、文字列) | その前に挿入するページ。省略すると末尾に追加されます。pattern: "^[A-Za-z][A-Za-z0-9_-]{0,63}$" |
リクエストテンプレートとレスポンス
curl --request POST --header 'Authorization: Bearer [SCREENRIG_TOKEN]' --cookie cookies.txt --cookie-jar cookies.txt --header 'Content-Type: application/json' --data '@request.json' 'https://screenrig.ai/api/playlists/RESOURCE_ID/pages'レスポンス
| ステータス | 意味 | 本文とヘッダー |
|---|---|---|
| 202 | 書き込みはレビューになり、ユーザーの承認を待っています(docs/reviews.md)。これは提案アクセスの場合、または任意のアクセスレベルで保護されたスクリーンフォルダー内のスクリーンに及ぶ場合で、後者は2人目の承認者が決定します(docs/screen-scope.md)。ユーザーは review.url のダッシュボードで承認、拒否、または変更を依頼します。 Idempotency-Key のリプレイは同じ本文を返します。 | ReviewPending(application/json) |
| 200 | 更新されたプレイリスト。ETag にリビジョンが含まれます。 | PlaylistV2(application/json) |
| 402 | feature_not_in_plan — フィールドの宣言、プリミティブのロック、フィールドを宣言するプレイリストの変更はプレイリストテンプレートであり、プロジェクトのプランには含まれていません。required_plan が、含まれるプランを示します。テンプレートからのプレイリストの作成は常に許可されます。 | 問題 (application/problem+json) |
| デフォルト | 安定した RFC 9457 問題応答。421 server_draining は Retry-After 1秒、500 not_ready または dependency_unavailable は 5秒、500 manifest_degraded は 60秒を持ちます。ハンドラーがより具体的な値を設定していない場合。 | 問題 (application/problem+json) |
プレイリストページを置換
承認済みプレイリストの1ページを、他のページを送らずにその場で置き換えます。本文がページで、そのIDは page_id です。不明なページは not_found です。
それ以外は addPlaylistPage と同じです。維持されるページと合わせて1回で検証され、レビュークラス(提案では202、保留中のページ変更レビューに連結)、管理か承認する人物による場合は即時反映、If-Match は任意、どの人物も承認していないプレイリストには playlist_not_approved を返します。
アップローダーは、自分のフォルダーのメディアページを、自分のフォルダーの別のメディアページにのみ置き換えられます。提案では、自分のレビューで待機中のページも置き換えられます。
パラメーター
| 名前 | 送信する | 必須? | 説明 |
|---|---|---|---|
| ScreenRig-Project | ヘッダー | オプション | 1リリースの間非推奨。JWTプロジェクトの権限と整合性が必要。Deprecation と Warning ヘッダーを追加。トークン交換なし。 |
| ID | パス | 必須 | |
| page_id | パス | 必須 | プレイリストのページ ID 文字列。 |
| Screenrig-Review-Note | ヘッダー | オプション | オプションの提案者メモ。レビュークラスの書き込み時に送信され、パーセントエンコードされたUTF-8(JavaScriptのencodeURIComponentが書くもの)です。サーバーはパーセントデコードします(無効なエスケープは400 invalid_request)。デコードされたメモはプレーンテキストで、トリム後最大280文字、制御文字なし(そうでなければ400 invalid_request)。 書き込みが1になるとレビューに保存されます。ライブ適用時は無視されます。 |
| If-Match | ヘッダー | オプション | オプションの正のリソースリビジョン。現在のリソースを書き込む場合は省略します。提供された古いリビジョンはrevision_conflictです。 |
| Idempotency-Key | ヘッダー | オプション | 新規操作のために省略します。再試行の重複排除にキーを供給し再利用してください。CLIがキーを自動管理します。 |
リクエストテンプレートとレスポンス
curl --request PUT --header 'Authorization: Bearer [SCREENRIG_TOKEN]' --cookie cookies.txt --cookie-jar cookies.txt --header 'Content-Type: application/json' --data '@request.json' 'https://screenrig.ai/api/playlists/RESOURCE_ID/pages/PAGE_ID'レスポンス
| ステータス | 意味 | 本文とヘッダー |
|---|---|---|
| 202 | 書き込みはレビューになり、ユーザーの承認を待っています(docs/reviews.md)。これは提案アクセスの場合、または任意のアクセスレベルで保護されたスクリーンフォルダー内のスクリーンに及ぶ場合で、後者は2人目の承認者が決定します(docs/screen-scope.md)。ユーザーは review.url のダッシュボードで承認、拒否、または変更を依頼します。 Idempotency-Key のリプレイは同じ本文を返します。 | ReviewPending(application/json) |
| 200 | 更新されたプレイリスト。ETag にリビジョンが含まれます。 | PlaylistV2(application/json) |
| 402 | feature_not_in_plan — フィールドの宣言、プリミティブのロック、フィールドを宣言するプレイリストの変更はプレイリストテンプレートであり、プロジェクトのプランには含まれていません。required_plan が、含まれるプランを示します。テンプレートからのプレイリストの作成は常に許可されます。 | 問題 (application/problem+json) |
| デフォルト | 安定した RFC 9457 問題応答。421 server_draining は Retry-After 1秒、500 not_ready または dependency_unavailable は 5秒、500 manifest_degraded は 60秒を持ちます。ハンドラーがより具体的な値を設定していない場合。 | 問題 (application/problem+json) |
プレイリストページを削除
承認済みプレイリストの1ページを削除します。プレイリストには1〜100ページと、表示条件のない通常ページが1つ必要です(満たさない場合は invalid_request)。不明なページは not_found です。それ以外は replacePlaylistPage と同じです。アップローダーが削除できるのは、自分のフォルダーのメディアページだけです。
パラメーター
| 名前 | 送信する | 必須? | 説明 |
|---|---|---|---|
| ScreenRig-Project | ヘッダー | オプション | 1リリースの間非推奨。JWTプロジェクトの権限と整合性が必要。Deprecation と Warning ヘッダーを追加。トークン交換なし。 |
| ID | パス | 必須 | |
| page_id | パス | 必須 | プレイリストのページ ID 文字列。 |
| Screenrig-Review-Note | ヘッダー | オプション | オプションの提案者メモ。レビュークラスの書き込み時に送信され、パーセントエンコードされたUTF-8(JavaScriptのencodeURIComponentが書くもの)です。サーバーはパーセントデコードします(無効なエスケープは400 invalid_request)。デコードされたメモはプレーンテキストで、トリム後最大280文字、制御文字なし(そうでなければ400 invalid_request)。 書き込みが1になるとレビューに保存されます。ライブ適用時は無視されます。 |
| If-Match | ヘッダー | オプション | オプションの正のリソースリビジョン。現在のリソースを書き込む場合は省略します。提供された古いリビジョンはrevision_conflictです。 |
| Idempotency-Key | ヘッダー | オプション | 新規操作のために省略します。再試行の重複排除にキーを供給し再利用してください。CLIがキーを自動管理します。 |
リクエストテンプレートとレスポンス
curl --request DELETE --header 'Authorization: Bearer [SCREENRIG_TOKEN]' --cookie cookies.txt --cookie-jar cookies.txt 'https://screenrig.ai/api/playlists/RESOURCE_ID/pages/PAGE_ID'レスポンス
| ステータス | 意味 | 本文とヘッダー |
|---|---|---|
| 202 | 書き込みはレビューになり、ユーザーの承認を待っています(docs/reviews.md)。これは提案アクセスの場合、または任意のアクセスレベルで保護されたスクリーンフォルダー内のスクリーンに及ぶ場合で、後者は2人目の承認者が決定します(docs/screen-scope.md)。ユーザーは review.url のダッシュボードで承認、拒否、または変更を依頼します。 Idempotency-Key のリプレイは同じ本文を返します。 | ReviewPending(application/json) |
| 200 | 更新されたプレイリスト。ETag にリビジョンが含まれます。 | PlaylistV2(application/json) |
| 402 | feature_not_in_plan — フィールドの宣言、プリミティブのロック、フィールドを宣言するプレイリストの変更はプレイリストテンプレートであり、プロジェクトのプランには含まれていません。required_plan が、含まれるプランを示します。テンプレートからのプレイリストの作成は常に許可されます。 | 問題 (application/problem+json) |
| デフォルト | 安定した RFC 9457 問題応答。421 server_draining は Retry-After 1秒、500 not_ready または dependency_unavailable は 5秒、500 manifest_degraded は 60秒を持ちます。ハンドラーがより具体的な値を設定していない場合。 | 問題 (application/problem+json) |