注意:YouTube Content ID API 為 YouTube 內容合作夥伴使用,並未開放所有開發人員或所有 YouTube 使用者存取。如果 Google API 控制台顯示的服務中沒有 YouTube Content ID API,請參閱 YouTube 說明中心,進一步瞭解 YouTube 合作夥伴計畫。
資產標籤可用於將資產歸類到自訂類別,好讓您更能輕鬆整理資產庫。您可以根據資產的標籤搜尋資產,這也能簡化需要更新特定資產群組的使用案例。
本指南將說明如何使用 YouTube Content ID API,執行與標籤相關的多項常用功能。本指南中的幾個章節都提供範例,協助您前往 Google API Explorer 並填入內容,以便您測試各項查詢。
建立資產標籤
這個 API 支援建立資產標籤的兩種方法:
-
呼叫
assetLabels.insert
方法。要求的主體是assetLabel
資源,其中labelName
屬性會指定新標籤的專屬名稱。如果已經有同名的標籤,API 會傳回409 (Conflict)
HTTP 回應代碼。以下查詢會呼叫
assetLabels.insert
方法,建立名為Explorer Test
的新標籤。範例要求的主體如下:{ "labelName": "Explorer Test" }
要求未設定任何查詢參數。不過,如果您的 Google 帳戶與多個內容擁有者帳戶相關聯,也必須為
onBehalfOfContentOwner
參數設定值。[no parameters set]
-
呼叫
assets.update
方法來更新資產的標籤。在要求中,將asset
資源的label[]
屬性設為與資產相關聯的標籤清單。API 會針對清單中任何未曾明確建立為assetLabel
資源的標籤,自動建立新的資產標籤。
列出內容擁有者的資產標籤
如要擷取內容擁有者的資產標籤清單,請呼叫 assetLabels.list
方法。
- 根據預設,API 會傳回內容擁有者的所有資產標籤。
- 如果您設定
labelPrefix
查詢參數的值,API 只會傳回開頭為指定字串的內容擁有者資產標籤。
以下查詢會呼叫 assetLabels.list
方法,擷取內容擁有者的所有標籤。不過請注意,如果您的 Google 帳戶與多個內容擁有者帳戶相關聯,您必須設定 onBehalfOfContentOwner
參數的值,要求將傳回 400 (Bad Request)
錯誤。
[no parameters set]
以下查詢會呼叫相同方法,但將 labelPrefix
參數值設為 news
。因此,API 只會傳回以該字串開頭的標籤。
labelPrefix=news
更新資產的標籤
如要更新資產的標籤,您可以在呼叫 assets.update 方法時設定 label[]
屬性的值。更新資產時,系統會移除其先前的標籤清單,並換成 API 要求中傳送的清單。因此,如要保留先前的標籤清單,應使用 assets.list
方法擷取原始標籤清單,然後修改 label[]
屬性的值。如果屬性值空白,API 會移除先前與資產建立關聯的標籤。
你可以將同一個標籤與多個資產建立關聯,也可以為同一個資產指派多個標籤。標籤可以包含空格,因此個別標籤的長度可能超過一個字。且不得使用角括號、逗號、冒號和直立線字元 (|)。每個標籤的長度必須至少為 2 個位元組,且不得超過 30 個位元組。每位內容擁有者最多可以為一個資產新增 30 個標籤;一個資產的所有標籤總長度上限為 500 位元組。
依標籤搜尋資產
如要擷取與某個或多組標籤相關聯的資產清單,請呼叫 assetSearch.list
方法,使用 labels
查詢參數指定以逗號分隔的資產標籤清單。
- 根據預設,API 會傳回具備所有指定資產標籤的資產清單。
- 如果 API 要求將
includeAnyProvidedLabel
參數設為true
,API 會傳回至少符合一個指定標籤的任何資產。