LiveBroadcasts: control

注: liveBroadcasts.control メソッドは非推奨となったため、2020 年 10 月 1 日以降は機能しなくなります。この日を過ぎると、このメソッドの呼び出しはすべて forbidden（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 はリクエストされたアクションをその時間の近くで実行します。

このパラメータに値を指定しない場合、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 のリクエストとレスポンスを確認します。