VideoCategories: list
透過集合功能整理內容
你可以依據偏好儲存及分類內容。
傳回可以與 YouTube 影片建立關聯的類別清單。
配額影響:呼叫這個方法的配額為 1 個單位。
常見用途
要求
HTTP 要求
GET https://www.googleapis.com/youtube/v3/videoCategories
參數
下表列出此查詢支援的參數。這裡列出的參數全都是查詢參數。
參數 |
必要參數 |
part |
string
part 參數會指定 API 回應會包含的 videoCategory 資源屬性。將參數值設為 snippet 。 |
篩選器 (請僅指定下列其中一個參數) |
id |
string
id 參數會針對要擷取的資源,指定以半形逗號分隔的影片類別 ID 清單。 |
regionCode |
string
regionCode 參數會指示 API 傳回指定國家/地區可用的影片類別清單。參數值採用 ISO 3166-1 alpha-2 國家/地區代碼。 |
選用參數 |
hl |
string
hl 參數會指定 API 回應中的文字值應使用的語言。預設值為 en_US 。 |
回應
如果成功的話,這個方法會傳回回應內文,其結構如下:
{
"kind": "youtube#videoCategoryListResponse",
"etag": etag,
"nextPageToken": string,
"prevPageToken": string,
"pageInfo": {
"totalResults": integer,
"resultsPerPage": integer
},
"items": [
videoCategory resource
]
}
屬性
下表定義了這項資源中顯示的屬性:
屬性 |
kind |
string 識別 API 資源的類型。值為 youtube#videoCategoryListResponse 。 |
etag |
etag
這項資源的 Etag。 |
nextPageToken |
string
可做為 pageToken 參數值的權杖,用於擷取結果集中的下一頁。 |
prevPageToken |
string
可做為 pageToken 參數值的權杖,擷取結果集中的上一頁。 |
pageInfo |
object
pageInfo 物件會封裝結果集的分頁資訊。 |
pageInfo.totalResults |
integer
結果集的結果總數。 |
pageInfo.resultsPerPage |
integer
API 回應中包含的結果數量。 |
items[] |
list
可與 YouTube 影片建立關聯的影片類別清單。在此地圖中,影片類別 ID 為地圖鍵,而其值是對應的 videoCategory 資源。 |
錯誤
下表列出 API 回應此方法時可能傳回的錯誤訊息。詳情請參閱錯誤訊息的說明文件。
錯誤類型 |
錯誤詳細資料 |
說明 |
notFound (404) |
videoCategoryNotFound |
找不到 id 參數識別的影片類別。使用 videoCategories.list 方法擷取有效值的清單。 |
試試看!
使用 APIs Explorer 呼叫這個 API 並查看 API 要求和回應。
除非另有註明,否則本頁面中的內容是採用創用 CC 姓名標示 4.0 授權,程式碼範例則為阿帕契 2.0 授權。詳情請參閱《Google Developers 網站政策》。Java 是 Oracle 和/或其關聯企業的註冊商標。
上次更新時間:2024-04-26 (世界標準時間)。
[null,null,["上次更新時間:2024-04-26 (世界標準時間)。"],[],[],null,["# VideoCategories: list\n\nReturns a list of categories that can be associated with YouTube videos.\n\n**Quota impact:** A call to this method has a [quota cost](/youtube/v3/getting-started#quota) of 1 unit.\n\nCommon use cases\n----------------\n\nThe list below shows common use cases for this method. Hover over a use case to see its description, or click on a use case to load sample parameter values in the APIs Explorer. You can open the [fullscreen APIs Explorer](#) to see code samples that dynamically update to reflect the parameter values entered in the Explorer.\n\nThe table below shows common use cases for this method. You can click on a use case name to load sample parameter values in the APIs Explorer. Or you can see code samples for a use case in the fullscreen APIs Explorer by clicking on the code icon below a use case name. In the fullscreen UI, you can update parameter and property values and the code samples will dynamically update to reflect the values you enter. \nThis method has one common use case, which is described below. The buttons below the description populate the APIs Explorer with sample values or open the fullscreen APIs Explorer to show code samples that use those values. The code samples also dynamically update if you change the values.\n\n\u003cbr /\u003e\n\nRequest\n-------\n\n### HTTP request\n\n```\nGET https://www.googleapis.com/youtube/v3/videoCategories\n```\n\n### Parameters\n\nThe following table lists the parameters that this query supports. All of the parameters listed are query parameters.\n\n| Parameters ||\n|--------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---|\n| **Required parameters** |||\n| `part` | `string` The **part** parameter specifies the `videoCategory` resource properties that the API response will include. Set the parameter value to `snippet`. |\n| **Filters (specify exactly one of the following parameters)** |||\n| `id` | `string` The **id** parameter specifies a comma-separated list of video category IDs for the resources that you are retrieving. |\n| `regionCode` | `string` The **regionCode** parameter instructs the API to return the list of video categories available in the specified country. The parameter value is an [ISO 3166-1 alpha-2](http://www.iso.org/iso/country_codes/iso_3166_code_lists/country_names_and_code_elements.htm) country code. |\n| **Optional parameters** |||\n| `hl` | `string` The **hl** parameter specifies the language that should be used for text values in the API response. The default value is `en_US`. |\n\n### Request body\n\nDo not provide a request body when calling this method.\n\nResponse\n--------\n\nIf successful, this method returns a response body with the following structure: \n\n```objective-c\n{\n \"kind\": \"youtube#videoCategoryListResponse\",\n \"etag\": etag,\n \"nextPageToken\": string,\n \"prevPageToken\": string,\n \"pageInfo\": {\n \"totalResults\": integer,\n \"resultsPerPage\": integer\n },\n \"items\": [\n videoCategory resource\n ]\n}\n```\n\n### Properties\n\nThe following table defines the properties that appear in this resource:\n\n| Properties ||\n|---------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `kind` | `string` Identifies the API resource's type. The value will be `youtube#videoCategoryListResponse`. |\n| `etag` | `etag` The Etag of this resource. |\n| `nextPageToken` | `string` The token that can be used as the value of the `pageToken` parameter to retrieve the next page in the result set. |\n| `prevPageToken` | `string` The token that can be used as the value of the `pageToken` parameter to retrieve the previous page in the result set. |\n| `pageInfo` | `object` The `pageInfo` object encapsulates paging information for the result set. |\n| pageInfo.`totalResults` | `integer` The total number of results in the result set. |\n| pageInfo.`resultsPerPage` | `integer` The number of results included in the API response. |\n| `items[]` | `list` A list of video categories that can be associated with YouTube videos. In this map, the video category ID is the map key, and its value is the corresponding `videoCategory` resource. |\n\nErrors\n------\n\nThe following table identifies error messages that the API could return in response to a call to this method. Please see the [error message](/youtube/v3/docs/errors) documentation for more detail.\n\n| Error type | Error detail | Description |\n|------------------|-------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `notFound (404)` | `videoCategoryNotFound` | The video category identified by the `id` parameter cannot be found. Use the [videoCategories.list](/youtube/v3/docs/videoCategories/list) method to retrieve a list of valid values. |\n\nTry it!\n-------\n\nUse the APIs Explorer to call this API and see the API request and response."]]