LiveBroadcasts: list

Menampilkan daftar siaran YouTube yang cocok dengan parameter permintaan API.

Kasus penggunaan umum

Permintaan

Permintaan HTTP

GET https://www.googleapis.com/youtube/v3/liveBroadcasts

Otorisasi

Permintaan ini memerlukan otorisasi dengan setidaknya salah satu cakupan berikut. Untuk membaca selengkapnya tentang autentikasi dan otorisasi, lihat Menerapkan autentikasi OAuth 2.0.

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 untuk satu atau beberapa properti resource liveBroadcast yang akan disertakan oleh respons API. Nama part yang dapat Anda sertakan dalam nilai parameter adalah id, snippet, contentDetails, monetizationDetails, dan status.
Filter (menentukan dengan tepat salah satu parameter berikut)
broadcastStatus string
Parameter broadcastStatus memfilter respons API agar hanya menyertakan siaran dengan status yang ditentukan.

Nilai yang dapat diterima:
  • active – Menampilkan live streaming saat ini.
  • all – Menampilkan semua siaran.
  • completed – Menampilkan siaran yang telah berakhir.
  • upcoming – Menampilkan siaran yang belum dimulai.
id string
Parameter id menentukan daftar ID siaran YouTube yang dipisahkan koma, yang mengidentifikasi siaran yang diambil. Dalam 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 nilai parameter ke true agar hanya mengambil siaran Anda sendiri.
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:
  • all – Menampilkan semua siaran.
  • event – Menampilkan siaran acara terjadwal saja.
  • persistent – Menampilkan siaran persisten saja.
maxResults unsigned integer
Parameter maxResults menentukan jumlah item maksimum 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 diotorisasi dengan benar.
Catatan: Parameter ini ditujukan khusus untuk partner konten YouTube.

Parameter onBehalfOfContentOwner menunjukkan bahwa kredensial otorisasi permintaan mengidentifikasi pengguna Sistem Pengelolaan Konten (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 layanan ini, pemilik konten dapat melakukan autentikasi sekali dan mendapatkan akses ke semua data video dan channel-nya, tanpa harus memberikan kredensial autentikasi untuk setiap channel. Akun CMS yang digunakan pengguna untuk melakukan autentikasi harus ditautkan ke pemilik konten YouTube yang ditentukan.
onBehalfOfContentOwnerChannel string
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 tempat video ditambahkan. Parameter ini wajib ada ketika permintaan menentukan nilai untuk parameter onBehalfOfContentOwner, dan hanya dapat digunakan bersama dengan parameter tersebut. Selain itu, permintaan harus diizinkan menggunakan akun CMS yang ditautkan ke pemilik konten yang ditentukan oleh parameter onBehalfOfContentOwner. Terakhir, channel yang ditentukan oleh nilai parameter onBehalfOfContentOwnerChannel harus ditautkan ke pemilik konten yang ditetapkan oleh parameter onBehalfOfContentOwner.

Parameter ini ditujukan untuk partner konten YouTube yang memiliki dan mengelola berbagai channel YouTube. Dengan fitur ini, pemilik konten dapat melakukan autentikasi satu kali dan melakukan tindakan atas nama channel yang ditentukan dalam nilai parameter, tanpa harus memberikan kredensial autentikasi untuk setiap channel terpisah.
pageToken string
Parameter pageToken mengidentifikasi halaman tertentu dalam set 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 menentukan properti yang muncul di resource ini:

Properti
kind string
Mengidentifikasi jenis resource API. Nilainya adalah 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. Untuk mengetahui detail selengkapnya, lihat pesan error.

Jenis error Detail error Deskripsi
insufficientPermissions insufficientLivePermissions Permintaan tidak diizinkan untuk mengambil siaran langsung.
insufficientPermissions liveStreamingNotEnabled Pengguna yang memberi otorisasi permintaan tidak diizinkan untuk melakukan streaming video live di YouTube. Untuk informasi selengkapnya, lihat Kelayakan fitur.

Cobalah!

Gunakan APIs Explorer untuk memanggil API ini serta melihat permintaan dan respons API.