API Reference

Dengan YouTube Data API, Anda dapat memasukkan fungsi yang biasanya dieksekusi di situs YouTube ke dalam situs atau aplikasi Anda sendiri. Daftar di bawah ini mengidentifikasi berbagai jenis resource yang dapat Anda ambil menggunakan API. API juga mendukung metode untuk menyisipkan, memperbarui, atau menghapus banyak resource ini.

Panduan referensi ini menjelaskan cara menggunakan API untuk melakukan semua operasi ini. Panduan ini disusun menurut jenis resource. Resource merepresentasikan jenis item yang merupakan bagian dari pengalaman YouTube, seperti video, playlist, atau subscription. Untuk setiap jenis resource, panduan ini mencantumkan satu atau beberapa representasi data, dan resource direpresentasikan sebagai objek JSON. Panduan ini juga mencantumkan satu atau beberapa metode yang didukung (LIST, POST, DELETE, dll.) untuk setiap jenis resource dan menjelaskan cara menggunakan metode tersebut di aplikasi Anda.

Memanggil API

Persyaratan berikut berlaku untuk permintaan YouTube Data API:

  1. Setiap permintaan harus menentukan kunci API (dengan parameter key) atau memberikan token OAuth 2.0. Kunci API Anda tersedia di panel API Access Developer Console untuk project Anda.

  2. Anda harus mengirim token otorisasi untuk setiap permintaan penyisipan, pembaruan, dan penghapusan. Anda juga harus mengirim token otorisasi untuk setiap permintaan yang mengambil data pribadi pengguna terautentikasi.

    Selain itu, beberapa metode API untuk mengambil resource dapat mendukung parameter yang memerlukan otorisasi atau mungkin berisi metadata tambahan bila permintaan diotorisasi. Misalnya, permintaan untuk mengambil video yang diupload pengguna juga dapat berisi video pribadi jika permintaan tersebut diotorisasi oleh pengguna tertentu tersebut.

  3. API tersebut mendukung protokol autentikasi OAuth 2.0. Anda dapat memberikan token OAuth 2.0 dengan salah satu cara berikut:

    • Gunakan parameter kueri access_token seperti ini: ?access_token=oauth2-token
    • Gunakan header Authorization HTTP seperti ini: Authorization: Bearer oauth2-token

    Petunjuk lengkap untuk menerapkan autentikasi OAuth 2.0 di aplikasi Anda dapat ditemukan dalam panduan autentikasi.

Jenis resource

Aktivitas

Resource activity berisi informasi tentang tindakan yang dilakukan channel atau pengguna tertentu di YouTube. Tindakan yang dilaporkan di feed aktivitas termasuk memberi rating video, membagikan video, menandai video sebagai favorit, mengupload video, dan sebagainya. Setiap resource activity mengidentifikasi jenis tindakan, saluran yang terkait dengan tindakan, dan resource yang terkait dengan tindakan, seperti video yang diberi rating atau diupload.

Untuk informasi selengkapnya tentang resource ini, lihat representasi resource dan daftar properti.

Metode Permintaan HTTP Deskripsi
URI relatif terhadap https://www.googleapis.com/youtube/v3
list GET /activities Menampilkan daftar peristiwa aktivitas saluran yang cocok dengan kriteria permintaan. Misalnya, Anda dapat mengambil peristiwa yang terkait dengan saluran tertentu atau dengan saluran pengguna itu sendiri.
insert POST /activities Catatan: Metode ini tidak digunakan lagi dan tidak lagi didukung.

Teks

Resource caption mewakili trek teks YouTube. Trek teks hanya terkait dengan satu video YouTube.

Untuk informasi selengkapnya tentang resource ini, lihat representasi resource dan daftar properti.

