screenRIG
サインイン開始する

API リファレンス

広告 API

プライベート広告ネットワークとキャンペーン

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

OpenAPI YAMLOpenAPI JSON問題 YAMLAPI の概要

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

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

プライベート広告ネットワークとキャンペーン

GET/api/advertising/network

広告ネットワークを取得

呼び出し元の販売者のネットワーク全体、解決された ScreenRig サービス料金を含みます。販売者はその料金を変更できません。

認証
projectBearer または dashboardSession
リクエスト本文
なし
操作ID
getAdvertisingNetwork

パラメーター

名前送信する必須？説明
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/advertising/network'

レスポンス

ステータス意味本文とヘッダー
200ネットワーク。AdvertisingNetwork（application/json）
デフォルト

安定した RFC 9457 問題応答。421 server_draining は Retry-After 1秒、500 not_ready または dependency_unavailable は 5秒、500 manifest_degraded は 60秒を持ちます。ハンドラーがより具体的な値を設定していない場合。

問題 (application/problem+json)
POST/api/advertising/network

広告ネットワークを作成

呼び出し元の販売者のネットワークが存在しない場合は作成します。screens=trueが必要です。冪等性あり。繰り返しは同じネットワークを返します。

認証
projectBearer または dashboardSession
リクエスト本文
AdvertisingNetworkCreate
操作ID
createAdvertisingNetwork

パラメーター

名前送信する必須？説明
ScreenRig-Projectヘッダーオプション1リリースの間非推奨。JWTプロジェクトの権限と整合性が必要。Deprecation と Warning ヘッダーを追加。トークン交換なし。

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

フィールド説明
name（必須、文字列）maxLength：120
リクエストテンプレートとレスポンス
シェル・リクエストテンプレート
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/advertising/network'

レスポンス

ステータス意味本文とヘッダー
200ネットワーク。AdvertisingNetwork（application/json）
403禁止 - プロジェクトにスクリーン機能がないか、プランが不明です。問題 (application/problem+json)
デフォルト

安定した RFC 9457 問題応答。421 server_draining は Retry-After 1秒、500 not_ready または dependency_unavailable は 5秒、500 manifest_degraded は 60秒を持ちます。ハンドラーがより具体的な値を設定していない場合。

問題 (application/problem+json)
POST/api/advertising/network/rate

広告のデフォルトレートを設定

販売者のプロジェクトデフォルトレートを15秒の完了再生ごとに設定します。変更が承認済みキャンペーンの実効レートを変えると、そのキャンペーン全体が price_change_pending で一時停止します。マスクされた変更や無操作変更は影響しません。If-Match はネットワーク改訂を保持します。

認証
projectBearer または dashboardSession
リクエスト本文
AdvertisingRate
操作ID
setAdvertisingDefaultRate

パラメーター

名前送信する必須？説明
ScreenRig-Projectヘッダーオプション1リリースの間非推奨。JWTプロジェクトの権限と整合性が必要。Deprecation と Warning ヘッダーを追加。トークン交換なし。
If-Matchヘッダーオプションオプションの正のリソースリビジョン。現在のリソースを書き込む場合は省略します。提供された古いリビジョンはrevision_conflictです。

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

フィールド説明
rate_mcr_per_15s（必須、McrString）正確な整数ミリクレジット量を標準的な10進文字列で。1クレジットは1000 mcr。パターン："^-?[0-9]+$"
リクエストテンプレートとレスポンス
シェル・リクエストテンプレート
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/advertising/network/rate'

レスポンス

ステータス意味本文とヘッダー
200ネットワークを更新しました。AdvertisingNetwork（application/json）
412revision_conflict - If-Match が古くなっています。問題 (application/problem+json)
デフォルト

安定した RFC 9457 問題応答。421 server_draining は Retry-After 1秒、500 not_ready または dependency_unavailable は 5秒、500 manifest_degraded は 60秒を持ちます。ハンドラーがより具体的な値を設定していない場合。

問題 (application/problem+json)
GET/api/advertising/inventory

広告インベントリ一覧

呼び出し元の販売者がオプトインした在庫です。

認証
projectBearer または dashboardSession
リクエスト本文
なし
操作ID
listAdvertisingInventory

パラメーター

名前送信する必須？説明
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/advertising/inventory'

レスポンス

ステータス意味本文とヘッダー
200インベントリ。AdvertisingInventoryList（application/json）
デフォルト

安定した RFC 9457 問題応答。421 server_draining は Retry-After 1秒、500 not_ready または dependency_unavailable は 5秒、500 manifest_degraded は 60秒を持ちます。ハンドラーがより具体的な値を設定していない場合。

問題 (application/problem+json)
PUT/api/advertising/inventory/{screen_id}

広告在庫をPUT

所有する1つのスクリーンのインベントリをアップサートします。スクリーンの所有権を検証します。null のレートオーバーライドは継承を復元し、ゼロにはしません。承認済みキャンペーンの有効レートを変更する変更は、そのキャンペーンを一時停止します。保護されたスクリーンフォルダー内のスクリーンは protected_target（409）です。

認証
projectBearer
リクエスト本文
AdvertisingInventoryWrite
操作ID
putAdvertisingInventory

パラメーター

名前送信する必須？説明
ScreenRig-Projectヘッダーオプション1リリースの間非推奨。JWTプロジェクトの権限と整合性が必要。Deprecation と Warning ヘッダーを追加。トークン交換なし。
screen_idパス必須
If-Matchヘッダーオプションオプションの正のリソースリビジョン。現在のリソースを書き込む場合は省略します。提供された古いリビジョンはrevision_conflictです。
Idempotency-Keyヘッダーオプション新規操作のために省略します。再試行の重複排除にキーを供給し再利用してください。CLIがキーを自動管理します。

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

フィールド説明
impressions_per_hour （任意、インライン）

この画面が 1 時間に届けるインプレッション数についての販売者の推定値。再生が完了するたびに、この値に再生秒数を掛けて 3600 で割った値が、レポートの推定インプレッションとして加算されます。null または省略は推定値なしを意味します。

ads_enabled（必須、ブール値）
site_name（任意、文字列）maxLength：120
city（任意、文字列）maxLength：120
地域（任意、文字列）maxLength：120
venue_type（任意、文字列）maxLength: 64
audience_tags（任意、配列）
配置（任意、文字列）maxLength：120
public_description（任意、文字列）maxLength: 500
rate_override_mcr_per_15s（任意、インライン）nullはプロジェクトのデフォルトからの継承を復元し、ゼロを意味しません。
リクエストテンプレートとレスポンス
シェル・リクエストテンプレート
curl --request PUT --header 'Authorization: Bearer [SCREENRIG_TOKEN]' --header 'Content-Type: application/json' --data '@request.json' 'https://screenrig.ai/api/advertising/inventory/SCREEN_ID'

レスポンス

ステータス意味本文とヘッダー
200保存された在庫。AdvertisingInventory（application/json）
403forbidden - スクリーンはこのプロジェクトのものではありません。スクリーンに限定された呼び出し元には outside_screen_scope または approver_required です。問題 (application/problem+json)
409

protected_target - スクリーンは保護されたスクリーンフォルダー内にあり、変更にはレビューの形式がありません（docs/screen-scope.md）。レビューを通じてフォルダーの保護を解除し、変更を行い、フォルダーを再度保護してください。

問題 (application/problem+json)
412revision_conflict。問題 (application/problem+json)
デフォルト

安定した RFC 9457 問題応答。421 server_draining は Retry-After 1秒、500 not_ready または dependency_unavailable は 5秒、500 manifest_degraded は 60秒を持ちます。ハンドラーがより具体的な値を設定していない場合。

問題 (application/problem+json)
GET/api/advertising/slots

広告スロット一覧

認証
projectBearer または dashboardSession
リクエスト本文
なし
操作ID
listAdvertisingSlots

パラメーター

名前送信する必須？説明
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/advertising/slots'

レスポンス

ステータス意味本文とヘッダー
200スロット。AdvertisingSlotList（application/json）
デフォルト

安定した RFC 9457 問題応答。421 server_draining は Retry-After 1秒、500 not_ready または dependency_unavailable は 5秒、500 manifest_degraded は 60秒を持ちます。ハンドラーがより具体的な値を設定していない場合。

問題 (application/problem+json)
POST/api/advertising/slots

広告スロットを作成

再利用可能な販売者スロットを作成します。画像は5～30秒、動画はプラットフォームの最大120秒です。広告は常にミュートされます。

認証
projectBearer または dashboardSession
リクエスト本文
AdvertisingSlotWrite
操作ID
createAdvertisingSlot

パラメーター

名前送信する必須？説明
ScreenRig-Projectヘッダーオプション1リリースの間非推奨。JWTプロジェクトの権限と整合性が必要。Deprecation と Warning ヘッダーを追加。トークン交換なし。

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

