YouTube ブロードキャストをストリームにバインドするか、ブロードキャストとストリームの間の既存のバインディングを削除します。ブロードキャストは 1 つの動画ストリームにのみバインドできますが、1 つの動画ストリームは複数のブロードキャストにバインドできます。
一般的なユースケース
リクエスト
HTTP リクエスト
POST https://www.googleapis.com/youtube/v3/liveBroadcasts/bind
承認
このリクエストは、少なくとも次のうち 1 つのスコープでの承認が必要です(認証と承認の詳細をご確認ください)。
範囲 |
---|
https://www.googleapis.com/auth/youtube |
https://www.googleapis.com/auth/youtube.force-ssl |
パラメータ
次の表に、このクエリがサポートするパラメータを示します。このリストのパラメータはすべてクエリ パラメータです。
パラメータ | ||
---|---|---|
必須パラメータ | ||
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 コンテンツ パートナーを対象としています。このパラメータを使用すると、コンテンツ所有者は一度認証されれば、パラメータ値で指定されたチャンネルの代わりにアクションを実行できるようになります。チャンネルごとに認証情報を指定する必要はありません。 |
|
streamId |
string streamId パラメータは、ブロードキャストにバインドされている動画ストリームの一意の ID を指定します。このパラメータを省略すると、API によってブロードキャストと動画ストリーム間の既存のバインディングがすべて削除されます。 |
リクエスト本文
このメソッドを呼び出す場合は、リクエストの本文を指定しないでください。
レスポンス
成功すると、このメソッドはレスポンスの本文で liveBroadcast リソースを返します。
エラー
次の表に、このメソッドの呼び出しに応じて API から返される可能性のあるエラー メッセージを示します。詳細については、エラー メッセージのドキュメントを参照してください。
エラーのタイプ | エラーの詳細 | 説明 |
---|---|---|
backendError |
internalError |
バインド中に内部エラーが発生しました。 |
forbidden (403) |
liveBroadcastBindingNotAllowed |
ライブ配信の現在のステータスでは、ストリームにバインドできません。 |
insufficientPermissions |
insufficientLivePermissions |
要求されたライブ ブロードキャストを取得する権限がありません。詳細については、OAuth2 認証の実装をご覧ください。 |
insufficientPermissions |
liveStreamingNotEnabled |
リクエストを認証したユーザーで、YouTube でライブ動画をストリーミングできません。詳しくは、https://www.youtube.com/features をご覧ください。 |
notFound (404) |
liveBroadcastNotFound |
id パラメータで指定されたブロードキャストは存在しません。 |
notFound (404) |
liveStreamNotFound |
streamId パラメータで指定されたストリームは存在しません。 |
rateLimitExceeded |
userRequestsExceedRateLimit |
特定の期間内にユーザーが送信したリクエストが多すぎます。 |
required (400) |
idRequired |
バインドするブロードキャストは、必須の id パラメータで識別する必要があります。 |
実習
APIs Explorer を使用してこの API を呼び出し、API のリクエストとレスポンスを確認します。