LiveChatBans: insert
Sử dụng bộ sưu tập để sắp xếp ngăn nắp các trang
Lưu và phân loại nội dung dựa trên lựa chọn ưu tiên của bạn.
Cấm một người dùng cụ thể tham gia cuộc trò chuyện trực tiếp. Yêu cầu API phải được chủ sở hữu kênh hoặc người kiểm duyệt cuộc trò chuyện trực tiếp liên quan đến lệnh cấm uỷ quyền.
Các trường hợp sử dụng phổ biến
Yêu cầu
Yêu cầu HTTP
POST https://www.googleapis.com/youtube/v3/liveChat/bans
Ủy quyền
Yêu cầu này yêu cầu phải được uỷ quyền với ít nhất một trong các phạm vi sau. Để đọc thêm về việc xác thực và uỷ quyền, hãy xem bài viết Triển khai xác thực OAuth 2.0.
Phạm vi |
https://www.googleapis.com/auth/youtube |
https://www.googleapis.com/auth/youtube.force-ssl |
Thông số
Bảng sau đây liệt kê các tham số mà truy vấn này hỗ trợ. Tất cả các tham số được liệt kê đều là tham số truy vấn.
Thông số |
Tham số bắt buộc |
part |
string
Tham số part phục vụ hai mục đích trong thao tác này. Phương thức này xác định các thuộc tính mà thao tác ghi sẽ đặt cũng như các thuộc tính mà phản hồi API trả về. Đặt giá trị tham số thành snippet . |
Nội dung yêu cầu
Cung cấp tài nguyên liveChatBan trong nội dung yêu cầu.
Đối với tài nguyên đó:
Lỗi
Bảng sau đây xác định thông báo lỗi mà API có thể trả về để phản hồi lệnh gọi đến phương thức này. Để biết thêm thông tin chi tiết, hãy xem bài viết YouTube Live Streaming API – Lỗi.
Loại lỗi |
Thông tin chi tiết về lỗi |
Mô tả |
forbidden (403) |
insufficientPermissions |
Bạn không có các quyền cần thiết để cấm một người dùng khỏi cuộc trò chuyện trực tiếp đã chỉ định. |
forbidden (403) |
liveChatBanInsertionNotAllowed |
Không thể tạo lệnh cấm đã chỉ định. Lỗi này có thể xảy ra nếu yêu cầu đó cố gắng cấm chủ sở hữu cuộc trò chuyện hoặc một người kiểm duyệt khác. |
invalidValue (400) |
invalidChannelId |
Không tìm thấy mã kênh được chỉ định. |
invalidValue (400) |
invalidLiveChatId |
Giá trị snippet.liveChatId được chỉ định trong yêu cầu là không hợp lệ. Kiểm tra tài nguyên liveBroadcast được liên kết để đảm bảo rằng bạn có giá trị chính xác. |
notFound (404) |
liveChatNotFound |
Không tìm thấy cuộc trò chuyện trực tiếp đã chỉ định. Kiểm tra tài nguyên liveBroadcast được liên kết để đảm bảo rằng bạn đang đặt thuộc tính snippet.liveChatId thành giá trị chính xác. |
notFound (404) |
liveChatUserNotFound |
Không tìm thấy người dùng trò chuyện trực tiếp mà bạn đang cố gắng cấm. |
required (400) |
bannedUserChannelIdRequired |
Tài nguyên liveChatBan được gửi trong phần nội dung yêu cầu phải chỉ định giá trị cho thuộc tính snippet.bannedUserDetails.channelId . |
required (400) |
liveChatIdRequired |
Tài nguyên liveChatBan được gửi trong phần nội dung yêu cầu phải chỉ định giá trị cho thuộc tính snippet.liveChatId . |
Hãy dùng thử!
Sử dụng APIs Explorer để gọi API này và xem yêu cầu và phản hồi API.
Trừ phi có lưu ý khác, nội dung của trang này được cấp phép theo Giấy phép ghi nhận tác giả 4.0 của Creative Commons và các mẫu mã lập trình được cấp phép theo Giấy phép Apache 2.0. Để biết thông tin chi tiết, vui lòng tham khảo Chính sách trang web của Google Developers. Java là nhãn hiệu đã đăng ký của Oracle và/hoặc các đơn vị liên kết với Oracle.
Cập nhật lần gần đây nhất: 2025-01-02 UTC.
[null,null,["Cập nhật lần gần đây nhất: 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."]]