LiveBroadcasts: update

Memperbarui siaran. Misalnya, Anda dapat mengubah setelan siaran yang ditentukan dalam objek contentDetails resource liveBroadcast.

Kasus penggunaan umum

Permintaan

Permintaan HTTP

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

Otorisasi

Permintaan ini memerlukan otorisasi dengan setidaknya salah satu cakupan berikut (baca lebih lanjut 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
part string
Parameter part memiliki dua fungsi dalam operasi ini. Parameter ini mengidentifikasi properti yang akan ditetapkan oleh operasi tulis serta properti yang akan disertakan oleh respons API.

Properti part yang dapat Anda sertakan dalam nilai parameter adalah id, snippet, contentDetails, monetizationDetails, dan status.

Perhatikan bahwa metode ini akan mengganti nilai yang ada untuk semua properti yang dapat diubah dan terdapat dalam setiap bagian yang ditentukan oleh nilai parameter. Misalnya, status privasi siaran ditentukan di bagian status. Dengan demikian, jika permintaan Anda memperbarui siaran pribadi atau tidak publik, dan nilai parameter part permintaan menyertakan bagian status, setelan privasi siaran akan diperbarui ke nilai apa pun yang ditentukan oleh isi permintaan. Jika isi permintaan tidak menentukan nilai, setelan privasi yang ada akan dihapus dan siaran akan dikembalikan ke setelan privasi default.
Parameter opsional
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 YouTube CMS 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 sekali dan mendapatkan akses ke semua data video dan channel 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 diotorisasi 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 akan ditambahi video. Parameter ini diperlukan saat permintaan menentukan nilai untuk parameter onBehalfOfContentOwner, dan hanya dapat digunakan bersama 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 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 melakukan autentikasi sekali dan melakukan tindakan atas nama channel yang ditentukan dalam nilai parameter, tanpa harus memberikan kredensial autentikasi untuk setiap channel yang terpisah.

Isi permintaan

Berikan resource liveBroadcast dalam isi permintaan. Untuk resource tersebut:

  • Anda harus menentukan nilai untuk properti ini:

    • id
    • snippet.scheduledStartTime
    • contentDetails.monitorStream.enableMonitorStream
    • contentDetails.monitorStream.broadcastStreamDelayMs

  • Anda dapat menetapkan nilai untuk properti berikut:

    • snippet.title
    • snippet.description
    • snippet.scheduledStartTime
    • snippet.scheduledEndTime
    • status.privacyStatus
    • contentDetails.monitorStream.enableMonitorStream
    • contentDetails.monitorStream.broadcastStreamDelayMs
    • contentDetails.enableAutoStart
    • contentDetails.enableAutoStop
    • contentDetails.enableClosedCaptions
    • contentDetails.enableDvr
    • contentDetails.enableEmbed
    • contentDetails.recordFromStart
    • monetizationDetails.cuepointSchedule.pauseAdsUntil

    Jika Anda mengirimkan permintaan pembaruan, dan permintaan Anda tidak menentukan nilai untuk properti yang sudah memiliki nilai, nilai properti yang ada akan dihapus.

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
forbidden (403) closedCaptionsTypeModificationNotAllowed Nilai contentDetails.closedCaptionsType hanya dapat diubah jika siaran dalam status created atau ready.
forbidden (403) enabledModificationNotAllowed Kolom enabled bersifat hanya baca.
forbidden (403) scheduleStrategyModificationNotAllowed Kolom scheduleStrategy bersifat hanya baca.
forbidden (403) repeatIntervalSecsModificationNotAllowed Kolom repeatIntervalSecs bersifat hanya baca.
forbidden (403) pauseAdsUntilModificationNotAllowed Kolom pauseAdsUntil tidak dapat diubah. Error ini dapat terjadi karena alasan berikut:
  • Kolom monetizationDetails.cuepointSchedule.enabled tidak ditetapkan ke true. Kolom ini hanya dapat disetel melalui YouTube Studio.
  • Siaran tidak live.
forbidden (403) enableAutoStartModificationNotAllowed Nilai contentDetails.enableAutoStart hanya dapat diubah jika streaming tidak aktif dan siaran dalam status created atau ready.
forbidden (403) enableClosedCaptionsModificationNotAllowed Nilai contentDetails.enableClosedCaptions hanya dapat diubah jika status siaran adalah created atau ready.
forbidden (403) enableDvrModificationNotAllowed Nilai contentDetails.enableDvr hanya dapat diubah jika status siaran adalah created atau ready.
forbidden (403) enableMonitorStreamModificationNotAllowed Nilai contentDetails.monitorStream.enableMonitorStream hanya dapat diubah jika status siaran adalah created atau ready.
forbidden (403) recordFromStartModificationNotAllowed Nilai contentDetails.recordFromStart hanya dapat diubah jika status siaran adalah created atau ready.
insufficientPermissions insufficientLivePermissions Permintaan tidak diizinkan untuk memperbarui live streaming yang ditentukan. Untuk informasi selengkapnya, lihat Menerapkan autentikasi OAuth2.
insufficientPermissions liveStreamingNotEnabled Pengguna yang mengizinkan permintaan tidak diaktifkan untuk melakukan streaming video live di YouTube. Pengguna dapat menemukan informasi selengkapnya di https://www.youtube.com/features.
invalidValue (400) invalidAutoStart Resource liveBroadcast berisi nilai yang tidak valid untuk properti contentDetails.enableAutoStart. Anda tidak dapat mengubah setelan enableAutoStart untuk siaran persisten.
invalidValue (400) invalidAutoStop Resource liveBroadcast berisi nilai yang tidak valid untuk properti contentDetails.enableAutoStop. Anda tidak dapat mengubah setelan enableAutoStop untuk siaran persisten.
invalidValue (400) invalidDescription Resource liveBroadcast tidak menentukan nilai yang valid untuk properti snippet.description. snippet.description dapat berisi hingga 5.000 karakter.
invalidValue (400) invalidEmbedSetting Resource liveBroadcast berisi nilai yang tidak valid untuk properti contentDetails.enable_embed. Anda tidak dapat menyematkan siaran ini.
invalidValue (400) invalidEnableClosedCaptions Di resource liveBroadcast, nilai properti contentDetails.enableClosedCaptions tidak kompatibel dengan nilai setelan contentDetails.closedCaptionType. Ubah resource agar hanya menyertakan salah satu dari dua properti, lalu kirim ulang permintaan.
invalidValue (400) invalidLatencyPreferenceOptions Resource liveBroadcast berisi nilai yang tidak valid untuk properti contentDetails.latencyPreference. Tidak semua setelan didukung dengan preferensi latensi ini.
invalidValue (400) invalidPauseAdsUntil Resource liveBroadcast berisi nilai yang tidak valid untuk properti monetizationDetails.cuepointSchedule.pauseAdsUntil. Error ini dapat terjadi karena alasan berikut:
  • Nilai monetizationDetails.cuepointSchedule.pauseAdsUntil tidak ditentukan dalam format ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ).
  • Nilai monetizationDetails.cuepointSchedule.pauseAdsUntil tidak ada di masa mendatang.
  • Nilai monetizationDetails.cuepointSchedule.pauseAdsUntil lebih jauh dari 10 menit dari waktu saat ini.
