Channels

Interfejs API obsługuje teraz możliwość oznaczania kanału lub filmów jako „przeznaczonych dla dzieci”. Dodatkowo zasoby channel i video zawierają teraz właściwość, która określa, czy dany kanał lub film jest przeznaczony dla dzieci. 10 stycznia 2020 r. zaktualizowaliśmy też Warunki korzystania z usług YouTube API i zasady dla deweloperów. Więcej informacji znajdziesz w historii zmian usługi YouTube Data API i Warunków korzystania z usług YouTube API.

Zasób channel zawiera informacje o kanale w YouTube.

Metody

Interfejs API obsługuje te metody w przypadku zasobów channels:

list
Zwraca kolekcję zawierającą co najmniej 0 zasobów channel, które spełniają kryteria żądania. Wypróbuj go teraz
update
Aktualizuje metadane kanału. Pamiętaj, że ta metoda obsługuje obecnie tylko aktualizacje obiektów brandingSettings i invideoPromotion zasobu channel oraz ich właściwości podrzędnych. Wypróbuj go teraz

Prezentacja zasobów

Poniższa struktura JSON pokazuje format zasobu channels:

{
  "kind": "youtube#channel",
  "etag": etag,
  "id": string,
  "snippet": {
    "title": string,
    "description": string,
    "customUrl": string,
    "publishedAt": datetime,
    "thumbnails": {
      (key): {
        "url": string,
        "width": unsigned integer,
        "height": unsigned integer
      }
    },
    "defaultLanguage": string,
    "localized": {
      "title": string,
      "description": string
    },
    "country": string
  },
  "contentDetails": {
    "relatedPlaylists": {
      "likes": string,
      "favorites": string,
      "uploads": string
    }
  },
  "statistics": {
    "viewCount": unsigned long,
    "subscriberCount": unsigned long,  // this value is rounded to three significant figures
    "hiddenSubscriberCount": boolean,
    "videoCount": unsigned long
  },
  "topicDetails": {
    "topicIds": [
      string
    ],
    "topicCategories": [
      string
    ]
  },
  "status": {
    "privacyStatus": string,
    "isLinked": boolean,
    "longUploadsStatus": string,
    "madeForKids": boolean,
    "selfDeclaredMadeForKids": boolean
  },
  "brandingSettings": {
    "channel": {
      "title": string,
      "description": string,
      "keywords": string,
      "trackingAnalyticsAccountId": string,
      "unsubscribedTrailer": string,
      "defaultLanguage": string,
      "country": string
    },
    "watch": {
      "textColor": string,
      "backgroundColor": string,
      "featuredPlaylistId": string
    }
  },
  "auditDetails": {
    "overallGoodStanding": boolean,
    "communityGuidelinesGoodStanding": boolean,
    "copyrightStrikesGoodStanding": boolean,
    "contentIdClaimsGoodStanding": boolean
  },
  "contentOwnerDetails": {
    "contentOwner": string,
    "timeLinked": datetime
  },
  "localizations": {
    (key): {
      "title": string,
      "description": string
    }
  }
}

Właściwości

W tabeli poniżej opisano właściwości, które pojawiają się w tym zasobie:

Właściwości
kind string
Identyfikuje typ zasobu interfejsu API. Wartość będzie wynosić youtube#channel.
etag etag
Tag Etag tego zasobu.
id string
Identyfikator, którego YouTube używa do jednoznacznego identyfikowania kanału.
snippet object
Obiekt snippet zawiera podstawowe informacje o kanale, takie jak tytuł, opis i miniatury.
snippet.title string
Tytuł kanału.
snippet.description string
Opis kanału. Maksymalna długość wartości właściwości to 1000 znaków.
snippet.customUrl string
Niestandardowy URL kanału. W Centrum pomocy YouTube znajdziesz informacje o wymaganiach, które trzeba spełnić, aby uzyskać niestandardowy URL, oraz o tym, jak go skonfigurować.
snippet.publishedAt datetime
Data i godzina utworzenia kanału. Wartość jest podana w formacie ISO 8601.
snippet.thumbnails object
Mapa obrazów miniatur powiązanych z kanałem. W przypadku każdego obiektu na mapie kluczem jest nazwa miniatury, a wartością jest obiekt zawierający inne informacje o miniaturze.

