LiveChatBans: insert

Melarang pengguna tertentu agar tidak berpartisipasi dalam live chat. Permintaan API harus diotorisasi oleh pemilik channel atau moderator live chat yang terkait dengan larangan tersebut.

Kasus penggunaan umum

Permintaan

Permintaan HTTP

POST https://www.googleapis.com/youtube/v3/liveChat/bans

Otorisasi

Permintaan ini memerlukan otorisasi dengan setidaknya salah satu cakupan berikut. Untuk membaca informasi 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
part string
Parameter part memiliki dua tujuan dalam operasi ini. Ini mengidentifikasi properti yang akan ditetapkan oleh operasi tulis serta properti yang ditampilkan respons API. Tetapkan nilai parameter ke snippet.

Isi permintaan

Berikan resource liveChatBan dalam isi permintaan. Untuk resource tersebut:

  • Anda harus menentukan nilai untuk properti ini:

    • snippet.liveChatId
    • snippet.type
    • snippet.bannedUserDetails.channelId

  • Anda dapat menetapkan nilai untuk properti berikut:

    • snippet.banDurationSeconds

Respons

Jika berhasil, metode ini akan menampilkan resource liveChatBan 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
forbidden (403) insufficientPermissions Anda tidak memiliki izin yang diperlukan untuk melarang pengguna dari live chat yang ditentukan.
forbidden (403) liveChatBanInsertionNotAllowed Larangan yang ditentukan tidak dapat dibuat. Error ini dapat terjadi jika permintaan mencoba melarang pemilik chat atau moderator lain.
invalidValue (400) invalidChannelId ID saluran yang ditentukan tidak dapat ditemukan.
invalidValue (400) invalidLiveChatId Nilai snippet.liveChatId yang ditentukan dalam permintaan tidak valid. Periksa resource liveBroadcast terkait untuk memastikan Anda memiliki nilai yang benar.
notFound (404) liveChatNotFound Live chat yang ditentukan tidak dapat ditemukan. Periksa resource liveBroadcast terkait untuk memastikan Anda menetapkan properti snippet.liveChatId ke nilai yang benar.
notFound (404) liveChatUserNotFound Pengguna live chat yang Anda coba blokir tidak dapat ditemukan.
required (400) bannedUserChannelIdRequired Resource liveChatBan yang dikirimkan dalam isi permintaan harus menentukan nilai untuk properti snippet.bannedUserDetails.channelId.
required (400) liveChatIdRequired Resource liveChatBan yang dikirimkan dalam isi permintaan harus menentukan nilai untuk properti snippet.liveChatId.

Cobalah!

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