OpenAPI YAMLOpenAPI JSON問題 YAMLAPI の概要
このグループには 7 件のオペレーションがあり、api/openapi.yaml から生成されています。パス、アクション、認証で絞り込めます。各エンドポイントには入力が一覧され、展開するとリクエストテンプレートとレスポンスコードを確認できます。テンプレートには、ご自身の値とスキーマに適合する本文が必要です。
大文字のプレースホルダーをあなたの値に置き換えます。JSONリクエストの場合、request.jsonのスキーマに合うボディを保存します。Cookie例は認証済みセッションのローカルCookieジャーを使用します。
エージェント変更のレビュー
レビュー一覧
プロジェクトのレビュー(docs/reviews.md):提案アクセスで提案されたプレイリストとスクリーンの変更、保護されたスクリーンに及ぶキャンペーン、スクリーンフォルダー、移動の書き込み(kind protected_change、docs/screen-scope.md)、そして広告ネットワークの場合は購入者が提出したクリエイティブ(kind ad_creative)。
最新順で最大limit件(デフォルト50、最大100)をページごとに表示します。同じフィルターでnext_cursorをカーソルとして渡します。stateはpending(デフォルト)、decided(その他すべての状態)、またはall。kindは1つの種類に絞ります。
ダッシュボードセッションはすべての種類を読み取ります。bearer は、その機能が対象とする種類を読み取ります(playlist_change は playlists、screen_change と protected_change は screens、ad_creative は advertising)。読み取れない種類は空のページになります。pending_count は、呼び出し元が表示できるすべての種類の保留中レビューを数えます。
スクリーンに限定された呼び出し元には、対象範囲全体がスコープ内にある screen_change レビューと protected_change レビュー(タグでスクリーンを選択するレビューは該当しません)、および playlist_change レビューのみが表示されます。ad_creative レビューは表示されず、pending_count は表示されるものを数えます。
パラメーター
| 名前 | 送信する | 必須? | 説明 |
|---|---|---|---|
| ScreenRig-Project | ヘッダー | オプション | 1リリースの間非推奨。JWTプロジェクトの権限と整合性が必要。Deprecation と Warning ヘッダーを追加。トークン交換なし。 |
| 状態 | クエリ | オプション | |
| 種類 | クエリ | オプション | |
| 制限 | クエリ | オプション | |
| カーソル | クエリ | オプション |
リクエストテンプレートとレスポンス
curl --request GET --header 'Authorization: Bearer [SCREENRIG_TOKEN]' --cookie cookies.txt --cookie-jar cookies.txt 'https://screenrig.ai/api/reviews'レスポンス
| ステータス | 意味 | 本文とヘッダー |
|---|---|---|
| 200 | 1ページのレビュー。 | ReviewList(application/json) |
| デフォルト | 安定した RFC 9457 問題応答。421 server_draining は Retry-After 1秒、500 not_ready または dependency_unavailable は 5秒、500 manifest_degraded は 60秒を持ちます。ハンドラーがより具体的な値を設定していない場合。 | 問題 (application/problem+json) |
レビューを取得
1つのレビュー。プレイリストの変更には preview が追加されます。保存された形式(resolved_media を持つページ)での、ライブのプレイリストと提案されたプレイリストです。作成の場合、live は null です。レビューの種類を読み取れない bearer には not_found が返されます(listReviews を参照)。対象範囲がスコープ内にないレビューについて、スクリーンに限定された呼び出し元にも同様です。
パラメーター
| 名前 | 送信する | 必須? | 説明 |
|---|---|---|---|
| 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/reviews/RESOURCE_ID'レスポンス
| ステータス | 意味 | 本文とヘッダー |
|---|---|---|
| 200 | レビュー。 | レビュー(application/json) |
| デフォルト | 安定した RFC 9457 問題応答。421 server_draining は Retry-After 1秒、500 not_ready または dependency_unavailable は 5秒、500 manifest_degraded は 60秒を持ちます。ハンドラーがより具体的な値を設定していない場合。 | 問題 (application/problem+json) |
レビューを探す
レビューが属するプロジェクト。メールリンク用:そのプロジェクトのメンバーでサインインしている人はidと名前を取得し(PUT /api/session/project)、レビューを読みます。その他はnot_foundです。セッションが選択したプロジェクトに関係なく動作します。
パラメーター
| 名前 | 送信する | 必須? | 説明 |
|---|---|---|---|
| ID | パス | 必須 |
リクエストテンプレートとレスポンス
curl --request GET --cookie cookies.txt --cookie-jar cookies.txt 'https://screenrig.ai/api/reviews/RESOURCE_ID/locate'レスポンス
| ステータス | 意味 | 本文とヘッダー |
|---|---|---|
| 200 | レビューのプロジェクト。 | ReviewLocation(application/json) |
| デフォルト | 安定した RFC 9457 問題応答。421 server_draining は Retry-After 1秒、500 not_ready または dependency_unavailable は 5秒、500 manifest_degraded は 60秒を持ちます。ハンドラーがより具体的な値を設定していない場合。 | 問題 (application/problem+json) |
審査を承認
承認可能な人物(プロジェクト所有者または can_approve 権限のメンバー;そうでなければ approver_required)として保留中の審査を承認します。フラグは決定のトランザクション内で再読込され、承認が無効になった人物は決定しません(approver_required)。スタッフのシャドウセッションは決定できません。
プレイリスト更新はベースリビジョンを If-Match として適用されます。ライブプレイリストが進んだ場合、レビューは古くなり review_stale で応答されます。
タグ、フォルダー、またはすべてのセレクターが、提案時に解決しなかったメディアを再生し、レビューで名前が付けられず、ライブ版でも再生されていない場合、その作成または更新は古くなり(review_stale)、レビュー対象になります。
スクリーン変更は保存されたリクエストを再生します(タグが今解決されます):呼び出しは数秒間スクリーンに適用し、残りはscreen_change.result.applyingがtrueの間バックグラウンドで続行します。
保留中のプレイリストレビューを待つスクリーン変更はreview_blockedで応答し、プレイリストに承認済みバージョンがない場合はplaylist_not_approvedで応答します。include_dependentsはこのプレイリストレビューを待つスクリーン変更も順に承認します。適用された変更のイベントは人物をアクター、提案したエージェントをエージェントとして持ちます。
応答には警告(PlaylistWarning)が含まれます。承認された変更が、iframe の src またはアプリケーションの params がスクリーントークンを読み取るページを、それを持たないスクリーンに置く場合は screen_fact_missing です。決定済みのレビューは review_not_pending で、同じ決定を繰り返すと同じ結果が返されます。
protected とマークされたレビュー(protected_change、または保護されたスクリーンに及んだ screen_change)は、提案者と、提案したエージェントの責任者以外の承認者が決定します。それ以外の場合、および提案者を特定のユーザーまで追跡できない場合は、second_approver_required(403)です(docs/screen-scope.md)。
スクリーンに限定された承認者は、対象範囲全体がスコープ内にあるレビューのみを決定できます(outside_screen_scope、403)。protected_change は、このリクエストによって、承認したユーザーとして、提案時のリビジョンで適用されます。その後に変更または削除されたキャンペーンやフォルダー、あるいは移動したスクリーンがあると、レビューは古くなります(review_stale、409)。
承認できない依存先は、dependents[].problem で同じコードを報告します。
パラメーター
| 名前 | 送信する | 必須? | 説明 |
|---|---|---|---|
| ID | パス | 必須 | |
| Idempotency-Key | ヘッダー | オプション | 新規操作のために省略します。再試行の重複排除にキーを供給し再利用してください。CLIがキーを自動管理します。 |
リクエスト本文フィールド
| フィールド | 説明 |
|---|---|
| include_dependents(任意、真偽値) | このプレイリストのレビュー待ちのスクリーン変更も順に承認してください。 |
リクエストテンプレートとレスポンス
curl --request POST --cookie cookies.txt --cookie-jar cookies.txt --header 'Content-Type: application/json' --data '@request.json' 'https://screenrig.ai/api/reviews/RESOURCE_ID/approve'レスポンス
| ステータス | 意味 | 本文とヘッダー |
|---|---|---|
| 200 | 承認済みレビューと依存する結果。 | ReviewDecisionResult(application/json) |
| 403 | approver_required、second_approver_required、または outside_screen_scope。 | 問題 (application/problem+json) |
| 409 | review_not_pending、review_stale、review_blocked、または playlist_not_approved。 | 問題 (application/problem+json) |
| デフォルト | 安定した RFC 9457 問題応答。421 server_draining は Retry-After 1秒、500 not_ready または dependency_unavailable は 5秒、500 manifest_degraded は 60秒を持ちます。ハンドラーがより具体的な値を設定していない場合。 | 問題 (application/problem+json) |
審査を拒否
提案者が読む理由を付けて、保留中のレビューを却下します。approveReview と同様、承認者のみ。スクリーンに限定された承認者は、スコープ内のレビューのみを決定でき(outside_screen_scope)、スクリーンに限定されたユーザーは広告クリエイティブを決定できません。画面は何も変わりません。却下されたプレイリストの作成は未承認のままです。
パラメーター
| 名前 | 送信する | 必須? | 説明 |
|---|---|---|---|
| ID | パス | 必須 | |
| Idempotency-Key | ヘッダー | オプション | 新規操作のために省略します。再試行の重複排除にキーを供給し再利用してください。CLIがキーを自動管理します。 |
リクエスト本文フィールド
| フィールド | 説明 |
|---|---|
| 理由(必須、文字列) | minLength: 1 maxLength: 500 |
リクエストテンプレートとレスポンス
curl --request POST --cookie cookies.txt --cookie-jar cookies.txt --header 'Content-Type: application/json' --data '@request.json' 'https://screenrig.ai/api/reviews/RESOURCE_ID/reject'レスポンス
| ステータス | 意味 | 本文とヘッダー |
|---|---|---|
| 200 | 拒否されたレビュー。 | ReviewDecisionResult(application/json) |
| 403 | outside_screen_scope - 呼び出し元がスクリーンに限定されており、リクエストが指定する、または及ぶスクリーン、スクリーンフォルダー、セレクター、対象がその範囲外です(docs/screen-scope.md)。スコープ外のIDと存在しないIDには同じ応答が返されます。errors[0].screen_scope には呼び出し元のスコープが含まれ、書き込みは絞り込まれることなく全体が拒否されます。 | 問題 (application/problem+json) |
| デフォルト | 安定した RFC 9457 問題応答。421 server_draining は Retry-After 1秒、500 not_ready または dependency_unavailable は 5秒、500 manifest_degraded は 60秒を持ちます。ハンドラーがより具体的な値を設定していない場合。 | 問題 (application/problem+json) |
レビュー変更を依頼
提案者が読むノートを付けて、変更を依頼します。提案者は再度提案します。approveReview と同様、承認者のみ。広告クリエイティブの場合は、購入者がクリエイティブ上でノートを読みます。スコープ付きの承認者は rejectReview と同様に限定されます。
パラメーター
| 名前 | 送信する | 必須? | 説明 |
|---|---|---|---|
| ID | パス | 必須 | |
| Idempotency-Key | ヘッダー | オプション | 新規操作のために省略します。再試行の重複排除にキーを供給し再利用してください。CLIがキーを自動管理します。 |
リクエスト本文フィールド
| フィールド | 説明 |
|---|---|
| note(必須、文字列) | minLength: 1 maxLength: 500 |
リクエストテンプレートとレスポンス
curl --request POST --cookie cookies.txt --cookie-jar cookies.txt --header 'Content-Type: application/json' --data '@request.json' 'https://screenrig.ai/api/reviews/RESOURCE_ID/request-changes'レスポンス
| ステータス | 意味 | 本文とヘッダー |
|---|---|---|
| 200 | レビュー、状態 changes_requested。 | ReviewDecisionResult(application/json) |
| 403 | outside_screen_scope - 呼び出し元がスクリーンに限定されており、リクエストが指定する、または及ぶスクリーン、スクリーンフォルダー、セレクター、対象がその範囲外です(docs/screen-scope.md)。スコープ外のIDと存在しないIDには同じ応答が返されます。errors[0].screen_scope には呼び出し元のスコープが含まれ、書き込みは絞り込まれることなく全体が拒否されます。 | 問題 (application/problem+json) |
| デフォルト | 安定した RFC 9457 問題応答。421 server_draining は Retry-After 1秒、500 not_ready または dependency_unavailable は 5秒、500 manifest_degraded は 60秒を持ちます。ハンドラーがより具体的な値を設定していない場合。 | 問題 (application/problem+json) |
レビューを取り下げる
保留中のプレイリスト、スクリーン、または protected_change のレビューを撤回します。bearer が撤回できるのは、自身のエージェントまたはサービスクライアントが提案したものだけです(それ以外は forbidden)。ユーザーは、承認者として、または提案者の責任者として撤回します。スクリーンに限定されたユーザーが撤回できるのは、スコープ内のレビューのみです(outside_screen_scope)。
撤回されたプレイリストの作成は未承認のままです。
パラメーター
| 名前 | 送信する | 必須? | 説明 |
|---|---|---|---|
| ScreenRig-Project | ヘッダー | オプション | 1リリースの間非推奨。JWTプロジェクトの権限と整合性が必要。Deprecation と Warning ヘッダーを追加。トークン交換なし。 |
| ID | パス | 必須 | |
| Idempotency-Key | ヘッダー | オプション | 新規操作のために省略します。再試行の重複排除にキーを供給し再利用してください。CLIがキーを自動管理します。 |
リクエストテンプレートとレスポンス
curl --request POST --header 'Authorization: Bearer [SCREENRIG_TOKEN]' --cookie cookies.txt --cookie-jar cookies.txt 'https://screenrig.ai/api/reviews/RESOURCE_ID/withdraw'レスポンス
| ステータス | 意味 | 本文とヘッダー |
|---|---|---|
| 200 | 取り下げられたレビュー。 | ReviewDecisionResult(application/json) |
| 403 | outside_screen_scope - 呼び出し元がスクリーンに限定されており、リクエストが指定する、または及ぶスクリーン、スクリーンフォルダー、セレクター、対象がその範囲外です(docs/screen-scope.md)。スコープ外のIDと存在しないIDには同じ応答が返されます。errors[0].screen_scope には呼び出し元のスコープが含まれ、書き込みは絞り込まれることなく全体が拒否されます。 | 問題 (application/problem+json) |
| デフォルト | 安定した RFC 9457 問題応答。421 server_draining は Retry-After 1秒、500 not_ready または dependency_unavailable は 5秒、500 manifest_degraded は 60秒を持ちます。ハンドラーがより具体的な値を設定していない場合。 | 問題 (application/problem+json) |