フィールド説明
name（必須、文字列）minLength: 1 maxLength: 120
enabled（任意、ブール値）
accepted_media（必須、配列）
max_image_duration_ms（必須、整数）最小値: 5000 最大値: 30000
max_video_duration_ms（必須、整数）最小値: 1000 最大値: 120000
rate_override_mcr_per_15s（任意、インライン）
vast_tag_url（任意、インライン）

販売者自身の VAST 2-4 広告タグ。招待されたキャンペーンがこのスロットを埋めない場合に販売者自身のスクリーンで試されます。ポート 443 または 8443 の HTTPS でパブリックホストのみ。

バックエンドはそれを取得し、最大5つのラッパーをたどり、選択されたプログレッシブ MP4 または WebM メディアファイルをプロジェクトのメディアに取り込み、承認された開始で Impression、creativeView、start を発火し、承認された完了で complete を、失敗で Error を発火します。四分位トラッカーは発火しません。

マクロ[CACHEBUSTING]、[TIMESTAMP]、[SCREENRIG_SCREEN_ID]、[SCREENRIG_SLOT_ID]、[SCREENRIG_PAGE_ID]は展開されます。スロットはビデオを受け入れる必要があります。null、未設定、空はタグをクリアします。購入者は決して見ません。

リクエストテンプレートとレスポンス
シェル・リクエストテンプレート
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/advertising/slots'

レスポンス

ステータス意味本文とヘッダー
201スロットスロット。AdvertisingSlot（application/json）
デフォルト

安定した RFC 9457 問題応答。421 server_draining は Retry-After 1秒、500 not_ready または dependency_unavailable は 5秒、500 manifest_degraded は 60秒を持ちます。ハンドラーがより具体的な値を設定していない場合。

問題 (application/problem+json)
POST/api/advertising/slots/{id}

広告スロットを更新

販売者の広告枠を1つ更新します。If-Matchに枠のリビジョンを指定します。料金の上書き変更は価格制約を再検証します。任意のIdempotency-Keyは、同じ枠、本文、If-Matchで、後から編集されていても最初の確定結果を24時間再現します。内容を変更して再利用するとidempotency_mismatch、新規の古い書き込みはrevision_conflictを返します。

認証
projectBearer または dashboardSession
リクエスト本文
AdvertisingSlotWrite
操作ID
updateAdvertisingSlot

パラメーター

名前送信する必須？説明
ScreenRig-Projectヘッダーオプション1リリースの間非推奨。JWTプロジェクトの権限と整合性が必要。Deprecation と Warning ヘッダーを追加。トークン交換なし。
IDパス必須
If-Matchヘッダーオプションオプションの正のリソースリビジョン。現在のリソースを書き込む場合は省略します。提供された古いリビジョンはrevision_conflictです。
Idempotency-Keyヘッダーオプション新規操作のために省略します。再試行の重複排除にキーを供給し再利用してください。CLIがキーを自動管理します。

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

フィールド説明
name（必須、文字列）minLength: 1 maxLength: 120
enabled（任意、ブール値）
accepted_media（必須、配列）
max_image_duration_ms（必須、整数）最小値: 5000 最大値: 30000
max_video_duration_ms（必須、整数）最小値: 1000 最大値: 120000
rate_override_mcr_per_15s（任意、インライン）
vast_tag_url（任意、インライン）

販売者自身の VAST 2-4 広告タグ。招待されたキャンペーンがこのスロットを埋めない場合に販売者自身のスクリーンで試されます。ポート 443 または 8443 の HTTPS でパブリックホストのみ。

バックエンドはそれを取得し、最大5つのラッパーをたどり、選択されたプログレッシブ MP4 または WebM メディアファイルをプロジェクトのメディアに取り込み、承認された開始で Impression、creativeView、start を発火し、承認された完了で complete を、失敗で Error を発火します。四分位トラッカーは発火しません。

マクロ[CACHEBUSTING]、[TIMESTAMP]、[SCREENRIG_SCREEN_ID]、[SCREENRIG_SLOT_ID]、[SCREENRIG_PAGE_ID]は展開されます。スロットはビデオを受け入れる必要があります。null、未設定、空はタグをクリアします。購入者は決して見ません。

リクエストテンプレートとレスポンス
シェル・リクエストテンプレート
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/advertising/slots/RESOURCE_ID'

レスポンス

ステータス意味本文とヘッダー
200スロットを更新しました。AdvertisingSlot（application/json）
409idempotency_mismatch.問題 (application/problem+json)
412revision_conflict。問題 (application/problem+json)
デフォルト

安定した RFC 9457 問題応答。421 server_draining は Retry-After 1秒、500 not_ready または dependency_unavailable は 5秒、500 manifest_degraded は 60秒を持ちます。ハンドラーがより具体的な値を設定していない場合。

問題 (application/problem+json)
GET/api/advertising/memberships

広告メンバーシップ一覧

認証
projectBearer または dashboardSession
リクエスト本文
なし
操作ID
listAdvertisingMemberships

パラメーター

名前送信する必須？説明
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/advertising/memberships'

レスポンス

ステータス意味本文とヘッダー
200メンバーシップ。AdvertisingMembershipList（application/json）
デフォルト

安定した RFC 9457 問題応答。421 server_draining は Retry-After 1秒、500 not_ready または dependency_unavailable は 5秒、500 manifest_degraded は 60秒を持ちます。ハンドラーがより具体的な値を設定していない場合。

問題 (application/problem+json)
POST/api/advertising/memberships/{id}

広告メンバーシップを更新

明示的な販売者ポリシー/スコープ編集。アクティブなメンバーシップはここで変更され、2回目の招待送信では変更されません。スコープ変更は新規選択を停止し、財務履歴は保持されます。

認証
projectBearer または dashboardSession
リクエスト本文
AdvertisingMembershipScope
操作ID
updateAdvertisingMembership

パラメーター

名前送信する必須？説明
ScreenRig-Projectヘッダーオプション1リリースの間非推奨。JWTプロジェクトの権限と整合性が必要。Deprecation と Warning ヘッダーを追加。トークン交換なし。
IDパス必須
If-Matchヘッダーオプションオプションの正のリソースリビジョン。現在のリソースを書き込む場合は省略します。提供された古いリビジョンはrevision_conflictです。

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

フィールド説明
ポリシー（必須、文字列）許可されている値: "trusted"、"review_required"。
screen_ids（必須、配列）
slot_ids（必須、配列）
リクエストテンプレートとレスポンス
シェル・リクエストテンプレート
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/advertising/memberships/RESOURCE_ID'

レスポンス

ステータス意味本文とヘッダー
200メンバーシップを更新しました。AdvertisingMembership（application/json）
412revision_conflict。問題 (application/problem+json)
デフォルト

安定した RFC 9457 問題応答。421 server_draining は Retry-After 1秒、500 not_ready または dependency_unavailable は 5秒、500 manifest_degraded は 60秒を持ちます。ハンドラーがより具体的な値を設定していない場合。

問題 (application/problem+json)
POST/api/advertising/memberships/{id}/revoke

広告メンバーシップを取り消す

メンバーシップを1つ取り消します。そのネットワークの新しい選択を停止しますが、広告主フラグ、他のメンバーシップ、または確定済みの履歴はクリアしません。

認証
projectBearer または dashboardSession
リクエスト本文
なし
操作ID
revokeAdvertisingMembership

パラメーター

名前送信する必須？説明
ScreenRig-Projectヘッダーオプション1リリースの間非推奨。JWTプロジェクトの権限と整合性が必要。Deprecation と Warning ヘッダーを追加。トークン交換なし。
IDパス必須
リクエストテンプレートとレスポンス
シェル・リクエストテンプレート
curl --request POST --header 'Authorization: Bearer [SCREENRIG_TOKEN]' --cookie cookies.txt --cookie-jar cookies.txt 'https://screenrig.ai/api/advertising/memberships/RESOURCE_ID/revoke'

レスポンス

ステータス意味本文とヘッダー
200取り消されたメンバーシップ。AdvertisingMembership（application/json）
デフォルト

安定した RFC 9457 問題応答。421 server_draining は Retry-After 1秒、500 not_ready または dependency_unavailable は 5秒、500 manifest_degraded は 60秒を持ちます。ハンドラーがより具体的な値を設定していない場合。

問題 (application/problem+json)
GET/api/advertising/networks

広告参加ネットワーク一覧

呼び出し中の広告主が現在所属するネットワークと付与された範囲および審査ポリシー。スクリーン数は保証されたインプレッション数ではありません。

認証
projectBearer または dashboardSession
リクエスト本文
なし
操作ID
listAdvertisingJoinedNetworks

パラメーター

名前送信する必須？説明
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/advertising/networks'

レスポンス

ステータス意味本文とヘッダー
200参加ネットワーク。AdvertisingJoinedNetworkList（application/json）
403禁止 - プロジェクトに広告主フラグがありません。問題 (application/problem+json)
デフォルト

