LiveBroadcasts: transition

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

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

ส่งคำขอ

คำขอ HTTP

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

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

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

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

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

อย่าระบุเนื้อหาคำขอเมื่อเรียกใช้เมธอดนี้

คำตอบ

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

ข้อผิดพลาด

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

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

ลองใช้งาน

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