Menampilkan daftar streaming video yang cocok dengan parameter permintaan API.
Kasus penggunaan umum
Permintaan
Permintaan HTTP
GET https://www.googleapis.com/youtube/v3/liveStreams
Otorisasi
Permintaan ini memerlukan otorisasi dengan setidaknya 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 dari satu atau beberapa properti resource liveStream yang akan disertakan dalam respons API. Nama part yang dapat Anda sertakan dalam nilai parameter adalah id , snippet , cdn , dan status . |
|
Filter (sebutkan salah satu parameter berikut) | ||
id |
string Parameter id menentukan daftar ID streaming YouTube yang dipisahkan koma yang mengidentifikasi streaming yang diambil. Dalam resource liveStream , properti id menentukan ID aliran data. |
|
mine |
boolean Parameter ini hanya dapat digunakan dalam permintaan yang diizinkan dengan benar. Parameter mine dapat digunakan untuk menginstruksikan API agar hanya menampilkan aliran data yang dimiliki oleh pengguna terautentikasi. Setel nilai parameter ke true untuk hanya mengambil aliran Anda sendiri. |
|
Parameter opsional | ||
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 secara eksklusif 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 berbagai channel YouTube. Dengan kebijakan ini, pemilik konten dapat mengautentikasi sekali serta mendapatkan akses ke semua data video dan channel mereka, tanpa harus memberikan kredensial autentikasi untuk setiap channel. Akun CMS yang diautentikasi pengguna harus ditautkan dengan 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 sah dengan benar. Catatan: Parameter ini ditujukan khusus untuk partner konten YouTube. Parameter onBehalfOfContentOwnerChannel menentukan ID channel YouTube dari channel yang menjadi tujuan penambahan video. Parameter ini diperlukan saat permintaan menentukan nilai untuk parameter onBehalfOfContentOwner , dan hanya dapat digunakan bersama parameter tersebut. Selain itu, permintaan tersebut harus diotorisasi menggunakan akun CMS yang ditautkan ke pemilik konten yang ditentukan oleh parameter onBehalfOfContentOwner . Terakhir, channel yang 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 berbagai channel YouTube. Dengan kebijakan ini, pemilik konten dapat mengautentikasi sekali dan melakukan tindakan atas nama saluran yang ditentukan dalam nilai parameter, tanpa harus memberikan kredensial autentikasi untuk setiap saluran 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.
Tanggapan
Jika berhasil, metode ini akan menampilkan isi respons dengan struktur berikut:
{ "kind": "youtube#liveStreamListResponse", "etag": etag, "nextPageToken": string, "prevPageToken": string, "pageInfo": { "totalResults": integer, "resultsPerPage": integer }, "items": [ liveStream Resource ] }
Properti
Tabel berikut menentukan properti yang muncul di resource ini:
Properti | |
---|---|
kind |
string Mengidentifikasi jenis resource API. Nilainya adalah youtube#liveStreamListResponse . |
etag |
etag Etag resource ini. |
nextPageToken |
string Token yang dapat digunakan sebagai nilai parameter pageToken untuk mengambil halaman berikutnya dalam kumpulan hasil. |
prevPageToken |
string Token yang dapat digunakan sebagai nilai parameter pageToken untuk mengambil halaman sebelumnya dalam kumpulan hasil. |
pageInfo |
object Objek pageInfo mengenkapsulasi informasi paging untuk kumpulan hasil. |
pageInfo.totalResults |
integer Total jumlah hasil dalam kumpulan hasil. |
pageInfo.resultsPerPage |
integer Jumlah hasil yang disertakan dalam respons API. |
items[] |
list Daftar live stream 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 mengetahui detail selengkapnya.
Jenis error | Detail error | Deskripsi |
---|---|---|
insufficientPermissions |
insufficientLivePermissions |
Permintaan tidak diizinkan untuk mengambil live stream yang ditentukan. |
insufficientPermissions |
liveStreamingNotEnabled |
Pengguna yang mengizinkan permintaan tersebut tidak dapat 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.