Metode Permintaan HTTP Deskripsi
URI relatif terhadap https://www.googleapis.com/youtube/v3
delete DELETE /captions Menghapus trek teks yang ditentukan.
download GET /captions/id Mendownload trek teks. Jalur teks ditampilkan dalam format aslinya kecuali jika permintaan menentukan nilai untuk parameter tfmt dan dalam bahasa aslinya kecuali jika permintaan tersebut menentukan nilai untuk parameter tlang.
insert POST /captions Mengupload trek teks.
list GET /captions Menampilkan daftar trek teks yang terkait dengan video yang ditentukan. Perhatikan bahwa respons API tidak berisi teks sebenarnya dan metode captions.download memberikan kemampuan untuk mengambil trek teks.
update PUT /captions Memperbarui trek teks. Saat memperbarui trek teks, Anda dapat mengubah status draf trek, mengupload file teks baru untuk trek, atau keduanya.

BannerBanner

Resource channelBanner berisi URL yang akan Anda gunakan untuk menyetel gambar yang baru diupload sebagai gambar banner untuk saluran.

Untuk informasi selengkapnya tentang resource ini, lihat representasi resource dan daftar properti.

Metode Permintaan HTTP Deskripsi
URI relatif terhadap https://www.googleapis.com/youtube/v3
insert POST /channelBanners/insert Mengupload gambar banner channel ke YouTube. Metode ini mewakili dua langkah pertama dalam proses tiga langkah untuk memperbarui gambar banner untuk channel:

  1. Panggil metode channelBanners.insert untuk mengupload data gambar biner ke YouTube. Gambar harus memiliki rasio lebar tinggi 16:9 dan berukuran minimal 2048x1152 piksel. Sebaiknya upload gambar berukuran 2560 x 1440 piksel.
  2. Ekstrak nilai properti url dari respons yang ditampilkan API untuk langkah 1.
  3. Panggil metode channels.update untuk memperbarui setelan branding channel. Tetapkan nilai properti brandingSettings.image.bannerExternalUrl ke URL yang diperoleh di langkah 2.

Bagian Channel

Resource channelSection berisi informasi tentang sekumpulan video yang telah dipilih oleh channel untuk ditampilkan. Misalnya, suatu bagian dapat menampilkan upload terbaru channel, upload terpopuler, atau video dari satu atau beberapa playlist.

Perhatikan bahwa bagian channel hanya terlihat jika channel tersebut menampilkan konten dalam tampilan jelajah (bukan tampilan feed). Agar channel dapat menampilkan konten dalam tampilan jelajah, tetapkan properti brandingSettings.channel.showBrowseView ke true untuk saluran yang ditentukan.

Saluran dapat membuat maksimum 10 galeri.

Untuk informasi selengkapnya tentang resource ini, lihat representasi resource dan daftar properti.

Metode Permintaan HTTP Deskripsi
URI relatif terhadap https://www.googleapis.com/youtube/v3
delete DELETE /channelSections Menghapus bagian channel.
insert POST /channelSections Menambahkan bagian saluran ke saluran pengguna terautentikasi. Channel dapat membuat maksimal 10 galeri.
list GET /channelSections Menampilkan daftar resource channelSection yang cocok dengan kriteria permintaan API.
update PUT /channelSections Memperbarui bagian channel.

Channel

Resource channel berisi informasi tentang channel YouTube.

Untuk informasi selengkapnya tentang resource ini, lihat representasi resource dan daftar properti.

Metode Permintaan HTTP Deskripsi
URI relatif terhadap https://www.googleapis.com/youtube/v3
list GET /channels Menampilkan kumpulan nol resource channel atau lebih yang cocok dengan kriteria permintaan.
update PUT /channels Memperbarui metadata channel. Perhatikan bahwa metode ini saat ini hanya mendukung pembaruan untuk objek brandingSettings dan invideoPromotion resource channel serta properti turunannya.

Rangkaian Komentar

Resource commentThread berisi informasi tentang rangkaian komentar YouTube, yang terdiri atas komentar dan balasan tingkat atas, jika ada, terhadap komentar tersebut. Resource commentThread dapat mewakili komentar tentang video atau channel.