安定した RFC 9457 問題応答。421 server_draining は Retry-After 1秒、500 not_ready または dependency_unavailable は 5秒、500 manifest_degraded は 60秒を持ちます。ハンドラーがより具体的な値を設定していない場合。

問題 (application/problem+json)
GET/api/advertising/networks/{seller_project_id}/inventory

広告参加インベントリ一覧

呼び出し元のメンバーシップ内の選択された在庫と再利用可能なスロット。販売者のスクリーンショット、プレイリスト、プロジェクト全体のデータは決して公開しません。

認証
projectBearer または dashboardSession
リクエスト本文
なし
操作ID
listAdvertisingJoinedInventory

パラメーター

名前送信する必須？説明
ScreenRig-Projectヘッダーオプション1リリースの間非推奨。JWTプロジェクトの権限と整合性が必要。Deprecation と Warning ヘッダーを追加。トークン交換なし。
seller_project_idパス必須
リクエストテンプレートとレスポンス
シェル・リクエストテンプレート
curl --request GET --header 'Authorization: Bearer [SCREENRIG_TOKEN]' --cookie cookies.txt --cookie-jar cookies.txt 'https://screenrig.ai/api/advertising/networks/SELLER_PROJECT_ID/inventory'

レスポンス

ステータス意味本文とヘッダー
200許可された在庫とスロット。AdvertisingJoinedInventory（application/json）
デフォルト

安定した RFC 9457 問題応答。421 server_draining は Retry-After 1秒、500 not_ready または dependency_unavailable は 5秒、500 manifest_degraded は 60秒を持ちます。ハンドラーがより具体的な値を設定していない場合。

問題 (application/problem+json)
GET/api/advertising/creatives

広告クリエイティブ一覧

認証
projectBearer または dashboardSession
リクエスト本文
なし
操作ID
listAdvertisingCreatives

パラメーター

名前送信する必須？説明
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/advertising/creatives'

レスポンス

ステータス意味本文とヘッダー
200クリエイティブ。AdvertisingCreativeList（application/json）
デフォルト

安定した RFC 9457 問題応答。421 server_draining は Retry-After 1秒、500 not_ready または dependency_unavailable は 5秒、500 manifest_degraded は 60秒を持ちます。ハンドラーがより具体的な値を設定していない場合。

問題 (application/problem+json)
POST/api/advertising/creatives

広告クリエイティブを作成

1つの準備済み所有メディアリビジョンを不変のクリエイティブにバインドします。バイトのコピー、再アップロード、再生成は行いません。未知または準備できていないメディアは拒否されます。

認証
projectBearer または dashboardSession
リクエスト本文
AdvertisingCreativeCreate
操作ID
createAdvertisingCreative

パラメーター

名前送信する必須？説明
ScreenRig-Projectヘッダーオプション1リリースの間非推奨。JWTプロジェクトの権限と整合性が必要。Deprecation と Warning ヘッダーを追加。トークン交換なし。
Idempotency-Keyヘッダーオプション新規操作のために省略します。再試行の重複排除にキーを供給し再利用してください。CLIがキーを自動管理します。

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

フィールド説明
media_id（必須、文字列）
copy（任意、文字列）maxLength: 500
リクエストテンプレートとレスポンス
シェル・リクエストテンプレート
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/advertising/creatives'

レスポンス

ステータス意味本文とヘッダー
201クリエイティブ。AdvertisingCreative（application/json）
デフォルト

安定した RFC 9457 問題応答。421 server_draining は Retry-After 1秒、500 not_ready または dependency_unavailable は 5秒、500 manifest_degraded は 60秒を持ちます。ハンドラーがより具体的な値を設定していない場合。

問題 (application/problem+json)
GET/api/advertising/creatives/{id}

広告クリエイティブを取得

認証
projectBearer または dashboardSession
リクエスト本文
なし
操作ID
getAdvertisingCreative

パラメーター

名前送信する必須？説明
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/advertising/creatives/RESOURCE_ID'

レスポンス

ステータス意味本文とヘッダー
200クリエイティブ。AdvertisingCreative（application/json）
デフォルト

安定した RFC 9457 問題応答。421 server_draining は Retry-After 1秒、500 not_ready または dependency_unavailable は 5秒、500 manifest_degraded は 60秒を持ちます。ハンドラーがより具体的な値を設定していない場合。

問題 (application/problem+json)
GET/api/advertising/seller-campaigns

広告販売者キャンペーン一覧

呼び出し元の販売者に送信された購入者キャンペーンを返します。再生のないキャンペーンや、購入者のアクセスが取り消された後の履歴も含まれます。識別子順に最大100件のキャンペーンを返します。ドラフト、他のネットワーク、購入者全体の予算は非公開です。next_after がなくなるまで、その値を after に指定して続けて取得してください。

認証
projectBearer または dashboardSession
リクエスト本文
なし
操作ID
listAdvertisingSellerCampaigns

パラメーター

名前送信する必須？説明
ScreenRig-Projectヘッダーオプション1リリースの間非推奨。JWTプロジェクトの権限と整合性が必要。Deprecation と Warning ヘッダーを追加。トークン交換なし。
以降クエリオプション前のページの next_after。
リクエストテンプレートとレスポンス
シェル・リクエストテンプレート
curl --request GET --header 'Authorization: Bearer [SCREENRIG_TOKEN]' --cookie cookies.txt --cookie-jar cookies.txt 'https://screenrig.ai/api/advertising/seller-campaigns'

レスポンス

ステータス意味本文とヘッダー
200この販売者のネットワーク上の送信済み購入者キャンペーン。AdvertisingSellerCampaignList（application/json）
デフォルト

安定した RFC 9457 問題応答。421 server_draining は Retry-After 1秒、500 not_ready または dependency_unavailable は 5秒、500 manifest_degraded は 60秒を持ちます。ハンドラーがより具体的な値を設定していない場合。

問題 (application/problem+json)
GET/api/advertising/seller-campaigns/{id}

広告販売者キャンペーンを取得

送信済みの購入者キャンペーン1件の、読み取り専用の販売者ビュー。インベントリと累計の確定済み配信は、呼び出し元の販売者のみが対象です。購入者全体の財務と他のネットワークは非公開です。無関係な販売者には not_found が返されます。

認証
projectBearer または dashboardSession
リクエスト本文
なし
操作ID
getAdvertisingSellerCampaign

パラメーター

名前送信する必須？説明
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/advertising/seller-campaigns/RESOURCE_ID'

レスポンス

ステータス意味本文とヘッダー
200販売者のキャンペーンと配信の詳細。AdvertisingSellerCampaignDetail（application/json）
デフォルト

安定した RFC 9457 問題応答。421 server_draining は Retry-After 1秒、500 not_ready または dependency_unavailable は 5秒、500 manifest_degraded は 60秒を持ちます。ハンドラーがより具体的な値を設定していない場合。

問題 (application/problem+json)
GET/api/advertising/campaigns

広告キャンペーン一覧

認証
projectBearer または dashboardSession
リクエスト本文
なし
操作ID
listAdvertisingCampaigns

パラメーター

名前送信する必須？説明
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/advertising/campaigns'

レスポンス

ステータス意味本文とヘッダー
200キャンペーン一覧。AdvertisingCampaignList（application/json）
デフォルト

安定した RFC 9457 問題応答。421 server_draining は Retry-After 1秒、500 not_ready または dependency_unavailable は 5秒、500 manifest_degraded は 60秒を持ちます。ハンドラーがより具体的な値を設定していない場合。

問題 (application/problem+json)
POST/api/advertising/campaigns

広告キャンペーンを作成

ドラフトキャンペーンを作成します。ドラフトは資金を保持せず、予約もせず、配信も許可しません。アクティベーションには明示的に承認された見積もりが必要です。

認証
projectBearer または dashboardSession
リクエスト本文
AdvertisingCampaignDraft
操作ID
createAdvertisingCampaign

パラメーター

名前送信する必須？説明
ScreenRig-Projectヘッダーオプション1リリースの間非推奨。JWTプロジェクトの権限と整合性が必要。Deprecation と Warning ヘッダーを追加。トークン交換なし。

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

フィールド説明
name（必須、文字列）minLength: 1 maxLength: 120
category（任意、AdvertisingCategory）

広告主のカテゴリ。同じカテゴリの広告 2 本が、スクリーンの同じ広告ブレークで再生されることはありません。カテゴリのない広告は分離されません。

許可："alcohol", "apparel", "automotive", "beauty", "cannabis", "consumer_electronics", "education", "entertainment", "financial_services", "food_and_beverage", "gambling", "government", "grocery", "health_and_pharma", "home_and_garden", "insurance", "jobs", "legal", "media", "political", "quick_service_restaurants", "real_estate", "restaurants", "retail", "sports_and_fitness", "technology", "telecom", "tobacco_and_vaping", "travel", "utilities"

