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