Contoh berikut menunjukkan cara menggunakan YouTube Data API (v3) untuk menjalankan fungsi yang terkait dengan teks.
Mengambil daftar trek teks untuk video
Untuk mengambil daftar trek teks yang tersedia untuk video tertentu, panggil metode captions.list
. Tetapkan nilai parameter videoId
ke ID video YouTube yang mengidentifikasi video yang teksnya Anda ambil secara unik. Permintaan Anda harus diotorisasi menggunakan OAuth 2.0.
Permintaan di bawah ini mengambil daftar teks untuk video di channel YouTube Google Stories:
https://developers.google.com/apis-explorer/#p/youtube/v3/youtube.captions.list? part=snippet &videoId=PRU2ShMzQRg
Lihat dokumentasi metode captions.list
untuk contoh kode.
Membuat trek teks
Kueri ini tidak dapat diuji menggunakan API Explorer karena API Explorer tidak mendukung kemampuan untuk mengupload file, yang merupakan persyaratan untuk metode ini.
Anda dapat menggunakan metode captions.insert
API untuk mengupload trek teks baru untuk video. Saat mengupload lagu, Anda harus menentukan nilai untuk properti resource caption
berikut:
snippet.videoId
- Ini mengidentifikasi video tempat trek teks ditambahkan.snippet.language
- Bahasa trek teks.snippet.name
- Nama trek teks.
Opsi tambahan berikut tersedia saat mengupload trek teks:
-
Jika Anda menetapkan parameter
sync
ketrue
, 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
ketrue
jika mengupload transkrip yang tidak memiliki kode waktu, atau jika Anda mencurigai kode waktu dalam file Anda salah dan ingin YouTube mencoba memperbaikinya. -
Jika Anda menetapkan properti
snippet.isDraft
resourcecaption
ketrue
, jalur tidak akan terlihat oleh publik.
Lihat dokumentasi metode captions.insert
untuk contoh kode.
Mendownload trek teks
Kueri ini tidak dapat diuji menggunakan API Explorer karena API Explorer tidak mendukung kemampuan untuk mendownload file.
Untuk mendownload trek teks tertentu, panggil metode captions.download
. Tetapkan nilai parameter id
ke ID trek teks YouTube yang secara unik mengidentifikasi trek teks yang Anda download. Permintaan Anda harus diotorisasi menggunakan OAuth 2.0.
API v3 mendukung opsi berikut:
-
Untuk menentukan bahwa trek teks harus ditampilkan dalam format tertentu, tetapkan nilai parameter
tfmt
untuk mengidentifikasi format yang diinginkan. Definisi parameter mencantumkan nilai yang didukung. -
Untuk mengambil terjemahan trek teks, tetapkan nilai parameter
tlang
ke kode bahasa dua huruf ISO 639-1 yang mengidentifikasi bahasa teks yang diinginkan. Terjemahan dibuat menggunakan terjemahan mesin, seperti Google Terjemahan.
Lihat dokumentasi metode captions.download
untuk contoh kode.
Memperbarui trek teks
API ini mendukung kemampuan untuk mengubah status draf trek teks, mengupload trek teks baru untuk file, atau keduanya.
Anda dapat menggunakan API Explorer untuk menguji kemampuan mengubah status draf lagu. Namun, Anda tidak dapat menggunakan API Explorer untuk memperbarui trek teks yang sebenarnya karena alat ini tidak mendukung kemampuan untuk mengupload file.
Permintaan di bawah ini mengambil daftar teks untuk video di channel YouTube Google Stories:
Permintaan ini memperbarui status draf trek teks ke true
, yang berarti trek tidak akan terlihat secara publik. Untuk menyelesaikan permintaan di API Explorer, Anda perlu menetapkan nilai properti id
untuk mengidentifikasi trek teks.
https://developers.google.com/apis-explorer/#p/youtube/v3/youtube.captions.update? part=snippet
Lihat dokumentasi metode captions.update
untuk contoh kode.
Menghapus trek teks
Contoh ini menunjukkan cara menghapus trek teks. Contoh ini memiliki langkah-langkah berikut:
-
Langkah 1: Ambil ID trek teks
Ikuti langkah-langkah di atas untuk mengambil daftar trek teks untuk video. Daftar ini dapat digunakan untuk menampilkan daftar trek teks, menggunakan ID setiap trek sebagai kunci.
-
Langkah 2: Hapus lagu
Panggil metode
captions.delete
untuk menghapus video tertentu. Dalam permintaan, parameterid
menentukan ID trek teks dari trek yang Anda hapus. Permintaan harus diotorisasi menggunakan OAuth 2.0. Jika menguji kueri ini di API Explorer, Anda harus mengganti ID trek teks yang valid untuk nilai parameterid
.https://developers.google.com/apis-explorer/#p/youtube/v3/youtube.captions.delete? id=CAPTION_TRACK_ID