Captions: update

Memperbarui trek subtitel. Saat memperbarui trek subtitel, Anda dapat mengubah status draf trek, mengupload file teks baru untuk trek, atau keduanya.

Metode ini mendukung upload media. File yang diupload harus mematuhi batasan berikut:

  • Ukuran file maksimum: 100 MB
  • Jenis MIME Media yang diterima: text/xml, application/octet-stream, */*

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

Kasus penggunaan umum

Permintaan

Permintaan HTTP

PUT https://www.googleapis.com/upload/youtube/v3/captions

Otorisasi

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

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

Parameter

Tabel berikut mencantumkan parameter yang didukung kueri ini. Semua parameter yang tercantum adalah parameter kueri.

Parameter
Parameter yang diperlukan
part string
Parameter part memiliki dua tujuan dalam operasi ini. Parameter ini mengidentifikasi properti yang akan ditetapkan oleh operasi tulis serta properti yang akan disertakan dalam respons API. Tetapkan nilai properti ke snippet jika Anda memperbarui status draf trek . Jika tidak, tetapkan nilai properti ke id.

Daftar berikut berisi nama part yang dapat Anda sertakan dalam nilai parameter:
  • id
  • snippet
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. Parameter 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.
sync boolean
Parameter ini tidak digunakan lagi. Catatan: Server API hanya memproses nilai parameter jika permintaan berisi file teks yang diperbarui.

Parameter sync menunjukkan apakah YouTube harus otomatis menyinkronkan file teks dengan trek audio video. Jika Anda menetapkan nilai ke true, YouTube akan otomatis menyinkronkan trek subtitel dengan trek audio.

Isi permintaan

Berikan resource teks dalam isi permintaan. Untuk resource tersebut:

  • Anda harus menentukan nilai untuk properti ini:

    • id

  • Anda dapat menetapkan nilai untuk properti ini:

    • snippet.isDraft

    Jika Anda mengirimkan permintaan pembaruan, dan permintaan Anda tidak menentukan nilai untuk properti yang sudah memiliki nilai, nilai properti yang ada akan dihapus.

Respons

Jika berhasil, metode ini akan menampilkan resource teks dalam isi respons.

Error

Tabel berikut 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
badRequest (400) contentRequired Permintaan tidak mengupload file teks yang diperbarui. Konten trek sebenarnya diperlukan jika parameter sync ditetapkan ke true.
forbidden (403) forbidden Izin yang terkait dengan permintaan tidak cukup untuk memperbarui trek subtitel. Permintaan mungkin tidak diotorisasi dengan benar.
notFound (404) captionNotFound Trek subtitel yang ditentukan tidak dapat ditemukan. Periksa nilai properti id permintaan untuk memastikan nilai tersebut benar.

Cobalah!

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