LiveStreams: update

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

一般的なユースケース

リクエスト

HTTP リクエスト

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

承認

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

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

エラーのタイプ エラーの詳細 説明
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 でライブ動画をストリーミングできません。詳しくは、https://www.youtube.com/features をご覧ください。
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 のリクエストとレスポンスを確認します。