Podczas wyświetlania miniatur w aplikacji upewnij się, że kod używa adresów URL obrazów dokładnie w takiej postaci, w jakiej są zwracane w odpowiedziach interfejsu API. Na przykład aplikacja nie powinna używać domeny http zamiast domeny https w adresie URL zwracanym w odpowiedzi interfejsu API.

Adresy URL miniatur kanałów są dostępne tylko w domenie https, czyli tak, jak pojawiają się w odpowiedziach interfejsu API. Jeśli Twoja aplikacja próbuje wczytać obrazy z YouTube z domeny http, mogą się one wyświetlać nieprawidłowo. W przypadku nowo utworzonych kanałów miniatury mogą być puste, a ich uzupełnienie może potrwać do 1 dnia.
snippet.thumbnails.(key) object
Prawidłowe wartości klucza:
  • default – domyślna miniatura. Domyślna miniatura filmu lub zasobu, który odnosi się do filmu, np. elementu playlisty lub wyniku wyszukiwania, ma 120 pikseli szerokości i 90 pikseli wysokości. Domyślna miniatura kanału ma 88 pikseli szerokości i 88 pikseli wysokości.
  • medium – wersja miniatury w wyższej rozdzielczości. W przypadku filmu (lub zasobu, który odnosi się do filmu) obraz ma 320 pikseli szerokości i 180 pikseli wysokości. W przypadku kanału obraz ma 240 pikseli szerokości i 240 pikseli wysokości.
  • high – wersja miniatury w wysokiej rozdzielczości. W przypadku filmu (lub zasobu, który odnosi się do filmu) ten obraz ma 480 pikseli szerokości i 360 pikseli wysokości. W przypadku kanału obraz ma 800 pikseli szerokości i 800 pikseli wysokości.
snippet.thumbnails.(key).url string
Adres URL obrazu. Dodatkowe wskazówki dotyczące używania adresów URL miniatur w aplikacji znajdziesz w definicji właściwości snippet.thumbnails.
snippet.thumbnails.(key).width unsigned integer
Szerokość obrazu.
snippet.thumbnails.(key).height unsigned integer
Wysokość obrazu.
snippet.defaultLanguage string
Język tekstu we właściwościach snippet.title i snippet.description zasobu channel.
snippet.localized object
Obiekt snippet.localized zawiera zlokalizowany tytuł i opis kanału lub tytuł i opis kanału w języku domyślnym dla metadanych kanału.
  • Zlokalizowany tekst jest zwracany we fragmencie zasobu, jeśli w żądaniu channels.list użyto parametru hl, aby określić język, dla którego ma zostać zwrócony zlokalizowany tekst, wartość parametru hl identyfikuje język aplikacji YouTube, a zlokalizowany tekst jest dostępny w tym języku.
  • Metadane dla języka domyślnego są zwracane, jeśli nie określono wartości parametru hl lub jeśli określono wartość, ale zlokalizowane metadane nie są dostępne dla określonego języka.
Właściwość zawiera wartość tylko do odczytu. Aby dodać, zaktualizować lub usunąć zlokalizowane metadane, użyj obiektu localizations.
snippet.localized.title string
Zlokalizowany tytuł kanału.
snippet.localized.description string
Zlokalizowany opis kanału.
snippet.country string
Kraj, z którym powiązany jest kanał. Aby ustawić wartość tej właściwości, zaktualizuj wartość właściwości brandingSettings.channel.country.
contentDetails object
Obiekt contentDetails zawiera informacje o treściach kanału.
contentDetails.relatedPlaylists object
Obiekt relatedPlaylists to mapa, która identyfikuje playlisty powiązane z kanałem, takie jak przesłane lub polubione filmy. Możesz pobrać dowolną z tych playlist za pomocą metody playlists.list.
contentDetails.relatedPlaylists.likes string
Identyfikator playlisty zawierającej polubione filmy z kanału. Użyj metod playlistItems.insert i playlistItems.delete, aby dodać lub usunąć elementy z tej listy.
contentDetails.relatedPlaylists.favorites string
Ta właściwość została wycofana.

