Usługi YouTube API – wymagana minimalna funkcjonalność

Uwaga: przestrzeganie zasad dla deweloperów w YouTube zawiera wskazówki i przykłady, które pomogą Ci zadbać o to, aby Twoi klienci korzystający z interfejsu API przestrzegali konkretnych warunków oraz zasad dotyczących usług interfejsu API YouTube. Przewodnik zawiera informacje o tym, jak YouTube egzekwuje niektóre aspekty Warunków korzystania z interfejsu API. Nie zastępuje on jednak żadnych istniejących dokumentów.

Ten dokument określa minimalne wymagania funkcjonalne dla klientów korzystających z interfejsu API, którzy wdrażają określone funkcje usług YouTube API („Klienty API”) lub zapewniają do nich dostęp.

Te wymagania i wytyczne zapewniają spójne wrażenia użytkowników, które umożliwiają klientom korzystanie z interfejsów API, chroniąc interesy użytkowników YouTube, właścicieli treści i reklamodawców. Zasady te stanowią integralną część Warunków korzystania z interfejsu API YouTube i muszą być przestrzegane podczas tworzenia i wdrażania klientów API.

Wymagania opisane w tym dokumencie ulegną zmianie, dzięki czemu będziemy mogli zapewnić lepsze wrażenia użytkownikom, którzy już korzystają z funkcji YouTube. Zmieniają się również w zależności od nowych i zaktualizowanych funkcji YouTube. Czasami takie zmiany mogą wymagać zaktualizowania klientów API, aby spełniały nowe wymagania. W historii zmian Warunków korzystania z usługi będą zapisywane wszystkie zmiany, dlatego często sprawdzaj ten dokument lub zasubskrybuj kanał RSS, aby szybko otrzymywać informacje o zmianach, które mogą mieć wpływ na Twoje klienty interfejsu API.

Oprócz wymagań opisanych w tym dokumencie zdecydowanie zalecamy stosowanie sprawdzonych metod opisanych w zasadach dotyczących usług YouTube API i omówionych w innym miejscu w dokumentacji usług YouTube API. Nawet jeśli nie jest to ściśle wymagane, praktyki te pomagają Twoim klientom API szybciej usuwać błędy i optymalizować wykorzystanie limitu w przypadku korzystania z usług interfejsu API YouTube, które mają przydzielony limit. Jednocześnie te praktyki mają na celu zapewnienie prawidłowego działania ekosystemu YouTube, a przede wszystkim zapewnienie jak najlepszych wrażeń użytkownikom Twoich klientów API i aplikacji YouTube.

Umieszczony odtwarzacz YouTube i odtwarzanie filmów

Wymagania w tej sekcji odnoszą się w szczególności do umieszczonych na stronie odtwarzaczy YouTube. Zasady dotyczące usług interfejsu API YouTube obejmują też kilka zasad dotyczących klientów API, które odtwarzają treści audiowizualne YouTube.

Rozmiar odtwarzacza YouTube umieszczonego na stronie

Odtwarzacz umieszczony na stronie musi mieć okno wyświetlania o rozmiarze co najmniej 200 x 200 pikseli. Jeżeli w odtwarzaczu mają być widoczne elementy sterujące, musi on być na tyle duży, aby elementy te były całkowicie widoczne bez zmniejszania okna wyświetlania poniżej rozmiaru minimalnego. W przypadku odtwarzaczy 16:9 zalecamy rozmiar co najmniej 480 pikseli szerokości i 270 pikseli wysokości.

Odtworzenia automatyczne i oparte na skryptach

Ta sekcja dotyczy automatycznych odtworzeń. Dotyczy to umieszczonych na stronie odtwarzaczy YouTube, które używają parametru odtwarzacza autoplay lub automatycznie inicjują automatyczne odtwarzanie za pomocą interfejsu YouTube IFrame Player API, interfejsu YouTube Android Player API lub innej usługi interfejsu API YouTube.

  • Odtwarzacz umieszczony na stronie, który automatycznie odtwarza film, powinien rozpoczynać się natychmiast po wczytaniu strony lub zaraz po tym, gdy umieszczony odtwarzacz staje się w pełni widoczny. Jednak klient API nie może inicjować automatycznego odtwarzania do czasu, gdy odtwarzacz nie jest widoczny, a na stronie lub na ekranie widoczna jest więcej niż połowa odtwarzacza.

  • Strona lub ekran może zawierać maksymalnie jeden odtwarzacz YouTube, który jednocześnie odtwarza treści automatycznie.

  • Każda miniatura YouTube, która rozpoczyna odtwarzanie, musi mieć co najmniej 120 pikseli szerokości i 70 pikseli wysokości.

