เพิ่มข้อความหรือแบบสำรวจในแชทสด
กรณีการใช้งานทั่วไป
ส่งคำขอ
คำขอ HTTP
POST https://www.googleapis.com/youtube/v3/liveChat/messages
การให้สิทธิ์
คำขอนี้ต้องได้รับการให้สิทธิ์ที่มีขอบเขตต่อไปนี้อย่างน้อย 1 ขอบเขต (อ่านเพิ่มเติมเกี่ยวกับการตรวจสอบสิทธิ์และการให้สิทธิ์)
ขอบเขต |
---|
https://www.googleapis.com/auth/youtube |
https://www.googleapis.com/auth/youtube.force-ssl |
พารามิเตอร์
ตารางต่อไปนี้แสดงพารามิเตอร์ที่การค้นหานี้รองรับ พารามิเตอร์ทั้งหมดที่แสดงคือพารามิเตอร์การค้นหา
พารามิเตอร์ | ||
---|---|---|
พารามิเตอร์ที่จำเป็น | ||
part |
string พารามิเตอร์ part ทำหน้าที่ 2 ประการ โดยระบุพร็อพเพอร์ตี้ที่การดำเนินการเขียนจะตั้งค่า ตลอดจนพร็อพเพอร์ตี้ที่การตอบกลับจาก API จะรวมไว้ด้วย ตั้งค่าพารามิเตอร์เป็น snippet |
เนื้อหาของคำขอ
ระบุทรัพยากร LiveChatMessage ในเนื้อหาคำขอ สำหรับทรัพยากรดังกล่าว คุณต้องระบุค่าสำหรับพร็อพเพอร์ตี้เหล่านี้
snippet.liveChatId
snippet.type
- เลือกตัวเลือกใดตัวเลือกหนึ่งต่อไปนี้textMessageEvent
หรือpollEvent
- หากประเภทคือ
textMessageEvent
ให้ใส่snippet.textMessageDetails.messageText
- หากประเภทคือ
pollEvent
ให้รวมsnippet.pollDetails
ด้วยค่าต่อไปนี้snippet.pollDetails.metadata.options.questionText
- รายชื่อ
snippet.pollDetails.metadata.options.optionText
คุณต้องแสดงอย่างน้อย 2 รายการและไม่เกิน 5 รายการ รายการจะแสดงตามลำดับการแสดง
คำตอบ
หากทำสำเร็จ เมธอดนี้จะแสดงทรัพยากร LiveChatMessage ในเนื้อหาการตอบกลับ
ข้อผิดพลาด
ตารางต่อไปนี้ระบุข้อความแสดงข้อผิดพลาดที่ API อาจส่งคืนเมื่อมีการเรียกใช้เมธอดนี้ โปรดดูรายละเอียดเพิ่มเติมในเอกสารประกอบข้อความแสดงข้อผิดพลาด
ประเภทข้อผิดพลาด | รายละเอียดข้อผิดพลาด | คำอธิบาย |
---|---|---|
forbidden (403) |
forbidden |
คุณไม่มีสิทธิ์ที่จำเป็นในการสร้างข้อความที่ระบุ |
forbidden (403) |
liveChatDisabled |
เจ้าของปิดใช้แชทสดที่ระบุ ซึ่งหมายความว่าเพิ่มข้อความไปยังแชทไม่ได้ |
forbidden (403) |
liveChatEnded |
แชทสดที่ระบุไม่ได้เผยแพร่อีกต่อไป |
invalidValue (400) |
messageTextInvalid |
ข้อความ (snippet.textMessageDetails.messageText ) ไม่ถูกต้อง |
notFound (404) |
liveChatNotFound |
ไม่มีแชทสดที่ระบุในคำขอ API ข้อผิดพลาดนี้จะเกิดขึ้นหากเจ้าของลบแชทไปแล้ว |
required (400) |
liveChatIdRequired |
ทรัพยากรliveChatMessage ต้องมีและระบุค่าสําหรับพร็อพเพอร์ตี้ snippet.liveChatId |
required (400) |
messageTextRequired |
ทรัพยากรliveChatMessage ต้องมีและระบุค่าสําหรับพร็อพเพอร์ตี้ snippet.textMessageDetails.messageText |
required (400) |
typeRequired |
ทรัพยากรliveChatMessage ต้องมีและระบุค่าสําหรับพร็อพเพอร์ตี้ snippet.type ตั้งค่าพารามิเตอร์เป็น text |
required (400) |
preconditionCheckFailed |
มีแบบสำรวจที่ใช้งานอยู่ซึ่งปักหมุดไว้อยู่แล้ว |
rateLimitExceeded |
rateLimitExceeded |
ผู้ใช้โพสต์ข้อความแชทมากเกินไปในกรอบเวลาที่กำหนด |
ลองใช้งาน
ใช้ APIs Explorer เพื่อเรียกใช้ API นี้ รวมถึงดูคำขอ API และการตอบกลับ