เอกสารอ้างอิง API

เอกสารอ้างอิง API นี้อธิบายวิธีกำหนดเวลาการถ่ายทอดสดและสตรีมวิดีโอบน YouTube โดยใช้ YouTube Live Streaming API

ประเภททรัพยากร

LiveBroadcasts

ทรัพยากร liveBroadcast หมายถึงกิจกรรมที่จะสตรีมผ่านวิดีโอสดบน YouTube

ดูข้อมูลเพิ่มเติมเกี่ยวกับทรัพยากรนี้ได้ที่การแสดงทรัพยากรและรายการพร็อพเพอร์ตี้

วิธีการ คำขอ HTTP คำอธิบาย
URI ที่สัมพันธ์กับ https://www.googleapis.com/youtube/v3
bind POST /liveBroadcasts/bind เชื่อมโยงการออกอากาศใน YouTube กับสตรีมหรือนำการเชื่อมโยงที่มีอยู่ระหว่างการออกอากาศกับสตรีมออก การออกอากาศสามารถเชื่อมโยงกับสตรีมวิดีโอได้ 1 รายการเท่านั้น แม้ว่าสตรีมวิดีโอจะผูกกับการออกอากาศมากกว่า 1 รายการก็ตาม
delete DELETE /liveBroadcasts ลบประกาศ
insert POST /liveBroadcasts สร้างการออกอากาศ
list GET /liveBroadcasts แสดงรายการการออกอากาศของ YouTube ที่ตรงกับพารามิเตอร์คำขอ API
transition POST /liveBroadcasts/transition เปลี่ยนสถานะการออกอากาศสดของ YouTube และเริ่มขั้นตอนที่เกี่ยวข้องกับสถานะใหม่ ตัวอย่างเช่น เมื่อคุณเปลี่ยนสถานะของการออกอากาศเป็น testing ระบบของ YouTube จะเริ่มส่งวิดีโอไปยังสตรีมบนหน้าจอของการออกอากาศดังกล่าว ก่อนที่จะเรียกใช้เมธอดนี้ คุณควรยืนยันว่าค่าของพร็อพเพอร์ตี้ status.streamStatus สำหรับสตรีมที่ผูกกับการออกอากาศเป็น active
update PUT /liveBroadcasts อัปเดตการออกอากาศ ตัวอย่างเช่น คุณอาจแก้ไขการตั้งค่าการออกอากาศที่กำหนดไว้ในออบเจ็กต์ contentDetails ของทรัพยากร liveBroadcast
cuepoint POST /liveBroadcasts/cuepoint แทรกจุดเริ่มโฆษณาในการถ่ายทอดสด จุดเริ่มโฆษณาอาจทริกเกอร์ช่วงพักโฆษณา

LiveChatBans

แหล่งข้อมูล liveChatBan ระบุผู้ใช้ YouTube และแชทสดใน YouTube ที่ผู้ใช้ถูกแบนไม่ให้เข้าร่วม

ดูข้อมูลเพิ่มเติมเกี่ยวกับทรัพยากรนี้ได้ที่การแสดงทรัพยากรและรายการพร็อพเพอร์ตี้

วิธีการ คำขอ HTTP คำอธิบาย
URI ที่สัมพันธ์กับ https://www.googleapis.com/youtube/v3
delete DELETE /liveChat/bans ยกเลิกการแบนที่ป้องกันไม่ให้ผู้ใช้บางรายมีส่วนร่วมในแชทสด และทำให้ผู้ใช้กลับมาแชทได้อีกครั้ง คำขอ API ต้องได้รับอนุญาตจากเจ้าของช่องหรือผู้ดูแลแชทสดที่เชื่อมโยงกับการแบน
insert POST /liveChat/bans แบนผู้ใช้บางรายจากการเข้าร่วมแชทสด คำขอ API ต้องได้รับอนุญาตจากเจ้าของช่องหรือผู้ดูแลแชทสดที่เชื่อมโยงกับการแบน

LiveChatMessages

ทรัพยากร liveChatMessage แสดงข้อความแชทในแชทสดของ YouTube ทรัพยากรอาจมีรายละเอียดเกี่ยวกับข้อความประเภทต่างๆ รวมถึงข้อความที่โพสต์ใหม่หรือกิจกรรมการให้เงินสนับสนุนของแฟนๆ

