LiveBroadcasts: transition

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

一般的なユースケース

リクエスト

HTTP リクエスト

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

認可

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

範囲
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 から返されるエラー メッセージを示します。詳細については、エラー メッセージのドキュメントを参照してください。

エラーのタイプ エラーの詳細 説明
backendError errorExecutingTransition ブロードキャストのステータスの変更中にエラーが発生しました。
forbidden (403) errorStreamInactive ブロードキャストにバインドされているストリームが非アクティブの場合、リクエストされた移行は許可されません。
forbidden (403) invalidTransition ライブ配信を、現在のステータスからリクエストされたステータスに移行できません。
forbidden (403) redundantTransition このライブ配信はすでにリクエストされたステータスになっているか、リクエストされたステータスに向けて処理中です。
insufficientPermissions insufficientLivePermissions このリクエストには、ライブ配信を移行する権限がありません。
insufficientPermissions livePermissionBlocked リクエストを承認したユーザーは、現時点では YouTube でライブ動画をストリーミングできません。ユーザーがライブ動画をストリーミングできない理由の詳細は、https://www.youtube.com/features のユーザーのチャンネル設定で確認できます。
insufficientPermissions liveStreamingNotEnabled リクエストを承認したユーザーには、YouTube でライブ動画をストリーミングする権限がありません。ユーザーは https://www.youtube.com/features で詳細を確認できます。
notFound (404) liveBroadcastNotFound id パラメータで指定されたブロードキャストが存在しません。
rateLimitExceeded (403) userRequestsExceedRateLimit ユーザーが一定期間内に送信したリクエストが多すぎます。
required (400) idRequired 必須の id パラメータには、ステータスを移行するブロードキャストを指定する必要があります。
required (400) statusRequired API リクエストでは、status パラメータの値を指定する必要があります。

試してみよう:

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