Channels: list

Uwaga: wartość właściwości statistics.subscriberCount zasobu channel została zaktualizowana, aby odzwierciedlić zmianę zasad YouTube, która wpływa na sposób wyświetlania liczby subskrybentów. Więcej informacji znajdziesz w Historii wersji lub w Centrum pomocy YouTube.

Zwraca zbiór zero lub więcej zasobów channel, które spełniają kryteria żądania.

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

Typowe przypadki użycia

Żądanie

Żądanie HTTP

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

Upoważnienie

Żądanie, które pobiera część auditDetails zasobu channel, musi udostępnić token autoryzacji zawierający zakres https://www.googleapis.com/auth/youtubepartner-channel-audit. Dodatkowo tokeny korzystające z tego zakresu muszą zostać unieważnione, gdy sieć wielokanałowa zdecyduje się zaakceptować lub odrzucić kanał albo w ciągu 2 tygodni od jego przyznania.

Parametry

W poniższej tabeli podano parametry obsługiwane przez to zapytanie. Wszystkie wymienione parametry są parametrami zapytania.

Parametry
Parametry wymagane
part string
Parametr part określa rozdzieloną przecinkami listę co najmniej jednej właściwości zasobu channel, która ma być uwzględniona w odpowiedzi interfejsu API.

Jeśli parametr wskazuje właściwość zawierającą właściwości podrzędne, zostaną one uwzględnione w odpowiedzi. Na przykład w zasobie channel właściwość contentDetails zawiera inne właściwości, takie jak właściwość uploads. Jeśli ustawisz part=contentDetails, odpowiedź interfejsu API będzie również zawierać wszystkie te zagnieżdżone właściwości.

Ta lista zawiera nazwy part, które możesz uwzględnić w wartości parametru:
  • auditDetails
  • brandingSettings
  • contentDetails
  • contentOwnerDetails
  • id
  • localizations
  • snippet
  • statistics
  • status
  • topicDetails
Filtry (podaj jeden z tych parametrów)
categoryId string
Ten parametr został wycofany. Parametr categoryId określa kategorię przewodnika YouTube i można go użyć, by zażądać kanałów YouTube powiązanych z tą kategorią.
forUsername string
Parametr forUsername określa nazwę użytkownika YouTube, żądając więc kanału powiązanego z tą nazwą.
id string
Parametr id określa rozdzieloną przecinkami listę identyfikatorów kanałów YouTube dla pobieranych zasobów. W zasobie channel właściwość id określa identyfikator kanału w YouTube.
managedByMe boolean
Ten parametr może być używany tylko w poprawnie autoryzowanym żądaniu. Uwaga: ten parametr jest przeznaczony wyłącznie dla dostawców treści w YouTube.

Ustaw jego wartość na true, by interfejs API zwrócił tylko te kanały, którymi zarządza właściciel treści, zgodnie z tym parametrem onBehalfOfContentOwner. Użytkownik musi być uwierzytelniony jako konto CMS połączone z określonym właścicielem treści i musi zostać podany onBehalfOfContentOwner.
mine boolean
Ten parametr może być używany tylko w poprawnie autoryzowanym żądaniu. Ustaw wartość tego parametru na true, by interfejs API zwracał tylko kanały należące do uwierzytelnionego użytkownika.
Parametry opcjonalne
hl string
Parametr hl nakazuje interfejsowi API pobrać zlokalizowane metadane zasobów dla konkretnego języka aplikacji obsługiwanego przez stronę YouTube. Wartość parametru musi być kodem języka znajdującym się na liście zwróconej metodą i18nLanguages.list.

Jeśli szczegółowe informacje o zasobach są dostępne w tym języku, obiekt snippet.localized zasobu będzie zawierać zlokalizowane wartości. Jeśli jednak szczegóły dotyczące lokalizacji nie będą dostępne, obiekt snippet.localized będzie zawierał szczegóły zasobów w języku domyślnym zasobu.
maxResults unsigned integer
Parametr maxResults określa maksymalną liczbę elementów, które powinny zostać zwrócone w zestawie wyników. Akceptowane wartości to 0–50 (włącznie). Wartością domyślną jest 5.
onBehalfOfContentOwner string
Ten parametr może być używany tylko w poprawnie autoryzowanym żądaniu. Uwaga: ten parametr jest przeznaczony wyłącznie dla partnerów w sieci reklamowej YouTube.

Parametr onBehalfOfContentOwner wskazuje, że dane logowania żądania autoryzacji to użytkownik YouTube, który działa w imieniu właściciela treści określonego w wartości parametru. Ten parametr jest przeznaczony dla partnerów w sieci reklamowej YouTube, którzy mają wiele kanałów YouTube i zarządzają nimi. Umożliwia właścicielom treści uwierzytelnianie tylko raz oraz dostęp do wszystkich filmów i kanałów bez konieczności podawania danych uwierzytelniających dla każdego kanału z osobna. Konto CMS, za pomocą którego użytkownik się uwierzytelni, musi być połączone z określonym właścicielem treści w YouTube.
pageToken string
Parametr pageToken wskazuje konkretną stronę w zestawie wyników, która powinna zostać zwrócona. W odpowiedzi interfejsu API właściwości nextPageToken i prevPageToken wskazują inne strony, które można pobrać.

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#channelListResponse",
  "etag": etag,
  "nextPageToken": string,
  "prevPageToken": string,
  "pageInfo": {
    "totalResults": integer,
    "resultsPerPage": integer
  },
  "items": [
    channel 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#channelListResponse.
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 do pobrania poprzedniej strony w zbiorze wyników. Pamiętaj, że ta właściwość nie jest uwzględniona w odpowiedzi interfejsu API, jeśli odpowiednie żądanie interfejsu API ustawia parametr managedByMe na true.
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 kanałów spełniających kryteria żądania.

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
badRequest (400) invalidCriteria Możesz określić maksymalnie jeden z tych filtrów:id, categoryId, mine, managedByMe, forUsername. Jeśli uwierzytelnianie właściciela treści odbywa się za pomocą parametru onBehalfOfContentOwner, można określić tylko id lub managedByMe.
forbidden (403) channelForbidden Kanał określony w parametrze id nie obsługuje żądania lub nie jest on poprawnie autoryzowany.
notFound (404) categoryNotFound Nie można znaleźć kategorii określonego przez parametr categoryId. Aby pobrać listę prawidłowych wartości, użyj metody guideCategory.list.
notFound (404) channelNotFound Nie można znaleźć kanału określonego w parametrze id.

Wypróbuj

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