LiveStreams: update

動画ストリームを更新します。変更するプロパティを更新できない場合は、適切な設定で新しいストリームを作成する必要があります。

一般的なユースケース

リクエスト

HTTP リクエスト

PUT https://www.googleapis.com/youtube/v3/liveStreams

承認

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

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

パラメータ

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

パラメータ
必須パラメータ
part string
part パラメータは、このオペレーションで 2 つの目的を果たします。書き込みオペレーションで設定されるプロパティと、API レスポンスに含まれるプロパティを指定します。

パラメータ値に含めることができる part プロパティは、id、snippet、cdn、status です。

このメソッドでは、パラメータ値で指定された部分に含まれる変更可能なプロパティの既存の値がすべてオーバーライドされます。リクエスト本文で変更可能なプロパティの値が指定されていない場合、そのプロパティの既存の値は削除されます。
オプション パラメータ
onBehalfOfContentOwner string
このパラメータは、適切に承認されたリクエストでのみ使用できます。

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

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

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

リクエスト本文

リクエスト本文に liveStream リソースを指定します。そのリソースの場合:

  • 以下のプロパティの値を指定する必要があります。

    • id
    • snippet.title
    • cdn.frameRate
    • cdn.ingestionType
    • cdn.resolution

  • 以下のプロパティの値を指定することができます。

    • snippet.title
    • snippet.description

    更新リクエストを送信する場合、既に値が設定されているプロパティの値を指定していないと、そのプロパティの既存の値が削除されます。

レスポンス

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

エラー

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

エラーのタイプ エラーの詳細 説明
forbidden (403) liveStreamModificationNotAllowed 指定されたライブ配信は、現在の状態では変更できません。詳細については、ブロードキャストのライフサイクルをご覧ください。
forbidden (403) liveStreamModificationNotAllowed この API では、ストリームの作成後に cdn.format、cdn.frameRate、cdn.ingestionType、cdn.resolution フィールドの値を変更することはできません。
forbidden (403) liveStreamModificationNotAllowed API では、再利用可能なストリームを再利用不可に変更したり、その逆を変更したりすることはできません。詳細については、ブロードキャストとストリームの理解をご覧ください。
insufficientPermissions insufficientLivePermissions リクエストには、指定されたライブ配信を更新する権限がありません。詳細については、OAuth2 認証の実装をご覧ください。
insufficientPermissions liveStreamingNotEnabled リクエストを承認したユーザーが、YouTube でライブ動画をストリーミングする権限を持っていません。詳しくは、機能の利用資格をご覧ください。
invalidValue (400) invalidDescription liveStream リソースの snippet.description プロパティの値は最大 10,000 文字です。
invalidValue (400) invalidTitle liveStream リソースの snippet.title プロパティの値は、1 ～ 128 文字にする必要があります。
notFound (404) liveStreamNotFound 指定されたライブ配信が存在しません。
required (400) idRequired liveStream リソースで id プロパティの値を指定する必要があります。
required (400) ingestionTypeRequired liveStream リソースで cdn.ingestionType プロパティの値を指定する必要があります。
required (400) titleRequired liveStream リソースで snippet.title プロパティの値を指定する必要があります。

試してみよう:

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