GuideCategories: list

注意:這是淘汰公告。

guideCategories 資源和 guideCategories.list 方法已於 2020 年 9 月 9 日淘汰。

傳回與 YouTube 頻道相關聯的類別清單。

配額影響:呼叫此方法的配額費用為 1 單位。

要求

HTTP 要求

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

參數

下表列出這項查詢支援的參數。上方列出的所有參數都是查詢參數。

參數
必要參數
part string
part 參數會指定 API 回應將包含的 guideCategory 資源屬性。將參數值設為 snippet
篩選器 (請僅指定下列其中一個參數)
id string
id 參數會擷取以逗號分隔的 YouTube 頻道類別 ID 清單資源清單。在 guideCategory 資源中,id 屬性會指定 YouTube 頻道類別 ID。
regionCode string
regionCode 參數會指示 API 傳回指定國家/地區可用的引導類別清單。參數值為 ISO 3166-1 alpha-2 國家/地區代碼,
選用參數
hl string
hl 參數會指定 API 回應中文字值的語言。預設值為 en-US

要求主體

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

回應

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

{
  "kind": "youtube#guideCategoryListResponse",
  "etag": etag,
  "nextPageToken": string,
  "prevPageToken": string,
  "pageInfo": {
    "totalResults": integer,
    "resultsPerPage": integer
  },
  "items": [
    guideCategory resource
  ]
}

屬性

下表定義此資源中顯示的屬性:

屬性
kind string
識別 API 資源類型。這個值會是 youtube#guideCategoryListResponse
etag etag
這項資源的 Etag。
nextPageToken string
這個符記可用做 pageToken 參數的值,以擷取結果集的下一頁。
prevPageToken string
這個符記可用做 pageToken 參數的值,以擷取結果集的上一頁。
pageInfo object
pageInfo 物件會封裝結果集的分頁資訊。
pageInfo.totalResults integer
結果集中的結果總數。
pageInfo.resultsPerPage integer
API 回應中包含的結果數量。
items[] list
可以與 YouTube 頻道建立關聯的類別清單。在這個對應中,類別 ID 是地圖金鑰,而其值則是對應的 guideCategory 資源。

錯誤

下表列出 API 針對呼叫方法所傳回的錯誤訊息。詳情請參閱錯誤訊息說明文件。

錯誤類型 錯誤詳細資料 說明
notFound (404) notFound 找不到以 id 參數識別的導覽類別。請使用 guideCategory.list 方法擷取有效值的清單。

試試看!

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