Captions: insert

Przesyła ścieżkę z napisami.

Ta metoda obsługuje przesyłanie multimediów. Przesłane pliki muszą być zgodne z tymi ograniczeniami:

  • Maksymalny rozmiar pliku: 100 MB
  • Akceptowane typy MIME multimediów: text/xml, application/octet-stream, */*

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

Typowe przypadki użycia

Prośba

Żądanie HTTP

POST https://www.googleapis.com/upload/youtube/v3/captions

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
part string
Parametr part określa części zasobów caption, które będzie zawierać odpowiedź interfejsu API. Ustaw wartość parametru na snippet.

Na poniższej liście znajdziesz nazwy parametrów typu part, które możesz uwzględnić w wartości parametru:
  • id
  • snippet
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.
sync boolean
Ten parametr został wycofany. Parametr sync wskazuje, czy YouTube ma automatycznie synchronizować plik z napisami ze ścieżką dźwiękową filmu. Jeśli ustawisz wartość true, YouTube zignoruje wszystkie kody czasu w przesłanym pliku napisów i wygeneruje nowe kody czasowe.

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

Treść żądania

W treści żądania podaj zasób napisów. W przypadku tego zasobu:

  • Musisz podać wartość tych właściwości:

    • snippet.videoId
    • snippet.language
    • snippet.name

  • Możesz ustawić wartości dla tych właściwości:

    • snippet.videoId
    • snippet.language
    • snippet.name
    • snippet.isDraft

Odpowiedź

Jeśli operacja się uda, metoda zwróci zasób napisów w treści odpowiedzi.

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
badRequest (400) contentRequired Żądanie nie zawiera treści ścieżki z napisami.
conflict (409) captionExists Wskazany film ma już ścieżkę z napisami snippet.language i snippet.name. Film może zawierać wiele ścieżek w tym samym języku, ale każda z nich musi mieć inną nazwę.

Błąd można rozwiązać na kilka sposobów. Możesz usunąć istniejącą ścieżkę, a następnie wstawić nową, lub zmienić nazwę nowej, zanim ją wstawisz.
forbidden (403) forbidden Uprawnienia powiązane z żądaniem są niewystarczające do przesłania ścieżki z napisami. Żądanie może nie być poprawnie autoryzowane.
invalidValue (400) invalidMetadata Żądanie zawiera nieprawidłowe wartości metadanych, które uniemożliwiają utworzenie ścieżki. Potwierdź, że w żądaniu określone są prawidłowe wartości właściwości snippet.language, snippet.name i snippet.videoId. Możesz też dołączyć właściwość snippet.isDraft, ale nie jest ona wymagana.
notFound (404) videoNotFound Nie udało się znaleźć filmu określonego przez parametr videoId.
invalidValue (400) nameTooLong Pole snippet.name w żądaniu jest za długie. Maksymalna obsługiwana długość to 150 znaków.

Wypróbuj

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