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 zmian lub w Centrum pomocy YouTube.

Zwraca zbiór co najmniej 0 zasobów channel, które spełniają kryteria żądania.

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

Typowe 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 wykorzystuje ten zakres, musi zostać cofnięty, gdy sieć wielokanałowa zdecyduje się zaakceptować lub odrzucić kanał, lub w ciągu 2 tygodni od daty wydania tokenu.

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 listę oddzielonych przecinkami właściwości zasobu channel, które będą uwzględnione w odpowiedzi interfejsu API.

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

Następująca 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 (wybierz dokładnie 1 z tych parametrów)
categoryId string
Ten parametr został wycofany. Parametry categoryId określały kategorię przewodnika YouTube i mogły służyć do żądania kanałów YouTube powiązanych z tą kategorią.
forHandle string
Parametr forHandle określa nick w YouTube, dzięki czemu prośba dotyczy kanału powiązanego z tym nickiem. Wartość parametru może być poprzedzona symbolem @. Aby na przykład pobrać zasób dla kanału „Google dla programistów”, ustaw wartość parametru forHandle na GoogleDevelopers lub @GoogleDevelopers.
forUsername string
Parametr forUsername określa nazwę użytkownika YouTube, co powoduje wysłanie żądania dotyczącego kanału powiązanego z tą nazwą.
id string
Parametry id określają listę rozdzielonych przecinkami identyfikatorów kanałów YouTube, do których mają być pobierane zasoby. 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 prawidłowo autoryzowanym żądaniu.

Uwaga: ten parametr jest przeznaczony wyłącznie dla partnerów treści YouTube.

Ustaw wartość tego parametru na true, aby polecić interfejsowi API zwracanie tylko kanałów zarządzanych przez właściciela treści, które są określone w parametrze onBehalfOfContentOwner. Użytkownik musi się uwierzytelnić jako konto CMS połączone z określonym właścicielem treści. Musi też podać onBehalfOfContentOwner.
mine boolean
Tego parametru można używać tylko w prawidłowo autoryzowanym żądaniu. Aby polecenie API zwracało tylko kanały należące do uwierzytelnionego użytkownika, ustaw wartość tego parametru na true.
Parametry opcjonalne
hl string
Parametr hl instruuje interfejs API, aby pobrać zlokalizowane metadane zasobu dla konkretnego języka aplikacji, który jest obsługiwany przez witrynę YouTube. Wartość parametru musi być kodem języka uwzględnionym na liście zwróconej przez metodę i18nLanguages.list.

Jeśli w danym języku są dostępne przetłumaczone szczegóły zasobu, obiekt snippet.localized zasobu będzie zawierać przetłumaczone wartości. Jeśli jednak szczegółowe informacje w danym języku są niedostępne, obiekt snippet.localized będzie zawierać szczegóły zasobu w języku domyślnym.
maxResults unsigned integer
Parametry maxResults określają maksymalną liczbę elementów, które powinny zostać zwrócone w zbiorze wyników. Akceptowane wartości to od 0 do 50 (włącznie). Wartością domyślną jest 5.
onBehalfOfContentOwner string
Tego parametru można używać tylko w prawidłowo autoryzowanym żądaniu.

Uwaga: ten parametr jest przeznaczony wyłącznie dla partnerów treści YouTube.

Parametr onBehalfOfContentOwner wskazuje, że dane uwierzytelniające autoryzacji żądania identyfikują użytkownika systemu CMS 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 treści w YouTube, którzy są właścicielami wielu kanałów YouTube i nimi zarządzają. Umożliwia ona właścicielom treści jednorazową weryfikację i uzyskanie dostępu do wszystkich danych o filmach i kanałach bez konieczności podawania danych logowania do każdego kanału. Konto CMS, za pomocą którego użytkownik się uwierzytelnia, musi być powiązane z określonym właścicielem treści w YouTube.
pageToken string
Parametr pageToken identyfikuje konkretną stronę w zbiorze 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ę powiedzie, metoda zwróci odpowiedź 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łaściwości występujące w tym zasobie są opisane w tabeli poniżej:

Właściwości
kind string
Określa typ zasobu interfejsu API. Wartość będzie wynosić youtube#channelListResponse.
etag etag
Etag tego zasobu.
nextPageToken string
Token, który można użyć jako wartości parametru pageToken, aby pobrać kolejną stronę zbioru wyników.
prevPageToken string
Token, który może służyć jako wartość parametru pageToken do pobierania poprzedniej strony w zbiorze wyników. Pamiętaj, że ta właściwość nie jest uwzględniana w odpowiedzi interfejsu API, jeśli odpowiednie żądanie interfejsu API skonfigurowało parametr managedByMe na wartość true.
pageInfo object
Obiekt pageInfo zawiera informacje o podziałach na strony w przypadku 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, które pasują 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 jeden 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 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 udało się znaleźć kategorii określonej przez parametr categoryId. Aby pobrać listę prawidłowych wartości, użyj metody guideCategories.list.
notFound (404) channelNotFound Nie udało się znaleźć kanału określonego w parametrze id.

Wypróbuj

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