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

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

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

การถ่ายทอดสด

ทรัพยากร 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 แทรกจุดเริ่มโฆษณาลงในการถ่ายทอดสด จุดเริ่มโฆษณาอาจทริกเกอร์ช่วงพักโฆษณา

แชทสด

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

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

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

ข้อความแชทสด

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

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

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

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

ผู้ดูแลแชทสด

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

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

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

สตรีมแบบสด

ทรัพยากร 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 อัปเดตสตรีมวิดีโอ หากอัปเดตพร็อพเพอร์ตี้ที่ต้องการเปลี่ยนแปลงไม่ได้ คุณจะต้องสร้างสตรีมใหม่ที่มีการตั้งค่าที่เหมาะสม

ผู้สนับสนุน

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

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

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

กิจกรรม SuperChat

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

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

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

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

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

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

กิจกรรมการให้เงินสนับสนุนของแฟนๆ

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

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

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