Captions

Uwaga: 13 marca 2024 r. ogłosiliśmy, że wycofujemy parametr sync w punktach końcowych interfejsu API captions.insert i captions.update. W YouTube Studio nadal dostępna jest automatyczna synchronizacja napisów. Więcej informacji znajdziesz w historii wersji interfejsu API.

Zasób caption reprezentuje ścieżkę z napisami w YouTube. Ścieżka z napisami jest powiązana tylko z jednym filmem w YouTube.

Metody

Interfejs API obsługuje te metody zasobów captions:

list

Pobieranie listy ścieżek z napisami powiązanych z określonym filmem. Zwróć uwagę, że odpowiedź interfejsu API nie zawiera rzeczywistych napisów, a metoda captions.download umożliwia pobranie ścieżki napisów. Wypróbuj teraz

wstaw

Prześlij ścieżkę z napisami.

aktualizacja

zaktualizować ścieżkę z napisami, Podczas aktualizowania ścieżki napisów możesz zmienić stan wersji roboczej ścieżki, przesłać nowy plik z napisami lub skorzystać z obu tych opcji.

usuń

Usunąć określoną ścieżkę z napisami. Wypróbuj teraz

pobierz

pobrać ś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.

Reprezentacja zasobu

Poniższa struktura JSON pokazuje format zasobu captions:

{
  "kind": "youtube#caption",
  "etag": etag,
  "id": string,
  "snippet": {
    "videoId": string,
    "lastUpdated": datetime,
    "trackKind": string,
    "language": string,
    "name": string,
    "audioTrackType": string,
    "isCC": boolean,
    "isLarge": boolean,
    "isEasyReader": boolean,
    "isDraft": boolean,
    "isAutoSynced": boolean,
    "status": string,
    "failureReason": string
  }
}

Właściwości

Poniższa tabela przedstawia właściwości, które pojawiają się w tym zasobie:

Właściwości
kind	string Określa typ zasobu interfejsu API. Wartością będzie youtube#caption.
etag	etag ETag tego zasobu.
id	string Identyfikator używany w YouTube do jednoznacznego identyfikowania ścieżki z napisami.
snippet	object Obiekt snippet zawiera podstawowe informacje o napisach.
snippet.videoId	string Identyfikator używany w YouTube do jednoznacznej identyfikacji filmu powiązanego ze ścieżką z napisami.
snippet.lastUpdated	datetime Data i godzina ostatniej aktualizacji ścieżki z napisami. Wartość należy podać w formacie ISO 8601.
snippet.trackKind	string Typ ścieżki napisów. Prawidłowe wartości tej właściwości to: ASR – ścieżka napisów wygenerowana przy użyciu automatycznego rozpoznawania mowy. forced – ścieżka z napisami odtwarzana, gdy w odtwarzaczu nie zostanie wybrana żadna inna ścieżka. Na przykład film przedstawiający kosmitów mówiących w obcym języku może mieć napisy, które będą wyświetlane tylko w języku obcym. standard – zwykła ścieżka napisów. jest to wartość domyślna
snippet.language	string Język ścieżki z napisami. Wartością właściwości jest tag języka BCP-47.
snippet.name	string Nazwa ścieżki z napisami. Nazwa jest widoczna dla użytkownika jako opcja podczas odtwarzania. Maksymalna obsługiwana nazwa to 150 znaków.
snippet.audioTrackType	string Typ ścieżki audio powiązanej ze ścieżką z napisami. Prawidłowe wartości tej właściwości to: commentary – ścieżka z napisami odpowiada alternatywnej ścieżce audio, która zawiera komentarz, np. komentarz do katalogu. descriptive – ścieżka z napisami odpowiada alternatywnej ścieżce audio, która zawiera dodatkową ścieżkę dźwiękową. primary – ścieżka z napisami odpowiada głównej ścieżce dźwiękowej filmu, którą jest zwykle powiązana z nim ścieżka dźwiękowa. unknown – to wartość domyślna.
snippet.isCC	boolean Wskazuje, czy ścieżka audio zawiera napisy dla osób niesłyszących i niedosłyszących. Wartością domyślną jest false.
snippet.isLarge	boolean Wskazuje, czy ścieżka z napisami zawiera duży tekst dla osób z wadą wzroku. Wartością domyślną jest false.
snippet.isEasyReader	boolean Wskazuje, czy ścieżka z napisami jest sformatowana pod kątem łatwego czytania, czyli jest przeznaczona dla osób uczących się języków obcych, dla których jest przeznaczona dla osób uczących się języka. Wartością domyślną jest false.
snippet.isDraft	boolean Wskazuje, czy ścieżka z napisami jest wersją roboczą. Jeśli wartością jest true, ścieżka nie jest widoczna publicznie. Wartością domyślną jest false.
snippet.isAutoSynced	boolean Wskazuje, czy YouTube zsynchronizował ścieżkę napisów ze ścieżką dźwiękową filmu. Jeśli podczas przesyłania ścieżki z napisami nastąpiła jawna prośba o synchronizację, wartość wynosi true. Na przykład podczas wywoływania metod captions.insert lub captions.update możesz ustawić parametr sync na true, aby nakazać YouTube synchronizację przesłanej ścieżki z filmem. Jeśli wartość to false, YouTube określa, kiedy wyświetlić napisy, na podstawie kodów czasowych z przesłanej ścieżki napisów.
snippet.status	string Stan ścieżki z napisami. Prawidłowe wartości tej właściwości to: failed serving syncing
snippet.failureReason	string Powód, dla którego YouTube nie przetworzył ścieżki z napisami. Ta właściwość występuje tylko wtedy, gdy state ma wartość failed. Prawidłowe wartości to: processingFailed – YouTube nie może przetworzyć przesłanej ścieżki napisów. unknownFormat – nie rozpoznano formatu ścieżki z napisami. unsupportedFormat – format ścieżki z napisami nie jest obsługiwany.