daily_cap_mcr（必須、McrString）正確な整数ミリクレジット量を標準的な10進文字列で。1クレジットは1000 mcr。パターン："^-?[0-9]+$"
lifetime_cap_mcr（必須、McrString）正確な整数ミリクレジット量を標準的な10進文字列で。1クレジットは1000 mcr。パターン："^-?[0-9]+$"
image_duration_ms（任意、整数）キャンペーン全体の画像表示時間。動画はサーバー検証済みの再生時間を保持します。デフォルト：10000、最小：5000、最大：30000
max_play_price_mcr（任意、インライン）正の最大完了再生価格。追加の上限がない場合は省略してください。
flight_start（必須、文字列）フォーマット: "date-time"
flight_end（必須、文字列）フォーマット: "date-time"
networks（必須、配列）
リクエストテンプレートとレスポンス
シェル・リクエストテンプレート
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/advertising/campaigns'

レスポンス

ステータス意味本文とヘッダー
201キャンペーン草稿。AdvertisingCampaign（application/json）
デフォルト

安定した RFC 9457 問題応答。421 server_draining は Retry-After 1秒、500 not_ready または dependency_unavailable は 5秒、500 manifest_degraded は 60秒を持ちます。ハンドラーがより具体的な値を設定していない場合。

問題 (application/problem+json)
GET/api/advertising/campaigns/{id}

広告キャンペーンを取得

認証
projectBearer または dashboardSession
リクエスト本文
なし
操作ID
getAdvertisingCampaign

パラメーター

名前送信する必須？説明
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/advertising/campaigns/RESOURCE_ID'

レスポンス

ステータス意味本文とヘッダー
200キャンペーン。AdvertisingCampaign（application/json）
デフォルト

安定した RFC 9457 問題応答。421 server_draining は Retry-After 1秒、500 not_ready または dependency_unavailable は 5秒、500 manifest_degraded は 60秒を持ちます。ハンドラーがより具体的な値を設定していない場合。

問題 (application/problem+json)
POST/api/advertising/campaigns/{id}

広告キャンペーンを更新

ドラフトキャンペーンを更新します。If-Matchにキャンペーンのリビジョンが含まれます。すでに使用済みと予約済みの合計を下回る予算削減は、最小許容値で拒否されます。

認証
projectBearer または dashboardSession
リクエスト本文
AdvertisingCampaignDraft
操作ID
updateAdvertisingCampaign

パラメーター

名前送信する必須？説明
ScreenRig-Projectヘッダーオプション1リリースの間非推奨。JWTプロジェクトの権限と整合性が必要。Deprecation と Warning ヘッダーを追加。トークン交換なし。
IDパス必須
If-Matchヘッダーオプションオプションの正のリソースリビジョン。現在のリソースを書き込む場合は省略します。提供された古いリビジョンはrevision_conflictです。

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

フィールド説明
name（必須、文字列）minLength: 1 maxLength: 120
category（任意、AdvertisingCategory）

広告主のカテゴリ。同じカテゴリの広告 2 本が、スクリーンの同じ広告ブレークで再生されることはありません。カテゴリのない広告は分離されません。

許可："alcohol", "apparel", "automotive", "beauty", "cannabis", "consumer_electronics", "education", "entertainment", "financial_services", "food_and_beverage", "gambling", "government", "grocery", "health_and_pharma", "home_and_garden", "insurance", "jobs", "legal", "media", "political", "quick_service_restaurants", "real_estate", "restaurants", "retail", "sports_and_fitness", "technology", "telecom", "tobacco_and_vaping", "travel", "utilities"

daily_cap_mcr（必須、McrString）正確な整数ミリクレジット量を標準的な10進文字列で。1クレジットは1000 mcr。パターン："^-?[0-9]+$"
lifetime_cap_mcr（必須、McrString）正確な整数ミリクレジット量を標準的な10進文字列で。1クレジットは1000 mcr。パターン："^-?[0-9]+$"
image_duration_ms（任意、整数）キャンペーン全体の画像表示時間。動画はサーバー検証済みの再生時間を保持します。デフォルト：10000、最小：5000、最大：30000
max_play_price_mcr（任意、インライン）正の最大完了再生価格。追加の上限がない場合は省略してください。
flight_start（必須、文字列）フォーマット: "date-time"
flight_end（必須、文字列）フォーマット: "date-time"
networks（必須、配列）
リクエストテンプレートとレスポンス
シェル・リクエストテンプレート
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/advertising/campaigns/RESOURCE_ID'

レスポンス

ステータス意味本文とヘッダー
200キャンペーンを更新しました。AdvertisingCampaign（application/json）
412revision_conflict。問題 (application/problem+json)
デフォルト

安定した RFC 9457 問題応答。421 server_draining は Retry-After 1秒、500 not_ready または dependency_unavailable は 5秒、500 manifest_degraded は 60秒を持ちます。ハンドラーがより具体的な値を設定していない場合。

問題 (application/problem+json)
POST/api/advertising/campaigns/{id}/quote

広告キャンペーンの見積もり

キャンペーンの現在の有効レート、フォーマット、期間、配信期間および上限を有効化前に価格設定します。見積もりは時間制限があり、価格生成または有効レートが変更されると古くなります。

認証
projectBearer または dashboardSession
リクエスト本文
なし
操作ID
quoteAdvertisingCampaign

パラメーター

名前送信する必須？説明
ScreenRig-Projectヘッダーオプション1リリースの間非推奨。JWTプロジェクトの権限と整合性が必要。Deprecation と Warning ヘッダーを追加。トークン交換なし。
IDパス必須
If-Matchヘッダーオプションオプションの正のリソースリビジョン。現在のリソースを書き込む場合は省略します。提供された古いリビジョンはrevision_conflictです。
リクエストテンプレートとレスポンス
シェル・リクエストテンプレート
curl --request POST --header 'Authorization: Bearer [SCREENRIG_TOKEN]' --cookie cookies.txt --cookie-jar cookies.txt 'https://screenrig.ai/api/advertising/campaigns/RESOURCE_ID/quote'

レスポンス

ステータス意味本文とヘッダー
201見積もり。AdvertisingQuote（application/json）
412revision_conflict。問題 (application/problem+json)
デフォルト

安定した RFC 9457 問題応答。421 server_draining は Retry-After 1秒、500 not_ready または dependency_unavailable は 5秒、500 manifest_degraded は 60秒を持ちます。ハンドラーがより具体的な値を設定していない場合。

問題 (application/problem+json)
POST/api/advertising/campaigns/{id}/activate

広告キャンペーンを有効化する

指定された現在の見積もりを明示的に受け入れ、キャンペーンを有効化します。所有権、メンバーシップ、見積もり有効期限、料金改定、受諾スコープ、同一プロジェクト拒否を原子操作でチェックし、購入条件を記録します。ウォレットの引き落としや販売者収益は発生しません。同じキーと同じ本文はリプレイされ、本文が変更されると競合となります。

認証
projectBearer または dashboardSession
リクエスト本文
AdvertisingQuoteAccept
操作ID
activateAdvertisingCampaign

パラメーター

名前送信する必須？説明
ScreenRig-Projectヘッダーオプション1リリースの間非推奨。JWTプロジェクトの権限と整合性が必要。Deprecation と Warning ヘッダーを追加。トークン交換なし。
IDパス必須
If-Matchヘッダーオプションオプションの正のリソースリビジョン。現在のリソースを書き込む場合は省略します。提供された古いリビジョンはrevision_conflictです。
Idempotency-Keyヘッダーオプション新規操作のために省略します。再試行の重複排除にキーを供給し再利用してください。CLIがキーを自動管理します。

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

フィールド説明
quote_id（必須、文字列）
リクエストテンプレートとレスポンス
シェル・リクエストテンプレート
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/advertising/campaigns/RESOURCE_ID/activate'

レスポンス

ステータス意味本文とヘッダー
200アクティブまたは審査中のキャンペーン。AdvertisingCampaign（application/json）
409quote_stale または self_deal または resource_conflict。問題 (application/problem+json)
デフォルト

安定した RFC 9457 問題応答。421 server_draining は Retry-After 1秒、500 not_ready または dependency_unavailable は 5秒、500 manifest_degraded は 60秒を持ちます。ハンドラーがより具体的な値を設定していない場合。

問題 (application/problem+json)
POST/api/advertising/campaigns/{id}/pause

広告キャンペーンを一時停止

このキャンペーンの新規予約を一時停止します。既に開始された有効な広告は通常通り終了し、完了時に課金されます。

認証
projectBearer または dashboardSession
リクエスト本文
なし
操作ID
pauseAdvertisingCampaign

パラメーター

名前送信する必須？説明
ScreenRig-Projectヘッダーオプション1リリースの間非推奨。JWTプロジェクトの権限と整合性が必要。Deprecation と Warning ヘッダーを追加。トークン交換なし。
IDパス必須
If-Matchヘッダーオプションオプションの正のリソースリビジョン。現在のリソースを書き込む場合は省略します。提供された古いリビジョンはrevision_conflictです。
リクエストテンプレートとレスポンス
シェル・リクエストテンプレート
curl --request POST --header 'Authorization: Bearer [SCREENRIG_TOKEN]' --cookie cookies.txt --cookie-jar cookies.txt 'https://screenrig.ai/api/advertising/campaigns/RESOURCE_ID/pause'

