เปลี่ยนสถานะของการประกาศแบบสดของ YouTube และเริ่มกระบวนการใดๆ ที่เชื่อมโยงกับสถานะใหม่ ตัวอย่างเช่น เมื่อคุณเปลี่ยนสถานะการประกาศเป็น testing YouTube จะเริ่มส่งวิดีโอไปยังสตรีมจอภาพของการประกาศนั้น ก่อนที่จะเรียกใช้เมธอดนี้ คุณควรยืนยันว่าค่าของพร็อพเพอร์ตี้ status.streamStatus สำหรับสตรีมที่ผูกกับการประกาศเป็น active
Use Case ทั่วไป
ส่งคำขอ
คำขอ 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 สำหรับสตรีมที่ผูกกับการประกาศค่าที่ยอมรับมีดังนี้
|
|
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 อาจแสดงผลเพื่อตอบสนองต่อการเรียกใช้เมธอดนี้ ดูรายละเอียดเพิ่มเติมได้ที่ 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 |
ผู้ใช้ส่งคำขอมากเกินไปในช่วงเวลาที่กำหนด |
rateLimitExceeded (403) |
concurrentBroadcastsExceedLimit |
ช่องมีการถ่ายทอดสดพร้อมกันครบตามจำนวนสูงสุดแล้ว คุณต้องหยุดการประกาศแบบสดอย่างน้อย 1 รายการก่อนจึงจะเริ่มการประกาศอื่นในช่องได้ |
rateLimitExceeded (403) |
sharedIngestionBroadcastsExceedLimit |
ช่องมีการถ่ายทอดสดที่แชร์แหล่งที่มาของการส่งผ่านข้อมูลครบตามจำนวนสูงสุดแล้ว คุณต้องหยุดการประกาศแบบสดอย่างน้อย 1 รายการก่อนจึงจะเริ่มการประกาศที่ขอได้ |
required (400) |
idRequired |
พารามิเตอร์ id ที่จำเป็นต้องระบุการประกาศที่คุณต้องการเปลี่ยนสถานะ |
required (400) |
statusRequired |
คำขอ API ต้องระบุค่าสำหรับพารามิเตอร์ status |
ลองใช้งาน
ใช้ APIs Explorer เพื่อเรียกใช้ API นี้และดูคำขอและการตอบกลับของ API