Wdrożenie: napisy

Poniższe przykłady pokazują, jak używać interfejsu YouTube Data API (w wersji 3) do wykonywania funkcji związanych z napisami.

Pobieranie listy ścieżek z napisami do filmu

Aby pobrać listę ścieżek napisów dostępnych w danym filmie, wywołaj metodę captions.list. Ustaw wartość parametru videoId na identyfikator filmu w YouTube, który jednoznacznie identyfikuje film, którego napisy chcesz pobrać. Żądanie musi być autoryzowane za pomocą OAuth 2.0.

Poniższe żądanie pobiera listę napisów do filmu na kanale YouTube Google Stories:

https://developers.google.com/apis-explorer/#p/youtube/v3/youtube.captions.list?
part=snippet
&videoId=PRU2ShMzQRg

Przykłady kodu znajdziesz w dokumentacji metody captions.list.

Tworzenie ścieżki z napisami

Nie można przetestować tego zapytania za pomocą narzędzia APIs Explorer, ponieważ nie obsługuje ono przesyłania plików, co jest wymagane w przypadku tej metody.

Aby przesłać nową ścieżkę z napisami do filmu, możesz użyć metody captions.insert interfejsu API. Podczas przesyłania utworu musisz podać wartość dla tych właściwości zasobu caption:

Podczas przesyłania ścieżki z napisami dostępne są te dodatkowe opcje:

  • Jeśli ustawisz parametr sync na true, YouTube zignoruje wszystkie kody czasowe w przesłanym pliku z napisami i wygeneruje nowe kody czasowe dla napisów.

    Jeśli przesyłasz transkrypcję, która nie zawiera kodów czasowych, lub jeśli podejrzewasz, że kody czasowe w pliku są nieprawidłowe i chcesz, aby YouTube spróbował je poprawić, ustaw parametr sync na true.

  • Jeśli ustawisz wartość właściwości snippet.isDraft zasobu caption na true, ścieżka nie będzie widoczna publicznie.

Przykłady kodu znajdziesz w dokumentacji metody captions.insert.

Pobieranie ścieżki z napisami

Nie można przetestować tego zapytania za pomocą narzędzia APIs Explorer, ponieważ nie obsługuje ono pobierania plików.

Aby pobrać określony ścieżkę z napisami, wywołaj metodę captions.download. Ustaw wartość parametru id na identyfikator ścieżki z napisami w YouTube, który jednoznacznie identyfikuje pobieraną ścieżkę z napisami. Żądanie musi być autoryzowane za pomocą OAuth 2.0.

Interfejs API w wersji 3 obsługuje te opcje:

  • Aby określić, że ścieżka z napisami ma zostać zwrócona w określonym formacie, ustaw wartość parametru tfmt, aby wskazać żądany format. Definicja parametru zawiera listę obsługiwanych wartości.

  • Aby pobrać tłumaczenie ścieżki z napisami, ustaw wartość parametru tlang na dwuliterowy kod języka ISO 639-1, który identyfikuje odpowiedni język napisów. Tłumaczenie jest generowane za pomocą tłumaczenia maszynowego, takiego jak Tłumacz Google.

Przykłady kodu znajdziesz w dokumentacji metody captions.download.

Aktualizowanie ścieżki z napisami

Interfejs API umożliwia zmianę stanu roboczego ścieżki napisów, przesłanie nowej ścieżki napisów do pliku lub wykonanie obu tych czynności.

Za pomocą narzędzia APIs Explorer możesz przetestować możliwość zmiany statusu szkicu utworu. Nie możesz jednak używać Eksploratora interfejsów API do aktualizowania właściwego ścieżki napisów, ponieważ to narzędzie nie obsługuje przesyłania plików.

Poniższe żądanie pobiera listę napisów do filmu na kanale YouTube Google Stories:

Prośba zaktualizuje stan wersji roboczej ścieżki z napisami na true, co oznacza, że ścieżka nie będzie widoczna publicznie. Aby przesłać żądanie w poruszniku interfejsów API, musisz ustawić wartość właściwości id, aby zidentyfikować ścieżkę napisów.

https://developers.google.com/apis-explorer/#p/youtube/v3/youtube.captions.update?
part=snippet

Przykłady kodu znajdziesz w dokumentacji metody captions.update.

Usuwanie ścieżki z napisami

Ten przykład pokazuje, jak usunąć ścieżkę z napisami. Przykład zawiera te kroki:

  • Krok 1. Pobierz identyfikator ścieżki napisów

    Aby pobrać listę ścieżek napisów w filmie, wykonaj czynności opisane powyżej. Lista może być używana do wyświetlania listy ścieżek napisów, przy czym identyfikator każdej ścieżki jest używany jako klucz.

  • Krok 2. Usuń ścieżkę

    Aby usunąć konkretny film, wywołaj metodę captions.delete. W żądaniu parametr id określa identyfikator ścieżki z napisami, którą usuwasz. Żądanie musi być autoryzowane za pomocą OAuth 2.0. Jeśli testujesz to zapytanie w narzędziu APIs Explorer, musisz zastąpić prawidłowy identyfikator ścieżki napisów wartością parametru id.

    https://developers.google.com/apis-explorer/#p/youtube/v3/youtube.captions.delete?
id=CAPTION_TRACK_ID