レスポンス

ステータス意味本文とヘッダー
200キャンペーンを一時停止しました。AdvertisingCampaign（application/json）
デフォルト

安定した RFC 9457 問題応答。421 server_draining は Retry-After 1秒、500 not_ready または dependency_unavailable は 5秒、500 manifest_degraded は 60秒を持ちます。ハンドラーがより具体的な値を設定していない場合。

問題 (application/problem+json)
POST/api/advertising/campaigns/{id}/resume

広告キャンペーンを再開する

手動で一時停止したキャンペーンを再開します。price_change_pendingブロックは解除できません。チャージ、スケジュールのティック、販売者の操作で同意は得られません。

認証
projectBearer または dashboardSession
リクエスト本文
なし
操作ID
resumeAdvertisingCampaign

パラメーター

名前送信する必須？説明
ScreenRig-Projectヘッダーオプション1リリースの間非推奨。JWTプロジェクトの権限と整合性が必要。Deprecation と Warning ヘッダーを追加。トークン交換なし。
IDパス必須
If-Matchヘッダーオプションオプションの正のリソースリビジョン。現在のリソースを書き込む場合は省略します。提供された古いリビジョンはrevision_conflictです。
リクエストテンプレートとレスポンス
シェル・リクエストテンプレート
curl --request POST --header 'Authorization: Bearer [SCREENRIG_TOKEN]' --cookie cookies.txt --cookie-jar cookies.txt 'https://screenrig.ai/api/advertising/campaigns/RESOURCE_ID/resume'

レスポンス

ステータス意味本文とヘッダー
200キャンペーンを再開しました。AdvertisingCampaign（application/json）
409price_change_pending - まず現在の料金を承認してください。問題 (application/problem+json)
デフォルト

安定した RFC 9457 問題応答。421 server_draining は Retry-After 1秒、500 not_ready または dependency_unavailable は 5秒、500 manifest_degraded は 60秒を持ちます。ハンドラーがより具体的な値を設定していない場合。

問題 (application/problem+json)
POST/api/advertising/campaigns/{id}/accept-rates

広告料金を承諾する

バイヤーの変更された実効料金の明示的承諾で、見積もり ID、キャンペーンリビジョン、現在の価格世代に紐付いています。将来の配信条件を原子操作で置き換え、実行者と時間を記録し、価格変更のブロックを解除します。別の同時料金変更はキャンペーンを一時停止にします。

認証
projectBearer または dashboardSession
リクエスト本文
AdvertisingQuoteAccept
操作ID
acceptAdvertisingRates

パラメーター

名前送信する必須？説明
ScreenRig-Projectヘッダーオプション1リリースの間非推奨。JWTプロジェクトの権限と整合性が必要。Deprecation と Warning ヘッダーを追加。トークン交換なし。
IDパス必須
If-Matchヘッダーオプションオプションの正のリソースリビジョン。現在のリソースを書き込む場合は省略します。提供された古いリビジョンはrevision_conflictです。

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

フィールド説明
quote_id（必須、文字列）
リクエストテンプレートとレスポンス
シェル・リクエストテンプレート
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/advertising/campaigns/RESOURCE_ID/accept-rates'

レスポンス

ステータス意味本文とヘッダー
200キャンペーンを再有効化しました。AdvertisingCampaign（application/json）
409price_change_pending または quote_stale。問題 (application/problem+json)
デフォルト

安定した RFC 9457 問題応答。421 server_draining は Retry-After 1秒、500 not_ready または dependency_unavailable は 5秒、500 manifest_degraded は 60秒を持ちます。ハンドラーがより具体的な値を設定していない場合。

問題 (application/problem+json)
GET/api/advertising/reviews

広告レビュー一覧

呼び出し元の販売者に提出されたクリエイティブバージョンのレビュー。販売者は提出された正確なクリエイティブのみを見て、購入者のライブラリは見ません。

認証
projectBearer または dashboardSession
リクエスト本文
なし
操作ID
listAdvertisingReviews

パラメーター

名前送信する必須？説明
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/advertising/reviews'

レスポンス

ステータス意味本文とヘッダー
200レビュー。AdvertisingReviewList（application/json）
デフォルト

安定した RFC 9457 問題応答。421 server_draining は Retry-After 1秒、500 not_ready または dependency_unavailable は 5秒、500 manifest_degraded は 60秒を持ちます。ハンドラーがより具体的な値を設定していない場合。

問題 (application/problem+json)
POST/api/advertising/reviews/{id}/approve

広告審査を承認

提出されたクリエイティブの1つの正確な改訂を承認します。承認は購入者の予算を選択せず、メディアライブラリへのアクセスも付与しません。ユーザーはレビューを承認できる必要があります（approver_required）。同じレビューは/api/reviews.の下で種類ad_creativeとしてもアクセス可能です。

認証
projectBearer または dashboardSession
リクエスト本文
なし
操作ID
approveAdvertisingReview

パラメーター

名前送信する必須？説明
ScreenRig-Projectヘッダーオプション1リリースの間非推奨。JWTプロジェクトの権限と整合性が必要。Deprecation と Warning ヘッダーを追加。トークン交換なし。
IDパス必須
リクエストテンプレートとレスポンス
シェル・リクエストテンプレート
curl --request POST --header 'Authorization: Bearer [SCREENRIG_TOKEN]' --cookie cookies.txt --cookie-jar cookies.txt 'https://screenrig.ai/api/advertising/reviews/RESOURCE_ID/approve'

レスポンス

ステータス意味本文とヘッダー
200承認済み審査。AdvertisingReview（application/json）
デフォルト

安定した RFC 9457 問題応答。421 server_draining は Retry-After 1秒、500 not_ready または dependency_unavailable は 5秒、500 manifest_degraded は 60秒を持ちます。ハンドラーがより具体的な値を設定していない場合。

問題 (application/problem+json)
POST/api/advertising/reviews/{id}/reject

広告審査を拒否

買い手がクリエイティブ上で読む理由で、提出されたクリエイティブ修正の1つを拒否します。承認可能な人物が必要です（approver_required）。

認証
projectBearer または dashboardSession
リクエスト本文
AdvertisingReviewRejection
操作ID
rejectAdvertisingReview

パラメーター

名前送信する必須？説明
ScreenRig-Projectヘッダーオプション1リリースの間非推奨。JWTプロジェクトの権限と整合性が必要。Deprecation と Warning ヘッダーを追加。トークン交換なし。
IDパス必須

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

フィールド説明
理由（必須、文字列）minLength: 1 maxLength: 500
リクエストテンプレートとレスポンス
シェル・リクエストテンプレート
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/advertising/reviews/RESOURCE_ID/reject'

レスポンス

ステータス意味本文とヘッダー
200拒否された審査。AdvertisingReview（application/json）
デフォルト

安定した RFC 9457 問題応答。421 server_draining は Retry-After 1秒、500 not_ready または dependency_unavailable は 5秒、500 manifest_degraded は 60秒を持ちます。ハンドラーがより具体的な値を設定していない場合。

問題 (application/problem+json)
GET/api/advertising/reports/spend

広告支出を取得

購入者単位のキャンペーンの支出と配信数。金額は小数の mcr 文字列です。販売者の収入、銀行状況、プロジェクト全体の使用状況は公開されません。

認証
projectBearer または dashboardSession
リクエスト本文
なし
操作ID
getAdvertisingSpend

パラメーター

名前送信する必須？説明
ScreenRig-Projectヘッダーオプション1リリースの間非推奨。JWTプロジェクトの権限と整合性が必要。Deprecation と Warning ヘッダーを追加。トークン交換なし。
フォーマットクエリオプションjson（既定）はレポートを JSON で返します。csv、xlsx、pdf は同じ行を添付ファイルとして返します（ページ分割されたレポートは全ページ、最大 50000 行）。
campaign_idクエリ必須
リクエストテンプレートとレスポンス
シェル・リクエストテンプレート
curl --request GET --header 'Authorization: Bearer [SCREENRIG_TOKEN]' --cookie cookies.txt --cookie-jar cookies.txt 'https://screenrig.ai/api/advertising/reports/spend?campaign_id=CAMPAIGN_ID'

レスポンス

ステータス意味本文とヘッダー
200支出レポート。AdvertisingSpendReport（application/json）
デフォルト

安定した RFC 9457 問題応答。421 server_draining は Retry-After 1秒、500 not_ready または dependency_unavailable は 5秒、500 manifest_degraded は 60秒を持ちます。ハンドラーがより具体的な値を設定していない場合。

問題 (application/problem+json)
GET/api/advertising/reports/delivery

広告配信を取得

