Captions: list

Menampilkan daftar trek subtitel yang terkait dengan video yang ditentukan. Perhatikan bahwa respons API tidak berisi teks yang sebenarnya dan metode captions.download memberikan kemampuan untuk mengambil trek subtitel.

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

Kasus penggunaan umum

Permintaan

Permintaan HTTP

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

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 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.

Daftar di bawah berisi nama part yang dapat Anda sertakan dalam nilai parameter:
  • id
  • snippet
videoId string
Parameter videoId menentukan ID video YouTube yang trek subtitelnya harus ditampilkan oleh API.
Parameter opsional
id string
Parameter id menentukan daftar ID yang dipisahkan koma yang mengidentifikasi resource caption yang harus diambil. Setiap ID harus mengidentifikasi trek subtitel yang terkait dengan video yang ditentukan.
onBehalfOfContentOwner string
Parameter ini hanya dapat digunakan dalam permintaan yang diberi otorisasi dengan benar. Catatan: Parameter ini ditujukan khusus untuk partner konten YouTube.

Parameter onBehalfOfContentOwner menunjukkan bahwa kredensial otorisasi permintaan mengidentifikasi pengguna YouTube CMS yang bertindak atas nama pemilik konten yang ditentukan dalam parameter value. Parameter ini ditujukan untuk partner konten YouTube yang memiliki dan mengelola banyak channel YouTube yang berbeda. Dengan fitur ini, pemilik konten dapat melakukan autentikasi sekali 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.

Isi permintaan

Jangan berikan isi permintaan saat memanggil metode ini.

Respons

Jika berhasil, metode ini akan menampilkan isi respons dengan struktur berikut:

{
  "kind": "youtube#captionListResponse",
  "etag": etag,
  "items": [
    caption Resource
  ]
}

Properti

Tabel berikut menentukan properti yang muncul di resource ini:

Properti
kind string
Mengidentifikasi jenis resource API. Nilainya akan menjadi youtube#captionListResponse.
etag etag
Etag resource ini.
items[] list
Daftar teks yang cocok dengan kriteria permintaan.

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
forbidden (403) forbidden Satu atau beberapa trek subtitel tidak dapat diambil karena izin yang terkait dengan permintaan tidak memadai untuk mengambil resource yang diminta. Permintaan mungkin tidak diizinkan dengan benar.
notFound (404) captionNotFound Satu atau beberapa trek subtitel yang ditentukan tidak dapat ditemukan. Error ini terjadi jika parameter videoId mengidentifikasi video yang sebenarnya, tetapi parameter id mengidentifikasi ID trek teks yang tidak ada atau ID trek yang terkait dengan video lain. Periksa nilai parameter id dan videoId permintaan untuk memastikan bahwa nilai tersebut sudah benar.
notFound (404) videoNotFound Video yang diidentifikasi oleh parameter videoId tidak dapat ditemukan.

Cobalah!

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