LiveStreams: update

更新影片串流。如果要更新的屬性無法更新，則必須使用正確的設定建立新串流。

常見用途

要求

HTTP 要求

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

授權

此要求需要至少具備下列其中一個範圍的授權 (進一步瞭解驗證和授權)。

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

參數

下表列出這項查詢支援的參數。上方列出的所有參數都是查詢參數。

參數
必要參數
part string
在這項作業中，part 參數有兩個用途。這個屬性可識別寫入作業將設定的屬性，以及 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 要求和回應。