invalidValue (400) invalidPrivacyStatus Resource liveBroadcast tidak menetapkan status privasi yang valid. Lihat nilai privacyStatus yang valid.
invalidValue (400) invalidProjection Resource liveBroadcast berisi nilai yang tidak valid untuk properti contentDetails.projection. Proyeksi siaran persisten tidak dapat disetel ke 360.
invalidValue (400) invalidScheduledEndTime Resource liveBroadcast berisi nilai yang tidak valid untuk properti snippet.scheduledEndTime. Waktu berakhir yang dijadwalkan harus mengikuti waktu mulai yang dijadwalkan.
invalidValue (400) invalidScheduledStartTime Resource liveBroadcast berisi nilai yang tidak valid untuk properti snippet.scheduledStartTime. Waktu mulai yang dijadwalkan harus berada di masa mendatang.
invalidValue (400) invalidTitle Resource liveBroadcast tidak menentukan nilai yang valid untuk properti snippet.title. Panjang snippet.title harus antara 1 dan 100 karakter.
notFound (404) liveBroadcastNotFound Properti id yang ditentukan di resource liveBroadcast tidak mengidentifikasi siaran.
required (400) broadcastStreamDelayMsRequired Resource liveBroadcast tidak menentukan properti contentDetails.monitorStream.broadcastStreamDelayMs.
required (400) enableMonitorStreamRequired Resource liveBroadcast tidak menentukan properti contentDetails.monitorStream.enableMonitorStream.
required (400) idRequired Resource liveBroadcast harus menyertakan dan menentukan nilai untuk properti id.
required (400) scheduledEndTimeRequired Resource liveBroadcast tidak menentukan properti snippet.scheduledEndTime.
required (400) scheduledStartTimeRequired Resource liveBroadcast tidak menentukan properti snippet.scheduledStartTime.

Cobalah!

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