LiveBroadcasts: transition

Mengubah status live streaming YouTube dan memulai proses apa pun yang berkaitan dengan status baru tersebut. Misalnya, saat Anda mentransisikan status siaran ke testing, YouTube akan mulai mentransmisikan video ke streaming monitor siaran tersebut. Sebelum memanggil metode ini, sebaiknya konfirmasi bahwa nilai properti status.streamStatus untuk streaming yang terikat ke siaran Anda adalah active.

Kasus penggunaan umum

Permintaan

Permintaan HTTP

POST https://www.googleapis.com/youtube/v3/liveBroadcasts/transition

Otorisasi

Permintaan ini memerlukan otorisasi dengan setidaknya salah satu cakupan berikut (baca selengkapnya tentang autentikasi dan otorisasi).

Cakupan
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
broadcastStatus string
Parameter broadcastStatus mengidentifikasi status yang menjadi perubahan siaran. Perlu diketahui bahwa untuk mentransisikan siaran ke status testing atau live, status.streamStatus harus active untuk streaming yang terikat ke siaran tersebut.

Nilai yang dapat diterima adalah:
  • complete – Siaran sudah berakhir. YouTube berhenti mentransmisikan video.
  • live – Siaran dapat dilihat oleh audiensnya. YouTube mentransmisikan video ke streaming monitor siaran dan streaming siarannya.
  • testing – Mulai menguji siaran. YouTube mentransmisikan video ke streaming monitor siaran. Perhatikan bahwa Anda hanya dapat mentransisikan siaran ke status testing jika properti contentDetails.monitorStream.enableMonitorStream-nya disetel ke true.
id string
Parameter id menentukan ID unik siaran yang ditransisikan ke status lain.
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, dan status.
Parameter opsional
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.

Isi permintaan

Jangan berikan isi permintaan saat memanggil metode ini.

Respons

Jika berhasil, metode ini akan menampilkan resource liveBroadcast dalam isi respons.

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
backendError errorExecutingTransition Terjadi error saat mengubah status siaran.
forbidden (403) errorStreamInactive Transisi yang diminta tidak diizinkan jika streaming yang terikat dengan siaran tidak aktif.
forbidden (403) invalidTransition Live streaming tidak dapat beralih dari status saat ini ke status yang diminta.
forbidden (403) redundantTransition Live streaming sudah dalam status yang diminta atau diproses ke status yang diminta.
insufficientPermissions insufficientLivePermissions Permintaan tidak diizinkan untuk mentransisikan live streaming.
insufficientPermissions livePermissionBlocked Saat ini, pengguna yang mengizinkan permintaan tidak dapat melakukan streaming video live di YouTube. Detail yang menjelaskan alasan pengguna tidak dapat melakukan streaming video live dapat tersedia di setelan channel pengguna di https://www.youtube.com/features.
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.
notFound (404) liveBroadcastNotFound Siaran yang ditentukan oleh parameter id tidak ada.
rateLimitExceeded (403) userRequestsExceedRateLimit Pengguna telah mengirim terlalu banyak permintaan dalam jangka waktu yang ditentukan.
required (400) idRequired Parameter id yang diperlukan harus mengidentifikasi siaran yang statusnya ingin Anda transisikan.
required (400) statusRequired Permintaan API harus menentukan nilai untuk parameter status.

Cobalah!

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