Videos: list

傳回符合 API 要求參數的影片清單。

配額影響：呼叫這個方法的配額為 1 個單位。

常見用途

要求

HTTP 要求

GET https://www.googleapis.com/youtube/v3/videos

參數

下表列出此查詢支援的參數。這裡列出的參數全都是查詢參數。

參數
必要參數
part string
part 參數會指定一份以半形逗號分隔的清單，列出一或多個 API 回應會包含的 video 資源屬性。

如果參數識別含有子屬性的屬性，則回應中會加入這些子項屬性。舉例來說，在 video 資源中，snippet 屬性包含 channelId、title、description、tags 和 categoryId 屬性。因此，如果您設定 part=snippet，API 回應就會包含所有屬性。

以下清單包含您可以加入參數值中的 part 名稱：
  • contentDetails
  • fileDetails
  • id
  • liveStreamingDetails
  • localizations
  • player
  • processingDetails
  • recordingDetails
  • snippet
  • statistics
  • status
  • suggestions
  • topicDetails
篩選器 (請僅指定下列其中一個參數)
chart string
chart 參數可指明您想要擷取的圖表。

可接受的值如下：
id string
id 參數會指定待擷取資源的 YouTube 影片 ID 清單 (以半形逗號分隔)。在 video 資源中，id 屬性會指定影片 ID。
myRating string
這個參數只能在正確的授權要求中使用。將這個參數的值設為 like 或 dislike，指示 API 只傳回已驗證使用者喜歡或不喜歡的影片。

可接受的值如下：
  • dislike：僅傳回已驗證使用者不喜歡的影片。
  • like：只傳回已驗證使用者喜歡的影片。
選用參數
hl string
hl 參數可指示 API 擷取 YouTube 網站支援的特定應用程式語言的本地化資源中繼資料。參數值必須是 i18nLanguages.list 方法傳回的清單中的語言代碼。

如果該語言有本地化的資源詳細資料，則資源的 snippet.localized 物件會包含本地化值。不過，如果沒有可用的本地化詳細資料，snippet.localized 物件就會以資源預設語言中的資源詳細資料提供資源詳細資料。
maxHeight unsigned integer
maxHeight 參數會指定 player.embedHtml 屬性中傳回的嵌入式播放器高度上限。您可使用此參數來指定尺寸而非預設尺寸，嵌入程式碼應使用適合應用程式版面配置的高度。如果同時提供 maxWidth 參數，播放器可能會短於 maxHeight 而短，以不違反寬度上限。可接受的值為 72 到 8192 (含頭尾)。
maxResults unsigned integer
maxResults 參數會指定結果集應傳回的項目數量上限。

注意：這個參數可與 myRating 參數搭配使用，但系統無法與 id 參數搭配使用。可接受的值為 1 到 50 (含頭尾)。預設值為 5。
maxWidth unsigned integer
maxWidth 參數會指定 player.embedHtml 屬性中傳回的嵌入式播放器寬度上限。你可以使用這個參數指定這一點，而不是使用預設尺寸。嵌入程式碼應使用適合應用程式版面配置的寬度。

如果同時提供 maxHeight 參數，播放器可能會小於 maxWidth 做為寬度，避免違反高度上限。可接受的值為 72 到 8192 (含頭尾)。
onBehalfOfContentOwner string
這個參數只能在正確的授權要求中使用。注意：這個參數僅適用於 YouTube 內容合作夥伴。

onBehalfOfContentOwner 參數代表透過要求的授權憑證，代表 YouTube CMS 使用者，代表在參數值中指定的內容擁有者擔任代理人。這個參數適用於擁有及管理多個不同 YouTube 頻道的 YouTube 內容合作夥伴。內容擁有者只要通過一次驗證，即可存取所有影片和頻道資料，不必分別提供各個頻道的驗證憑證。用於驗證的 CMS 帳戶，必須連結至指定的 YouTube 內容擁有者。
pageToken string
pageToken 參數可在結果集中指明應傳回的特定網頁。在 API 回應中，nextPageToken 和 prevPageToken 屬性會識別其他可擷取的網頁。

注意：這個參數可與 myRating 參數搭配使用，但無法與 id 參數搭配使用。
regionCode string
regionCode 參數會指示 API 選取一個指定區域提供的影片圖表。這個參數只能搭配 chart 參數使用。參數值是 ISO 3166-1 alpha-2 國家/地區代碼。
videoCategoryId string
videoCategoryId 參數可指明應擷取圖表的影片類別。這個參數只能搭配 chart 參數使用。根據預設，圖表不限於特定類別。預設值為 0。

要求主體

呼叫此方法時，不要提供要求主體。

回應

如果成功的話，這個方法會傳回回應內文，其結構如下：

{
  "kind": "youtube#videoListResponse",
  "etag": etag,
  "nextPageToken": string,
  "prevPageToken": string,
  "pageInfo": {
    "totalResults": integer,
    "resultsPerPage": integer
  },
  "items": [
    video Resource
  ]
}

屬性

下表定義了這項資源中顯示的屬性：

屬性
kind string
識別 API 資源的類型。值為 youtube#videoListResponse。
etag etag
這項資源的 Etag。
nextPageToken string
可做為 pageToken 參數值的權杖，用於擷取結果集中的下一頁。
prevPageToken string
可做為 pageToken 參數值的權杖，擷取結果集中的上一頁。
pageInfo object
pageInfo 物件會封裝結果集的分頁資訊。
pageInfo.totalResults integer
結果集的結果總數。
pageInfo.resultsPerPage integer
API 回應中包含的結果數量。
items[] list
符合要求條件的影片清單。

錯誤

下表列出 API 回應此方法時可能傳回的錯誤訊息。詳情請參閱錯誤訊息的說明文件。

錯誤類型 錯誤詳細資料 說明
badRequest (400) videoChartNotFound 您要求的影片圖表不受支援或無法使用。
forbidden (403) forbidden 這項要求未獲適當授權，無法存取影片檔案或處理資訊。請注意，fileDetails、processingDetails 和 suggestions 部分僅供影片擁有者使用。
forbidden (403) forbidden 這項要求無法存取使用者評分資訊。之所以發生這個錯誤，可能是要求未獲適當授權使用 myRating 參數。
notFound (404) videoNotFound 找不到你嘗試擷取的影片。檢查要求的 id 參數值，確認值正確無誤。

試試看！

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