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

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

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

LiveBroadcasts

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

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

วิธีการ คำขอ HTTP คำอธิบาย
URI ที่เกี่ยวข้องกับ https://www.googleapis.com/youtube/v3
bind POST /liveBroadcasts/bind เชื่อมโยงการออกอากาศ YouTube กับสตรีมหรือนำการเชื่อมโยงที่มีอยู่ระหว่างการออกอากาศกับสตรีมออก การออกอากาศจะเชื่อมโยงกับสตรีมวิดีโอได้เพียงรายการเดียว แต่สตรีมวิดีโอจะเชื่อมโยงกับการออกอากาศได้มากกว่า 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 ได้รับการปักหมุดในทิกเกอร์ และความยาวสูงสุดของข้อความล้วนขึ้นอยู่กับจำนวนเงินที่ซื้อ ดูข้อมูลเพิ่มเติมเกี่ยวกับ 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 สำหรับการควบคุมจุดเริ่มต้นเล่นเป็นส่วนหนึ่งของ YouTube Content ID API และมีข้อกำหนดการให้สิทธิ์แตกต่างจากคำขอจัดการทรัพยากร 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 ต้องได้รับอนุญาตจากเจ้าของช่อง