Menampilkan daftar siaran YouTube yang cocok dengan parameter permintaan API.
Permintaan
Permintaan HTTP
GET https://www.googleapis.com/youtube/v3/liveBroadcasts
Otorisasi
Permintaan ini memerlukan otorisasi dengan setidaknya salah satu cakupan berikut (baca selengkapnya tentang autentikasi dan otorisasi).
Cakupan |
---|
https://www.googleapis.com/auth/youtube.readonly |
https://www.googleapis.com/auth/youtube |
https://www.googleapis.com/auth/youtube.force-ssl |
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 daftar yang dipisahkan koma yang berisi satu atau beberapa properti resource liveBroadcast yang akan disertakan dalam respons API. Nama part yang dapat Anda sertakan dalam nilai parameter adalah id , snippet , contentDetails , monetizationDetails , dan status . |
|
Filter (tentukan salah satu parameter berikut) | ||
broadcastStatus |
string Parameter broadcastStatus memfilter respons API agar hanya menyertakan siaran dengan status yang ditentukan.Nilai yang dapat diterima adalah:
|
|
id |
string Parameter id menentukan daftar ID siaran YouTube yang dipisahkan koma yang mengidentifikasi siaran yang sedang diambil. Di resource liveBroadcast , properti id menentukan ID siaran. |
|
mine |
boolean Parameter mine dapat digunakan untuk memerintahkan API agar hanya menampilkan siaran yang dimiliki oleh pengguna yang diautentikasi. Setel parameter value ke true untuk mengambil siaran Anda sendiri saja. |
|
Parameter opsional | ||
broadcastType |
string Parameter broadcastType memfilter respons API agar hanya menyertakan siaran dengan jenis yang ditentukan. Parameter ini harus digunakan dalam permintaan yang menetapkan parameter mine ke true atau yang menggunakan parameter broadcastStatus . Nilai defaultnya adalah event .Nilai yang dapat diterima:
|
|
maxResults |
unsigned integer Parameter maxResults menentukan jumlah maksimum item yang harus ditampilkan dalam kumpulan hasil. Nilai yang dapat diterima adalah 0 hingga 50 , inklusif. Nilai defaultnya adalah 5 . |
|
onBehalfOfContentOwner |
string Parameter ini hanya dapat digunakan dalam permintaan yang diizinkan dengan benar. Catatan: Parameter ini ditujukan khusus untuk partner konten YouTube. Parameter onBehalfOfContentOwner menunjukkan bahwa kredensial otorisasi permintaan mengidentifikasi pengguna CMS YouTube yang bertindak atas nama pemilik konten yang ditentukan dalam nilai parameter. Parameter ini ditujukan untuk partner konten YouTube yang memiliki dan mengelola banyak channel YouTube yang berbeda. Pemilik konten dapat melakukan autentikasi sekali dan mendapatkan akses ke semua data channel serta video mereka, tanpa harus memberikan kredensial autentikasi untuk setiap channel. Akun CMS yang diautentikasi oleh pengguna harus ditautkan ke pemilik konten YouTube yang ditentukan. |
|
onBehalfOfContentOwnerChannel |
string Parameter ini hanya dapat digunakan dalam permintaan yang diizinkan dengan benar. Parameter ini hanya dapat digunakan dalam permintaan yang diotorisasi dengan benar. Catatan: Parameter ini ditujukan khusus untuk partner konten YouTube. Parameter onBehalfOfContentOwnerChannel menentukan ID channel YouTube dari channel yang ditambahi video. Parameter ini diperlukan saat permintaan menentukan nilai untuk parameter onBehalfOfContentOwner , dan hanya dapat digunakan bersama dengan parameter tersebut. Selain itu, permintaan tersebut harus diizinkan menggunakan akun CMS yang ditautkan ke pemilik konten yang ditentukan oleh parameter onBehalfOfContentOwner . Terakhir, channel yang telah ditentukan oleh parameter value onBehalfOfContentOwnerChannel harus ditautkan ke pemilik konten yang ditentukan oleh parameter onBehalfOfContentOwner .Parameter ini ditujukan untuk partner konten YouTube yang memiliki dan mengelola banyak channel YouTube yang berbeda. ID ini memungkinkan pemilik konten mengautentikasi satu kali dan melakukan tindakan atas nama channel yang ditentukan dalam nilai parameter, tanpa harus memberikan kredensial autentikasi untuk setiap channel yang terpisah. |
|
pageToken |
string Parameter pageToken mengidentifikasi halaman tertentu dalam kumpulan hasil yang harus ditampilkan. Dalam respons API, properti nextPageToken dan prevPageToken mengidentifikasi halaman lain yang dapat diambil. |
Isi permintaan
Jangan berikan isi permintaan saat memanggil metode ini.
Respons
Jika berhasil, metode ini akan menampilkan isi respons dengan struktur berikut:
{ "kind": "youtube#liveBroadcastListResponse", "etag": etag, "nextPageToken": string, "prevPageToken": string, "pageInfo": { "totalResults": integer, "resultsPerPage": integer }, "items": [ liveBroadcast Resource ] }
Properti
Tabel berikut mendefinisikan properti yang muncul di resource ini:
Properti | |
---|---|
kind |
string Mengidentifikasi jenis resource API. Nilainya akan berupa youtube#liveBroadcastListResponse . |
etag |
etag Etag resource ini. |
nextPageToken |
string Token yang dapat digunakan sebagai nilai parameter pageToken untuk mengambil halaman berikutnya di kumpulan hasil. |
prevPageToken |
string Token yang dapat digunakan sebagai nilai parameter pageToken untuk mengambil halaman sebelumnya di kumpulan hasil. |
pageInfo |
object Objek pageInfo mengenkapsulasi informasi paging untuk kumpulan hasil. |
pageInfo.totalResults |
integer Jumlah total hasil dalam kumpulan hasil. |
pageInfo.resultsPerPage |
integer Jumlah hasil yang disertakan dalam respons API. |
items[] |
list Daftar siaran 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 detail selengkapnya.
Jenis error | Detail error | Deskripsi |
---|---|---|
insufficientPermissions |
insufficientLivePermissions |
Permintaan tidak diizinkan untuk mengambil live streaming. |
insufficientPermissions |
liveStreamingNotEnabled |
Pengguna yang mengizinkan permintaan tidak diizinkan untuk melakukan streaming video live di YouTube. Pengguna dapat menemukan informasi selengkapnya di https://www.youtube.com/features. |
Cobalah!
Gunakan APIs Explorer untuk memanggil API ini dan melihat permintaan dan respons API.