Cấm một người dùng cụ thể tham gia Trò chuyện trong sự kiện phát 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 Trò chuyện trong sự kiện phát trực tiếp liên kết với 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 cần được uỷ quyền với ít nhất một trong các phạm vi sau. Để đọc thêm về quy trình xác thực và uỷ quyền, hãy xem bài viết Triển khai quy trình 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 |
stringTham số part phục vụ 2 mục đích trong thao tác này. Tham số 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 của 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 đó:
-
Bạn phải chỉ định giá trị cho các thuộc tính sau:
snippet.liveChatIdsnippet.type– chọn một trong các lựa chọn sau:permanenthoặctemporarysnippet.bannedUserDetails.channelId
-
Bạn có thể đặt giá trị cho các thuộc tính sau:
snippet.banDurationSeconds
Phản hồi
Nếu thành công, phương thức này sẽ trả về tài nguyên liveChatBan trong nội dung phản hồi.
Lỗi
Bảng sau đây xác định các 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 API phát trực tiếp trên YouTube – Lỗi.
| Loại lỗi | Chi tiết 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 tham gia cuộc trò chuyện trực tiếp được chỉ định. |
forbidden (403) |
liveChatBanInsertionNotAllowed |
Không thể tạo lệnh cấm được 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 người kiểm duyệt khác. |
invalidValue (400) |
invalidChannelId |
Không tìm thấy mã nhận dạng kênh được chỉ định. |
invalidValue (400) |
invalidLiveChatId |
Giá trị snippet.liveChatId được chỉ định trong yêu cầu không hợp lệ. Hãy kiểm tra tài nguyên liveBroadcast được liên kết để đảm bảo bạn có giá trị chính xác. |
notFound (404) |
liveChatNotFound |
Không tìm thấy cuộc trò chuyện qua Live được chỉ định. Hãy kiểm tra tài nguyên liveBroadcast được liên kết để đảm bảo 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 cuộc 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 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 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 API và phản hồi.