ฟีเจอร์แชทสดจะเปิดใช้โดยค่าเริ่มต้นสำหรับการถ่ายทอดสด และจะพร้อมใช้งานขณะถ่ายทอดสด (หลังจากกิจกรรมสิ้นสุดลง แชทสดจะไม่พร้อมใช้งานสำหรับกิจกรรมนั้นอีกต่อไป)

ดูข้อมูลเพิ่มเติมเกี่ยวกับทรัพยากรนี้ได้ที่การแสดงทรัพยากรและรายการพร็อพเพอร์ตี้

วิธีการ คำขอ HTTP คำอธิบาย
URI ที่สัมพันธ์กับ https://www.googleapis.com/youtube/v3
delete DELETE /liveChat/messages ลบข้อความแชท คำขอ API ต้องได้รับอนุญาตจากเจ้าของช่องหรือผู้ดูแลแชทสดที่เชื่อมโยงกับการแบน
insert POST /liveChat/messages เพิ่มข้อความในแชทสด
list GET /liveChat/messages แสดงข้อความแชทสดสำหรับแชทที่เฉพาะเจาะจง

LiveChatModerators

ทรัพยากร liveChatModerator เป็นตัวแทนของผู้ดูแลแชทสดของ YouTube ผู้ดูแลแชทสามารถแบนหรือเลิกแบนผู้ใช้จากแชท นำข้อความออก และดำเนินการด้านการดูแลระบบอื่นๆ สำหรับแชทสดได้

ดูข้อมูลเพิ่มเติมเกี่ยวกับทรัพยากรนี้ได้ที่การแสดงทรัพยากรและรายการพร็อพเพอร์ตี้

วิธีการ คำขอ HTTP คำอธิบาย
URI ที่สัมพันธ์กับ https://www.googleapis.com/youtube/v3
delete DELETE /liveChat/moderators นำผู้ดูแลแชทออก คำขอต้องได้รับอนุญาตจากเจ้าของช่องของการถ่ายทอดสด
insert POST /liveChat/moderators เพิ่มผู้ดูแลใหม่สำหรับแชท คำขอต้องได้รับอนุญาตจากเจ้าของช่องของการถ่ายทอดสด
list GET /liveChat/moderators แสดงรายการผู้ดูแลสำหรับแชทสด คำขอต้องได้รับอนุญาตจากเจ้าของช่องของการถ่ายทอดสด

LiveStreams

แหล่งข้อมูล liveStream มีข้อมูลเกี่ยวกับสตรีมวิดีโอที่คุณกำลังส่งไปยัง YouTube สตรีมมีเนื้อหาที่จะออกอากาศให้ผู้ใช้ YouTube ทราบ เมื่อสร้างแล้ว ทรัพยากร liveStream จะผูกกับทรัพยากร liveBroadcast ได้อย่างน้อย 1 รายการ

ดูข้อมูลเพิ่มเติมเกี่ยวกับทรัพยากรนี้ได้ที่การแสดงทรัพยากรและรายการพร็อพเพอร์ตี้

วิธีการ คำขอ HTTP คำอธิบาย
URI ที่สัมพันธ์กับ https://www.googleapis.com/youtube/v3
delete DELETE /liveStreams ลบสตรีมวิดีโอ
insert POST /liveStreams สร้างสตรีมวิดีโอ สตรีมจะช่วยให้คุณส่งวิดีโอไปยัง YouTube ซึ่งจะเผยแพร่วิดีโอไปยังผู้ชมได้
list GET /liveStreams แสดงรายการสตรีมวิดีโอที่ตรงกับพารามิเตอร์คำขอ API
update PUT /liveStreams อัปเดตสตรีมวิดีโอ หากพร็อพเพอร์ตี้ที่คุณต้องการเปลี่ยนแปลงไม่สามารถอัปเดตได้ คุณต้องสร้างสตรีมใหม่ที่มีการตั้งค่าที่เหมาะสม

SuperChatEvents

ทรัพยากร superChatEvent แสดงถึงข้อความ Super Chat ที่แฟนๆ ซื้อระหว่างสตรีมแบบสดบน YouTube ในแชทสดของ YouTube Super Chat จะโดดเด่นกว่าข้อความอื่นๆ ใน 2 รูปแบบดังนี้

  • Super Chat จะไฮไลต์ด้วยสี
  • Super Chat จะตรึงไว้ในทิกเกอร์ในระยะเวลาหนึ่ง

