LiveBroadcasts: transition

Mengubah status siaran live YouTube dan memulai proses apa pun yang terkait dengan status baru. Misalnya, saat Anda mengubah 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 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. Untuk membaca selengkapnya tentang autentikasi dan otorisasi, lihat Menerapkan autentikasi OAuth 2.0.

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 diubah oleh siaran. Perhatikan bahwa untuk mentransisikan siaran ke status testing atau live, status.streamStatus harus berupa active untuk streaming yang menjadi tujuan siaran.

Nilai yang dapat diterima adalah:
  • complete – Siaran telah berakhir. YouTube berhenti mengirimkan video.
  • live – Siaran dapat dilihat oleh audiensnya. YouTube mengirimkan video ke streaming monitor siaran dan streaming siarannya.
  • testing – Mulai menguji siaran. YouTube mengirimkan video ke streaming monitor siaran. Perhatikan bahwa Anda hanya dapat mentransisikan siaran ke status testing jika properti contentDetails.monitorStream.enableMonitorStream-nya ditetapkan ke true.
id string
Parameter id menentukan ID unik siaran yang bertransisi 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 diotorisasi 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 banyak channel YouTube yang berbeda. Fitur ini memungkinkan pemilik konten melakukan autentikasi satu kali dan mendapatkan akses ke semua data video dan channel mereka, 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 secara eksklusif untuk partner konten YouTube.

Parameter onBehalfOfContentOwnerChannel menentukan ID channel YouTube dari channel tempat video ditambahkan. Parameter ini diperlukan saat permintaan menentukan nilai untuk parameter onBehalfOfContentOwner, dan hanya dapat digunakan bersama dengan parameter tersebut. Selain itu, permintaan harus diotorisasi 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 ditentukan oleh parameter onBehalfOfContentOwner.

Parameter ini ditujukan untuk partner konten YouTube yang memiliki dan mengelola banyak channel YouTube yang berbeda. Hal ini memungkinkan pemilik konten melakukan autentikasi satu kali 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.

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. Untuk mengetahui detail selengkapnya, lihat YouTube Live Streaming API - Error.

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 Siaran live tidak dapat bertransisi dari status saat ini ke status yang diminta.
forbidden (403) redundantTransition Siaran langsung sudah dalam status yang diminta atau sedang diproses ke status yang diminta.
insufficientPermissions insufficientLivePermissions Permintaan tidak diberi otorisasi untuk melakukan transisi siaran live.
insufficientPermissions livePermissionBlocked Saat ini, pengguna yang mengizinkan permintaan tersebut tidak dapat melakukan live streaming video di YouTube. Untuk mengetahui detail yang menjelaskan alasan pengguna tidak dapat melakukan live streaming video, lihat setelan channel pengguna di Kelayakan fitur.
insufficientPermissions liveStreamingNotEnabled Pengguna yang mengizinkan permintaan tidak diizinkan untuk melakukan live streaming video di YouTube. Untuk mengetahui informasi selengkapnya, lihat Kelayakan fitur.
notFound (404) liveBroadcastNotFound Siaran yang ditentukan oleh parameter id tidak ada.
rateLimitExceeded (403) userRequestsExceedRateLimit Pengguna telah mengirim 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 serta respons API.