9 września 2020 r. wycofaliśmy zarówno zasób
guideCategories
, jak i metodę guideCategories.list
.
Zwraca listę kategorii, które można powiązać z kanałami YouTube.
Wpływ na limit: wywołanie tej metody ma koszt limitu wynoszący 1 jednostkę.
Prośba
Żądanie HTTP
GET https://www.googleapis.com/youtube/v3/guideCategories
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 guideCategory , 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 określa rozdzieloną przecinkami listę identyfikatorów kategorii kanału w YouTube dla pobieranych zasobów. W zasobie guideCategory właściwość id określa identyfikator kategorii kanału w YouTube. |
|
regionCode |
string Parametr regionCode powoduje, że interfejs API zwraca listę kategorii przewodników dostępnych w wybranym 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 będzie 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#guideCategoryListResponse", "etag": etag, "nextPageToken": string, "prevPageToken": string, "pageInfo": { "totalResults": integer, "resultsPerPage": integer }, "items": [ guideCategory 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#guideCategoryListResponse . |
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, które można powiązać z kanałami YouTube. Na tej mapie identyfikator kategorii jest kluczem mapy, a jego wartością jest odpowiadający jej zasób guideCategory . |
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) |
notFound |
Nie udało się znaleźć kategorii przewodnika wskazana przez parametr id . Aby pobrać listę prawidłowych wartości, użyj metody guideCategories.list. |
Wypróbuj
Użyj interfejsu APIs Explorer, aby wywołać ten interfejs API i wyświetlić żądanie oraz odpowiedź interfejsu API.