Watermarks: set

將浮水印圖片上傳至 YouTube，並為頻道設定浮水印。

這個方法支援上傳媒體。上傳的檔案必須符合下列限制：

  • 檔案大小上限：10 MB
  • 可接受的媒體 MIME 類型： image/jpeg、image/png、application/octet-stream

配額影響：呼叫此方法會產生 50 個單位的配額費用。

要求

HTTP 要求

POST https://www.googleapis.com/upload/youtube/v3/watermarks/set

授權

這項要求需要使用下列至少一個範圍授權。如要進一步瞭解驗證和授權，請參閱「實作 OAuth 2.0 授權」。

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

參數

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

參數
必要參數
channelId string
channelId 參數會指定要提供浮水印的 YouTube 頻道 ID。
選用參數
onBehalfOfContentOwner string
注意：這個參數僅供 YouTube 內容合作夥伴使用。

onBehalfOfContentOwner 參數表示要求授權憑證會識別 YouTube 內容管理系統使用者，該使用者會代表參數值中指定的內容擁有者採取行動。這項參數適用於擁有及管理多個不同 YouTube 頻道的 YouTube 內容合作夥伴。內容擁有者只要驗證一次，就能存取所有影片和頻道資料，不必為每個頻道提供驗證憑證。使用者用來驗證的 CMS 帳戶必須連結至指定的 YouTube 內容擁有者。

要求主體

在要求主體中提供 watermark 資源。資源包含下列屬性：

  • timing (object，必要)：封裝浮水印顯示時間。
    • timing.type (string，必要)：設為 offsetFromStart 或 offsetFromEnd。
    • timing.offsetMs (unsigned long，必要)：開始偏移量 (以毫秒為單位)。如果 type 為 offsetFromEnd，則不得小於 1000 毫秒。
    • timing.durationMs (unsigned long，選用)：可見時間長度 (以毫秒為單位，最少 1000 毫秒)。如果 type 為 offsetFromEnd，則不得超過 offsetMs。
  • targetChannelId (string，選用)：浮水印連結的 YouTube 頻道 ID。如果省略此屬性，系統會連結至 channelId 指定的頻道。
  • position (object，已淘汰)：YouTube 會忽略這項設定。浮水印一律會顯示在右上角。

回應

如果成功，這個方法會傳回 HTTP 204 No Content 狀態碼。

錯誤

下表列出 API 可能在呼叫這個方法時傳回的錯誤訊息。詳情請參閱「YouTube Data API - Errors」。

錯誤類型 錯誤詳細資料 說明
badRequest (400) imageFormatUnsupported 您提供的圖片格式不受支援。
badRequest (400) imageTooTall 你提供的圖片過高。
badRequest (400) imageTooWide 你提供的圖片過寬。
badRequest (400) mediaBodyRequired 要求不含圖片內容。
forbidden (403) forbidden 無法為指定頻道設定浮水印。要求可能未獲得適當授權，或 channelId 參數設為無效值。

試試看！

使用 APIs Explorer 呼叫這個 API，並查看 API 要求和回應。