Captions

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

Resource caption merepresentasikan trek teks YouTube. Trek teks dikaitkan dengan satu video YouTube.

Metode

API ini mendukung metode berikut untuk resource captions:

list
Mengambil daftar trek teks yang terkait dengan video tertentu. Perhatikan bahwa respons API tidak berisi teks yang sebenarnya dan bahwa metode captions.download memberikan kemampuan untuk mengambil trek teks. Coba sekarang.
sisipkan
Mengupload trek teks.
perbarui
Memperbarui trek teks. Saat memperbarui trek teks, Anda dapat mengubah status draf trek, mengupload file teks baru untuk trek tersebut, atau keduanya.
hapus
Menghapus trek teks tertentu. Coba sekarang.
download
Download trek teks. Trek teks ditampilkan dalam format aslinya kecuali jika permintaan menentukan nilai untuk parameter tfmt dan dalam bahasa aslinya, kecuali jika permintaan tersebut menentukan nilai untuk parameter tlang.

Representasi resource

Struktur JSON berikut menampilkan 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 mendefinisikan properti yang muncul di resource ini:

Properti
kind string
Mengidentifikasi jenis resource API. Nilainya akan berupa 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 secara unik video yang terkait dengan trek teks.
snippet.lastUpdated datetime
Tanggal dan waktu 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 dalam pemutar. Misalnya, video yang menampilkan alien yang berbicara dalam bahasa asing mungkin memiliki trek teks paksa yang hanya menampilkan subtitel untuk bahasa asing.
  • standard – Trek teks reguler. Nilai ini merupakan default.
snippet.language string
Bahasa trek teks. Nilai propertinya adalah tag bahasa BCP-47.
snippet.name string
Nama trek teks. Nama tersebut 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, yang merupakan 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 atau tidak. Nilai defaultnya adalah false.
snippet.isEasyReader boolean
Menunjukkan apakah trek teks diformat untuk "mudah dibaca", yang berarti trek teks tersebut berada di tingkat tiga untuk pelajar bahasa. Nilai defaultnya adalah false.
snippet.isDraft boolean
Menunjukkan apakah trek teks merupakan draf. Jika nilainya true, lagu 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 menyetel parameter sync ke true untuk memerintahkan YouTube menyinkronkan trek yang diupload dengan video. Jika nilainya adalah false, YouTube akan menggunakan kode waktu dalam trek teks yang diupload untuk menentukan waktu saat teks 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.