Captions: download

Mendownload trek teks. Jalur teks ditampilkan dalam format aslinya, kecuali jika permintaan menentukan nilai untuk parameter tfmt dan dalam bahasa aslinya, kecuali jika permintaan menentukan nilai untuk parameter tlang.

Dampak kuota: Panggilan ke metode ini memiliki biaya kuota sebesar 200 unit.

Kasus penggunaan umum

Permintaan

Permintaan HTTP

GET https://www.googleapis.com/youtube/v3/captions/id

Otorisasi

Permintaan ini memerlukan otorisasi dengan setidaknya salah satu cakupan berikut (baca selengkapnya tentang autentikasi dan otorisasi).

Cakupan
https://www.googleapis.com/auth/youtube.force-ssl
https://www.googleapis.com/auth/youtubepartner

Parameter

Tabel di bawah mencantumkan parameter yang didukung kueri ini. Semua parameter yang tercantum adalah parameter kueri.

Parameter
Parameter yang diperlukan
id string
Parameter id mengidentifikasi trek teks yang diambil. Nilainya adalah ID trek teks seperti yang diidentifikasi oleh properti id dalam resource caption.
Parameter opsional
onBehalfOfContentOwner string
Parameter ini hanya dapat digunakan dalam permintaan yang diotorisasi dengan benar. Catatan: Parameter ini ditujukan secara eksklusif untuk partner konten YouTube.

Parameter onBehalfOfContentOwner menunjukkan bahwa kredensial otorisasi permintaan mengidentifikasi pengguna CMS YouTube yang bertindak atas nama pemilik konten yang ditentukan dalam nilai parameter. Parameter ini ditujukan untuk partner konten YouTube yang memiliki dan mengelola banyak channel YouTube yang berbeda. Fitur ini memungkinkan pemilik konten melakukan autentikasi satu kali dan mendapatkan akses ke semua data video dan channel mereka, tanpa harus memberikan kredensial autentikasi untuk setiap channel. Akun CMS sebenarnya yang digunakan pengguna untuk melakukan autentikasi harus ditautkan ke pemilik konten YouTube yang ditentukan.
tfmt string
Parameter tfmt menentukan bahwa trek teks harus ditampilkan dalam format tertentu. Jika parameter tidak disertakan dalam permintaan, lagu akan ditampilkan dalam format aslinya.

Nilai yang didukung adalah:
  • sbv – Subtitel SubViewer
  • scc – Format Scenarist Closed Caption
  • srt – Subtitel SubRip
  • ttml – Teks Timed Text Markup Language
  • vtt – Teks Trek Teks Video Web
tlang string
Parameter tlang menentukan bahwa respons API harus menampilkan terjemahan trek teks yang ditentukan. Nilai parameter adalah kode bahasa dua huruf ISO 639-1 yang mengidentifikasi bahasa teks yang diinginkan. Terjemahan dibuat menggunakan terjemahan mesin, seperti Google Terjemahan.

Isi permintaan

Jangan berikan isi permintaan saat memanggil metode ini.

Respons

Jika berhasil, metode ini akan menampilkan file biner. Header Content-Type untuk respons adalah application/octet-stream.

Error

Tabel di bawah mengidentifikasi pesan error yang dapat ditampilkan API sebagai respons terhadap panggilan ke metode ini. Lihat dokumentasi pesan error untuk mengetahui detail selengkapnya.

Jenis error Detail error Deskripsi
forbidden (403) forbidden Izin yang terkait dengan permintaan tidak memadai untuk mendownload trek teks. Permintaan mungkin tidak diotorisasi dengan benar.
invalidValue (400) couldNotConvert Data trek teks tidak dapat dikonversi ke bahasa dan/atau format yang diminta. Pastikan nilai tfmt dan tlang yang diminta valid, dan snippet.status dari trek teks yang diminta bukan failed.
notFound (404) captionNotFound Trek teks tidak dapat ditemukan. Periksa nilai parameter id permintaan untuk memastikan nilainya sudah benar.

Cobalah!

Gunakan APIs Explorer untuk memanggil API ini dan melihat permintaan serta respons API.