Method: claimSearch.list

擷取符合搜尋條件的聲明清單。您可以搜尋與特定資產/影片相關聯的版權聲明，或是符合指定查詢字串的版權聲明。

HTTP 要求

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

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

查詢參數

參數
assetId

string

assetId 參數會指定您要擷取版權聲明的資產的 YouTube 資產 ID。
contentType

enum (ContentType)

contentType 參數指定您要擷取的版權聲明內容類型。
createdAfter

string

createdAfter 參數可讓您將一組傳回的版權聲明限制在指定日期當天或之後建立 (含當天)。
createdBefore

string

createdBefore 參數可讓您將一組傳回的版權聲明限制在指定日期前建立 (排除)。
inactiveReasons

string

inactiveReasons 參數可讓您根據版權聲明失效的原因，指定要尋找哪一種無效的版權聲明。
includeThirdPartyClaims

boolean

這個參數可與 videoId 參數搭配使用，可決定是否在搜尋結果中加入第三方聲明。
onBehalfOfContentOwner

string

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

string

origin 參數會指定要尋找版權聲明的來源。這是以半形逗號分隔的來源值清單。
pageToken

string

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

boolean

partnerUploaded 參數可指定是否要篩選搜尋結果，只顯示合作夥伴上傳的版權聲明，還是合作夥伴上傳的版權聲明。
q

string

q 參數會指定要用於篩選搜尋結果的查詢字串。YouTube 會在下列聲明欄位中搜尋查詢字串：videoTitle、video_keywords、user_name、isrc、iswc、grid、customId，以及內容擁有者的電子郵件地址。
referenceId

string

referenceId 參數會指定您要擷取版權聲明的參考檔案的 YouTube 參考 ID。
sort

enum (Sort)

sort 參數會指定在 API 回應中，用來排序資源的方法。預設值為 date。不過，如果 status 參數值為 appealed、disputed、pending、potential 或 routedForReview，結果會以版權聲明審查期的到期時間排序。
status

enum (Status)

status 參數會限制結果只顯示指定狀態的聲明。
statusModifiedAfter

string

statusModifiedAfter 參數可讓您限制結果集，只納入在指定日期當天或之後修改狀態的版權聲明 (包含指定日期當天或之後)。指定的日期必須晚於 2016 年 6 月 30 日 (2016 年 6 月 30 日)。參數值的格式為 YYYY-MM-DD。
statusModifiedBefore

string

statusModifiedBefore 參數可讓您限制結果集，只納入狀態在指定日期之前修改的版權聲明 (不含)。指定的日期必須晚於 2016 年 7 月 1 日 (2016 年 7 月 1 日)。參數值的格式為 YYYY-MM-DD。
videoId

string

videoId 參數會指定您要擷取版權聲明的 YouTube 影片 ID 清單 (以半形逗號分隔)。
isVideoShortsEligible

boolean

透過 isVideoShortsEligible 參數，你可以限制結果集，只包含符合 YouTube Shorts 資格的影片版權聲明，或是排除這類版權聲明。如未指定，系統不會根據 YouTube Shorts 的使用資格進行篩選。

要求主體

要求主體必須為空白。

回應主體

回應 claimSearch.list 呼叫而傳回的聲明片段清單分頁。

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

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

string

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

object (PageInfo)

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

object (ClaimSnippet)

符合要求條件的版權聲明清單。
nextPageToken

string

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

string

可用來做為 pageToken 參數值的權杖，可在結果集中擷取上一頁。

授權範圍

需要下列 OAuth 範圍：

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

詳情請參閱 OAuth 2.0 總覽。

ContentType

內容類型列舉。

列舉
CONTENT_TYPE_UNSPECIFIED 預設值。
AUDIO 限制系統只傳回音訊版權聲明。
AUDIOVISUAL 僅根據影音版權聲明顯示結果。
VISUAL 僅顯示僅限影片的版權聲明。

排序

支援的排序順序。

列舉
SORT_UNSPECIFIED 預設值。
DATE 資源會根據資源建立日期，按時間由新到舊排序 (由新到舊)。如果 status 參數設為下列任一值，則不適用此值：appealed、disputed、pending、potential 或 routedForReview。
VIEW_COUNT 系統會根據已聲明版權內容的觀看次數，從高到低排序資源。如果 status 參數設為下列任一值，則不適用此值：appealed、disputed、pending、potential 或 routedForReview。

狀態

版權聲明狀態列舉。

列舉
STATUS_UNSPECIFIED 預設值。
ACTIVE 只傳回處於有效狀態的版權聲明。
APPEALED 只顯示已申訴狀態的版權聲明。
DISPUTED 只傳回有爭議狀態的版權聲明。
INACTIVE 限制系統只傳回處於無效狀態的版權聲明結果。
PENDING 限制系統只傳回處於待處理狀態的版權聲明結果。
POTENTIAL 限制系統只傳回具有職業狀態的版權聲明結果。
ROUTED_FOR_REVIEW 根據比對政策規則，只傳回需要審查的版權聲明結果。
TAKEDOWN 限制系統只傳回有下架狀態的版權聲明。
SHORT_MATCH 將結果限制在相符片段太短的版權聲明上，以便我們確信該片段應製作。
YOUTUBE_PARTNER 限制系統僅搜尋上傳至 YouTube 合作夥伴頻道的影片版權聲明。
LOW_CONFIDENCE 基於各種原因，只顯示可信度偏低的版權聲明。
YT_MONETIZATION_POLICY 僅針對疑似透過音樂集結網站提交第一方聲明的第 3 項版權聲明限制結果 (可讓創作者在不必加入 YouTube 合作夥伴計畫的情況下營利)。
RETROACTIVE_BLOCK 以舊版封鎖中的低可信度版權聲明來限制結果。