Baik komentar tingkat atas maupun balasan sebenarnya adalah resource comment yang bertingkat di dalam resource commentThread. Resource commentThread tidak selalu berisi semua balasan untuk komentar, dan Anda harus menggunakan metode comments.list jika ingin mengambil semua balasan untuk komentar tertentu. Perhatikan juga bahwa beberapa komentar tidak memiliki balasan.

Untuk informasi selengkapnya tentang resource ini, lihat representasi resource dan daftar properti.

Metode Permintaan HTTP Deskripsi
URI relatif terhadap https://www.googleapis.com/youtube/v3
list GET /commentThreads Menampilkan daftar thread komentar yang cocok dengan parameter permintaan API.
insert POST /commentThreads Membuat komentar tingkat teratas baru. Untuk menambahkan balasan ke komentar yang sudah ada, gunakan metode comments.insert sebagai gantinya.

Komentar

Resource comment berisi informasi tentang satu komentar YouTube. Resource comment dapat mewakili komentar tentang video atau channel. Selain itu, komentar dapat berupa komentar tingkat teratas atau balasan untuk komentar tingkat atas.

Untuk informasi selengkapnya tentang resource ini, lihat representasi resource dan daftar properti.

Metode Permintaan HTTP Deskripsi
URI relatif terhadap https://www.googleapis.com/youtube/v3
list GET /comments Menampilkan daftar komentar yang cocok dengan parameter permintaan API.
setModerationStatus POST /comments/setModerationStatus Menetapkan status moderasi satu komentar atau lebih. Permintaan API harus diotorisasi oleh pemilik channel atau video yang terkait dengan komentar tersebut.
insert POST /comments Membuat balasan untuk komentar yang sudah ada. Catatan: Untuk membuat komentar tingkat atas, gunakan metode commentThreads.insert.
markAsSpam POST /comments/markAsSpam Menyatakan pendapat penelepon bahwa satu atau beberapa komentar harus ditandai sebagai spam.
delete DELETE /comments Menghapus komentar.
update PUT /comments Mengubah komentar.

Kategori Pemandu

Resource guideCategory mengidentifikasi kategori yang ditetapkan secara algoritme oleh YouTube berdasarkan konten channel atau indikator lainnya, seperti popularitas channel. Daftar ini mirip dengan kategori video, perbedaannya adalah uploader video dapat menetapkan kategori video, tetapi hanya YouTube yang dapat menetapkan kategori channel.

Untuk informasi selengkapnya tentang resource ini, lihat representasi resource dan daftar properti.

Metode Permintaan HTTP Deskripsi
URI relatif terhadap https://www.googleapis.com/youtube/v3
list GET /guideCategories Menampilkan daftar kategori yang dapat dikaitkan dengan channel YouTube.

I18nBahasa

Resource i18nLanguage mengidentifikasi bahasa aplikasi yang didukung oleh situs YouTube. Bahasa aplikasi juga dapat disebut sebagai bahasa UI. Untuk situs YouTube, bahasa aplikasi dapat dipilih secara otomatis berdasarkan setelan Akun Google, bahasa browser, atau lokasi IP. Pengguna juga dapat memilih bahasa UI yang diinginkan secara manual dari footer situs YouTube.

Setiap resource i18nLanguage mengidentifikasi kode dan nama bahasa. Kode bahasa dapat digunakan sebagai nilai parameter hl saat memanggil metode API seperti videoCategories.list dan guideCategories.list.

Untuk informasi selengkapnya tentang resource ini, lihat representasi resource dan daftar properti.

Metode Permintaan HTTP Deskripsi
URI relatif terhadap https://www.googleapis.com/youtube/v3
list GET /i18nLanguages Menampilkan daftar bahasa aplikasi yang didukung oleh situs YouTube.

Wilayah I18n

