Captions: download

Pobiera ścieżkę z napisami. Ścieżka z napisami jest zwracana w oryginalnym formacie, chyba że w żądaniu określono wartość parametru tfmt w oryginalnym języku, chyba że w żądaniu określisz wartość parametru tlang.

Wpływ na limit: wywołanie tej metody ma koszt limitu wynoszący 200 jednostek.

Typowe przypadki użycia

Prośba

Żądanie HTTP

GET https://www.googleapis.com/youtube/v3/captions/id

Upoważnienie

To żądanie wymaga autoryzacji z użyciem co najmniej jednego z tych zakresów (więcej informacji o uwierzytelnianiu i autoryzacji).

Zakres
https://www.googleapis.com/auth/youtube.force-ssl
https://www.googleapis.com/auth/youtubepartner

Parametry

W tabeli poniżej znajdziesz parametry obsługiwane przez to zapytanie. Wszystkie wymienione parametry są parametrami zapytania.

Parametry
Parametry wymagane
id string
Parametr id określa pobieraną ścieżkę z napisami. Wartością jest identyfikator ścieżki z napisami identyfikowany przez właściwość id w zasobie caption.
Parametry opcjonalne
onBehalfOfContentOwner string
Tego parametru można używać tylko w prawidłowo autoryzowanym żądaniu. Uwaga: ten parametr jest przeznaczony wyłącznie dla dostawców treści w YouTube.

Parametr onBehalfOfContentOwner wskazuje, że dane uwierzytelniające żądanie identyfikują użytkownika YouTube CMS działającego w imieniu właściciela treści określonego w wartości parametru. Jest on przeznaczony dla dostawców treści w YouTube, którzy mają wiele różnych kanałów w YouTube i nimi zarządzają. Dzięki niej właściciele treści mogą jednorazowo uwierzytelnić się i uzyskiwać dostęp do wszystkich swoich filmów oraz danych dotyczących kanałów bez konieczności podawania danych uwierzytelniających dla każdego kanału z osobna. Konto CMS, za pomocą którego użytkownik uwierzytelnia się, musi być powiązane z określonym właścicielem treści YouTube.
tfmt string
Parametr tfmt określa, że ścieżka z napisami powinna zostać zwrócona w określonym formacie. Jeśli żądanie nie zawiera danego parametru, ścieżka jest zwracana w pierwotnym formacie.

Obsługiwane wartości to:
  • sbv – podtytuł SubViewer
  • scc – format Scenarist Closed Caption
  • srt – podtytuł SubRip
  • ttml – podpis chronologicznie w języku znaczników
  • vtt – podpis ścieżek tekstowych w filmach internetowych
tlang string
Parametr tlang określa, że odpowiedź interfejsu API powinna zwracać tłumaczenie podanej ścieżki napisów. Wartością tego parametru jest dwuliterowy kod języka w standardzie ISO 639-1, który określa język napisów. Tłumaczenie jest generowane przy użyciu tłumaczenia maszynowego, np. Tłumacza Google.

Treść żądania

Nie podawaj treści żądania podczas wywoływania tej metody.

Odpowiedź

Jeśli operacja się uda, metoda zwróci plik binarny. Nagłówek Content-Type odpowiedzi to application/octet-stream.

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 szczegółów znajdziesz w dokumentacji komunikatów o błędach.

Typ błędu Szczegóły błędu Opis
forbidden (403) forbidden Uprawnienia powiązane z żądaniem są niewystarczające do pobrania ścieżki z napisami. Żądanie może nie być odpowiednio autoryzowane lub zamówienie filmu nie umożliwia przesyłania napisów przez osoby trzecie.
invalidValue (400) couldNotConvert Nie udało się przekonwertować danych ścieżki z napisami na żądany język lub format. Sprawdź, czy żądane wartości tfmt i tlang są prawidłowe oraz czy snippet.status żądanej ścieżki napisów nie ma wartości failed.
notFound (404) captionNotFound Nie udało się znaleźć ścieżki z napisami. Sprawdź, czy wartość parametru id żądania jest prawidłowa.

Wypróbuj

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