LiveBroadcasts: transition

เปลี่ยนสถานะการถ่ายทอดสดของ YouTube และเริ่มกระบวนการที่เกี่ยวข้องกับสถานะใหม่ เช่น เมื่อคุณเปลี่ยนสถานะการออกอากาศเป็น testing YouTube จะเริ่มส่งวิดีโอไปยังสตรีมการตรวจสอบของการออกอากาศนั้น ก่อนเรียกใช้วิธีนี้ คุณควรยืนยันว่าค่าของพร็อพเพอร์ตี้ status.streamStatus สําหรับสตรีมที่เชื่อมโยงกับการออกอากาศคือ active

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

ส่งคำขอ

คำขอ HTTP

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

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

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

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

พารามิเตอร์

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

พารามิเตอร์
พารามิเตอร์ที่จําเป็น
broadcastStatus string
พารามิเตอร์ broadcastStatus จะระบุสถานะที่การออกอากาศมีการเปลี่ยนแปลง โปรดทราบว่าหากต้องการเปลี่ยนการออกอากาศเป็นสถานะ testing หรือ live ค่า status.streamStatus ต้องเป็น active สําหรับสตรีมที่มีการเชื่อมโยง

ค่าที่ยอมรับได้ ได้แก่
  • complete – การออกอากาศสิ้นสุดแล้ว YouTube จะหยุดส่งวิดีโอ
  • live – การออกอากาศปรากฏต่อกลุ่มเป้าหมาย YouTube จะส่งวิดีโอไปยังสตรีมการตรวจสอบของการออกอากาศและสตรีมการออกอากาศ
  • testing – เริ่มทดสอบการออกอากาศ YouTube จะส่งวิดีโอไปยังสตรีมการตรวจสอบของการออกอากาศ โปรดทราบว่าคุณสามารถเปลี่ยนการออกอากาศเป็นสถานะ testing ได้ก็ต่อเมื่อตั้งค่าพร็อพเพอร์ตี้ contentDetails.monitorStream.enableMonitorStream เป็น true
id string
พารามิเตอร์ id จะระบุรหัสที่ไม่ซ้ํากันของการออกอากาศที่จะเปลี่ยนเป็นสถานะอื่น
part string
พารามิเตอร์ part ระบุรายการพร็อพเพอร์ตี้ทรัพยากร liveBroadcast ที่คั่นด้วยคอมมาอย่างน้อย 1 รายการซึ่งการตอบกลับของ API จะรวม ชื่อ part ที่คุณใส่ไว้ในค่าพารามิเตอร์ได้คือ id, snippet, contentDetails และ status
พารามิเตอร์ที่ไม่บังคับ
onBehalfOfContentOwner string
พารามิเตอร์นี้ใช้ได้เฉพาะในคําขอที่ได้รับอนุญาตอย่างถูกต้อง หมายเหตุ: พารามิเตอร์นี้มีไว้สําหรับพาร์ทเนอร์เนื้อหาของ YouTube เท่านั้น

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

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

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

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

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

คำตอบ

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

ข้อผิดพลาด

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

ประเภทข้อผิดพลาด รายละเอียดข้อผิดพลาด คำอธิบาย
backendError errorExecutingTransition เกิดข้อผิดพลาดขณะเปลี่ยนสถานะการออกอากาศ
forbidden (403) errorStreamInactive การเปลี่ยนรุ่นที่ขอไม่ได้รับอนุญาตเมื่อสตรีมที่เชื่อมโยงกับการออกอากาศไม่ทํางาน
forbidden (403) invalidTransition การถ่ายทอดสดไม่สามารถเปลี่ยนจากสถานะปัจจุบันเป็นสถานะที่ขอได้
forbidden (403) redundantTransition การถ่ายทอดสดอยู่ในสถานะตามที่ขอหรือกําลังดําเนินการตามสถานะที่ขอ
insufficientPermissions insufficientLivePermissions โดยไม่ได้รับอนุญาตให้เปลี่ยนการถ่ายทอดสด
insufficientPermissions livePermissionBlocked ผู้ใช้ที่ให้สิทธิ์คําขอไม่สามารถสตรีมวิดีโอสดบน YouTube ได้ในขณะนี้ ดูรายละเอียดที่อธิบายสาเหตุที่ผู้ใช้สตรีมวิดีโอสดไม่ได้ในการตั้งค่าช่องของผู้ใช้ที่ https://www.youtube.com/features
insufficientPermissions liveStreamingNotEnabled ผู้ใช้ที่ให้สิทธิ์คําขอไม่ได้เปิดใช้สตรีมวิดีโอสดบน YouTube ผู้ใช้จะดูข้อมูลเพิ่มเติมได้ที่ https://www.youtube.com/features
notFound (404) liveBroadcastNotFound ไม่มีการออกอากาศที่ระบุโดยพารามิเตอร์ id
rateLimitExceeded (403) userRequestsExceedRateLimit ผู้ใช้ส่งคําขอมากเกินไปในกรอบเวลาที่กําหนด
required (400) idRequired พารามิเตอร์ id ที่จําเป็นต้องระบุการออกอากาศที่คุณต้องการเปลี่ยนสถานะ
required (400) statusRequired คําขอ API ต้องระบุค่าของพารามิเตอร์ status

ลองใช้เลย

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