Captions: insert

Mengupload trek teks.

Metode ini mendukung upload media. File yang diupload harus sesuai dengan 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 400 unit.

Kasus penggunaan umum

Permintaan

Permintaan HTTP

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

Otorisasi

Permintaan ini memerlukan otorisasi dengan setidaknya salah satu cakupan berikut. Untuk membaca selengkapnya tentang autentikasi dan otorisasi, lihat Menerapkan otorisasi OAuth 2.0.

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 menentukan bagian resource caption yang akan disertakan dalam respons API. Tetapkan nilai parameter ke snippet.

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. 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.
sync boolean
Parameter ini tidak digunakan lagi. Parameter sync menunjukkan apakah YouTube harus menyinkronkan file teks secara otomatis dengan trek audio video. Jika Anda menetapkan nilai ke true, YouTube akan mengabaikan kode waktu apa pun yang ada dalam file teks yang diupload dan membuat kode waktu baru untuk teks.

Anda harus menetapkan parameter sync ke true jika mengupload transkrip, yang tidak memiliki kode waktu, atau jika Anda mencurigai kode waktu dalam file Anda salah dan ingin YouTube mencoba memperbaikinya.

Isi permintaan

Berikan resource caption dalam isi permintaan. Untuk resource tersebut:

Anda harus menentukan nilai untuk properti ini:

  • snippet.videoId
  • snippet.language
  • snippet.name

Anda dapat menetapkan nilai untuk properti berikut:

  • snippet.videoId
  • snippet.language
  • snippet.name
  • snippet.isDraft

Respons

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

Error

Tabel berikut mengidentifikasi pesan error yang dapat ditampilkan API sebagai respons terhadap panggilan ke metode ini. Untuk mengetahui detail selengkapnya, lihat YouTube Data API - Error.

Jenis error Detail error Deskripsi
badRequest (400) contentRequired Permintaan tidak berisi konten trek teks.
conflict (409) captionExists Video yang ditentukan sudah memiliki trek teks dengan snippet.language dan snippet.name yang diberikan. Video dapat memiliki beberapa trek untuk bahasa yang sama, tetapi setiap trek harus memiliki nama yang berbeda.

Ada beberapa cara untuk mengatasi error ini. Anda dapat menghapus trek yang ada, lalu menyisipkan trek baru atau mengubah nama trek baru sebelum menyisipkannya.
forbidden (403) forbidden Izin yang terkait dengan permintaan tidak memadai untuk mengupload trek teks. Permintaan mungkin tidak diotorisasi dengan benar.
invalidValue (400) invalidMetadata Permintaan berisi nilai metadata yang tidak valid, sehingga trek tidak dapat dibuat. Pastikan permintaan menentukan nilai yang valid untuk properti snippet.language, snippet.name, dan snippet.videoId. Properti snippet.isDraft juga dapat disertakan, tetapi tidak diwajibkan.
notFound (404) videoNotFound Video yang diidentifikasi oleh parameter videoId tidak dapat ditemukan.
invalidValue (400) nameTooLong snippet.name yang ditentukan dalam permintaan terlalu panjang. Panjang maksimum yang didukung adalah 150 karakter.

Cobalah!

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