LiveChatBans: insert

แบนผู้ใช้รายหนึ่งไม่ให้เข้าร่วมแชทสด เจ้าของช่องหรือผู้ดูแลแชทสดที่เกี่ยวข้องกับการแบนต้องให้สิทธิ์คําขอ API ดังกล่าว

กรณีการใช้งานทั่วไป

ส่งคำขอ

คำขอ HTTP

POST https://www.googleapis.com/youtube/v3/liveChat/bans

การให้สิทธิ์

คําขอนี้ต้องมีการให้สิทธิ์กับขอบเขตต่อไปนี้อย่างน้อย 1 ขอบเขต (อ่านเพิ่มเติมเกี่ยวกับการตรวจสอบสิทธิ์และการให้สิทธิ์)

ขอบเขต
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 อาจแสดงเพื่อตอบสนองต่อการเรียกเมธอดนี้ โปรดดูรายละเอียดเพิ่มเติมในเอกสารประกอบข้อความแสดงข้อผิดพลาด

ประเภทข้อผิดพลาด รายละเอียดข้อผิดพลาด คำอธิบาย
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