LiveBroadcasts: control

หมายเหตุ: เราเลิกใช้งานเมธอด liveBroadcasts.control แล้ว และจะหยุดให้บริการในวันที่ 1 ตุลาคม 2020 เป็นต้นไป หลังจากวันที่ดังกล่าว การเรียกวิธีนี้ทั้งหมดจะแสดงข้อผิดพลาดที่ไม่ได้รับอนุญาต (403) และระบบจะนําวิธีการดังกล่าวออกโดยสมบูรณ์ในภายหลัง

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

ควบคุมแถบสเลทที่จะแสดงในสตรีมการออกอากาศได้

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

ส่งคำขอ

คำขอ HTTP

POST https://www.googleapis.com/youtube/v3/liveBroadcasts/control

การให้สิทธิ์

คําขอนี้ต้องมีการให้สิทธิ์กับขอบเขตต่อไปนี้อย่างน้อย 1 ขอบเขต (อ่านเพิ่มเติมเกี่ยวกับการตรวจสอบสิทธิ์และการให้สิทธิ์)

ขอบเขต
https://www.googleapis.com/auth/youtube
https://www.googleapis.com/auth/youtube.force-ssl

พารามิเตอร์

ตารางต่อไปนี้จะแสดงพารามิเตอร์ที่คําค้นหานี้รองรับ พารามิเตอร์ทั้งหมดที่แสดงคือพารามิเตอร์การค้นหา

พารามิเตอร์
พารามิเตอร์ที่จําเป็น
id string
พารามิเตอร์ id จะระบุรหัสการถ่ายทอดสดของ YouTube ซึ่งระบุการออกอากาศที่มีการอัปเดตแถบสเลทที่ไม่ซ้ํา
part string
พารามิเตอร์ part ระบุรายการพร็อพเพอร์ตี้ทรัพยากร liveBroadcast ที่คั่นด้วยคอมมาอย่างน้อย 1 รายการซึ่งการตอบกลับของ API จะรวม ชื่อ part ที่คุณใส่ไว้ในค่าพารามิเตอร์ได้คือ id, snippet, contentDetails และ status
พารามิเตอร์ที่ไม่บังคับ
displaySlate boolean
พารามิเตอร์ displaySlate ระบุว่ามีการเปิดใช้หรือปิดใช้แถบสเลท
offsetTimeMs unsigned long
พารามิเตอร์ offsetTimeMs จะระบุการชดเชยเวลาเชิงบวกเมื่อเกิดการเปลี่ยนแปลงแถบสเลทที่ระบุ ค่านี้จะวัดเป็นมิลลิวินาทีนับจากจุดเริ่มต้นของสตรีมการตรวจสอบการออกอากาศ ซึ่งเป็นเวลาที่ช่วงทดสอบของการออกอากาศเริ่มต้น แม้จะระบุเป็นมิลลิวินาที แต่ค่าที่ได้เป็นเพียงค่าประมาณโดยประมาณและ YouTube จะดําเนินการตามที่ขอโดยเร็วที่สุดเท่าที่จะทําได้

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

สําคัญ: คุณควรระบุค่าสําหรับพารามิเตอร์นี้เฉพาะในกรณีที่สตรีมการออกอากาศล่าช้าเท่านั้น
onBehalfOfContentOwner string
พารามิเตอร์นี้ใช้ได้เฉพาะในคําขอที่ได้รับอนุญาตอย่างถูกต้อง หมายเหตุ: พารามิเตอร์นี้มีไว้สําหรับพาร์ทเนอร์เนื้อหาของ YouTube เท่านั้น

พารามิเตอร์ onBehalfOfContentOwner ระบุว่าข้อมูลเข้าสู่ระบบการให้สิทธิ์ของคําขอระบุผู้ใช้ CMS ของ YouTube ที่ทําหน้าที่ในนามของเจ้าของเนื้อหาที่ระบุในค่าพารามิเตอร์ พารามิเตอร์นี้มีไว้สําหรับพาร์ทเนอร์เนื้อหา YouTube ที่เป็นเจ้าของและจัดการช่อง YouTube ต่างๆ จํานวนมาก ช่วยให้เจ้าของเนื้อหาตรวจสอบสิทธิ์ได้เพียงครั้งเดียวและเข้าถึงข้อมูลวิดีโอและช่องทั้งหมดได้โดยไม่ต้องระบุข้อมูลเข้าสู่ระบบของแต่ละช่อง บัญชี CMS ที่ผู้ใช้ตรวจสอบสิทธิ์ด้วยจะต้องลิงก์กับเจ้าของเนื้อหาของ YouTube ที่ระบุ
onBehalfOfContentOwnerChannel string
พารามิเตอร์นี้ใช้ได้เฉพาะในคําขอที่ได้รับอนุญาตอย่างถูกต้อง พารามิเตอร์นี้ใช้ได้เฉพาะในคําขอที่ได้รับอนุญาตอย่างถูกต้อง หมายเหตุ: พารามิเตอร์นี้มีไว้สําหรับพาร์ทเนอร์เนื้อหา YouTube เท่านั้น

