LiveBroadcasts: transition

Mengubah status live streaming YouTube dan memulai proses apa pun yang terkait dengan status baru. Misalnya, saat Anda mentransisikan status siaran ke testing, YouTube akan mulai mengirimkan video ke streaming monitor siaran tersebut. Sebelum memanggil metode ini, Anda harus mengonfirmasi bahwa nilai properti status.streamStatus untuk aliran yang terikat dengan 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 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 siarannya berubah. Perhatikan bahwa untuk mentransisikan siaran ke status testing atau live, status.streamStatus harus berupa active untuk aliran tempat siaran terikat.

Nilai yang dapat diterima adalah:
  • complete – Siaran berakhir. YouTube menghentikan transmisi video.
  • live – Siaran dapat dilihat oleh audiens. 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 disetel ke true.
id string
Parameter id menentukan ID unik siaran yang bertransisi ke status lain.
part string
Parameter part menentukan daftar yang dipisahkan koma dari 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 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.

Isi permintaan

Jangan berikan isi permintaan saat memanggil metode ini.

Tanggapan

Jika berhasil, metode ini 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 mengetahui detail selengkapnya.

Jenis error Detail error Deskripsi
backendError errorExecutingTransition Terjadi kesalahan 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 ditransisikan dari statusnya saat ini ke status yang diminta.
forbidden (403) redundantTransition Live streaming sudah memiliki status yang diminta atau sedang memproses status yang diminta.
insufficientPermissions insufficientLivePermissions Permintaan tidak diotorisasi untuk mentransisikan live streaming.
insufficientPermissions livePermissionBlocked Pengguna yang mengizinkan permintaan ini tidak dapat melakukan streaming video live di YouTube untuk saat ini. Detail yang menjelaskan mengapa pengguna tidak dapat melakukan streaming video live mungkin tersedia di setelan channel pengguna di https://www.youtube.com/features.
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.
notFound (404) liveBroadcastNotFound Siaran yang ditentukan oleh parameter id tidak ada.
rateLimitExceeded (403) userRequestsExceedRateLimit Pengguna telah mengirimkan terlalu banyak permintaan dalam jangka waktu tertentu.
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.