GuideCategories: list

Uwaga: to jest ogłoszenie o wycofaniu.

Zasób guideCategories i metoda guideCategories.list zostały wycofane 9 września 2020 r.

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

Wpływ na limit: wywołanie tej metody wiąże się z kosztem limitu w wysokości 1 jednostki.

Żądanie

Żądanie HTTP

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

Parametry

W tabeli poniżej znajdziesz listę parametrów obsługiwanych przez to zapytanie. Wszystkie wymienione parametry to parametry zapytania.

Parametry
Parametry wymagane
part string
Parametr part określa właściwości zasobu guideCategory, które będą uwzględnione w odpowiedzi 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łów 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 nakazuje interfejsowi API zwrócenie listy kategorii przewodników dostępnych w określonym kraju. Wartością parametru jest kod kraju w formacie ISO 3166-1 alpha-2.
Parametry opcjonalne
hl string
Parametr hl określa język, który będzie używany w przypadku wartości 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 poniższym formacie:

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

Właściwości

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

Właściwości
kind string
Określa typ zasobu interfejsu API. Wartość będzie wynosić youtube#guideCategoryListResponse.
etag etag
Tag ETag tego zasobu.
nextPageToken string
Token, którego można użyć jako wartości parametru pageToken, aby pobrać następną stronę w zbiorze wyników.
prevPageToken string
Token, którego można użyć jako wartości parametru pageToken, aby pobrać poprzednią stronę w zbiorze wyników.
pageInfo object
Obiekt pageInfo zawiera informacje o stronicowaniu zestawu wyników.
pageInfo.totalResults integer
Łączna liczba wyników w zbiorze wyników.
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 w YouTube. W tej mapie identyfikator kategorii jest kluczem mapy, a jego wartością jest 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 komunikatu o błędzie.

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

Wypróbuj

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