GuideCategories: list

Uwaga: to jest ogłoszenie o wycofaniu.

9 września 2020 r. zarówno zasób guideCategories, jak i metoda guideCategories.list zostały wycofane.

Zwraca listę kategorii, które można powiązać z kanałami YouTube.

Wpływ limitu: wywołanie tej metody ma limit limitu wynoszący 1 jednostkę.

Żądanie

Żądanie HTTP

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

Parametry

Tabela poniżej zawiera listę parametrów obsługiwanych 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ędą uwzględniane w odpowiedzi interfejsu API. Ustaw wartość parametru na snippet.
Filtry (podaj jeden z tych parametrów)
id string
Parametr id określa oddzieloną przecinkami listę identyfikatorów kategorii kanału w przypadku pobieranych zasobów. W zasobie guideCategory właściwość id określa identyfikator kategorii kanału w YouTube.
regionCode string
Parametr regionCode nakazuje interfejsowi API zwracanie listy kategorii przewodnika dostępnych w danym kraju. Wartością tego parametru jest kod kraju w formacie ISO 3166-1 alfa-2.
Parametry opcjonalne
hl string
Parametr hl określa język, który będzie używany w wartościach tekstowych w odpowiedzi interfejsu API. Wartością domyślną jest en-US.

Treść żądania

Podczas wywoływania tej metody nie podawaj treści żądania.

Odpowiedź

Jeśli operacja się uda, metoda zwróci odpowiedź w następującym formacie:

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

Usługi

Poniższa tabela określa właściwości, które pojawiają się w tym zasobie:

Usługi
kind string
Określa typ zasobu interfejsu API. Wartość będzie wynosić youtube#guideCategoryListResponse.
etag etag
Otagowanie tego zasobu.
nextPageToken string
Token, który może zostać użyty jako wartość parametru pageToken, by pobrać następną stronę z zestawu wyników.
prevPageToken string
Token, którego można użyć jako wartości parametru pageToken w celu pobrania poprzedniej strony z zestawu wyników.
pageInfo object
Obiekt pageInfo zawiera informacje o stronicowaniu dla zestawu wyników.
pageInfo.totalResults integer
Łączna liczba wyników w zestawie wyników.
pageInfo.resultsPerPage integer
Liczba wyników zawartych w odpowiedzi interfejsu API.
items[] list
Lista kategorii, które można powiązać z kanałami w YouTube. Na tej mapie identyfikator kategorii to klucz, a jego wartość to odpowiedni 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 informacji znajdziesz w dokumentacji komunikatów o błędach.

Typ błędu Szczegóły błędu Opis
notFound (404) notFound Nie można znaleźć kategorii przewodnika oznaczonej parametrem id. Aby pobrać listę prawidłowych wartości, użyj metody guideCategory.list.

Wypróbuj

Użyj APIs Explorer, aby wywołać ten interfejs API i wyświetlić żądanie oraz odpowiedź interfejsu API.