Captions

Uwaga: 13 marca 2024 r. YouTube ogłosił, że wycofuje parametr sync w przypadku punktów końcowych interfejsu API captions.insert i captions.update. Automatyczna synchronizacja napisów jest nadal dostępna w YouTube Studio. Więcej informacji znajdziesz w historii zmian interfejsu API.

Zasób caption reprezentuje ścieżkę z napisami w YouTube. Utwór z napisami jest powiązany z dokładnie jednym filmem w YouTube.

Metody

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

list
Pobierz listę ścieżek napisów powiązanych z określonym filmem. Pamiętaj, że odpowiedź interfejsu API nie zawiera faktycznych napisów, a metoda captions.download umożliwia pobranie ścieżki z napisami. Wypróbuj
insert
Prześlij ścieżkę z napisami. Wypróbuj teraz
update
Zaktualizuj ścieżkę z napisami. Podczas aktualizowania ścieżki napisów możesz zmienić stan projektu ścieżki, przesłać nowy plik napisów lub wykonać obie te czynności. Wypróbuj
download
Pobierz ścieżkę z napisami. Ścieżka z napisami jest zwracana w oryginalnym formacie, chyba że żądanie określa wartość parametru tfmt, oraz w oryginalnym języku, chyba że żądanie określa wartość parametru tlang. Wypróbuj
usuń
Usuń określoną ścieżkę z napisami. Wypróbuj teraz

Reprezentacja zasobu

Struktura JSON poniżej 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

Właściwości występujące w tym zasobie są opisane w tabeli poniżej:

Właściwości
kind string
Określa typ zasobu interfejsu API. Wartość będzie wynosić youtube#caption.
etag etag
Etag tego zasobu.
id string
Identyfikator, którego YouTube używa do jednoznacznej identyfikacji ścieżki z napisami.
snippet object
Obiekt snippet zawiera podstawowe informacje o napisach.
snippet.videoId string
Identyfikator, którego YouTube używa do jednoznacznej identyfikacji filmu powiązanego z ścieżką z napisami.
snippet.lastUpdated datetime
Data i godzina ostatniej aktualizacji ścieżki z napisami. Wartość jest podawana w formacie ISO 8601.
snippet.trackKind string
Typ ścieżki z napisami.

Dozwolone wartości tej właściwości to:
  • ASR – napisy utworzone przez system rozpoznawania mowy.
  • forced – ścieżka z napisami, która jest odtwarzana, gdy w odtwarzaczu nie jest wybrana żadna inna ścieżka. Na przykład film, w którym występują obcy mówiący w obcym języku, może mieć wymuszoną ścieżkę napisów, aby wyświetlać tylko napisy w obcym języku.
  • standard – zwykła ścieżka z napisami. Jest to wartość domyślna.
snippet.language string
Język ścieżki z napisami. Wartość właściwości to tag języka zgodny ze standardem BCP-47.
snippet.name string
Nazwa ścieżki z napisami. Nazwa ma być widoczna dla użytkownika jako opcja podczas odtwarzania. Maksymalna długość nazwy to 150 znaków.
snippet.audioTrackType string
Typ ścieżki audio powiązanej ze ścieżką z napisami.

Dopuszczalne wartości tej właściwości to:
  • commentary – ścieżka z napisami odpowiada ścieżce audio z komentarzem, np. komentarzem do katalogu.
  • descriptive – ścieżka z napisami odpowiada ścieżce audio, która zawiera dodatkowe audiodeskrypcje.
  • primary – ścieżka napisów odpowiada głównej ścieżce audio filmu, czyli ścieżce audio zwykle powiązanej z filmem.
  • unknown – wartość domyślna.
snippet.isCC boolean
Wskazuje, czy ścieżka zawiera napisy dla osób głuchych 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 niedowidzących. Wartością domyślną jest false.
snippet.isEasyReader boolean
Wskazuje, czy ścieżka z napisami jest sformatowana w taki sposób, aby była łatwa do czytania, co oznacza, że jest przeznaczona dla osób uczących się języka na poziomie szkoły podstawowej. Wartością domyślną jest false.
snippet.isDraft boolean
Wskazuje, czy ścieżka z napisami jest wersją roboczą. Jeśli wartość to true, utwór jest niewidoczny publicznie. Wartością domyślną jest false.
snippet.isAutoSynced boolean
Wskazuje, czy YouTube zsynchronizował ścieżkę napisów ze ścieżką audio w filmie. Jeśli podczas przesyłania ścieżki napisów zostało wyraźnie zażądane zsynchronizowanie, wartość będzie wynosić true. Na przykład podczas wywoływania metod captions.insert lub captions.update możesz ustawić parametr sync na wartość true, aby zlecić YouTube zsynchronizowanie przesłanej ścieżki z filmem. Jeśli wartość to false, YouTube używa kodów czasu w przesłanym pliku napisów, aby określić, kiedy wyświetlać napisy.
snippet.status string
Stan ścieżki z napisami.

Dozwolone wartości tej właściwości to:
  • failed
  • serving
  • syncing
snippet.failureReason string
Przyczyna, dla której YouTube nie udało się przetworzyć ścieżki z napisami. Ta właściwość jest obecna tylko wtedy, gdy wartość właściwości state to failed.

Dozwolone wartości tej właściwości to:
  • processingFailed – nie udało się przetworzyć przesłanego pliku z napisami.
  • unknownFormat – nie rozpoznano formatu ścieżki z napisami.
  • unsupportedFormat – format ścieżki z napisami nie jest obsługiwany.