แบนผู้ใช้บางรายจากการเข้าร่วมแชทสด คำขอ API ต้องได้รับอนุญาตจากเจ้าของช่องหรือผู้ดูแลแชทสดที่เชื่อมโยงกับการแบน
Use Case ทั่วไป
ส่งคำขอ
คำขอ 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