LiveChatBans: insert
Tetap teratur dengan koleksi
Simpan dan kategorikan konten berdasarkan preferensi Anda.
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:
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.
Kecuali dinyatakan lain, konten di halaman ini dilisensikan berdasarkan Lisensi Creative Commons Attribution 4.0, sedangkan contoh kode dilisensikan berdasarkan Lisensi Apache 2.0. Untuk mengetahui informasi selengkapnya, lihat Kebijakan Situs Google Developers. Java adalah merek dagang terdaftar dari Oracle dan/atau afiliasinya.
Terakhir diperbarui pada 2025-01-02 UTC.
[null,null,["Terakhir diperbarui pada 2025-01-02 UTC."],[],[],null,["# LiveChatBans: insert\n\nBans a specific user from participating in the live chat. The API request must be authorized by the channel owner or a moderator of the live chat associated with the ban.\n\nCommon use cases\n----------------\n\nThe list below shows common use cases for this method. Hover over a use case to see its description, or click on a use case to load sample parameter values in the APIs Explorer. You can open the [fullscreen APIs Explorer](#) to see code samples that dynamically update to reflect the parameter values entered in the Explorer.\n\nThe table below shows common use cases for this method. You can click on a use case name to load sample parameter values in the APIs Explorer. Or you can see code samples for a use case in the fullscreen APIs Explorer by clicking on the code icon below a use case name. In the fullscreen UI, you can update parameter and property values and the code samples will dynamically update to reflect the values you enter. \nThis method has one common use case, which is described below. The buttons below the description populate the APIs Explorer with sample values or open the fullscreen APIs Explorer to show code samples that use those values. The code samples also dynamically update if you change the values.\n\n\u003cbr /\u003e\n\nRequest\n-------\n\n### HTTP request\n\n```\nPOST https://www.googleapis.com/youtube/v3/liveChat/bans\n```\n\n### Authorization\n\nThis request requires authorization with at least one of the following scopes. To read more\nabout authentication and authorization, see\n[Implementing OAuth 2.0 authentication](/youtube/v3/live/authentication).\n\n| Scope |\n|-----------------------------------------------------|\n| `https://www.googleapis.com/auth/youtube` |\n| `https://www.googleapis.com/auth/youtube.force-ssl` |\n\n### Parameters\n\nThe following table lists the parameters that this query supports. All of the parameters listed are query parameters.\n\n| Parameters ||\n|--------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---|\n| **Required parameters** |||\n| `part` | `string` The **part** parameter serves two purposes in this operation. It identifies the properties that the write operation will set as well as the properties that the API response returns. Set the parameter value to `snippet`. |\n\n### Request body\n\nProvide a [liveChatBan resource](/youtube/v3/live/docs/liveChatBans#resource) in the request body.\nFor that resource:\n\n- You must specify a value for these properties:\n\n \u003cbr /\u003e\n\n - `snippet.liveChatId`\n - `snippet.type`\n - `snippet.bannedUserDetails.channelId`\n\n \u003cbr /\u003e\n\n- You can set values for these properties:\n\n \u003cbr /\u003e\n\n - `snippet.banDurationSeconds`\n\n \u003cbr /\u003e\n\nResponse\n--------\n\nIf successful, this method returns a [liveChatBan resource](/youtube/v3/live/docs/liveChatBans#resource) in the response body.\n\nErrors\n------\n\nThe following table identifies error messages that the API could return in response to a call to this method. For more details, see [YouTube Live Streaming API - Errors](/youtube/v3/live/docs/errors).\n\n| Error type | Error detail | Description |\n|----------------------|----------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `forbidden (403)` | `insufficientPermissions` | You do not have the necessary permissions to ban a user from the specified live chat. |\n| `forbidden (403)` | `liveChatBanInsertionNotAllowed` | The specified ban cannot be created. This error can occur if the request attempts to ban the chat owner or another moderator. |\n| `invalidValue (400)` | `invalidChannelId` | The specified channel ID cannot be found. |\n| `invalidValue (400)` | `invalidLiveChatId` | The `snippet.liveChatId` value specified in the request is invalid. Check the associated `liveBroadcast` resource to ensure that you have the correct value. |\n| `notFound (404)` | `liveChatNotFound` | The specified live chat cannot be found. Check the associated `liveBroadcast` resource to ensure that you are setting the `snippet.liveChatId` property to the correct value. |\n| `notFound (404)` | `liveChatUserNotFound` | The live chat user you are trying to ban cannot be found. |\n| `required (400)` | `bannedUserChannelIdRequired` | The `liveChatBan` resource submitted in the request body must specify a value for the `snippet.bannedUserDetails.channelId` property. |\n| `required (400)` | `liveChatIdRequired` | The `liveChatBan` resource submitted in the request body must specify a value for the `snippet.liveChatId` property. |\n\nTry it!\n-------\n\nUse the APIs Explorer to call this API and see the API request and response."]]
