ข้อมูลอ้างอิงของ 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 แทรกคิวพอยต์ลงในการถ่ายทอดสด 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 แสดงรายการข้อความแชทสดของแชทที่เฉพาะเจาะจง
streamList การสาธิตโค้ด เปิดใช้การเชื่อมต่อการสตรีมฝั่งเซิร์ฟเวอร์เพื่อรับข้อความแชทสดสำหรับแชทที่เฉพาะเจาะจงโดยมีความหน่วงต่ำ

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 สำหรับควบคุมคิวพอยต์เป็นส่วนหนึ่งของ 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 ต้องได้รับอนุญาตจากเจ้าของช่อง