LiveChatMessages: insert

เพิ่มข้อความหรือโพลลงในแชทสด

ผลกระทบต่อโควต้า: การเรียกเมธอดนี้มีค่าใช้จ่ายโควต้า 20 หน่วย

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

ส่งคำขอ

คำขอ 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.questionText (String): คำถามหลักสำหรับโพล
    • snippet.pollDetails.metadata.options (Array): รายการออบเจ็กต์ตัวเลือก
    • ข้อกำหนด: คุณต้องใส่รายการอย่างน้อย 2 รายการและไม่เกิน 4 รายการ
    • การจัดลำดับ: รายการจะแสดงตามลำดับที่แสดง
    • ออบเจ็กต์แต่ละรายการในอาร์เรย์ต้องมีข้อมูลต่อไปนี้
      • optionText (String): ข้อความที่แสดงสำหรับตัวเลือกโพลนั้นๆ

คำตอบ

หากทำสำเร็จ เมธอดนี้จะแสดงผลทรัพยากร liveChatMessage ในเนื้อหาการตอบกลับ

ข้อผิดพลาด

ตารางต่อไปนี้ระบุข้อความแสดงข้อผิดพลาดที่ API อาจแสดงผลเพื่อตอบสนองต่อการเรียกเมธอดนี้ ดูรายละเอียดเพิ่มเติมได้ที่ YouTube Live Streaming API - Errors

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