Identyfikator playlisty zawierającej ulubione filmy kanału. Użyj metod playlistItems.insert i playlistItems.delete, aby dodać elementy do tej listy lub je z niej usunąć.

Pamiętaj, że YouTube wycofał funkcję ulubionych filmów. Na przykład właściwość statistics.favoriteCount zasobu video została wycofana 28 sierpnia 2015 r. W związku z tym ze względów historycznych ta wartość właściwości może zawierać identyfikator playlisty, który odnosi się do pustej playlisty, i dlatego nie można jej pobrać.
contentDetails.relatedPlaylists.uploads string
Identyfikator playlisty zawierającej filmy przesłane na kanał. Użyj metody videos.insert, aby przesłać nowe filmy, i metody videos.delete, aby usunąć wcześniej przesłane filmy.
statistics object
Obiekt statistics zawiera statystyki kanału.
statistics.viewCount unsigned long

Suma liczby wyświetleń wszystkich filmów we wszystkich formatach na kanale.

W przypadku wszystkich formatów filmów (długich filmów, transmisji na żywo i Shorts) na kanale viewCount liczy wyświetlenia od momentu rozpoczęcia odtwarzania filmu (obejmuje to autoodtwarzanie, najechanie kursorem i kliknięcie/dotknięcie, aby odtworzyć).

W przypadku wszystkich formatów wideo (długich filmów, transmisji na żywo i Shorts) na kanale viewCount uwzględnia wspólne oglądanie, gdy kilka osób ogląda treści razem na ekranie telewizora.

statistics.commentCount unsigned long
Ta właściwość została wycofana.

Liczba komentarzy na kanale.
statistics.subscriberCount unsigned long
Liczba subskrybentów kanału. Ta wartość jest zaokrąglana w dół do 3 cyfr znaczących. Więcej informacji o tym, jak zaokrąglana jest liczba subskrybentów, znajdziesz w historii zmian lub w Centrum pomocy YouTube.
statistics.hiddenSubscriberCount boolean
Wskazuje, czy liczba subskrybentów kanału jest widoczna publicznie.
statistics.videoCount unsigned long
Liczba publicznych filmów przesłanych na kanał. Pamiętaj, że wartość odzwierciedla liczbę publicznych filmów na kanale, nawet dla właścicieli. To zachowanie jest zgodne z liczbami wyświetlanymi na stronie YouTube.
topicDetails object
Obiekt topicDetails zawiera informacje o tematach powiązanych z kanałem.

Ważne: więcej informacji o zmianach związanych z identyfikatorami tematów znajdziesz w definicji właściwości topicDetails.topicIds[] i historii zmian.
topicDetails.topicIds[] list
Lista identyfikatorów tematów powiązanych z kanałem.

Ta właściwość została wycofana 10 listopada 2016 r. Będzie on obsługiwany do 10 listopada 2017 r.

Ważne: ze względu na wycofanie bazy Freebase i interfejsu Freebase API od 27 lutego 2017 r. identyfikatory tematów działają inaczej. Wtedy YouTube zaczął zwracać niewielki zestaw wybranych identyfikatorów tematów.

topicDetails.topicCategories[] list
Lista adresów URL Wikipedii, które opisują tematykę kanału.
status object
Obiekt status zawiera informacje o stanie prywatności kanału.
status.privacyStatus string
Stan prywatności kanału.

Prawidłowe wartości tej właściwości to:
  • private
  • public
  • unlisted
status.isLinked boolean
Wskazuje, czy dane kanału identyfikują użytkownika, który jest już połączony z nazwą użytkownika YouTube lub kontem Google+. Użytkownik, który ma jeden z tych linków, ma już publiczną tożsamość w YouTube, która jest wymagana do wykonania kilku działań, takich jak przesyłanie filmów.
status.longUploadsStatus string
Wskazuje, czy na kanale można przesyłać filmy dłuższe niż 15 minut. Ta właściwość jest zwracana tylko wtedy, gdy właściciel kanału autoryzował żądanie do interfejsu API. Więcej informacji o tej funkcji znajdziesz w Centrum pomocy YouTube.