Atrybuty odtwarzacza YouTube

Atrybuty i parametry odtwarzacza YouTube – w tym np. wygląd marki YouTube w odtwarzaczu – są określone w dokumentacji i specyfikacjach interfejsu YouTube API (https://developers.google.com/youtube). Nie możesz wprowadzać w odtwarzaczu YouTube zmian, które nie zostały wyraźnie opisane w dokumentacji interfejsu API.

Nakładki i ramki

Nie wolno wyświetlać nakładek, ramek ani innych elementów wizualnych przed żadną częścią odtwarzacza YouTube umieszczonego na stronie, w tym elementami sterującymi odtwarzaczem. Podobnie nie można używać nakładek, ramek ani innych elementów wizualnych do zasłaniania jakiejkolwiek części umieszczonego odtwarzacza, w tym elementów sterujących odtwarzaczem.

Przesunięcia kursora myszy

Nie wolno używać najechania kursorem myszy ani zdarzeń dotknięcia w odtwarzaczu YouTube do inicjowania jakichkolwiek działań w imieniu użytkownika, takich jak otwarcie okna lub zasubskrybowanie kanału.

Przesyłanie filmów wideo

Jeśli klienty API umożliwiają użytkownikom przesyłanie treści na wiele platform, powinni mieć możliwość zaznaczania i odznaczania platform, na które chcą przesyłać filmy.

Wymagania dotyczące danych

Klienty interfejsu API, które umożliwiają użytkownikom przesyłanie filmów do YouTube, muszą umożliwić użytkownikom ustawianie wartości z poniższej listy. Wszystkie właściwości, których nie ma na liście, są opcjonalne.

  Nazwa Opis
Właściwości zasobu
snippet.title Wymagany. Tytuł filmu. YouTube zwraca błąd, jeśli jego wartość przekracza 100 znaków. YouTube obsługuje wszystkie prawidłowe znaki UTF-8 z wyjątkiem < i >.

snippet.description Wymagany. Opis filmu. YouTube zwraca błąd, jeśli wartość przekracza 5000 bajtów. YouTube obsługuje wszystkie prawidłowe znaki UTF-8 z wyjątkiem < i >.
status.privacyStatus Wymagany. Ustawienia prywatności filmu. Użytkownicy muszą mieć możliwość określenia, czy przesłany film ma być publiczny, prywatny czy niepubliczny.
Parametry żądania
onBehalfOfContentOwnerChannel Wymagane warunkowo. Jeśli dane uwierzytelniające żądania identyfikują właściciela treści i jest ustawiony parametr onBehalfOfContentOwner, użytkownik interfejsu API musi też mieć możliwość określenia kanału YouTube, na który jest przesyłany film.

Wyświetlanie komentarzy

  Nazwa Opis
Właściwości zasobu
snippet.textDisplay Wymagany. Tekst komentarza. Klient interfejsu API musi (a) wyświetlić pełny tekst komentarza lub odpowiedzi na komentarz albo (b) obciąć tekst i umożliwić użytkownikowi łatwy dostęp do pełnego tekstu z skróconej wersji.

To wymaganie dotyczy wszystkich komentarzy i odpowiedzi na komentarze, niezależnie od typu zasobu, z którym powiązane są komentarze (filmy, kanały itp.).

Pamiętaj, że właściwość snippet.topLevelComment zasobu commentThread jest listą zasobów comment, a wartość właściwości replies.comments[]comment Z tego względu ten wymóg dotyczy również właściwości snippet.topLevelComment.snippet.textDisplay i replies.comments[].snippet.textDisplay.
snippet.title
(channel)
Wymagane (sugestia). Tytuł kanału.
  • Jeśli komentarz dotyczy kanału, klient API musi wyświetlić nazwę kanału.
  • Jeśli komentarz dotyczy filmu, klient API musi wyświetlić nazwę kanału, z którego ten film został przesłany.
snippet.title
(video)
Wymagane warunkowo (sugestia). Tytuł filmu. Ta wartość musi być wyświetlana, jeśli komentarz dotyczy filmu.
snippet.moderationStatus Wymagane warunkowo. Jeśli wartość parametru moderationStatus w żądaniu do interfejsu API to heldForReview lub likelySpam, identyfikator musi być wyraźnie określony za pomocą wartości właściwości, podobnego języka (np. „Ten komentarz jest przeznaczony do sprawdzenia”), nagłówka (np. „Do sprawdzenia”) lub innego jednoznacznego języka. Metoda commentThreads.list umożliwia pobieranie komentarzy na podstawie ich stanu moderacji.

Dodawanie komentarzy

  Nazwa Opis
Właściwości zasobu
snippet.title
(channel)
Wymagany. Tytuł kanału.
  • Jeśli użytkownik dodaje komentarz na temat kanału, klient interfejsu API musi wyświetlić nazwę kanału.
  • Jeśli użytkownik dodaje komentarz na temat filmu, klient interfejsu API musi wyświetlić nazwę kanału, z którego ten film został przesłany.
snippet.title
(video)
Wymagany. Jeśli użytkownik dodaje komentarz na temat filmu, klient interfejsu API musi wyświetlić tytuł filmu.
Inne wymagania
Comment author's channel name Wymagany. Klient interfejsu API musi wyraźnie wskazać konto użytkownika YouTube, do którego zostanie przypisany komentarz. Jeśli dane uwierzytelniające żądania identyfikują właściciela treści i jest ustawiony parametr onBehalfOfContentOwner, użytkownik interfejsu API musi też mieć możliwość określenia kanału w YouTube, do którego zostanie przypisany komentarz.

Dodawanie odpowiedzi na komentarze

  Nazwa Opis
Właściwości zasobu
snippet.textDisplay Wymagany. Tekst komentarza. Klient interfejsu API musi wyświetlać tekst komentarza, na który odpowiada użytkownik, zgodnie z regułami określonymi w sekcji Wyświetlanie komentarzy w tym dokumencie.
snippet.title
(channel)
Wymagany. Tytuł kanału.
  • Jeśli użytkownik odpowiada na komentarz na temat kanału, klient API musi wyświetlić nazwę kanału.
  • Jeśli użytkownik odpowiada na komentarz do filmu, klient API musi wyświetlić nazwę kanału, z którego ten film został przesłany.
snippet.title
(video)
Wymagany. Jeśli użytkownik odpowiada na komentarz na temat filmu, klient interfejsu API musi wyświetlić tytuł filmu.
Inne wymagania
Comment author's channel name Wymagany. Klient interfejsu API musi wyraźnie wskazać konto użytkownika YouTube, do którego zostanie przypisana odpowiedź na komentarz. Jeśli dane logowania do autoryzacji żądania wskazują właściciela treści i jest skonfigurowany parametr onBehalfOfContentOwner, użytkownik interfejsu API musi też mieć możliwość określenia kanału w YouTube, do którego zostanie przypisana odpowiedź na komentarz.

Edytowanie i usuwanie odpowiedzi na komentarze

  Nazwa Opis
Właściwości zasobu
snippet.textDisplay Wymagany. Tekst komentarza. Klient interfejsu API musi wyświetlić tekst komentarza, który użytkownik edytuje lub usuwa, zgodnie z regułami określonymi w sekcji Wyświetlanie komentarzy w tym dokumencie.
snippet.title
(channel)
Wymagany. Tytuł kanału.
  • Jeśli użytkownik edytuje lub usuwa komentarz na temat kanału, klient API musi wyświetlić nazwę kanału.
  • Jeśli użytkownik edytuje lub usuwa komentarz do filmu, klient API musi wyświetlić nazwę kanału, z którego ten film został przesłany.
snippet.title
(video)
Wymagany. Jeśli użytkownik edytuje lub usuwa komentarz na temat filmu, klient interfejsu API musi wyświetlić tytuł filmu.
Inne wymagania
Comment author's channel name Wymagany. Klient interfejsu API musi wyraźnie wskazać konto użytkownika YouTube, do którego przypisano komentarz.

Blokowanie użytkownika w czacie na żywo (lub usuwanie blokady)

  Nazwa Opis
Właściwości zasobu
snippet.title
(channel)
Wymagany. Nazwa kanału w YouTube, który został zablokowany lub odblokowany. Dodatkowo nazwa musi prowadzić do kanału lub wyświetlać jego adres URL.
Inne wymagania
Nazwa kanału autora komentarza Wymagany. Klient interfejsu API musi wyraźnie wskazać konto użytkownika YouTube użyte do dodania lub usunięcia blokady.