LiveBroadcasts: control

注: liveBroadcasts.control メソッドは非推奨になりました。2020 年 10 月 1 日以降、動作しなくなります。この日を過ぎると、このメソッドへのすべての呼び出しで禁止（403）エラーが返され、メソッドは後で完全に削除されます。

なお、クライアントは YouTube の取り込みサーバーに送信される動画にオーバーレイを追加することで、独自のスライドを実装できます。非推奨のお知らせをご覧ください。

ブロードキャスト ストリームに表示可能なスレートの設定を制御します。

一般的なユースケース

リクエスト

HTTP リクエスト

POST https://www.googleapis.com/youtube/v3/liveBroadcasts/control

承認

このリクエストは、少なくとも次のうち 1 つのスコープでの承認が必要です（認証と承認の詳細をご確認ください）。

範囲
https://www.googleapis.com/auth/youtube
https://www.googleapis.com/auth/youtube.force-ssl

パラメータ

次の表に、このクエリがサポートするパラメータを示します。このリストのパラメータはすべてクエリ パラメータです。

パラメータ
必須パラメータ
id string
id パラメータは、スレートが更新されるブロードキャストを一意に識別する YouTube ライブ ブロードキャスト ID を指定します。
part string
part パラメータには、API レスポンスに含める 1 つ以上の liveBroadcast リソース プロパティのカンマ区切りリストを指定します。パラメータ値に含めることができる part 名は、id、snippet、contentDetails、status です。
オプション パラメータ
displaySlate boolean
displaySlate パラメータは、スレートを有効にするか無効にするかを指定します。
offsetTimeMs unsigned long
offsetTimeMs パラメータは、指定されたスレートの変更が発生したときに正のタイム オフセットを指定します。この値は、ブロードキャストのモニタリング ストリーム（ブロードキャストのテスト フェーズが開始された時間）の開始時点からミリ秒単位で測定されます。ミリ秒単位で指定されている場合でも、値は実際にはおおよその値であり、YouTube はその時点の時間にできるだけ近いタイミングでリクエストされたアクションを実行します。

このパラメータに値を指定しない場合は、できる限り早くアクションが実行されます。詳しくは、スタートガイドをご覧ください。

重要: このパラメータは、ブロードキャスト ストリームが遅延する場合にのみ指定します。
onBehalfOfContentOwner string
このパラメータは、適切に承認されたリクエストでのみ使用できます。注: このパラメータは、YouTube コンテンツ パートナー専用です。

onBehalfOfContentOwner パラメータは、パラメータ値で指定されたコンテンツ所有者に代わって行動する YouTube CMS ユーザーを識別するリクエストの認証情報です。このパラメータは、複数の YouTube チャンネルを所有、管理している YouTube コンテンツ パートナーを対象にしています。このパラメータを使用すると、コンテンツ所有者は一度認証されれば、すべての動画やチャンネル データにアクセスできるようになります。チャンネルごとに認証情報を指定する必要はありません。ユーザー認証に使用する CMS アカウントは、指定された YouTube コンテンツ所有者にリンクされていなければなりません。
onBehalfOfContentOwnerChannel string
このパラメータは、適切に承認されたリクエストでのみ使用できます。このパラメータは、適切に承認されたリクエストでのみ使用できます。注: このパラメータは、YouTube コンテンツ パートナー専用です。

onBehalfOfContentOwnerChannel パラメータは、動画を追加するチャンネルの YouTube チャンネル ID を指定します。このパラメータは、リクエストで onBehalfOfContentOwner パラメータの値を指定するときに必要です。このパラメータとの組み合わせでのみ使用できます。また、このリクエストは onBehalfOfContentOwner パラメータで指定されたコンテンツ所有者にリンクされている CMS アカウントを使用して承認される必要があります。最後に、onBehalfOfContentOwnerChannel パラメータの値で指定するチャンネルは、onBehalfOfContentOwner で指定するコンテンツ所有者にリンクする必要があります。

このパラメータは、さまざまな YouTube チャンネルを所有、管理している YouTube コンテンツ パートナーを対象としています。このパラメータを使用すると、コンテンツ所有者は一度認証されれば、パラメータ値で指定されたチャンネルの代わりにアクションを実行できるようになります。チャンネルごとに認証情報を指定する必要はありません。
walltime datetime
walltime パラメータは、指定されたスレート変更が行われる実時間を示します。値は ISO 8601（YYYY-MM-DDThh:mm:ss.sZ）形式で指定します。

リクエスト本文

このメソッドを呼び出す場合は、リクエストの本文を指定しないでください。

レスポンス

成功すると、このメソッドはレスポンスの本文で liveBroadcast リソースを返します。

エラー

次の表に、このメソッドの呼び出しに応じて API から返される可能性のあるエラー メッセージを示します。詳細については、エラー メッセージのドキュメントを参照してください。

エラーのタイプ エラーの詳細 説明
backendError errorDisplaySlate 要求されたアクションの実行中にエラーが発生しました。
forbidden (403) liveBroadcastControlNotAllowed ブロードキャストに対するステータスが live の場合にのみ、リクエストされたアクションが許可されます。
insufficientPermissions insufficientLivePermissions ライブ ストリームを行う権限がユーザーにないため、リクエストされたオペレーションに対する権限がユーザーにありません。
insufficientPermissions liveStreamingNotEnabled リクエストを認証したユーザーで、YouTube でライブ動画をストリーミングできません。詳しくは、https://www.youtube.com/features をご覧ください。
invalidValue (400) conflictingTimeFields offsetTimeMs と walltime のどちらか一方のみを指定できます。
invalidValue (400) invalidOffsetTimeMs offsetTimeMs パラメータの値が無効です。パラメータ値は正数でなければなりませんが、ブロードキャストのモニター ストリームが有効である場合にのみ、パラメータを指定できます。
invalidValue (400) invalidWalltime walltime パラメータの値が無効です。
notFound (404) liveBroadcastNotFound id パラメータで指定されたブロードキャストは存在しません。
required (400) actionRequired API リクエストには、少なくとも 1 つのアクションを指定する必要があります。現時点では、スレートを有効または無効にする機能のみがサポートされています。
required (400) idRequired 必須の id パラメータでは、更新するブロードキャストを識別する必要があります。

実習

APIs Explorer を使用してこの API を呼び出し、API のリクエストとレスポンスを確認します。