Prawidłowe wartości tej właściwości to:
  • allowed – na tym kanale można przesyłać filmy dłuższe niż 15 minut.
  • disallowed – ten kanał nie może przesyłać filmów dłuższych niż 15 minut lub nie kwalifikuje się do tego. Kanał może przesyłać długie filmy tylko wtedy, gdy ma dobrą opinię zgodnie z wytycznymi dla społeczności YouTube i nie ma żadnych blokad Content ID na całym świecie nałożonych na jego treści.

    Gdy właściciel kanału rozwiąże problemy, które uniemożliwiają przesyłanie dłuższych filmów, kanał powróci do stanu allowed lub eligible.
  • eligible – na tym kanale można przesyłać filmy dłuższe niż 15 minut. Właściciel kanału musi jednak najpierw włączyć możliwość przesyłania dłuższych filmów, przechodząc weryfikację telefoniczną. Więcej informacji o tej funkcji znajdziesz w Centrum pomocy YouTube.
status.madeForKids boolean
Ta wartość wskazuje, czy kanał jest oznaczony jako przeznaczony dla dzieci, i zawiera aktualny stan kanału „przeznaczony dla dzieci”. Stan może być na przykład określany na podstawie wartości właściwości selfDeclaredMadeForKids. Więcej informacji o określaniu odbiorców kanału, filmów lub transmisji znajdziesz w Centrum pomocy YouTube.
status.selfDeclaredMadeForKids boolean
W żądaniu channels.update ta właściwość pozwala właścicielowi kanału oznaczyć kanał jako przeznaczony dla dzieci. Wartość właściwości jest zwracana tylko wtedy, gdy właściciel kanału autoryzował żądanie do interfejsu API.
brandingSettings object
Obiekt brandingSettings zawiera informacje o marce kanału.
brandingSettings.channel object
Obiekt channel zawiera właściwości marki strony kanału.
brandingSettings.channel.title string
Tytuł kanału. Tytuł może mieć maksymalnie 30 znaków.
brandingSettings.channel.description string
Opis kanału, który pojawia się w polu informacji o kanale na stronie kanału. Maksymalna długość wartości właściwości to 1000 znaków.
brandingSettings.channel.keywords string
Słowa kluczowe powiązane z Twoim kanałem. Wartość to lista ciągów znaków rozdzielonych spacjami. Słowa kluczowe kanału mogą zostać obcięte, jeśli przekraczają maksymalną dozwoloną długość 500 znaków lub zawierają niepoprawnie sformatowane cudzysłowy ("). Pamiętaj, że limit 500 znaków nie dotyczy pojedynczego słowa kluczowego, ale łącznej długości wszystkich słów kluczowych.
brandingSettings.channel.trackingAnalyticsAccountId string
Identyfikator konta Google Analytics, którego chcesz używać do śledzenia i pomiaru ruchu na kanale.
brandingSettings.channel.unsubscribedTrailer string
Film, który powinien być odtwarzany w module polecanego filmu w widoku przeglądania na stronie kanału dla widzów, którzy nie subskrybują kanału. Subskrybenci mogą zobaczyć inny film, który przedstawia najnowszą aktywność na kanale.

Jeśli ta właściwość jest określona, jej wartością musi być identyfikator filmu na YouTube, który jest publiczny lub niepubliczny i należy do właściciela kanału.
brandingSettings.channel.defaultLanguage string
Język tekstu we właściwościach snippet.title i snippet.description zasobu channel.
brandingSettings.channel.country string
Kraj, z którym powiązany jest kanał. Zaktualizuj tę właściwość, aby ustawić wartość właściwości snippet.country.
brandingSettings.watch object
Uwaga: ten obiekt i wszystkie jego właściwości podrzędne zostały wycofane.

Obiekt watch zawiera właściwości marki stron odtwarzania filmów z kanału.
brandingSettings.watch.textColor string
Uwaga: ta właściwość została wycofana.

Kolor tekstu w obszarze marki na stronie odtwarzania filmu.
brandingSettings.watch.backgroundColor string
Uwaga: ta właściwość została wycofana.

Kolor tła obszaru marki na stronie odtwarzania filmu.
brandingSettings.watch.featuredPlaylistId string
Uwaga: ta właściwość została wycofana. Jeśli spróbujesz ustawić jego wartość, interfejs API zwróci błąd.
brandingSettings.image object
Ta właściwość i wszystkie jej właściwości podrzędne zostały wycofane.

Obiekt image zawiera informacje o obrazach wyświetlanych na stronie kanału lub stronach odtwarzania filmów.
brandingSettings.image.bannerImageUrl string
Ta właściwość została wycofana.

Adres URL obrazu banera wyświetlanego na stronie kanału w witrynie YouTube. Obraz ma wymiary 1060 x 175 pikseli.
brandingSettings.image.bannerMobileImageUrl string
Ta właściwość została wycofana.

Adres URL obrazu banera wyświetlanego na stronie kanału w aplikacjach mobilnych. Obraz ma wymiary 640 × 175 pikseli.
brandingSettings.image.watchIconImageUrl string
Ta właściwość została wycofana.

Adres URL obrazu, który pojawia się nad odtwarzaczem. Jest to obraz o wysokości 25 pikseli i elastycznej szerokości, która nie może przekraczać 170 pikseli. Jeśli nie prześlesz tego obrazu, zamiast niego będzie wyświetlana nazwa kanału.
brandingSettings.image.trackingImageUrl string
Ta właściwość została wycofana.

Adres URL piksela śledzącego o wymiarach 1 x 1 piksel, który może służyć do zbierania statystyk wyświetleń stron kanału lub filmu.
brandingSettings.image.bannerTabletLowImageUrl string
Ta właściwość została wycofana.

Adres URL obrazu banera o niskiej rozdzielczości, który wyświetla się na stronie kanału w aplikacjach na tablety. Maksymalny rozmiar obrazu to 1138 x 188 pikseli.
brandingSettings.image.bannerTabletImageUrl string
Ta właściwość została wycofana.

Adres URL obrazu banera, który wyświetla się na stronie kanału w aplikacjach na tablety. Obraz ma wymiary 1707 x 283 piksele.
brandingSettings.image.bannerTabletHdImageUrl string
Ta właściwość została wycofana.

Adres URL obrazu banera w wysokiej rozdzielczości, który wyświetla się na stronie kanału w aplikacjach na tablety. Maksymalny rozmiar obrazu to 2276 x 377 pikseli.
brandingSettings.image.bannerTabletExtraHdImageUrl string
Ta właściwość została wycofana.

Adres URL obrazu banera w bardzo wysokiej rozdzielczości, który wyświetla się na stronie kanału w aplikacjach na tablety. Maksymalny rozmiar obrazu to 2560 x 424 piksele.
brandingSettings.image.bannerMobileLowImageUrl string
Ta właściwość została wycofana.

Adres URL obrazu banera o niskiej rozdzielczości, który wyświetla się na stronie kanału w aplikacjach mobilnych. Maksymalny rozmiar obrazu to 320 x 88 pikseli.
brandingSettings.image.bannerMobileMediumHdImageUrl string
Ta właściwość została wycofana.

Adres URL obrazu banera o średniej rozdzielczości, który wyświetla się na stronie kanału w aplikacjach mobilnych. Maksymalny rozmiar obrazu to 960 x 263 piksele.
brandingSettings.image.bannerMobileHdImageUrl string
Ta właściwość została wycofana.

Adres URL obrazu banera w wysokiej rozdzielczości, który wyświetla się na stronie kanału w aplikacjach mobilnych. Maksymalny rozmiar obrazu to 1280 x 360 pikseli.
brandingSettings.image.bannerMobileExtraHdImageUrl string
Ta właściwość została wycofana.

Adres URL obrazu banera w bardzo wysokiej rozdzielczości, który wyświetla się na stronie kanału w aplikacjach mobilnych. Maksymalny rozmiar obrazu to 1440 x 395 pikseli.
brandingSettings.image.bannerTvImageUrl string
Ta właściwość została wycofana.

Adres URL obrazu banera w bardzo wysokiej rozdzielczości, który wyświetla się na stronie kanału w aplikacjach telewizyjnych. Maksymalny rozmiar obrazu to 2120 x 1192 piksele.
brandingSettings.image.bannerTvLowImageUrl string
Ta właściwość została wycofana.

Adres URL obrazu banera o niskiej rozdzielczości, który wyświetla się na stronie kanału w aplikacjach telewizyjnych. Maksymalny rozmiar obrazu to 854 x 480 pikseli.
brandingSettings.image.bannerTvMediumImageUrl string
Ta właściwość została wycofana.

Adres URL obrazu banera o średniej rozdzielczości, który wyświetla się na stronie kanału w aplikacjach telewizyjnych. Maksymalny rozmiar obrazu to 1280 x 720 pikseli.
brandingSettings.image.bannerTvHighImageUrl string
Ta właściwość została wycofana.

Adres URL obrazu banera w wysokiej rozdzielczości, który wyświetla się na stronie kanału w aplikacjach telewizyjnych. Maksymalny rozmiar obrazu to 1920 x 1080 pikseli.
brandingSettings.image.bannerExternalUrl string
Ta właściwość określa lokalizację obrazu banera, którego YouTube używa do generowania różnych rozmiarów obrazu banera dla kanału.
brandingSettings.hints[] list
Ta właściwość i wszystkie jej właściwości podrzędne zostały wycofane.

Obiekt hints zawiera dodatkowe właściwości marki.
brandingSettings.hints[].property string
Ta właściwość została wycofana.

Właściwość.
brandingSettings.hints[].value string
Ta właściwość została wycofana.

Wartość właściwości.
auditDetails object
Obiekt auditDetails zawiera dane kanału, które sieć wielokanałowa ocenia, decydując, czy zaakceptować, czy odrzucić dany kanał. Pamiętaj, że każde żądanie do interfejsu API, które pobiera tę część zasobu, musi zawierać token autoryzacji z zakresem https://www.googleapis.com/auth/youtubepartner-channel-audit. Dodatkowo każdy token, który używa tego zakresu, musi zostać unieważniony, gdy sieć wielokanałowa zdecyduje się zaakceptować lub odrzucić kanał, albo w ciągu 2 tygodni od daty wydania tokena.
auditDetails.overallGoodStanding boolean
To pole wskazuje, czy występują jakieś problemy z kanałem. Obecnie to pole reprezentuje wynik operacji logicznej AND na właściwościach communityGuidelinesGoodStanding, copyrightStrikesGoodStanding i contentIdClaimsGoodStanding, co oznacza, że ta właściwość ma wartość true, jeśli wszystkie pozostałe właściwości również mają wartość true. Jeśli jednak którakolwiek z tych właściwości ma wartość false, ta właściwość będzie miała wartość false. Pamiętaj jednak, że metodologia używana do ustawiania wartości tej właściwości może ulec zmianie.
auditDetails.communityGuidelinesGoodStanding boolean
Wskazuje, czy kanał przestrzega wytycznych dla społeczności YouTube.
auditDetails.copyrightStrikesGoodStanding boolean
Wskazuje, czy kanał ma ostrzeżenia o naruszeniu praw autorskich.
auditDetails.contentIdClaimsGoodStanding boolean
Wskazuje, czy na kanale są jakieś nierozstrzygnięte roszczenia.
contentOwnerDetails object
Obiekt contentOwnerDetails zawiera dane kanału, które są widoczne tylko dla partnera YouTube, który połączył kanał ze swoim Menedżerem treści.
contentOwnerDetails.contentOwner string
Identyfikator właściciela treści powiązanego z kanałem.
contentOwnerDetails.timeLinked datetime
Data i godzina połączenia kanału z kontem właściciela treści. Wartość jest podana w formacie ISO 8601.
localizations object
Obiekt localizations zawiera tłumaczenia metadanych kanału.
localizations.(key) object
Język zlokalizowanych metadanych powiązanych z wartością klucza. Wartość jest ciągiem znaków zawierającym kod języka BCP-47.
localizations.(key).title string
Zlokalizowany tytuł kanału.
localizations.(key).description string
Zlokalizowany opis kanału.