LiveBroadcasts: transition

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

Use Case ทั่วไป

ส่งคำขอ

คำขอ 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 ส่งวิดีโอไปยังสตรีมจอภาพของการออกอากาศและสตรีมการออกอากาศของ 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 ระบุว่าข้อมูลเข้าสู่ระบบการให้สิทธิ์ของคำขอระบุผู้ใช้ YouTube CMS ที่ดำเนินการในนามของเจ้าของเนื้อหาที่ระบุไว้ในค่าพารามิเตอร์ พารามิเตอร์นี้มีไว้สำหรับพาร์ทเนอร์เนื้อหาของ YouTube ที่เป็นเจ้าของและจัดการช่อง YouTube หลายช่อง ซึ่งช่วยให้เจ้าของเนื้อหาตรวจสอบสิทธิ์เพียงครั้งเดียวและมีสิทธิ์เข้าถึงข้อมูลวิดีโอและช่องทั้งหมดของตนโดยไม่ต้องระบุข้อมูลเข้าสู่ระบบการตรวจสอบสิทธิ์สำหรับแต่ละช่อง บัญชี CMS ที่ผู้ใช้ตรวจสอบสิทธิ์จะต้องลิงก์กับเจ้าของเนื้อหา YouTube ที่ระบุ
onBehalfOfContentOwnerChannel string
พารามิเตอร์นี้ใช้ได้เฉพาะในคำขอที่ได้รับอนุญาตที่เหมาะสมเท่านั้น พารามิเตอร์นี้ใช้ได้เฉพาะในคำขอที่ได้รับอนุญาตอย่างถูกต้องเท่านั้น หมายเหตุ: พารามิเตอร์นี้มีไว้สำหรับพาร์ทเนอร์เนื้อหาของ YouTube เท่านั้น

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

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

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

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

คำตอบ

หากสำเร็จ เมธอดนี้จะแสดงผลทรัพยากร 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