販売者範囲の総額、サービス料、純額を1つのウィンドウで、その配信証拠付きで示します。購入者のウォレットや他のネットワークは決して公開しません。請求可能な配信は、認可された完了再生証拠のみで確立されます。ウィンドウは最大92日で、それを超えると invalid_request です。

5000件以上の決済がある場合、レスポンスは切り捨てを設定し、合計とカウントはすべてをカバーし、行は最も古い5000件のみをリストします。

認証
projectBearer または dashboardSession
リクエスト本文
なし
操作ID
getAdvertisingDelivery

パラメーター

名前送信する必須？説明
ScreenRig-Projectヘッダーオプション1リリースの間非推奨。JWTプロジェクトの権限と整合性が必要。Deprecation と Warning ヘッダーを追加。トークン交換なし。
フォーマットクエリオプションjson（既定）はレポートを JSON で返します。csv、xlsx、pdf は同じ行を添付ファイルとして返します（ページ分割されたレポートは全ページ、最大 50000 行）。
開始クエリ必須
からクエリ必須
リクエストテンプレートとレスポンス
シェル・リクエストテンプレート
curl --request GET --header 'Authorization: Bearer [SCREENRIG_TOKEN]' --cookie cookies.txt --cookie-jar cookies.txt 'https://screenrig.ai/api/advertising/reports/delivery?from=FROM&to=TO'

レスポンス

ステータス意味本文とヘッダー
200配信レポート。AdvertisingDeliveryReport（application/json）
デフォルト

安定した RFC 9457 問題応答。421 server_draining は Retry-After 1秒、500 not_ready または dependency_unavailable は 5秒、500 manifest_degraded は 60秒を持ちます。ハンドラーがより具体的な値を設定していない場合。

問題 (application/problem+json)
GET/api/advertising/direct-campaigns

広告ダイレクトキャンペーンを一覧表示

呼び出した販売者のダイレクトキャンペーンを新しい順に、ペースとともに示します。

認証
projectBearer または dashboardSession
リクエスト本文
なし
操作ID
listAdvertisingDirectCampaigns

パラメーター

名前送信する必須？説明
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/advertising/direct-campaigns'

レスポンス

ステータス意味本文とヘッダー
200ダイレクトキャンペーン一覧。AdvertisingDirectCampaignList（application/json）
デフォルト

安定した RFC 9457 問題応答。421 server_draining は Retry-After 1秒、500 not_ready または dependency_unavailable は 5秒、500 manifest_degraded は 60秒を持ちます。ハンドラーがより具体的な値を設定していない場合。

問題 (application/problem+json)
POST/api/advertising/direct-campaigns

広告ダイレクトキャンペーンを作成

販売者が社外の広告主と結んだ取引であるダイレクトキャンペーンを、販売者自身の広告インベントリに登録します。金銭は移動せず、販売者が広告主に請求し、価格はレポートの金額算出のために記録されます。登録と同時に有効となり、マーケットプレイスキャンペーンより先にスロットを埋めます。

目標付きキャンペーンはフライト全体にわたって均等にペース配分され、ペースが遅れている間は最優先で再生されます。目標のないキャンペーンはフライト中、対象となるすべてのスロットを取ります。同じカテゴリの広告 2 本が、スクリーンの同じ広告ブレークで再生されることはありません。空き見積もりを超える目標は、overbook が true でない限り goal_overbooked で拒否されます。

同じキーと同じ本文はリプレイされ、本文が変更されると競合となります。

認証
projectBearer または dashboardSession
リクエスト本文
AdvertisingDirectCampaignDraft
操作ID
createAdvertisingDirectCampaign

パラメーター

名前送信する必須？説明
ScreenRig-Projectヘッダーオプション1リリースの間非推奨。JWTプロジェクトの権限と整合性が必要。Deprecation と Warning ヘッダーを追加。トークン交換なし。
Idempotency-Keyヘッダー必須

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

フィールド説明
name（必須、文字列）minLength: 1 maxLength: 200
advertiser（必須、string）minLength: 1 maxLength: 200
category（任意、AdvertisingCategory）

広告主のカテゴリ。同じカテゴリの広告 2 本が、スクリーンの同じ広告ブレークで再生されることはありません。カテゴリのない広告は分離されません。

許可："alcohol", "apparel", "automotive", "beauty", "cannabis", "consumer_electronics", "education", "entertainment", "financial_services", "food_and_beverage", "gambling", "government", "grocery", "health_and_pharma", "home_and_garden", "insurance", "jobs", "legal", "media", "political", "quick_service_restaurants", "real_estate", "restaurants", "retail", "sports_and_fitness", "technology", "telecom", "tobacco_and_vaping", "travel", "utilities"

flight_start（必須、文字列）フォーマット: "date-time"
flight_end（必須、文字列）フォーマット: "date-time"
goal_plays（任意、integer）配信する再生数。フライト全体にわたって均等にペース配分されます。0 または省略すると、フライト中の対象となるすべてのスロットを取ります。最小：0 最大：1000000000000
price（任意、AdvertisingDirectPrice）販売者が記録した取引価格。screenRIG がこれを請求することはなく、レポートの金額算出に使われます。
media_ids（必須、array）販売者の準備完了の画像と動画。それぞれ 1 回だけ名前を指定します。
image_duration_ms（任意、整数）キャンペーン全体の画像表示時間。動画はサーバー検証済みの再生時間を保持します。デフォルト：10000、最小：5000、最大：30000
screen_ids（任意、array）空の場合は参加済みのすべてのスクリーンです。
slot_ids（任意、array）空の場合は有効なすべてのスロットです。
venue_types（任意、array）
cities（任意、array）
tags（任意、array）
dayparts（任意、array）
overbook（任意、boolean）空き見積もりを超える目標を登録します。指定しない場合、リクエストは goal_overbooked で拒否されます。デフォルト：false
リクエストテンプレートとレスポンス
シェル・リクエストテンプレート
curl --request POST --header 'Authorization: Bearer [SCREENRIG_TOKEN]' --cookie cookies.txt --cookie-jar cookies.txt --header 'Idempotency-Key: REQUEST_ID' --header 'Content-Type: application/json' --data '@request.json' 'https://screenrig.ai/api/advertising/direct-campaigns'

レスポンス

ステータス意味本文とヘッダー
201ダイレクトキャンペーン。AdvertisingDirectCampaign（application/json）
402feature_not_in_plan — プロジェクトのプランにはダイレクトキャンペーンが含まれていません。required_plan が、含まれるプランを示します。問題 (application/problem+json)
409goal_overbooked または resource_conflict。問題 (application/problem+json)
デフォルト

安定した RFC 9457 問題応答。421 server_draining は Retry-After 1秒、500 not_ready または dependency_unavailable は 5秒、500 manifest_degraded は 60秒を持ちます。ハンドラーがより具体的な値を設定していない場合。

問題 (application/problem+json)
GET/api/advertising/direct-campaigns/{id}

広告ダイレクトキャンペーンを取得

認証
projectBearer または dashboardSession
リクエスト本文
なし
操作ID
getAdvertisingDirectCampaign

パラメーター

名前送信する必須？説明
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/advertising/direct-campaigns/RESOURCE_ID'

レスポンス

ステータス意味本文とヘッダー
200ダイレクトキャンペーン。AdvertisingDirectCampaign（application/json）
デフォルト

安定した RFC 9457 問題応答。421 server_draining は Retry-After 1秒、500 not_ready または dependency_unavailable は 5秒、500 manifest_degraded は 60秒を持ちます。ハンドラーがより具体的な値を設定していない場合。

問題 (application/problem+json)
POST/api/advertising/direct-campaigns/{id}

広告ダイレクトキャンペーンを更新

キャンペーンのドラフトフィールドを置き換えます。If-Match はキャンペーンのリビジョンを運びます。配信済みの再生は保持されます。まだ配信すべき再生は、キャンペーン自身の予約分を除いた空き見積もりと照合され、overbook を指定するとそのまま登録されます。

認証
projectBearer または dashboardSession
リクエスト本文
AdvertisingDirectCampaignDraft
操作ID
updateAdvertisingDirectCampaign

パラメーター

名前送信する必須？説明
ScreenRig-Projectヘッダーオプション1リリースの間非推奨。JWTプロジェクトの権限と整合性が必要。Deprecation と Warning ヘッダーを追加。トークン交換なし。
IDパス必須
If-Matchヘッダーオプションオプションの正のリソースリビジョン。現在のリソースを書き込む場合は省略します。提供された古いリビジョンはrevision_conflictです。

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

フィールド説明
name（必須、文字列）minLength: 1 maxLength: 200
advertiser（必須、string）minLength: 1 maxLength: 200
category（任意、AdvertisingCategory）

広告主のカテゴリ。同じカテゴリの広告 2 本が、スクリーンの同じ広告ブレークで再生されることはありません。カテゴリのない広告は分離されません。

