LiveBroadcasts: transition

YouTube ライブ配信のステータスを変更し、新しいステータスに関連するプロセスを開始します。たとえば、ブロードキャストのステータスを testing に変更すると、YouTube はブロードキャストのモニター ストリームに動画の送信を開始します。このメソッドを呼び出す前に、ブロードキャスト バインド ストリームの status.streamStatus プロパティの値が active であることを確認する必要があります。

一般的なユースケース

リクエスト

HTTP リクエスト

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

承認

このリクエストは、少なくとも次のうち 1 つのスコープによる承認が必要です。認証と認可の詳細については、OAuth 2.0 認証の実装をご覧ください。

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

パラメータ

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

パラメータ
必須パラメータ
broadcastStatus string
broadcastStatus パラメータは、ブロードキャストの変換先の状態を識別します。ブロードキャストを testing 状態または live 状態に遷移させるには、ブロードキャストがバインドされているストリームの status.streamStatus が active である必要があります。

使用できる値は次のとおりです。
  • complete - ブロードキャストが終了しました。YouTube が動画の送信を停止します。
  • live - 視聴者にブロードキャストが表示されます。YouTube は、ブロードキャストのモニター ストリームとブロードキャスト ストリームに動画を送信します。
  • testing - ブロードキャストのテストを開始します。YouTube は、動画をブロードキャストのモニター ストリームに送信します。ブロードキャストを testing 状態に遷移できるのは、contentDetails.monitorStream.enableMonitorStream プロパティが true に設定されている場合のみです。
id string
id パラメータには、別のステータスに移行するブロードキャストの一意の ID を指定します。
part string
part パラメータは、API レスポンスに含まれる 1 つ以上の liveBroadcast リソース プロパティのカンマ区切りのリストを指定します。パラメータ値に含めることができる part 名は、id、snippet、contentDetails、status です。
オプション パラメータ
onBehalfOfContentOwner string
このパラメータは、適切に承認されたリクエストでのみ使用できます。

注: このパラメータは YouTube コンテンツ パートナー専用です。

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

注: このパラメータは YouTube コンテンツ パートナー専用です。

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

このパラメータは、さまざまな YouTube チャンネルを所有して管理している YouTube コンテンツ パートナーを対象としています。このパラメータを使用すると、コンテンツ所有者は一度認証されれば、パラメータ値で指定されたチャンネルの代わりにアクションを実行できるようになります。チャンネルごとに認証情報を指定する必要はありません。

リクエストの本文

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

レスポンス

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

エラー

次の表に、このメソッドの呼び出しに対する応答として API から返される可能性のあるエラー メッセージを示します。詳細については、YouTube Live Streaming API - エラーをご覧ください。

エラーのタイプ エラーの詳細 説明
backendError errorExecutingTransition ブロードキャストのステータスの変更中にエラーが発生しました。
forbidden (403) errorStreamInactive ブロードキャストにアタッチされているストリームが無効な場合、リクエストされた遷移は許可されません。
forbidden (403) invalidTransition ライブ配信を現在のステータスからリクエストされたステータスに移行できません。
forbidden (403) redundantTransition ライブ配信がすでにリクエストされたステータスになっているか、リクエストされたステータスへの処理中である。
insufficientPermissions insufficientLivePermissions リクエストには、ライブ配信を切り替える権限がありません。
insufficientPermissions livePermissionBlocked リクエストを承認したユーザーは、現時点では YouTube でライブ動画をストリーミングできません。ユーザーがライブ動画をストリーミングできない理由について詳しくは、機能の利用資格でユーザーのチャンネル設定をご覧ください。
insufficientPermissions liveStreamingNotEnabled リクエストを承認したユーザーが、YouTube でライブ動画をストリーミングできない。詳細については、機能の利用条件をご覧ください。
notFound (404) liveBroadcastNotFound id パラメータで指定されたブロードキャストが存在しません。
rateLimitExceeded (403) userRequestsExceedRateLimit ユーザーが一定の期間内に送信したリクエストが多すぎます。
required (400) idRequired 必須の id パラメータには、ステータスを移行するブロードキャストを指定する必要があります。
required (400) statusRequired API リクエストで status パラメータの値を指定する必要があります。

試してみよう:

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