Dengan YouTube Data API, Anda dapat menyertakan fungsi yang biasanya dijalankan di situs YouTube ke dalam situs atau aplikasi Anda sendiri. Bagian berikut 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 berdasarkan jenis resource. Resource mewakili jenis item yang merupakan bagian dari pengalaman YouTube, seperti video, playlist, atau langganan. 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:
-
Setiap permintaan harus menentukan kunci API (dengan parameter
key) atau memberikan token OAuth 2.0. Kunci API Anda tersedia di panel Akses API Konsol Developer untuk project Anda. -
Anda harus mengirim token otorisasi untuk setiap permintaan penyisipan, pembaruan, dan penghapusan. Anda juga harus mengirimkan 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 dapat berisi metadata tambahan saat permintaan diotorisasi. Misalnya, permintaan untuk mengambil video yang diupload pengguna juga dapat berisi video pribadi jika permintaan tersebut diizinkan oleh pengguna tertentu tersebut.
-
API ini mendukung protokol autentikasi OAuth 2.0. Anda dapat memberikan token OAuth 2.0 dengan salah satu cara berikut:
- Gunakan parameter kueri
access_tokenseperti ini:?access_token=oauth2-token - Gunakan header HTTP
Authorizationseperti ini:Authorization: Beareroauth2-token
Petunjuk lengkap untuk menerapkan autentikasi OAuth 2.0 di aplikasi Anda dapat ditemukan dalam panduan autentikasi.
- Gunakan parameter kueri
Jenis resource
Aktivitas
Resource activity berisi informasi tentang tindakan yang telah dilakukan oleh channel atau pengguna tertentu di YouTube. Tindakan yang dilaporkan di feed aktivitas mencakup memberi rating video, membagikan video, menandai video sebagai favorit, mengupload video, dan sebagainya. Setiap resource activity mengidentifikasi jenis tindakan, channel yang terkait dengan tindakan, dan resource yang terkait dengan tindakan, seperti video yang diberi rating atau diupload.
Untuk mengetahui informasi selengkapnya tentang resource ini, lihat representasi resource dan daftar properti-nya.
| Metode | Permintaan HTTP | Deskripsi |
|---|---|---|
URI relatif terhadap https://www.googleapis.com/youtube/v3 |
||
list |
GET /activities |
Menampilkan daftar peristiwa aktivitas channel yang cocok dengan kriteria permintaan. Misalnya, Anda dapat mengambil peristiwa yang terkait dengan channel tertentu atau dengan channel pengguna itu sendiri. |
Teks
Resource caption mewakili trek teks YouTube. Trek teks dikaitkan dengan tepat satu video YouTube.
Untuk mengetahui informasi selengkapnya tentang resource ini, lihat representasi resource dan daftar properti-nya.
| 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. Trek teks ditampilkan dalam format aslinya, kecuali jika permintaan menentukan nilai untuk parameter tfmt dan dalam bahasa aslinya, kecuali jika permintaan menentukan nilai untuk parameter tlang. |
insert |
POST /captions |
Mengupload trek teks. |
list |
GET /captions |
Menampilkan daftar trek teks yang terkait dengan video tertentu. 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. |
ChannelBanners
Resource channelBanner berisi URL yang akan Anda gunakan untuk menetapkan gambar yang baru diupload sebagai gambar banner untuk channel.
Untuk mengetahui informasi selengkapnya tentang resource ini, lihat representasi resource dan daftar properti-nya.
| 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 merepresentasikan dua langkah pertama dalam proses tiga langkah untuk memperbarui gambar banner channel:
|
ChannelSections
Resource channelSection berisi informasi tentang sekumpulan video yang dipilih untuk ditampilkan oleh channel. Misalnya, bagian dapat menampilkan upload terbaru, upload paling populer, atau video dari satu atau beberapa playlist channel.
Bagian channel hanya terlihat jika channel menampilkan konten dalam tampilan penjelajahan (bukan tampilan feed). Agar channel dapat menampilkan konten dalam tampilan penjelajahan, tetapkan properti brandingSettings.channel.showBrowseView ke true untuk channel yang ditentukan.
Channel dapat membuat maksimal 10 galeri.
Untuk mengetahui informasi selengkapnya tentang resource ini, lihat representasi resource dan daftar properti-nya.
| Metode | Permintaan HTTP | Deskripsi |
|---|---|---|
URI relatif terhadap https://www.googleapis.com/youtube/v3 |
||
delete |
DELETE /channelSections |
Menghapus bagian channel. |
insert |
POST /channelSections |
Menambahkan bagian channel ke channel pengguna yang diautentikasi. 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 mengetahui informasi selengkapnya tentang resource ini, lihat representasi resource dan daftar properti-nya.
| Metode | Permintaan HTTP | Deskripsi |
|---|---|---|
URI relatif terhadap https://www.googleapis.com/youtube/v3 |
||
list |
GET /channels |
Menampilkan kumpulan nol atau lebih resource channel yang cocok dengan kriteria permintaan. |
update |
PUT /channels |
Memperbarui metadata saluran. Metode ini hanya mendukung update pada objek brandingSettings dan invideoPromotion resource channel serta properti turunannya. |
CommentThreads
Resource commentThread berisi informasi tentang rangkaian pesan komentar YouTube, yang terdiri dari komentar tingkat teratas dan balasan, jika ada, untuk komentar tersebut. Resource commentThread dapat merepresentasikan komentar tentang video atau channel.
Komentar tingkat teratas dan balasan sebenarnya adalah resource comment yang berada di dalam resource commentThread. Resource commentThread tidak selalu berisi semua balasan untuk komentar, dan Anda perlu menggunakan metode comments.list jika ingin mengambil semua balasan untuk komentar tertentu. Selain itu, beberapa komentar tidak memiliki balasan.
Untuk mengetahui informasi selengkapnya tentang resource ini, lihat representasi resource dan daftar properti-nya.
| Metode | Permintaan HTTP | Deskripsi |
|---|---|---|
URI relatif terhadap https://www.googleapis.com/youtube/v3 |
||
list |
GET /commentThreads |
Menampilkan daftar rangkaian komentar yang cocok dengan parameter permintaan API. |
insert |
POST /commentThreads |
Membuat komentar tingkat teratas baru. Untuk menambahkan balasan ke komentar yang ada, gunakan metode comments.insert. |
Komentar
Resource comment berisi informasi tentang satu komentar YouTube. Resource comment dapat merepresentasikan komentar tentang video atau channel. Selain itu, komentar dapat berupa komentar tingkat teratas atau balasan terhadap komentar tingkat teratas.
Untuk mengetahui informasi selengkapnya tentang resource ini, lihat representasi resource dan daftar properti-nya.
| 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 atau beberapa komentar. Permintaan API harus diotorisasi oleh pemilik channel atau video yang terkait dengan komentar. |
insert |
POST /comments |
Membuat balasan untuk komentar yang ada. Catatan: Untuk membuat komentar tingkat teratas, gunakan metode commentThreads.insert. |
delete |
DELETE /comments |
Menghapus komentar. |
update |
PUT /comments |
Mengubah komentar. |
I18nLanguages
Resource i18nLanguage mengidentifikasi bahasa aplikasi yang didukung 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 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.
Untuk mengetahui informasi selengkapnya tentang resource ini, lihat representasi resource dan daftar properti-nya.
| Metode | Permintaan HTTP | Deskripsi |
|---|---|---|
URI relatif terhadap https://www.googleapis.com/youtube/v3 |
||
list |
GET /i18nLanguages |
Menampilkan daftar bahasa aplikasi yang didukung situs YouTube. |
I18nRegions
Resource i18nRegion mengidentifikasi area geografis yang dapat dipilih pengguna YouTube sebagai wilayah konten pilihan. Wilayah 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 wilayah konten secara manual dari footer situs YouTube.
Setiap resource i18nRegion mengidentifikasi kode dan nama wilayah. Kode wilayah dapat digunakan sebagai nilai parameter regionCode saat memanggil metode API seperti search.list, videos.list, activities.list, dan videoCategories.list.
Untuk mengetahui informasi selengkapnya tentang resource ini, lihat representasi resource dan daftar properti-nya.
| Metode | Permintaan HTTP | Deskripsi |
|---|---|---|
URI relatif terhadap https://www.googleapis.com/youtube/v3 |
||
list |
GET /i18nRegions |
Menampilkan daftar wilayah konten yang didukung situs YouTube. |
Anggota
Resource member merepresentasikan pelanggan channel untuk channel
YouTube. Pelanggan memberikan dukungan finansial berulang kepada kreator dan menerima manfaat khusus. Misalnya, pelanggan dapat melakukan chat saat kreator mengaktifkan mode khusus pelanggan untuk
chat.
Untuk mengetahui informasi selengkapnya tentang resource ini, lihat representasi resource dan daftar properti-nya.
| Metode | Permintaan HTTP | Deskripsi |
|---|---|---|
URI relatif terhadap https://www.googleapis.com/youtube/v3 |
||
list |
GET /members |
Mencantumkan pelanggan (sebelumnya dikenal sebagai "sponsor") untuk suatu channel. Permintaan API harus diizinkan oleh pemilik channel. |
MembershipsLevels
Resource membershipsLevel mengidentifikasi tingkat harga untuk
kreator yang mengizinkan permintaan API.
Untuk mengetahui informasi selengkapnya tentang resource ini, lihat representasi resource dan daftar properti-nya.
| Metode | Permintaan HTTP | Deskripsi |
|---|---|---|
URI relatif terhadap https://www.googleapis.com/youtube/v3 |
||
list |
GET /membershipsLevels |
Menampilkan kumpulan nol atau lebih resource membershipsLevel
yang dimiliki oleh channel yang mengizinkan permintaan API. Tingkat ditampilkan dalam
urutan tampilan implisit. |
PlaylistItems
Resource playlistItem mengidentifikasi resource lain, seperti
video, yang disertakan dalam playlist. Selain itu, resource playlistItem
berisi detail tentang resource yang disertakan yang secara khusus berkaitan dengan cara resource tersebut
digunakan 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. Kemudian, Anda dapat menggunakan
metode playlistItems.list untuk
daftar.
Untuk mengetahui informasi selengkapnya tentang resource ini, lihat representasi resource dan daftar properti-nya.
| Metode | Permintaan HTTP | Deskripsi |
|---|---|---|
URI relatif terhadap https://www.googleapis.com/youtube/v3 |
||
delete |
DELETE /playlistItems |
Menghapus item playlist. |
insert |
POST /playlistItems |
Menambahkan materi ke playlist. |
list |
GET /playlistItems |
Menampilkan kumpulan item playlist yang cocok dengan parameter permintaan API. Anda dapat mengambil semua item playlist dalam playlist tertentu atau mengambil satu atau beberapa item playlist berdasarkan ID uniknya. |
update |
PUT /playlistItems |
Mengubah item playlist. Misalnya, Anda dapat memperbarui posisi item dalam playlist. |
Playlist
Resource playlist mewakili playlist YouTube. Playlist adalah kumpulan video yang dapat ditonton secara berurutan dan dibagikan kepada pengguna lain. Secara default, playlist dapat dilihat secara publik oleh pengguna lain, tetapi playlist dapat disetel ke publik atau pribadi.
YouTube juga menggunakan playlist untuk mengidentifikasi koleksi video khusus untuk suatu channel, seperti:
- video yang diupload
- video yang diberi rating positif (disukai)
- riwayat tontonan
- tonton nanti
Agar lebih spesifik, daftar ini dikaitkan dengan channel, yang merupakan kumpulan video, playlist, dan informasi YouTube lainnya dari seseorang, grup, atau perusahaan. Anda dapat mengambil ID playlist untuk setiap daftar ini dari channel resource untuk channel tertentu.
Kemudian, Anda dapat menggunakan metode playlistItems.list untuk mengambil salah satu daftar tersebut. Anda juga dapat menambahkan atau menghapus item dari daftar tersebut dengan memanggil metode playlistItems.insert dan playlistItems.delete.
Untuk mengetahui informasi selengkapnya tentang resource ini, lihat representasi resource dan daftar properti-nya.
| 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 berdasarkan ID uniknya. |
insert |
POST /playlists |
Membuat playlist. |
update |
PUT /playlists |
Mengubah playlist. Misalnya, Anda dapat mengubah judul, deskripsi, atau status privasi playlist. |
Telusuri
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 diidentifikasi secara unik, seperti video, hasil penelusuran tidak memiliki data persistennya sendiri.
Untuk mengetahui informasi selengkapnya tentang resource ini, lihat representasi resource dan daftar properti-nya.
| 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. |
Langganan
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 pada video, atau mengomentari video.
Untuk mengetahui informasi selengkapnya tentang resource ini, lihat representasi resource dan daftar properti-nya.
| Metode | Permintaan HTTP | Deskripsi |
|---|---|---|
URI relatif terhadap https://www.googleapis.com/youtube/v3 |
||
delete |
DELETE /subscriptions |
Menghapus langganan. |
insert |
POST /subscriptions |
Menambahkan langganan untuk channel pengguna yang diautentikasi. |
list |
GET /subscriptions |
Menampilkan resource langganan yang cocok dengan kriteria permintaan API. |
Thumbnail
Resource thumbnail mengidentifikasi berbagai ukuran gambar thumbnail yang terkait dengan resource. Karakteristik gambar thumbnail berikut:
- Properti
snippet.thumbnailsresource adalah objek yang mengidentifikasi gambar thumbnail yang tersedia untuk resource tersebut. - Resource
thumbnailberisi serangkaian objek. Nama setiap objek (default,medium,high, dll.) mengacu pada ukuran gambar thumbnail. - Berbagai jenis aset dapat mendukung ukuran gambar thumbnail yang berbeda.
- Berbagai jenis resource dapat menentukan ukuran yang berbeda untuk gambar thumbnail dengan nama yang sama. Misalnya, gambar thumbnail
defaultuntuk asetvideobiasanya berukuran 120 px x 90 px, dan gambar thumbnaildefaultuntuk asetchannelbiasanya berukuran 88 px x 88 px. - Resource dengan jenis yang sama mungkin masih memiliki ukuran gambar thumbnail yang berbeda untuk gambar tertentu, bergantung pada resolusi gambar atau konten asli yang diupload ke YouTube. Misalnya, video HD dapat mendukung thumbnail beresolusi lebih tinggi daripada video non-HD.
- Setiap objek yang berisi informasi tentang ukuran gambar thumbnail memiliki properti
widthdan propertiheight. Namun, properti lebar dan tinggi mungkin tidak ditampilkan untuk gambar tersebut. - Jika gambar thumbnail yang diupload tidak sesuai dengan dimensi yang diperlukan, ukuran gambar akan diubah agar sesuai dengan ukuran yang benar tanpa mengubah rasio aspeknya. Gambar tidak dipangkas, tetapi dapat menyertakan batang hitam agar ukurannya benar.
Untuk mengetahui informasi selengkapnya tentang resource ini, lihat representasi resource dan daftar properti-nya.
| 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. |
VideoAbuseReportReasons
Resource videoAbuseReportReason berisi informasi tentang alasan video ditandai karena berisi konten yang menyinggung. Saat aplikasi Anda memanggil metode videos.reportAbuse untuk melaporkan video yang melanggar, permintaan menggunakan informasi dari resource videoAbuseReportReason untuk mengidentifikasi alasan video dilaporkan.
Untuk mengetahui informasi selengkapnya tentang resource ini, lihat representasi resource dan daftar properti-nya.
| 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. |
VideoCategories
Resource videoCategory mengidentifikasi kategori yang telah atau dapat dikaitkan dengan video yang diupload.
Untuk mengetahui informasi selengkapnya tentang resource ini, lihat representasi resource dan daftar properti-nya.
| 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 mengetahui informasi selengkapnya tentang resource ini, lihat representasi resource dan daftar properti-nya.
| Metode | Permintaan HTTP | Deskripsi |
|---|---|---|
URI relatif terhadap https://www.googleapis.com/youtube/v3 |
||
insert |
POST /videos |
Mengupload video ke YouTube dan secara opsional 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 |
Menambahkan rating suka atau tidak suka ke video atau menghapus rating dari video. |
getRating |
GET /videos/getRating |
Mengambil rating yang diberikan pengguna yang berwenang ke daftar video tertentu. |
reportAbuse |
POST /videos/reportAbuse |
Laporkan video karena berisi konten yang menghina. |
Watermark
Resource watermark mengidentifikasi gambar yang ditampilkan selama pemutaran video channel tertentu. Anda juga dapat menentukan channel target yang akan ditautkan ke gambar serta detail waktu yang menentukan kapan tanda air muncul selama pemutaran video dan berapa lama tanda air tersebut terlihat.
Untuk mengetahui informasi selengkapnya tentang resource ini, lihat representasi resource dan daftar properti-nya.
| 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. |