API リファレンス

アプリケーションストレージ API

ランタイムアプリケーション K/V

HTTP リファレンス。 バックエンド契約から生成。以下のエンドポイントを参照するか、OpenAPI をダウンロードしてください。

このグループには 4 件のオペレーションがあり、api/openapi.yaml から生成されています。パス、アクション、認証で絞り込めます。各エンドポイントには入力が一覧され、展開するとリクエストテンプレートとレスポンスコードを確認できます。テンプレートには、ご自身の値とスキーマに適合する本文が必要です。

大文字のプレースホルダーをあなたの値に置き換えます。JSONリクエストの場合、request.jsonのスキーマに合うボディを保存します。Cookie例は認証済みセッションのローカルCookieジャーを使用します。

ランタイムアプリケーション K/V

GET/screen/apps/{application_id}/kv

ランタイム KV 一覧

昇順のキー順で最大200件返し、ページングしません。キーが多い名前空間は部分的にしかリストされません。スクリーンの現在のコンテンツが保持するアプリケーションのメタデータをリストします。

Runtime KV は Player のランタイムセッション(kv.read、書き込みは kv.write)とスクリーンの現在の権限によって認可されます。権限はアプリケーションの準備完了リリースを保持している必要があります。ScreenRig-Primitive-Capability ヘッダーは無視されます。アップロードされたフレームはこれらのルートを呼び出さず、検証済みの親 SDK ブリッジを使用する必要があります。

認証
runtimeCookie または nativeSessionAuthorization
リクエスト本文
なし
操作ID
listRuntimeKV

パラメーター

名前送信する必須?説明
application_idパス必須
リクエストテンプレートとレスポンス
シェル・リクエストテンプレート
curl --request GET --cookie cookies.txt --cookie-jar cookies.txt 'https://play.screenrig.ai/screen/apps/APPLICATION_ID/kv'

レスポンス

ステータス意味本文とヘッダー
200マニフェスト承認済みアプリケーション KVランタイムKVリスト(application/json)
デフォルト

Player 対応のランタイム、コンテンツ、またはプローブルートでの安定した RFC 9457 問題応答。ランタイムドキュメント形式(RuntimeProblem)。421 server_draining は Retry-After 1秒、500 not_ready または dependency_unavailable は 5秒、500 manifest_degraded は 60秒を持ちます。ハンドラーがより具体的な値を設定していない場合。

ランタイム問題(application/problem+json)
GET/screen/apps/{application_id}/kv/{key}

ランタイム KV を取得

認証
runtimeCookie または nativeSessionAuthorization
リクエスト本文
なし
操作ID
getRuntimeKV

パラメーター

名前送信する必須?説明
application_idパス必須
キーパス必須
リクエストテンプレートとレスポンス
シェル・リクエストテンプレート
curl --request GET --cookie cookies.txt --cookie-jar cookies.txt 'https://play.screenrig.ai/screen/apps/APPLICATION_ID/kv/KEY'

レスポンス

ステータス意味本文とヘッダー
200マニフェスト承認済みアプリケーション KV 値ランタイムKVエントリ(application/json)
デフォルト

Player 対応のランタイム、コンテンツ、またはプローブルートでの安定した RFC 9457 問題応答。ランタイムドキュメント形式(RuntimeProblem)。421 server_draining は Retry-After 1秒、500 not_ready または dependency_unavailable は 5秒、500 manifest_degraded は 60秒を持ちます。ハンドラーがより具体的な値を設定していない場合。

ランタイム問題(application/problem+json)
PUT/screen/apps/{application_id}/kv/{key}

ランタイムKVをPUT

認証
pairedRuntimeCookie または nativeSessionAuthorization
リクエスト本文
ランタイムKV書き込み
操作ID
putRuntimeKV

パラメーター

名前送信する必須?説明
application_idパス必須
キーパス必須
If-Matchヘッダーオプションオプションの正のリソースリビジョン。キーの作成または上書き時は省略します。提供された古いリビジョンはrevision_conflictです。
Idempotency-Keyヘッダーオプション新規操作のために省略します。再試行の重複排除にキーを供給し再利用してください。CLIがキーを自動管理します。

リクエスト本文フィールド

フィールド説明
value_base64(必須、文字列)maxLength:1398104
content_type(任意、文字列)デフォルト:「application/octet-stream」minLength:1 maxLength:127
リクエストテンプレートとレスポンス
シェル・リクエストテンプレート
curl --request PUT --cookie cookies.txt --cookie-jar cookies.txt --header 'Content-Type: application/json' --data '@request.json' 'https://play.screenrig.ai/screen/apps/APPLICATION_ID/kv/KEY'

レスポンス

ステータス意味本文とヘッダー
200ペアリングデバイスのKV変更ランタイムKVエントリ(application/json);ヘッダー:RateLimit-Policy、RateLimit
デフォルト

Player 対応のランタイム、コンテンツ、またはプローブルートでの安定した RFC 9457 問題応答。ランタイムドキュメント形式(RuntimeProblem)。421 server_draining は Retry-After 1秒、500 not_ready または dependency_unavailable は 5秒、500 manifest_degraded は 60秒を持ちます。ハンドラーがより具体的な値を設定していない場合。

ランタイム問題(application/problem+json)
削除/screen/apps/{application_id}/kv/{key}

ランタイムKV削除

認証
pairedRuntimeCookie または nativeSessionAuthorization
リクエスト本文
なし
操作ID
deleteRuntimeKV

パラメーター

名前送信する必須?説明
application_idパス必須
キーパス必須
If-Matchヘッダーオプションオプションの正のリソースリビジョン。現在のリソースを書き込む場合は省略します。提供された古いリビジョンはrevision_conflictです。
Idempotency-Keyヘッダーオプション新規操作のために省略します。再試行の重複排除にキーを供給し再利用してください。CLIがキーを自動管理します。
リクエストテンプレートとレスポンス
シェル・リクエストテンプレート
curl --request DELETE --cookie cookies.txt --cookie-jar cookies.txt 'https://play.screenrig.ai/screen/apps/APPLICATION_ID/kv/KEY'

レスポンス

ステータス意味本文とヘッダー
204ペアリングデバイスのKV削除本文なし;ヘッダー:RateLimit-Policy、RateLimit
デフォルト

Player 対応のランタイム、コンテンツ、またはプローブルートでの安定した RFC 9457 問題応答。ランタイムドキュメント形式(RuntimeProblem)。421 server_draining は Retry-After 1秒、500 not_ready または dependency_unavailable は 5秒、500 manifest_degraded は 60秒を持ちます。ハンドラーがより具体的な値を設定していない場合。

ランタイム問題(application/problem+json)