LiveChatBans: insert

Memblokir pengguna tertentu untuk berpartisipasi dalam live chat. Permintaan API harus diizinkan oleh pemilik channel atau moderator live chat yang terkait dengan pemblokiran.

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 (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
part string
Parameter part memiliki dua tujuan dalam operasi ini. Kode ini mengidentifikasi properti yang akan ditetapkan oleh operasi tulis serta properti yang ditampilkan oleh respons API. Setel 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. Lihat dokumentasi pesan error untuk detail selengkapnya.

Jenis error Detail error Deskripsi
forbidden (403) insufficientPermissions Anda tidak memiliki izin yang diperlukan untuk memblokir pengguna dari live chat yang ditentukan.
forbidden (403) liveChatBanInsertionNotAllowed Pemblokiran yang ditentukan tidak dapat dibuat. Error ini dapat terjadi jika permintaan mencoba memblokir pemilik chat atau moderator lain.
invalidValue (400) invalidChannelId ID channel 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 ingin Anda 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 dan respons API.