Resource i18nRegion mengidentifikasi area geografis yang dapat dipilih pengguna YouTube sebagai region konten pilihan. Region konten juga dapat disebut sebagai lokalitas konten. Untuk situs YouTube, wilayah konten dapat dipilih secara otomatis berdasarkan heuristik seperti domain YouTube atau lokasi IP pengguna. Pengguna juga dapat memilih region konten yang diinginkan secara manual dari footer situs YouTube.

Setiap resource i18nRegion mengidentifikasi kode wilayah dan nama. Kode wilayah dapat digunakan sebagai nilai parameter regionCode saat memanggil metode API seperti search.list, videos.list, activities.list, dan videoCategories.list.

Untuk informasi selengkapnya tentang resource ini, lihat representasi resource dan daftar properti.

Metode Permintaan HTTP Deskripsi
URI relatif terhadap https://www.googleapis.com/youtube/v3
list GET /i18nRegions Menampilkan daftar region konten yang didukung oleh situs YouTube.

Pelanggan

Resource member mewakili anggota channel untuk sebuah channel YouTube. Seorang anggota memberikan dukungan uang berulang kepada kreator dan menerima manfaat khusus. Misalnya, pelanggan dapat melakukan chat saat kreator mengaktifkan mode khusus pelanggan untuk chat.

Untuk informasi selengkapnya tentang resource ini, lihat representasi resource dan daftar properti.

Metode Permintaan HTTP Deskripsi
URI relatif terhadap https://www.googleapis.com/youtube/v3
list GET /members Mencantumkan pelanggan (sebelumnya dikenal sebagai "sponsor") untuk channel. Permintaan API harus diotorisasi oleh pemilik saluran.

Level Langganan

Resource membershipsLevel mengidentifikasi tingkat harga untuk kreator yang mengizinkan permintaan API.

Untuk informasi selengkapnya tentang resource ini, lihat representasi resource dan daftar properti.

Metode Permintaan HTTP Deskripsi
URI relatif terhadap https://www.googleapis.com/youtube/v3
list GET /membershipsLevels Menampilkan kumpulan nol resource membershipsLevel atau lebih yang dimiliki oleh saluran yang mengizinkan permintaan API. Level ditampilkan dalam urutan tampilan implisit.

ItemItem Playlist

Resource playlistItem mengidentifikasi resource lain, seperti video, yang disertakan dalam playlist. Selain itu, resource playlistItem berisi detail tentang resource yang disertakan yang secara spesifik berkaitan dengan penggunaan resource tersebut dalam playlist tersebut.

YouTube juga menggunakan playlist untuk mengidentifikasi daftar video yang diupload channel, dengan setiap playlistItem dalam daftar tersebut mewakili satu video yang diupload. Anda dapat mengambil ID playlist untuk daftar tersebut dari channel resource untuk saluran tertentu. Lalu, Anda dapat menggunakan metode playlistItems.list ke daftar.

Untuk informasi selengkapnya tentang resource ini, lihat representasi resource dan daftar properti.

Metode Permintaan HTTP Deskripsi
URI relatif terhadap https://www.googleapis.com/youtube/v3
delete DELETE /playlistItems Menghapus item playlist.
insert POST /playlistItems Menambahkan resource ke playlist.
list GET /playlistItems Menampilkan kumpulan item playlist yang cocok dengan parameter permintaan API. Anda dapat mengambil semua item playlist dalam playlist yang ditentukan atau mengambil satu atau beberapa item playlist berdasarkan ID uniknya.
update PUT /playlistItems Memodifikasi item playlist. Misalnya, Anda dapat memperbarui posisi item di playlist.

Playlist

Resource playlist mewakili playlist YouTube. Playlist adalah kumpulan video yang dapat ditonton secara berurutan dan dibagikan kepada pengguna lain. Playlist dapat berisi hingga 200 video, dan YouTube tidak membatasi jumlah playlist yang dibuat oleh setiap pengguna. Secara default, playlist dapat dilihat oleh pengguna lain, tetapi playlist dapat disetel untuk publik atau pribadi.