許可："alcohol", "apparel", "automotive", "beauty", "cannabis", "consumer_electronics", "education", "entertainment", "financial_services", "food_and_beverage", "gambling", "government", "grocery", "health_and_pharma", "home_and_garden", "insurance", "jobs", "legal", "media", "political", "quick_service_restaurants", "real_estate", "restaurants", "retail", "sports_and_fitness", "technology", "telecom", "tobacco_and_vaping", "travel", "utilities"

flight_start（必須、文字列）フォーマット: "date-time"
flight_end（必須、文字列）フォーマット: "date-time"
goal_plays（任意、integer）配信する再生数。フライト全体にわたって均等にペース配分されます。0 または省略すると、フライト中の対象となるすべてのスロットを取ります。最小：0 最大：1000000000000
price（任意、AdvertisingDirectPrice）販売者が記録した取引価格。screenRIG がこれを請求することはなく、レポートの金額算出に使われます。
media_ids（必須、array）販売者の準備完了の画像と動画。それぞれ 1 回だけ名前を指定します。
image_duration_ms（任意、整数）キャンペーン全体の画像表示時間。動画はサーバー検証済みの再生時間を保持します。デフォルト：10000、最小：5000、最大：30000
screen_ids（任意、array）空の場合は参加済みのすべてのスクリーンです。
slot_ids（任意、array）空の場合は有効なすべてのスロットです。
venue_types（任意、array）
cities（任意、array）
tags（任意、array）
dayparts（任意、array）
overbook（任意、boolean）空き見積もりを超える目標を登録します。指定しない場合、リクエストは goal_overbooked で拒否されます。デフォルト：false
リクエストテンプレートとレスポンス
シェル・リクエストテンプレート
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/advertising/direct-campaigns/RESOURCE_ID'

レスポンス

ステータス意味本文とヘッダー
200更新されたダイレクトキャンペーン。AdvertisingDirectCampaign（application/json）
402feature_not_in_plan — プロジェクトのプランにはダイレクトキャンペーンが含まれていません。required_plan が、含まれるプランを示します。問題 (application/problem+json)
409goal_overbooked または resource_conflict。問題 (application/problem+json)
412revision_conflict。問題 (application/problem+json)
デフォルト

安定した RFC 9457 問題応答。421 server_draining は Retry-After 1秒、500 not_ready または dependency_unavailable は 5秒、500 manifest_degraded は 60秒を持ちます。ハンドラーがより具体的な値を設定していない場合。

問題 (application/problem+json)
POST/api/advertising/direct-campaigns/{id}/pause

広告ダイレクトキャンペーンを一時停止

有効なキャンペーンの新規再生を停止します。配信済みの再生とフライトは保持されます。一時停止中または終了済みのキャンペーンは resource_conflict になります。

認証
projectBearer または dashboardSession
リクエスト本文
なし
操作ID
pauseAdvertisingDirectCampaign

パラメーター

名前送信する必須？説明
ScreenRig-Projectヘッダーオプション1リリースの間非推奨。JWTプロジェクトの権限と整合性が必要。Deprecation と Warning ヘッダーを追加。トークン交換なし。
IDパス必須
If-Matchヘッダーオプションオプションの正のリソースリビジョン。現在のリソースを書き込む場合は省略します。提供された古いリビジョンはrevision_conflictです。
リクエストテンプレートとレスポンス
シェル・リクエストテンプレート
curl --request POST --header 'Authorization: Bearer [SCREENRIG_TOKEN]' --cookie cookies.txt --cookie-jar cookies.txt 'https://screenrig.ai/api/advertising/direct-campaigns/RESOURCE_ID/pause'

レスポンス

ステータス意味本文とヘッダー
200一時停止したダイレクトキャンペーン。AdvertisingDirectCampaign（application/json）
412revision_conflict。問題 (application/problem+json)
デフォルト

安定した RFC 9457 問題応答。421 server_draining は Retry-After 1秒、500 not_ready または dependency_unavailable は 5秒、500 manifest_degraded は 60秒を持ちます。ハンドラーがより具体的な値を設定していない場合。

問題 (application/problem+json)
POST/api/advertising/direct-campaigns/{id}/resume

広告ダイレクトキャンペーンを再開

一時停止中のダイレクトキャンペーンを再開します。一時停止中にペースが遅れた目標付きキャンペーンは、ペースに戻るまで最優先で再生されます。有効または終了済みのキャンペーンは resource_conflict になります。

認証
projectBearer または dashboardSession
リクエスト本文
なし
操作ID
resumeAdvertisingDirectCampaign

パラメーター

名前送信する必須？説明
ScreenRig-Projectヘッダーオプション1リリースの間非推奨。JWTプロジェクトの権限と整合性が必要。Deprecation と Warning ヘッダーを追加。トークン交換なし。
IDパス必須
If-Matchヘッダーオプションオプションの正のリソースリビジョン。現在のリソースを書き込む場合は省略します。提供された古いリビジョンはrevision_conflictです。
リクエストテンプレートとレスポンス
シェル・リクエストテンプレート
curl --request POST --header 'Authorization: Bearer [SCREENRIG_TOKEN]' --cookie cookies.txt --cookie-jar cookies.txt 'https://screenrig.ai/api/advertising/direct-campaigns/RESOURCE_ID/resume'

レスポンス

ステータス意味本文とヘッダー
200再開したダイレクトキャンペーン。AdvertisingDirectCampaign（application/json）
402feature_not_in_plan — プロジェクトのプランにはダイレクトキャンペーンが含まれていません。required_plan が、含まれるプランを示します。問題 (application/problem+json)
412revision_conflict。問題 (application/problem+json)
デフォルト

安定した RFC 9457 問題応答。421 server_draining は Retry-After 1秒、500 not_ready または dependency_unavailable は 5秒、500 manifest_degraded は 60秒を持ちます。ハンドラーがより具体的な値を設定していない場合。

問題 (application/problem+json)
POST/api/advertising/direct-campaigns/{id}/end

広告ダイレクトキャンペーンを終了

有効または一時停止中のキャンペーンを、フライトの終了前に終了します。終了したキャンペーンはそれ以降再生されず、レポートは保持されます。

認証
projectBearer または dashboardSession
リクエスト本文
なし
操作ID
endAdvertisingDirectCampaign

パラメーター

名前送信する必須？説明
ScreenRig-Projectヘッダーオプション1リリースの間非推奨。JWTプロジェクトの権限と整合性が必要。Deprecation と Warning ヘッダーを追加。トークン交換なし。
IDパス必須
If-Matchヘッダーオプションオプションの正のリソースリビジョン。現在のリソースを書き込む場合は省略します。提供された古いリビジョンはrevision_conflictです。
リクエストテンプレートとレスポンス
シェル・リクエストテンプレート
curl --request POST --header 'Authorization: Bearer [SCREENRIG_TOKEN]' --cookie cookies.txt --cookie-jar cookies.txt 'https://screenrig.ai/api/advertising/direct-campaigns/RESOURCE_ID/end'

レスポンス

ステータス意味本文とヘッダー
200終了したダイレクトキャンペーン。AdvertisingDirectCampaign（application/json）
412revision_conflict。問題 (application/problem+json)
デフォルト

安定した RFC 9457 問題応答。421 server_draining は Retry-After 1秒、500 not_ready または dependency_unavailable は 5秒、500 manifest_degraded は 60秒を持ちます。ハンドラーがより具体的な値を設定していない場合。

問題 (application/problem+json)
GET/api/advertising/direct-campaigns/{id}/report

広告ダイレクトキャンペーンレポートを取得

1 つのダイレクトキャンペーンの期間内の配信状況。ペース、配信済み再生の記録金額、UTC 日・スクリーン・スロット・メディアごとの行を含みます。from と to がない場合、期間はフライト全体です。期間内の行がレポートの掲載数を超える場合、レスポンスは truncated を設定し、合計は引き続きすべての再生を対象とします。

認証
projectBearer または dashboardSession
リクエスト本文
なし
操作ID
getAdvertisingDirectCampaignReport

パラメーター

名前送信する必須？説明
ScreenRig-Projectヘッダーオプション1リリースの間非推奨。JWTプロジェクトの権限と整合性が必要。Deprecation と Warning ヘッダーを追加。トークン交換なし。
フォーマットクエリオプションjson（既定）はレポートを JSON で返します。csv、xlsx、pdf は同じ行を添付ファイルとして返します（ページ分割されたレポートは全ページ、最大 50000 行）。
IDパス必須
開始クエリオプション
からクエリオプション
リクエストテンプレートとレスポンス
シェル・リクエストテンプレート
curl --request GET --header 'Authorization: Bearer [SCREENRIG_TOKEN]' --cookie cookies.txt --cookie-jar cookies.txt 'https://screenrig.ai/api/advertising/direct-campaigns/RESOURCE_ID/report'

レスポンス

ステータス意味本文とヘッダー
200ダイレクトキャンペーンのレポート。AdvertisingDirectReport（application/json）
402feature_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)
POST/api/advertising/availability

広告の空きを見積もる