พารามิเตอร์ onBehalfOfContentOwnerChannel ระบุรหัสช่อง YouTube ของช่องที่กําลังเพิ่มวิดีโอ ต้องใช้พารามิเตอร์นี้เมื่อคําขอระบุค่าของพารามิเตอร์ onBehalfOfContentOwner และจะใช้ร่วมกับพารามิเตอร์นั้นได้เท่านั้น นอกจากนี้ คําขอต้องได้รับอนุญาตโดยใช้บัญชี CMS ที่ลิงก์กับเจ้าของเนื้อหาซึ่งพารามิเตอร์ onBehalfOfContentOwner ระบุ สุดท้าย แชแนลที่ค่าพารามิเตอร์ onBehalfOfContentOwnerChannel ระบุไว้จะต้องลิงก์กับเจ้าของเนื้อหาที่พารามิเตอร์ onBehalfOfContentOwner ระบุไว้

พารามิเตอร์นี้มีไว้สําหรับพาร์ทเนอร์เนื้อหา YouTube ที่เป็นเจ้าของและจัดการช่อง YouTube ต่างๆ จํานวนมาก ช่วยให้เจ้าของเนื้อหาตรวจสอบสิทธิ์ได้ 1 ครั้งและดําเนินการในนามของช่องที่ระบุไว้ในค่าพารามิเตอร์ โดยไม่ต้องระบุข้อมูลเข้าสู่ระบบของแต่ละช่อง
walltime datetime
พารามิเตอร์ walltime จะระบุเวลาของนาฬิกาที่จะเปลี่ยนแปลงแถบสเลทที่ระบุ ค่านี้ระบุในรูปแบบ ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ)

เนื้อหาของคำขอ

ไม่ต้องให้เนื้อหาคําขอเมื่อเรียกใช้วิธีการนี้

คำตอบ

หากใช้วิธีนี้ วิธีนี้จะแสดงทรัพยากร LiveBroadcast ในเนื้อหาการตอบกลับ

ข้อผิดพลาด

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

ประเภทข้อผิดพลาด รายละเอียดข้อผิดพลาด คำอธิบาย
backendError errorDisplaySlate เกิดข้อผิดพลาดขณะดําเนินการตามที่ขอ
forbidden (403) liveBroadcastControlNotAllowed การดําเนินการที่ขอจะได้รับอนุญาตเฉพาะเมื่อสถานะของการออกอากาศเป็น live เท่านั้น
insufficientPermissions insufficientLivePermissions ผู้ใช้ไม่ได้รับอนุญาตสําหรับการดําเนินการที่ขอ ซึ่งอาจเป็นเพราะผู้ใช้ไม่ได้รับอนุญาตให้สตรีมแบบสด
insufficientPermissions liveStreamingNotEnabled ผู้ใช้ที่ให้สิทธิ์คําขอไม่ได้เปิดใช้สตรีมวิดีโอสดบน YouTube ผู้ใช้จะดูข้อมูลเพิ่มเติมได้ที่ https://www.youtube.com/features
invalidValue (400) conflictingTimeFields ระบุ offsetTimeMs และ walltime ได้เพียงรายการเดียว
invalidValue (400) invalidOffsetTimeMs ค่าพารามิเตอร์ offsetTimeMs ไม่ถูกต้อง ค่าพารามิเตอร์ต้องเป็นค่าบวก แต่ระบุพารามิเตอร์ได้เมื่อเปิดใช้สตรีมการตรวจสอบการออกอากาศเท่านั้น
invalidValue (400) invalidWalltime ค่าพารามิเตอร์ walltime ไม่ถูกต้อง
notFound (404) liveBroadcastNotFound ไม่มีการออกอากาศที่ระบุโดยพารามิเตอร์ id
required (400) actionRequired คําขอ API ต้องระบุการดําเนินการอย่างน้อย 1 รายการ ในขณะนี้ การดําเนินการที่สนับสนุนเพียงอย่างเดียวคือความสามารถในการเปิดหรือปิดแถบสเลท
required (400) idRequired พารามิเตอร์ id ที่จําเป็นต้องระบุการออกอากาศที่จะอัปเดต

ลองใช้เลย

ใช้ APIs Explorer เพื่อเรียกใช้ API นี้และดูคําขอและการตอบกลับ API