YouTube juga menggunakan playlist untuk mengidentifikasi koleksi video khusus untuk channel, seperti:

  • video yang diupload
  • video dengan rating positif (disukai)
  • riwayat tontonan
  • tonton nanti
Untuk lebih spesifiknya, daftar ini terkait dengan channel, yang merupakan kumpulan video orang, grup, atau perusahaan, playlist, dan informasi YouTube lainnya. Anda dapat mengambil ID playlist untuk setiap daftar ini dari channel resource untuk saluran tertentu.

Anda kemudian dapat menggunakan metode playlistItems.list untuk mengambil salah satu dari daftar tersebut. Anda juga dapat menambahkan atau menghapus item dari daftar tersebut dengan memanggil metode playlistItems.insert dan playlistItems.delete.

Untuk informasi selengkapnya tentang resource ini, lihat representasi resource dan daftar properti.

Metode Permintaan HTTP Deskripsi
URI relatif terhadap https://www.googleapis.com/youtube/v3
delete DELETE /playlists Menghapus playlist.
list GET /playlists Menampilkan kumpulan playlist yang cocok dengan parameter permintaan API. Misalnya, Anda dapat mengambil semua playlist yang dimiliki pengguna terautentikasi, atau Anda dapat mengambil satu atau beberapa playlist menurut ID uniknya.
insert POST /playlists Membuat playlist.
update PUT /playlists Mengubah playlist. Misalnya, Anda dapat mengubah judul, deskripsi, atau status privasi playlist.

Hasil penelusuran berisi informasi tentang video, channel, atau playlist YouTube yang cocok dengan parameter penelusuran yang ditentukan dalam permintaan API. Meskipun hasil penelusuran mengarah ke resource yang dapat dikenali secara unik, seperti video, resource tersebut tidak memiliki data persisten sendiri.

Untuk informasi selengkapnya tentang resource ini, lihat representasi resource dan daftar properti.

Metode Permintaan HTTP Deskripsi
URI relatif terhadap https://www.googleapis.com/youtube/v3
list GET /search Menampilkan kumpulan hasil penelusuran yang cocok dengan parameter kueri yang ditentukan dalam permintaan API. Secara default, kumpulan hasil penelusuran mengidentifikasi resource video, channel, dan playlist yang cocok, tetapi Anda juga dapat mengonfigurasi kueri untuk hanya mengambil jenis resource tertentu.

Subscription

Resource subscription berisi informasi tentang langganan pengguna YouTube. Langganan memberi tahu pengguna saat video baru ditambahkan ke channel atau saat pengguna lain melakukan salah satu dari beberapa tindakan di YouTube, seperti mengupload video, memberi rating video, atau mengomentari video.

Untuk informasi selengkapnya tentang resource ini, lihat representasi resource dan daftar properti.

Metode Permintaan HTTP Deskripsi
URI relatif terhadap https://www.googleapis.com/youtube/v3
delete DELETE /subscriptions Menghapus langganan.
insert POST /subscriptions Menambahkan langganan untuk saluran pengguna terautentikasi.
list GET /subscriptions Menampilkan resource langganan yang cocok dengan kriteria permintaan API.

Thumbnail

Resource thumbnail mengidentifikasi berbagai ukuran gambar thumbnail yang terkait dengan satu resource. Harap perhatikan karakteristik gambar thumbnail berikut:

  • Properti snippet.thumbnails resource adalah objek yang mengidentifikasi gambar thumbnail yang tersedia untuk resource tersebut.
  • Resource thumbnail berisi serangkaian objek. Nama setiap objek (default, medium, high, dll.) merujuk pada ukuran gambar thumbnail.
  • Berbagai jenis resource mungkin mendukung ukuran gambar thumbnail yang berbeda-beda.
  • Berbagai jenis resource dapat mendefinisikan ukuran yang berbeda untuk gambar thumbnail dengan nama yang sama. Misalnya, gambar thumbnail default untuk resource video biasanya berukuran 120 x 90 piksel, dan gambar thumbnail default untuk resource channel biasanya berukuran 88 x 88 piksel.
  • Resource dari jenis yang sama mungkin masih memiliki ukuran gambar thumbnail yang berbeda untuk gambar tertentu, bergantung pada resolusi gambar asli atau konten yang diupload ke YouTube. Misalnya, video HD dapat mendukung thumbnail dengan resolusi yang lebih tinggi daripada video non-HD.
  • Setiap objek yang berisi informasi tentang ukuran gambar thumbnail memiliki properti width dan properti height. Namun, properti lebar dan tinggi mungkin tidak dikembalikan untuk gambar tersebut.
  • Jika gambar thumbnail yang diupload tidak sesuai dengan dimensi yang diperlukan, gambar akan diubah ukurannya agar sesuai dengan ukuran yang tepat tanpa mengubah rasio lebar tingginya. Gambar tidak dipangkas, tetapi dapat menyertakan batang hitam sehingga ukurannya benar.

