เพิ่มข้อความหรือแบบสำรวจลงในแชทสด
กรณีการใช้งานทั่วไป
ส่งคำขอ
คำขอ HTTP
POST https://www.googleapis.com/youtube/v3/liveChat/messages
การให้สิทธิ์
คำขอนี้ต้องมีการให้สิทธิ์ด้วยขอบเขตต่อไปนี้อย่างน้อย 1 รายการ อ่านเพิ่มเติมเกี่ยวกับการตรวจสอบสิทธิ์และการให้สิทธิ์ได้ที่การใช้การตรวจสอบสิทธิ์ OAuth 2.0
ขอบเขต |
---|
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 อาจแสดงเมื่อมีการเรียกใช้เมธอดนี้ ดูรายละเอียดเพิ่มเติมได้ที่ YouTube Live Streaming 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