使用資產標籤

注意:YouTube Content ID API 供 YouTube 內容合作夥伴使用,僅供部分開發人員或 YouTube 使用者存取。如果您在 Google API 控制台中並未看到 YouTube Content ID API 提供服務,請參閱 YouTube 說明中心,進一步瞭解 YouTube 合作夥伴計畫。

資產標籤可用於將資產歸類到自訂類別,好讓您更能輕鬆整理資產庫。您可以根據資產標籤搜尋資產,這在處理需要更新特定資產群組的使用情境時更加輕鬆。

本指南將說明如何使用 YouTube Content ID API 執行與標籤相關的多項常用功能。本指南中的幾個章節包含範例,以連結至 Google APIs 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 會傳回至少符合其中一個指定標籤的資產。