Aktualizujemy interfejs Data API, aby był zgodny ze sposobem zliczania przez YouTube wyświetleń filmów Short.
Więcej informacji
VideoCategories: list
Zadbaj o dobrą organizację dzięki kolekcji
Zapisuj i kategoryzuj treści zgodnie ze swoimi preferencjami.
Zwraca listę kategorii, które można powiązać z filmami w YouTube.
Wpływ na limit: wywołanie tej metody ma koszt limitu wynoszący 1 jednostkę.
Typowe przypadki użycia
Prośba
Żądanie HTTP
GET https://www.googleapis.com/youtube/v3/videoCategories
Parametry
W tabeli poniżej znajdziesz parametry obsługiwane przez to zapytanie. Wszystkie wymienione parametry są parametrami zapytania.
Parametry |
Parametry wymagane |
part |
string Parametr part określa właściwości zasobu videoCategory , które będzie zawierać odpowiedź interfejsu API. Ustaw wartość parametru na snippet .
|
Filtry (określ dokładnie jeden z tych parametrów) |
id |
string Parametr id zawiera rozdzieloną przecinkami listę identyfikatorów kategorii filmów dla pobieranych zasobów. |
regionCode |
string Parametr regionCode powoduje, że interfejs API zwraca listę kategorii filmów dostępnych w danym kraju. Jego wartością jest kod kraju zgodny ze standardem ISO 3166-1 alfa-2. |
Parametry opcjonalne |
hl |
string Parametr hl określa język, który powinien być używany na potrzeby wartości tekstowych w odpowiedzi interfejsu API. Wartością domyślną jest en_US . |
Treść żądania
Nie podawaj treści żądania podczas wywoływania tej metody.
Odpowiedź
Jeśli operacja się uda, metoda zwróci odpowiedź o następującej strukturze:
{
"kind": "youtube#videoCategoryListResponse",
"etag": etag,
"nextPageToken": string,
"prevPageToken": string,
"pageInfo": {
"totalResults": integer,
"resultsPerPage": integer
},
"items": [
videoCategory resource
]
}
Właściwości
Poniższa tabela przedstawia właściwości, które pojawiają się w tym zasobie:
Właściwości |
kind |
string Określa typ zasobu interfejsu API. Wartością będzie youtube#videoCategoryListResponse . |
etag |
etag
ETag tego zasobu. |
nextPageToken |
string Token, który może być używany jako wartość parametru pageToken w celu pobrania następnej strony w zestawie wyników. |
prevPageToken |
string Token, który może być używany jako wartość parametru pageToken do pobierania poprzedniej strony w zestawie wyników. |
pageInfo |
object Obiekt pageInfo zawiera informacje o stronicowaniu zbioru wyników. |
pageInfo.totalResults |
integer Łączna liczba wyników w zestawie. |
pageInfo.resultsPerPage |
integer
Liczba wyników uwzględnionych w odpowiedzi interfejsu API. |
items[] |
list Lista kategorii filmów, które można powiązać z filmami w YouTube. Na tej mapie identyfikator kategorii filmu jest kluczem mapy, a jego wartością jest odpowiadający jej zasób videoCategory . |
Błędy
W tabeli poniżej znajdziesz komunikaty o błędach, które interfejs API może zwrócić w odpowiedzi na wywołanie tej metody. Więcej szczegółów znajdziesz w dokumentacji komunikatów o błędach.
Typ błędu |
Szczegóły błędu |
Opis |
notFound (404) |
videoCategoryNotFound |
Nie udało się znaleźć kategorii filmu określonej przez parametr id . Aby pobrać listę prawidłowych wartości, użyj metody videoCategories.list. |
Wypróbuj
Użyj interfejsu APIs Explorer, aby wywołać ten interfejs API i wyświetlić żądanie oraz odpowiedź interfejsu API.
O ile nie stwierdzono inaczej, treść tej strony jest objęta licencją Creative Commons – uznanie autorstwa 4.0, a fragmenty kodu są dostępne na licencji Apache 2.0. Szczegółowe informacje na ten temat zawierają zasady dotyczące witryny Google Developers. Java jest zastrzeżonym znakiem towarowym firmy Oracle i jej podmiotów stowarzyszonych.
Ostatnia aktualizacja: 2024-04-26 UTC.
[null,null,["Ostatnia aktualizacja: 2024-04-26 UTC."],[],[],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."]]