สีของ Super Chat ระยะเวลาที่จะปักหมุดไว้ในทิกเกอร์ และความยาวสูงสุดของข้อความจะกำหนดโดยยอดรวมการซื้อ ดูข้อมูลเพิ่มเติมเกี่ยวกับ Super Chat ได้ที่ศูนย์ช่วยเหลือของ YouTube

ดูข้อมูลเพิ่มเติมเกี่ยวกับทรัพยากรนี้ได้ที่การแสดงทรัพยากรและรายการพร็อพเพอร์ตี้

วิธีการ คำขอ HTTP คำอธิบาย
URI ที่สัมพันธ์กับ https://www.googleapis.com/youtube/v3
list GET /superChatEvents แสดงรายการกิจกรรม Super Chat จากสตรีมแบบสดของช่องในช่วง 30 วันที่ผ่านมา

ประเภททรัพยากรที่เลิกใช้งาน

FanFundingEvents

ทรัพยากร fanFundingEvent แสดงถึงกิจกรรมการให้เงินสนับสนุนของแฟนๆ ในช่อง YouTube การให้เงินสนับสนุนของแฟนๆ เป็นวิธีที่ช่วยสนับสนุนครีเอเตอร์ YouTube ในการสร้างรายได้ กิจกรรมการให้เงินสนับสนุนของแฟนๆ จะเกิดขึ้นเมื่อผู้ใช้ชำระเงินให้ช่องโดยสมัครใจแบบครั้งเดียว ดูศูนย์ช่วยเหลือของ YouTube เพื่อเรียนรู้เพิ่มเติมเกี่ยวกับการให้เงินสนับสนุนของแฟนๆ

ดูข้อมูลเพิ่มเติมเกี่ยวกับทรัพยากรนี้ได้ที่การแสดงทรัพยากรและรายการพร็อพเพอร์ตี้

วิธีการ คำขอ HTTP คำอธิบาย
URI ที่สัมพันธ์กับ https://www.googleapis.com/youtube/v3
list GET /fanFundingEvents แสดงรายการกิจกรรมการให้เงินสนับสนุนของแฟนๆ สำหรับช่อง คำขอ API ต้องได้รับอนุญาตจากเจ้าของช่อง

LiveCuepoints

ทรัพยากร liveCuepoint จะเริ่มต้นช่วงพักโฆษณาในสตรีมวิดีโอออกอากาศ

หมายเหตุ: คำสั่ง API สำหรับควบคุมจุดเริ่มโฆษณาเป็นส่วนหนึ่งของ API สำหรับ Content ID ของ YouTube และมีข้อกำหนดการให้สิทธิ์ที่แตกต่างจากคำขอจัดการทรัพยากร liveBroadcast และ liveStream

ดูข้อมูลเพิ่มเติมเกี่ยวกับทรัพยากรนี้ได้ที่การแสดงทรัพยากรและรายการพร็อพเพอร์ตี้

วิธีการ คำขอ HTTP คำอธิบาย
URI ที่สัมพันธ์กับ https://www.googleapis.com/
insert POST /liveCuepoints แทรกจุดเริ่มโฆษณาในการถ่ายทอดสด ปัจจุบันคำขอวิธีนี้ต้องได้รับอนุญาตจากบัญชีที่เชื่อมโยงกับเจ้าของเนื้อหา YouTube

ผู้สนับสนุน

ทรัพยากร sponsor หมายถึงผู้สนับสนุนช่อง YouTube ผู้สนับสนุนจะให้การสนับสนุนทางการเงินตามรอบ เช่น ค่าธรรมเนียมการสมัครใช้บริการหรือการเป็นสมาชิก ให้แก่ครีเอเตอร์ และได้รับสิทธิประโยชน์พิเศษ เช่น ผู้สนับสนุนจะแชทได้เมื่อครีเอเตอร์เปิดโหมดสำหรับผู้สนับสนุนเท่านั้น

ดูข้อมูลเพิ่มเติมเกี่ยวกับทรัพยากรนี้ได้ที่การแสดงทรัพยากรและรายการพร็อพเพอร์ตี้

วิธีการ คำขอ HTTP คำอธิบาย
URI ที่สัมพันธ์กับ https://www.googleapis.com/youtube/v3
list GET /sponsors แสดงรายชื่อผู้สนับสนุนของช่อง คำขอ API ต้องได้รับอนุญาตจากเจ้าของช่อง