Method: assetSearch.list

依據資產中繼資料搜尋資產。這個方法可以擷取內容擁有者擁有的所有資產或資產。這種方法類似於 CMS「資產」頁面中的進階搜尋功能。

HTTP 要求

GET https://youtubepartner.googleapis.com/youtube/partner/v1/assetSearch

這個網址使用 gRPC 轉碼語法。

查詢參數

參數
createdAfter

string

createdAfter 參數會將傳回的資產集限制在原本指定日期當天或之後建立的資產集。例如：2015-01-29T23:00:00Z
createdBefore

string

createdBefore 參數會將傳回的資產集限制在指定日期當天或之前建立的資產集。例如：2015-01-29T23:00:00Z
hasConflicts

boolean

hasConflicts 參數能讓您只擷取出現擁有權衝突的資產。唯一的有效值是 true。將參數值設為 false 不會影響結果。
includeAnyProvidedlabel

boolean

如果將 includeAnyProvidedlabel 參數設為 true，系統會搜尋含有任一指定標籤的資產，否則會搜尋包含所有已提供標籤的資產。
isrcs

string

以半形逗號分隔的清單，最多可包含 50 個 ISRC。如果指定這個參數的值，API 伺服器會忽略為下列參數設定的任何值：q、includeAnyProvidedLabel、hasConflicts、labels、metadataSearchFields、sort 和 type。
labels

string

labels 參數指定待擷取特定資產標籤的資產。參數值是以逗號分隔的資產標籤清單。
metadataSearchFields

string

metadataSearchField 參數會指定要搜尋的中繼資料欄位。此為以半形逗號分隔的清單，當中列出以冒號(:) 連接的中繼資料欄位與值組合，例如：customId:my_custom_id,artist:Dandexx
onBehalfOfContentOwner

string

onBehalfOfContentOwner 參數會指出使用者代表的內容擁有者。這個參數支援帳戶與多個內容擁有者相關聯的使用者。
ownershipRestriction

enum (OwnershipRestriction)

ownershipRestriction 參數會指定搜尋的擁有權篩選選項。根據預設，只有通過驗證的使用者擁有的資產會執行搜尋。
pageToken

string

pageToken 參數會指定一個符記，用於識別要傳回的特定結果頁面。將這個參數設為前一個 API 回應中的 nextPageToken 值，即可擷取搜尋結果的下一頁。
q

string

YouTube 會搜尋所有資產的 id、type 和 customId 欄位，以及許多其他中繼資料欄位 (例如 actor、album、director、isrc 和 tmsId)，這些欄位會因資產類型 (電影、音樂影片等) 而異。
sort

enum (Sort)

sort 參數會指定搜尋結果的排序方式。請注意，結果一律以遞減順序排序。
type

string

type 參數會指定您要擷取的資產類型。參數值是以逗號分隔的資產類型清單。

要求主體

要求主體必須為空白。

回應主體

此回應會顯示符合搜尋查詢的 YouTube 資產清單。清單中的每個項目都包含一項資產的中繼資料。

如果成功，回應主體即會包含具有以下結構的資料：

JSON 表示法 
{
  "kind": string,
  "pageInfo": {
    object (PageInfo)
  },
  "items": [
    {
      object (AssetSnippet)
    }
  ],
  "nextPageToken": string
}
欄位
kind

string

API 回應的類型。這項作業的值為 youtubePartner#assetSnippetList。
pageInfo

object (PageInfo)

pageInfo 物件會封裝結果集的分頁資訊。
items[]

object (AssetSnippet)

符合要求條件的資產資源清單。
nextPageToken

string

可用來做為 pageToken 參數值的權杖，以擷取下一頁的結果。

授權範圍

需要下列 OAuth 範圍：

  • https://www.googleapis.com/auth/youtubepartner

詳情請參閱 OAuth 2.0 總覽。

OwnershipRestriction

擁有權限制列舉。

列舉
OWNERSHIP_RESTRICTION_UNSPECIFIED 預設值。
MINE 尋找目前使用者擁有且符合搜尋查詢的資產。此為預設行為。
NONE 尋找符合搜尋查詢的所有資產 (不限擁有者)。

排序

資產搜尋清單要求中支援的排序順序列舉。

列舉
SORT_UNSPECIFIED 預設值。
CLAIMS 按照各項資產的版權聲明數量排序。
TIME 按照各項素材資源的修改時間排序。這是預設值。
VIEWS 按各項資產的約略每日觀看次數排序。