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 コンテンツ パートナー専用です。

The 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 ユーザーが一定期間内に送信したリクエストが多すぎます。
rateLimitExceeded (403) concurrentBroadcastsExceedLimit チャンネルの同時ライブ配信数が上限に達しています。チャンネルで別の配信を開始するには、すでにライブ配信中の 1 つ以上の配信を停止する必要があります。
rateLimitExceeded (403) sharedIngestionBroadcastsExceedLimit チャンネルのライブ配信数が、取り込みソースを共有するライブ配信の上限に達しています。リクエストされた配信を開始するには、これらの配信の 1 つ以上を停止する必要があります。
required (400) idRequired 必須の id パラメータは、ステータスを移行する配信を指定する必要があります。
required (400) statusRequired API リクエストで status パラメータの値を指定する必要があります。

試してみよう:

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