Referensi API

Referensi API ini menjelaskan cara menjadwalkan siaran live dan streaming video di YouTube menggunakan YouTube Live Streaming API.

Jenis resource

LiveBroadcasts

Resource liveBroadcast merepresentasikan acara yang akan di-streaming, melalui video live, di 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
bind POST /liveBroadcasts/bind Mengikat siaran YouTube ke streaming atau menghapus pengikatan yang ada antara siaran dan streaming. Siaran hanya dapat terikat ke satu streaming video, meskipun streaming video dapat terikat ke lebih dari satu siaran.
delete DELETE /liveBroadcasts Menghapus siaran.
insert POST /liveBroadcasts Membuat siaran.
list GET /liveBroadcasts Menampilkan daftar siaran YouTube yang cocok dengan parameter permintaan API.
transition POST /liveBroadcasts/transition Mengubah status siaran live YouTube dan memulai proses apa pun yang terkait dengan status baru. Misalnya, saat Anda mengubah status siaran menjadi testing, YouTube akan mulai mengirimkan video ke streaming monitor siaran tersebut. Sebelum memanggil metode ini, Anda harus mengonfirmasi bahwa nilai properti status.streamStatus untuk streaming yang terikat ke siaran Anda adalah active.
update PUT /liveBroadcasts Memperbarui siaran. Misalnya, Anda dapat mengubah setelan siaran yang ditentukan dalam objek contentDetails resource liveBroadcast.
cuepoint POST /liveBroadcasts/cuepoint Menyisipkan titik cuplikan ke siaran langsung. Cuepoint dapat memicu jeda iklan.

LiveChatBans

Resource liveChatBan mengidentifikasi pengguna YouTube dan live chat YouTube yang melarang pengguna tersebut berpartisipasi.

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 /liveChat/bans Menghapus larangan yang mencegah pengguna tertentu berkontribusi dalam live chat, sehingga memungkinkan pengguna tersebut bergabung kembali ke chat. Permintaan API harus diizinkan oleh pemilik channel atau moderator chat live yang terkait dengan larangan.
insert POST /liveChat/bans Melarang pengguna tertentu berpartisipasi dalam live chat. Permintaan API harus diizinkan oleh pemilik channel atau moderator chat live yang terkait dengan larangan.

LiveChatMessages

Resource liveChatMessage mewakili pesan chat di live chat YouTube. Resource dapat berisi detail tentang beberapa jenis pesan, termasuk pesan teks yang baru diposting atau acara pendanaan penggemar.

Fitur live chat diaktifkan secara default untuk siaran live dan tersedia saat acara live aktif. (Setelah acara berakhir, live chat tidak lagi tersedia untuk acara tersebut.)

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 /liveChat/messages Menghapus pesan chat. Permintaan API harus diizinkan oleh pemilik channel atau moderator chat live yang terkait dengan larangan.
insert POST /liveChat/messages Menambahkan pesan ke live chat.
list GET /liveChat/messages Mencantumkan pesan live chat untuk chat tertentu.
streamList Demo Kode Mengaktifkan koneksi streaming server untuk menerima pesan live chat untuk chat tertentu dengan latensi rendah.

LiveChatModerators

Resource liveChatModerator mewakili moderator untuk live chat YouTube. Moderator chat memiliki kemampuan untuk memblokir atau membatalkan pemblokiran pengguna dari chat, menghapus pesan, dan melakukan tindakan administratif lainnya untuk live 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
delete DELETE /liveChat/moderators Menghapus moderator chat. Permintaan harus disahkan oleh pemilik channel siaran live.
insert POST /liveChat/moderators Menambahkan moderator baru untuk chat. Permintaan harus disahkan oleh pemilik channel siaran live.
list GET /liveChat/moderators Mencantumkan moderator untuk live chat. Permintaan harus disahkan oleh pemilik channel siaran live.

LiveStreams

Resource liveStream berisi informasi tentang streaming video yang Anda kirimkan ke YouTube. Streaming menyediakan konten yang akan disiarkan kepada pengguna YouTube. Setelah dibuat, resource liveStream dapat terikat ke satu atau beberapa resource liveBroadcast.

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 /liveStreams Menghapus streaming video.
insert POST /liveStreams Membuat streaming video. Streaming memungkinkan Anda mengirim video ke YouTube, yang kemudian dapat menyiarkan video tersebut kepada audiens Anda.
list GET /liveStreams Menampilkan daftar streaming video yang cocok dengan parameter permintaan API.
update PUT /liveStreams Memperbarui streaming video. Jika properti yang ingin Anda ubah tidak dapat diperbarui, Anda harus membuat aliran baru dengan setelan yang tepat.

SuperChatEvents

Resource superChatEvent merepresentasikan pesan Super Chat yang dibeli oleh penggemar selama live stream YouTube. Dalam streaming live chat YouTube, Super Chat lebih terlihat dari pesan lainnya karena dua hal:

  • Super Chat ditandai dengan warna.
  • Super Chat akan terus disematkan di ticker selama jangka waktu yang ditetapkan.

Warna Super Chat, jangka waktu Super Chat tetap disematkan di ticker, dan panjang maksimum pesan ditentukan oleh jumlah pembelian. Lihat Pusat Bantuan YouTube untuk mempelajari lebih lanjut Super 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 /superChatEvents Mencantumkan acara Super Chat dari live stream channel dalam 30 hari sebelumnya.

Jenis resource yang tidak digunakan lagi

FanFundingEvents

Resource fanFundingEvent mewakili acara Fan Funding di channel YouTube. Fan Funding menyediakan cara untuk mendukung kreator YouTube secara finansial. Peristiwa Pendanaan dari Penggemar terjadi saat pengguna melakukan pembayaran sukarela satu kali ke channel. Lihat Pusat Bantuan YouTube untuk mempelajari lebih lanjut Pendanaan dari Penggemar.

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 /fanFundingEvents Mencantumkan acara fan funding untuk channel. Permintaan API harus diizinkan oleh pemilik channel.

LiveCuepoints

Resource liveCuepoint memulai jeda iklan di streaming video siaran.

Catatan: Perintah API untuk mengontrol titik cue sebenarnya adalah bagian dari YouTube Content ID API dan memiliki persyaratan otorisasi yang berbeda dengan permintaan untuk mengelola resource liveBroadcast dan liveStream.

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/
insert POST /liveCuepoints Menyisipkan titik cuplikan ke siaran langsung. Saat ini, permintaan ke metode ini harus diizinkan oleh akun yang terkait dengan Pemilik Konten YouTube.

Sponsor

Resource sponsor mewakili sponsor untuk channel YouTube. Sponsor memberikan dukungan finansial berulang, seperti biaya langganan atau keanggotaan, kepada kreator dan menerima manfaat khusus. Misalnya, sponsor dapat melakukan chat saat kreator mengaktifkan mode khusus sponsor 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 /sponsors Mencantumkan sponsor untuk channel. Permintaan API harus diizinkan oleh pemilik channel.