Captions

Catatan: Pada 13 Maret 2024, YouTube mengumumkan bahwa parameter sync tidak digunakan lagi untuk endpoint captions.insert dan captions.update API. Sinkronisasi otomatis teks masih tersedia di YouTube Creator Studio. Lihat histori revisi API untuk mengetahui detail selengkapnya.

Resource caption mewakili trek teks YouTube. Trek teks dikaitkan dengan tepat satu video YouTube.

Metode

API ini mendukung metode berikut untuk resource captions:

list
Mengambil daftar trek teks yang terkait dengan video yang ditentukan. Perhatikan bahwa respons API tidak berisi teks sebenarnya dan metode captions.download memberikan kemampuan untuk mengambil trek teks. Coba sekarang.
insert
Upload trek teks. Coba sekarang.
update
Memperbarui trek teks. Saat memperbarui trek teks, Anda dapat mengubah status draf trek, mengupload file teks baru untuk trek, atau keduanya. Coba sekarang.
download
Mendownload trek teks. Jalur teks ditampilkan ke format aslinya kecuali jika permintaan menentukan nilai untuk parameter tfmt dan ke bahasa aslinya kecuali jika permintaan menentukan nilai untuk parameter tlang. Coba sekarang.
hapus
Menghapus trek teks yang ditentukan. Coba sekarang.

Representasi resource

Struktur JSON berikut menunjukkan format resource 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
  }
}

Properti

Tabel berikut menentukan properti yang muncul dalam resource ini:

Properti
kind string
Mengidentifikasi jenis resource API. Nilainya akan menjadi youtube#caption.
etag etag
Etag resource ini.
id string
ID yang digunakan YouTube untuk mengidentifikasi trek teks secara unik.
snippet object
Objek snippet berisi detail dasar tentang teks.
snippet.videoId string
ID yang digunakan YouTube untuk mengidentifikasi video yang terkait dengan trek teks secara unik.
snippet.lastUpdated datetime
Tanggal dan waktu saat trek teks terakhir diperbarui. Nilai ditentukan dalam format ISO 8601.
snippet.trackKind string
Jenis trek teks.

Nilai yang valid untuk properti ini adalah:
  • ASR – Trek teks yang dibuat menggunakan pengenalan ucapan otomatis.
  • forced – Trek teks yang diputar saat tidak ada trek lain yang dipilih di pemutar. Misalnya, video yang menampilkan alien yang berbicara dalam bahasa alien mungkin memiliki trek teks paksa untuk hanya menampilkan subtitel untuk bahasa alien.
  • standard – Trek teks reguler. Nilai ini merupakan default.
snippet.language string
Bahasa trek teks. Nilai properti adalah tag bahasa BCP-47.
snippet.name string
Nama trek teks. Nama ini dimaksudkan agar dapat dilihat oleh pengguna sebagai opsi selama pemutaran. Panjang nama maksimum yang didukung adalah 150 karakter.
snippet.audioTrackType string
Jenis trek audio yang terkait dengan trek teks.

Nilai yang valid untuk properti ini adalah:
  • commentary – Trek teks sesuai dengan trek audio alternatif yang menyertakan komentar, seperti komentar direktori.
  • descriptive – Trek teks sesuai dengan trek audio alternatif yang menyertakan audio deskriptif tambahan.
  • primary – Trek teks sesuai dengan trek audio utama untuk video, yaitu trek audio yang biasanya dikaitkan dengan video.
  • unknown – Ini adalah nilai default.
snippet.isCC boolean
Menunjukkan apakah trek berisi teks tertutup untuk penyandang tunarungu dan gangguan pendengaran. Nilai defaultnya adalah false.
snippet.isLarge boolean
Menunjukkan apakah trek teks menggunakan teks besar untuk penyandang gangguan penglihatan. Nilai defaultnya adalah false.
snippet.isEasyReader boolean
Menunjukkan apakah trek teks diformat untuk "pembaca mudah", yang berarti berada di tingkat kelas tiga untuk pelajar bahasa. Nilai defaultnya adalah false.
snippet.isDraft boolean
Menunjukkan apakah trek teks adalah draf. Jika nilainya true, berarti jalur tidak terlihat secara publik. Nilai defaultnya adalah false.
snippet.isAutoSynced boolean
Menunjukkan apakah YouTube menyinkronkan trek teks ke trek audio dalam video. Nilainya akan menjadi true jika sinkronisasi diminta secara eksplisit saat trek teks diupload. Misalnya, saat memanggil metode captions.insert atau captions.update, Anda dapat menetapkan parameter sync ke true untuk memerintahkan YouTube menyinkronkan lagu yang diupload ke video. Jika nilainya adalah false, YouTube akan menggunakan kode waktu di trek teks yang diupload untuk menentukan kapan teks akan ditampilkan.
snippet.status string
Status trek teks.

Nilai yang valid untuk properti ini adalah:
  • failed
  • serving
  • syncing
snippet.failureReason string
Alasan YouTube gagal memproses trek teks. Properti ini hanya ada jika nilai properti state adalah failed.

Nilai yang valid untuk properti ini adalah:
  • processingFailed – YouTube gagal memproses trek teks yang diupload.
  • unknownFormat – Format trek teks tidak dikenal.
  • unsupportedFormat – Format trek teks tidak didukung.