指定したインベントリとフライトでダイレクト目標が登録できる再生数を見積もります。読み取りのみで何も変更しません。見積もりは、対象スクリーンの直近の広告スロット発生数をフライト全体に投影し、同じスクリーンで他のダイレクトキャンペーンがまだ必要とする目標を差し引いた値です。

認証
projectBearer または dashboardSession
リクエスト本文
AdvertisingAvailabilityQuery
操作ID
estimateAdvertisingAvailability

パラメーター

名前送信する必須？説明
ScreenRig-Projectヘッダーオプション1リリースの間非推奨。JWTプロジェクトの権限と整合性が必要。Deprecation と Warning ヘッダーを追加。トークン交換なし。

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

フィールド説明
screen_ids（任意、array）空の場合は参加済みのすべてのスクリーンです。
slot_ids（任意、array）空の場合は有効なすべてのスロットです。
venue_types（任意、array）
cities（任意、array）
tags（任意、array）
dayparts（任意、array）
flight_start（必須、文字列）フォーマット: "date-time"
flight_end（必須、文字列）フォーマット: "date-time"
exclude_campaign_id（任意、string）編集用に、このダイレクトキャンペーン自身の予約分を booked_plays から除外します。
リクエストテンプレートとレスポンス
シェル・リクエストテンプレート
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/advertising/availability'

レスポンス

ステータス意味本文とヘッダー
200空き見積もり。AdvertisingAvailability（application/json）
402feature_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)
GET/api/advertising/reports/fill

広告フィル統計を取得

呼び出した販売者の広告枠供給を期間内のUTC日別と合計で返します。各発生は直接キャンペーン、マーケットプレイスのキャンペーン、VASTタグで充填されるか、理由付きで未充填となります。要求期間は最大35日、既定は過去7日です。供給量は1時間単位の精度です。

要求された半開区間と重なるUTCの各時間を丸ごと含みます。fromはUTCの時間境界へ切り下げ、toは切り上げます。境界に一致するtoは排他的なままです。応答はこの実効範囲を返し、最大35日と1時間に及ぶ場合があります。

認証
projectBearer または dashboardSession
リクエスト本文
なし
操作ID
getAdvertisingFillStats

パラメーター

名前送信する必須？説明
ScreenRig-Projectヘッダーオプション1リリースの間非推奨。JWTプロジェクトの権限と整合性が必要。Deprecation と Warning ヘッダーを追加。トークン交換なし。
フォーマットクエリオプションjson（既定）はレポートを JSON で返します。csv、xlsx、pdf は同じ行を添付ファイルとして返します（ページ分割されたレポートは全ページ、最大 50000 行）。
開始クエリオプション
からクエリオプション
リクエストテンプレートとレスポンス
シェル・リクエストテンプレート
curl --request GET --header 'Authorization: Bearer [SCREENRIG_TOKEN]' --cookie cookies.txt --cookie-jar cookies.txt 'https://screenrig.ai/api/advertising/reports/fill'

レスポンス

ステータス意味本文とヘッダー
200フィル統計。AdvertisingFillStats（application/json）
デフォルト

安定した RFC 9457 問題応答。421 server_draining は Retry-After 1秒、500 not_ready または dependency_unavailable は 5秒、500 manifest_degraded は 60秒を持ちます。ハンドラーがより具体的な値を設定していない場合。

問題 (application/problem+json)
GET/api/advertising/reviews/{id}

広告レビューを取得

ネットワークのレビューの販売者詳細。レビューと正確に提出されたクリエイティブの改訂版を返します。購入者の他のメディアは決して公開しません。

認証
projectBearer または dashboardSession
リクエスト本文
なし
操作ID
getAdvertisingReview

パラメーター

名前送信する必須？説明
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/advertising/reviews/RESOURCE_ID'

レスポンス

ステータス意味本文とヘッダー
200レビューとそのクリエイティブ。AdvertisingReviewDetail（application/json）
404not_found - この販売者にレビューがありません。問題 (application/problem+json)
デフォルト

安定した RFC 9457 問題応答。421 server_draining は Retry-After 1秒、500 not_ready または dependency_unavailable は 5秒、500 manifest_degraded は 60秒を持ちます。ハンドラーがより具体的な値を設定していない場合。

問題 (application/problem+json)
GET/api/advertising/reviews/{id}/content

広告レビューコンテンツを取得

この販売者自身のレビューが参照する正確なクリエイティブリビジョンのみをストリーム。所有権は購入者プロジェクトにあり、オブジェクトキーや署名済みロケーションは公開されず、他の購入者メディアにはアクセスできません。ETag はクリエイティブの強力な SHA-256 で、レビューで変わりません。

ダッシュボードセッションの応答はプライベートで no-cache なのでブラウザは1つのコピーを保持し再検証します。プロジェクトベアラーの応答はプライベートで no-store です。

認証
projectBearer または dashboardSession
リクエスト本文
なし
操作ID
getAdvertisingReviewContent

パラメーター

名前送信する必須？説明
ScreenRig-Projectヘッダーオプション1リリースの間非推奨。JWTプロジェクトの権限と整合性が必要。Deprecation と Warning ヘッダーを追加。トークン交換なし。
IDパス必須
範囲ヘッダーオプションV1は1つのバイト範囲のみ受け入れます。
If-None-Matchヘッダーオプションこのルートが返した強力なクリエイティブ SHA-256 ETag。
リクエストテンプレートとレスポンス
シェル・リクエストテンプレート
curl --request GET --header 'Authorization: Bearer [SCREENRIG_TOKEN]' --cookie cookies.txt --cookie-jar cookies.txt 'https://screenrig.ai/api/advertising/reviews/RESOURCE_ID/content'

レスポンス

ステータス意味本文とヘッダー
200レビューの正確なクリエイティブバイト。本文なし；ヘッダー：Accept-Ranges、Content-Length、ETag、Cache-Control
2061つの標準準拠バイト範囲。本文なし；ヘッダー：Content-Range、ETag、Cache-Control
304クリエイティブのETagはIf-None-Matchと一致し、レビューが販売者プロジェクトで解決された後にチェックされます。本文や送信増分は生成されません。本文なし；ヘッダー：ETag、Cache-Control
デフォルト

安定した RFC 9457 問題応答。421 server_draining は Retry-After 1秒、500 not_ready または dependency_unavailable は 5秒、500 manifest_degraded は 60秒を持ちます。ハンドラーがより具体的な値を設定していない場合。

問題 (application/problem+json)
HEAD/api/advertising/reviews/{id}/content

広告審査コンテンツ

認証
projectBearer
リクエスト本文
なし
操作ID
headAdvertisingReviewContent

パラメーター

名前送信する必須？説明
ScreenRig-Projectヘッダーオプション1リリースの間非推奨。JWTプロジェクトの権限と整合性が必要。Deprecation と Warning ヘッダーを追加。トークン交換なし。
IDパス必須
範囲ヘッダーオプションV1は1つのバイト範囲のみ受け入れます。
リクエストテンプレートとレスポンス
シェル・リクエストテンプレート
curl --request HEAD --header 'Authorization: Bearer [SCREENRIG_TOKEN]' 'https://screenrig.ai/api/advertising/reviews/RESOURCE_ID/content'

レスポンス

ステータス意味本文とヘッダー
200メタデータのみです。本文なし；ヘッダー：Content-Length、ETag
デフォルト

安定した RFC 9457 問題応答。421 server_draining は Retry-After 1秒、500 not_ready または dependency_unavailable は 5秒、500 manifest_degraded は 60秒を持ちます。ハンドラーがより具体的な値を設定していない場合。

問題 (application/problem+json)
POST/api/advertising/reviews/{id}/request-changes

広告レビュー変更を依頼

販売者は提出されたクリエイティブリビジョンの変更を購入者に求めます。レビューは changes_requested となり、理由にメモが付きます。購入者はクリエイティブで読み取り、次のレビューでキャンペーンがこの販売者の previous_review_id にリンクします。承認者が必要です（approver_required）。

認証
projectBearer または dashboardSession
リクエスト本文
ReviewChangesRequest
操作ID
requestAdvertisingReviewChanges

パラメーター

名前送信する必須？説明
ScreenRig-Projectヘッダーオプション1リリースの間非推奨。JWTプロジェクトの権限と整合性が必要。Deprecation と Warning ヘッダーを追加。トークン交換なし。
IDパス必須

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

フィールド説明
note（必須、文字列）minLength: 1 maxLength: 500
リクエストテンプレートとレスポンス
シェル・リクエストテンプレート
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/advertising/reviews/RESOURCE_ID/request-changes'

レスポンス

ステータス意味本文とヘッダー
200レビュー、状態 changes_requested。AdvertisingReview（application/json）
デフォルト

安定した RFC 9457 問題応答。421 server_draining は Retry-After 1秒、500 not_ready または dependency_unavailable は 5秒、500 manifest_degraded は 60秒を持ちます。ハンドラーがより具体的な値を設定していない場合。

問題 (application/problem+json)