Untuk informasi selengkapnya tentang resource ini, lihat representasi resource dan daftar properti.

Metode Permintaan HTTP Deskripsi
URI relatif terhadap https://www.googleapis.com/youtube/v3
set POST /thumbnails/set Mengupload thumbnail video kustom ke YouTube dan menyetelnya untuk video.

Alasan VideoAbuseReport

Resource videoAbuseReportReason berisi informasi tentang alasan video ditandai karena berisi konten yang melanggar. Saat aplikasi Anda memanggil metode videos.reportAbuse untuk melaporkan video yang melanggar, permintaan tersebut menggunakan informasi dari resource videoAbuseReportReason untuk mengidentifikasi alasan video dilaporkan.

Untuk informasi selengkapnya tentang resource ini, lihat representasi resource dan daftar properti.

Metode Permintaan HTTP Deskripsi
URI relatif terhadap https://www.googleapis.com/youtube/v3
list GET /videoAbuseReportReasons Mengambil daftar alasan yang dapat digunakan untuk melaporkan video yang melanggar.

Kategori Video

Resource videoCategory mengidentifikasi kategori yang telah atau dapat dikaitkan dengan video yang diupload.

Untuk informasi selengkapnya tentang resource ini, lihat representasi resource dan daftar properti.

Metode Permintaan HTTP Deskripsi
URI relatif terhadap https://www.googleapis.com/youtube/v3
list GET /videoCategories Menampilkan daftar kategori yang dapat dikaitkan dengan video YouTube.

Video

Resource video mewakili video YouTube.

Untuk informasi selengkapnya tentang resource ini, lihat representasi resource dan daftar properti.

Metode Permintaan HTTP Deskripsi
URI relatif terhadap https://www.googleapis.com/youtube/v3
insert POST /videos Mengupload video ke YouTube dan, jika ingin, menetapkan metadata video.
list GET /videos Menampilkan daftar video yang cocok dengan parameter permintaan API.
delete DELETE /videos Menghapus video YouTube.
update PUT /videos Memperbarui metadata video.
rate POST /videos/rate Tambahkan rating suka atau tidak suka ke video atau hapus rating dari video.
getRating GET /videos/getRating Mengambil rating yang diberikan oleh pengguna resmi ke daftar video yang ditentukan.
reportAbuse POST /videos/reportAbuse Melaporkan video karena berisi konten yang melanggar.

Watermark

Resource watermark mengidentifikasi gambar yang ditampilkan selama pemutaran video channel tertentu. Anda juga dapat menentukan saluran target yang akan ditautkan ke gambar serta detail pengaturan waktu yang menentukan kapan watermark muncul selama pemutaran video dan durasi tampilannya.

Untuk informasi selengkapnya tentang resource ini, lihat representasi resource dan daftar properti.

Metode Permintaan HTTP Deskripsi
URI relatif terhadap https://www.googleapis.com/youtube/v3
set POST /watermarks/set Mengupload gambar watermark ke YouTube dan menyetelnya untuk channel.
unset POST /watermarks/unset Menghapus gambar watermark channel.