ห้ามผู้ใช้บางรายไม่ให้เข้าร่วมแชทสด คำขอ API ต้องได้รับอนุญาตจากเจ้าของช่องหรือผู้ดูแลแชทสดที่เชื่อมโยงกับการแบน
กรณีการใช้งานทั่วไป
ส่งคำขอ
คำขอ HTTP
POST https://www.googleapis.com/youtube/v3/liveChat/bans
การให้สิทธิ์
คำขอนี้ต้องมีการให้สิทธิ์ด้วยขอบเขตต่อไปนี้อย่างน้อย 1 รายการ อ่านเพิ่มเติมเกี่ยวกับการตรวจสอบสิทธิ์และการให้สิทธิ์ได้ที่การใช้การตรวจสอบสิทธิ์ OAuth 2.0
ขอบเขต |
---|
https://www.googleapis.com/auth/youtube |
https://www.googleapis.com/auth/youtube.force-ssl |
พารามิเตอร์
ตารางต่อไปนี้แสดงพารามิเตอร์ที่การค้นหานี้รองรับ พารามิเตอร์ทั้งหมดที่แสดงคือพารามิเตอร์การค้นหา
พารามิเตอร์ | ||
---|---|---|
พารามิเตอร์ที่จำเป็น | ||
part |
string พารามิเตอร์ part มีไว้เพื่อวัตถุประสงค์ 2 อย่างในการดำเนินการนี้ โดยจะระบุพร็อพเพอร์ตี้ที่การดำเนินการเขียนจะตั้งค่า รวมถึงพร็อพเพอร์ตี้ที่การตอบกลับของ API จะแสดงผล ตั้งค่าพารามิเตอร์เป็น snippet |
เนื้อหาของคำขอ
ระบุทรัพยากร liveChatBan ในเนื้อหาคําขอ สำหรับทรัพยากรนั้น
-
คุณต้องระบุค่าสำหรับพร็อพเพอร์ตี้ต่อไปนี้
snippet.liveChatId
snippet.type
snippet.bannedUserDetails.channelId
-
คุณตั้งค่าพร็อพเพอร์ตี้ต่อไปนี้ได้
snippet.banDurationSeconds
คำตอบ
หากดำเนินการสำเร็จ เมธอดนี้จะแสดงทรัพยากร liveChatBan ในเนื้อหาการตอบกลับ
ข้อผิดพลาด
ตารางต่อไปนี้ระบุข้อความแสดงข้อผิดพลาดที่ API อาจแสดงเมื่อมีการเรียกใช้เมธอดนี้ ดูรายละเอียดเพิ่มเติมได้ที่ YouTube Live Streaming API - ข้อผิดพลาด
ประเภทข้อผิดพลาด | รายละเอียดข้อผิดพลาด | คำอธิบาย |
---|---|---|
forbidden (403) |
insufficientPermissions |
คุณไม่มีสิทธิ์ที่จำเป็นในการแบนผู้ใช้จากแชทสดที่ระบุ |
forbidden (403) |
liveChatBanInsertionNotAllowed |
สร้างการห้ามที่ระบุไม่ได้ ข้อผิดพลาดนี้อาจเกิดขึ้นหากคำขอพยายามแบนเจ้าของแชทหรือผู้ดูแลคนอื่นๆ |
invalidValue (400) |
invalidChannelId |
ไม่พบรหัสแชแนลที่ระบุ |
invalidValue (400) |
invalidLiveChatId |
ค่า snippet.liveChatId ที่ระบุในคำขอไม่ถูกต้อง ตรวจสอบทรัพยากร liveBroadcast ที่เชื่อมโยงเพื่อให้แน่ใจว่าคุณมีค่าที่ถูกต้อง |
notFound (404) |
liveChatNotFound |
ไม่พบแชทสดที่ระบุ ตรวจสอบทรัพยากร liveBroadcast ที่เชื่อมโยงเพื่อให้แน่ใจว่าคุณกําลังตั้งค่าพร็อพเพอร์ตี้ snippet.liveChatId เป็นค่าที่ถูกต้อง |
notFound (404) |
liveChatUserNotFound |
ไม่พบผู้ใช้แชทสดที่คุณพยายามจะแบน |
required (400) |
bannedUserChannelIdRequired |
ทรัพยากร liveChatBan ที่ส่งในเนื้อหาคําขอต้องระบุค่าสําหรับพร็อพเพอร์ตี้ snippet.bannedUserDetails.channelId |
required (400) |
liveChatIdRequired |
ทรัพยากร liveChatBan ที่ส่งในเนื้อหาคําขอต้องระบุค่าสําหรับพร็อพเพอร์ตี้ snippet.liveChatId |
ลองใช้งาน
ใช้ APIs Explorer เพื่อเรียก API นี้และดูคําขอและการตอบกลับของ API