Channels: list

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

Zwraca zbiór zawierający 0 lub więcej zasobów channel pasujących do kryteriów żądania.

Wpływ na limit: wywołanie tej metody kosztuje 1 jednostkę limitu.

Częste zastosowania

Żądanie

Żądanie HTTP

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

Autoryzacja

Żądanie, które pobiera część auditDetails zasobu channel, musi zawierać token autoryzacji z zakresem https://www.googleapis.com/auth/youtubepartner-channel-audit. Ponadto każdy token, który używa tego zakresu, musi zostać unieważniony, gdy sieć MCN zdecyduje się zaakceptować lub odrzucić kanał, albo w ciągu 2 tygodni od daty wydania tokena.

Parametry

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

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

Jeśli parametr identyfikuje właściwość, która zawiera właściwości podrzędne, te właściwości podrzędne zostaną uwzględnione w odpowiedzi. Na przykład we właściwości contentDetails zasobu channel znajdują się inne właściwości, takie jak uploads. Jeśli ustawisz part=contentDetails, odpowiedź interfejsu API będzie zawierać też wszystkie te zagnieżdżone właściwości.

Poniżej znajdziesz listę nazw part, które możesz uwzględnić w wartości parametru:
  • auditDetails
  • brandingSettings
  • contentDetails
  • contentOwnerDetails
  • id
  • localizations
  • snippet
  • statistics
  • status
  • topicDetails
Filtry (określ dokładnie 1 z tych parametrów)
categoryId string
Ten parametr został wycofany. Parametr categoryId określał kategorię przewodnika YouTube i można go było użyć do wysyłania żądań dotyczących kanałów YouTube powiązanych z tą kategorią.
forHandle string
Parametr forHandle określa nick na YouTube, a tym samym żąda kanału powiązanego z tym nickiem. Przed wartością parametru można dodać symbol @. Aby na przykład pobrać zasób kanału „Google dla deweloperów”, ustaw wartość parametru forHandle na GoogleDevelopers lub @GoogleDevelopers.
forUsername string
Parametr forUsername określa nazwę użytkownika YouTube, a tym samym żąda kanału powiązanego z tą nazwą.
id string
Parametr id określa rozdzieloną przecinkami listę identyfikatorów kanałów YouTube, dla których pobierane są zasoby. We właściwości id zasobu channel znajduje się identyfikator kanału YouTube.
managedByMe boolean
Ten parametr można używać tylko w prawidłowo autoryzowanym żądaniu.

Uwaga: ten parametr jest przeznaczony wyłącznie dla partnerów YouTube zajmujących się treściami.

Ustaw wartość tego parametru na true, aby poinstruować interfejs API, aby zwracał tylko kanały zarządzane przez właściciela treści określonego w parametrze onBehalfOfContentOwner. Użytkownik musi być uwierzytelniony jako konto CMS powiązane z określonym właścicielem treści, a parametr onBehalfOfContentOwner musi być podany.
mine boolean
Ten parametr można używać tylko w prawidłowo autoryzowanym żądaniu. Ustaw wartość tego parametru na true, aby poinstruować interfejs API, aby zwracał tylko kanały należące do uwierzytelnionego użytkownika.
Parametry opcjonalne
hl string
Parametr hl instruuje interfejs API, aby pobierał zlokalizowane metadane zasobów w określonym języku aplikacji obsługiwanym przez witrynę YouTube. Wartość parametru musi być kodem języka zawartym na liście zwracanej przez metodę i18nLanguages.list.

Jeśli zlokalizowane szczegóły zasobu są dostępne w danym języku, obiekt snippet.localized zasobu będzie zawierać zlokalizowane wartości. Jeśli jednak zlokalizowane szczegóły nie są dostępne, obiekt snippet.localized będzie zawierać szczegóły zasobu w języku domyślnym zasobu.
maxResults unsigned integer
Parametr maxResults określa maksymalną liczbę elementów, które mają być zwracane w zbiorze wyników. Akceptowane wartości to od 0 do 50 włącznie. Wartością domyślną jest 5.
onBehalfOfContentOwner string
Ten parametr można używać tylko w prawidłowo autoryzowanym żądaniu.

Uwaga: ten parametr jest przeznaczony wyłącznie dla partnerów YouTube zajmujących się treściami.

Parametr onBehalfOfContentOwner wskazuje, że dane uwierzytelniające żądania identyfikują użytkownika systemu YouTube CMS, który działa w imieniu właściciela treści określonego w wartości parametru. Ten parametr jest przeznaczony dla partnerów YouTube zajmujących się treściami, którzy są właścicielami wielu różnych kanałów YouTube i nimi zarządzają. Umożliwia on właścicielom treści jednorazowe uwierzytelnienie i uzyskanie dostępu do wszystkich danych o filmach i kanałach bez konieczności podawania danych uwierzytelniających dla każdego kanału. Konto CMS, za pomocą którego uwierzytelnia się użytkownik, musi być powiązane z określonym właścicielem treści YouTube.
pageToken string
Parametr pageToken określa konkretną stronę w zbiorze wyników, która ma zostać zwrócona. W odpowiedzi interfejsu API właściwości nextPageToken i prevPageToken identyfikują 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, ta metoda zwróci treść odpowiedzi o tej strukturze:

{
  "kind": "youtube#channelListResponse",
  "etag": etag,
  "nextPageToken": string,
  "prevPageToken": string,
  "pageInfo": {
    "totalResults": integer,
    "resultsPerPage": integer
  },
  "items": [
    channel Resource
  ]
}

Właściwości

W tabeli poniżej znajdziesz definicje właściwości, które występują w tym zasobie:

Właściwości
kind string
Określa typ zasobu interfejsu API. Wartość to youtube#channelListResponse.
etag etag
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. Pamiętaj, że ta właściwość nie jest uwzględniana w odpowiedzi interfejsu API, jeśli odpowiednie żądanie do interfejsu API ustawiło parametr managedByMe na true.
pageInfo object
Obiekt pageInfo zawiera informacje o stronicowaniu zbioru 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 kanałów pasujących do kryteriów żą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 artykule Błędy w interfejsie YouTube Data API.

Typ błędu Szczegóły błędu Opis
badRequest (400) invalidCriteria Można określić maksymalnie 1 z tych filtrów:id, categoryId, mine, managedByMe, forHandle, forUsername. W przypadku uwierzytelniania właściciela treści za pomocą parametru onBehalfOfContentOwner można określić tylko parametr id lub managedByMe.
forbidden (403) channelForbidden Kanał określony przez parametr id nie obsługuje żądania lub żądanie nie jest prawidłowo autoryzowane.
notFound (404) categoryNotFound Nie można znaleźć kategorii określonej przez parametr categoryId. Aby pobrać listę prawidłowych wartości, użyj metody guideCategories.list.
notFound (404) channelNotFound Nie można znaleźć kanału określonego w parametrze id.

Wypróbuj

Aby wywołać ten interfejs API i zobaczyć żądanie do interfejsu API oraz odpowiedź, użyj APIs Explorer.