LiveBroadcasts: update

อัปเดตการออกอากาศ เช่น คุณอาจแก้ไขการตั้งค่าการออกอากาศที่กําหนดไว้ในออบเจ็กต์ contentDetails ของliveBroadcast ทรัพยากร

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

ส่งคำขอ

คำขอ HTTP

PUT https://www.googleapis.com/youtube/v3/liveBroadcasts

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

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

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

พารามิเตอร์

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

พารามิเตอร์
พารามิเตอร์ที่จำเป็น
part string
พารามิเตอร์ part มีไว้เพื่อวัตถุประสงค์ 2 อย่างในการดำเนินการนี้ ซึ่งจะระบุพร็อพเพอร์ตี้ที่การดำเนินการเขียนจะตั้งค่า รวมถึงพร็อพเพอร์ตี้ที่การตอบกลับของ API จะรวมไว้ด้วย

พร็อพเพอร์ตี้ part ที่คุณรวมไว้ในค่าพารามิเตอร์ได้ ได้แก่ id, snippet, contentDetails, monetizationDetails และ status

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

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

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

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

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

ระบุทรัพยากรการถ่ายทอดสดในเนื้อหาคำขอ สำหรับทรัพยากรนั้น

  • คุณต้องระบุค่าสำหรับพร็อพเพอร์ตี้ต่อไปนี้

    • id
    • snippet.scheduledStartTime
    • contentDetails.monitorStream.enableMonitorStream
    • contentDetails.monitorStream.broadcastStreamDelayMs

  • คุณตั้งค่าพร็อพเพอร์ตี้ต่อไปนี้ได้

    • snippet.title
    • snippet.description
    • snippet.scheduledStartTime
    • snippet.scheduledEndTime
    • status.privacyStatus
    • contentDetails.monitorStream.enableMonitorStream
    • contentDetails.monitorStream.broadcastStreamDelayMs
    • contentDetails.enableAutoStart
    • contentDetails.enableAutoStop
    • contentDetails.enableClosedCaptions
    • contentDetails.enableDvr
    • contentDetails.enableEmbed
    • contentDetails.recordFromStart
    • monetizationDetails.cuepointSchedule.pauseAdsUntil

    หากคุณส่งคำขออัปเดต แต่ไม่ได้ระบุค่าสำหรับพร็อพเพอร์ตี้ที่มีค่าอยู่แล้ว ระบบจะลบค่าที่มีอยู่ของพร็อพเพอร์ตี้นั้น

คำตอบ

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

ข้อผิดพลาด

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

ประเภทข้อผิดพลาด รายละเอียดข้อผิดพลาด คำอธิบาย
forbidden (403) closedCaptionsTypeModificationNotAllowed คุณแก้ไขค่า contentDetails.closedCaptionsType ได้ก็ต่อเมื่อการออกอากาศอยู่ในสถานะ created หรือ ready
forbidden (403) enabledModificationNotAllowed ช่อง enabled เป็นแบบอ่านอย่างเดียว
forbidden (403) scheduleStrategyModificationNotAllowed ฟิลด์ scheduleStrategy เป็นแบบอ่านอย่างเดียว
forbidden (403) repeatIntervalSecsModificationNotAllowed ช่อง repeatIntervalSecs เป็นแบบอ่านอย่างเดียว
forbidden (403) pauseAdsUntilModificationNotAllowed ไม่สามารถแก้ไขช่อง pauseAdsUntil ข้อผิดพลาดนี้อาจเกิดขึ้นจากสาเหตุต่อไปนี้
  • ไม่ได้ตั้งค่าฟิลด์ monetizationDetails.cuepointSchedule.enabled เป็น true คุณจะตั้งค่าช่องนี้ได้โดยใช้ YouTube Studio เท่านั้น
  • การออกอากาศไม่ได้ถ่ายทอดสด
forbidden (403) enableAutoStartModificationNotAllowed คุณแก้ไขค่า contentDetails.enableAutoStart ได้ก็ต่อเมื่อสตรีมไม่ได้ใช้งานและออกอากาศอยู่ในสถานะ created หรือ ready
forbidden (403) enableClosedCaptionsModificationNotAllowed จะแก้ไขค่า contentDetails.enableClosedCaptions ได้เมื่อสถานะของการออกอากาศเป็น created หรือ ready เท่านั้น
forbidden (403) enableDvrModificationNotAllowed คุณแก้ไขค่า contentDetails.enableDvr ได้ก็ต่อเมื่อสถานะของการออกอากาศเป็น created หรือ ready เท่านั้น
forbidden (403) enableMonitorStreamModificationNotAllowed คุณแก้ไขค่า contentDetails.monitorStream.enableMonitorStream ได้ก็ต่อเมื่อสถานะของการออกอากาศเป็น created หรือ ready เท่านั้น
forbidden (403) recordFromStartModificationNotAllowed คุณแก้ไขค่า contentDetails.recordFromStart ได้ก็ต่อเมื่อสถานะของการออกอากาศเป็น created หรือ ready เท่านั้น
insufficientPermissions insufficientLivePermissions คำขอไม่ได้รับอนุญาตให้อัปเดตการถ่ายทอดสดที่ระบุ ดูข้อมูลเพิ่มเติมได้ที่การใช้การตรวจสอบสิทธิ์ OAuth2
insufficientPermissions liveStreamingNotEnabled ผู้ใช้ที่อนุญาตให้ส่งคำขอนี้ไม่มีสิทธิ์สตรีมวิดีโอสดบน YouTube ผู้ใช้ดูข้อมูลเพิ่มเติมได้ที่ https://www.youtube.com/features
invalidValue (400) invalidAutoStart ทรัพยากรการถ่ายทอดสดมีค่าที่ไม่ถูกต้องสำหรับพร็อพเพอร์ตี้ contentDetails.enableAutoStart คุณแก้ไขการตั้งค่า enableAutoStart สําหรับการออกอากาศแบบถาวรไม่ได้
invalidValue (400) invalidAutoStop ทรัพยากรการถ่ายทอดสดมีค่าที่ไม่ถูกต้องสำหรับพร็อพเพอร์ตี้ contentDetails.enableAutoStop คุณแก้ไขการตั้งค่า enableAutoStop สำหรับการออกอากาศต่อเนื่องไม่ได้
invalidValue (400) invalidDescription ทรัพยากรการถ่ายทอดสดไม่ได้ระบุค่าที่ถูกต้องสำหรับพร็อพเพอร์ตี้ snippet.description snippet.description มีความยาวได้ไม่เกิน 5,000 อักขระ
invalidValue (400) invalidEmbedSetting ทรัพยากรการถ่ายทอดสดมีค่าที่ไม่ถูกต้องสำหรับพร็อพเพอร์ตี้ contentDetails.enable_embed คุณฝังการออกอากาศนี้ไม่ได้
invalidValue (400) invalidEnableClosedCaptions ในทรัพยากรการถ่ายทอดสด ค่าของพร็อพเพอร์ตี้ contentDetails.enableClosedCaptions ใช้ร่วมกับค่าการตั้งค่า contentDetails.closedCaptionType ไม่ได้ แก้ไขทรัพยากรให้รวมพร็อพเพอร์ตี้เพียงรายการใดรายการหนึ่ง แล้วส่งคำขออีกครั้ง
invalidValue (400) invalidLatencyPreferenceOptions ทรัพยากรการถ่ายทอดสดมีค่าที่ไม่ถูกต้องสำหรับพร็อพเพอร์ตี้ contentDetails.latencyPreference ค่ากำหนดเวลาในการตอบสนองนี้รองรับการตั้งค่าบางรายการเท่านั้น
invalidValue (400) invalidPauseAdsUntil ทรัพยากรการถ่ายทอดสดมีค่าที่ไม่ถูกต้องสำหรับพร็อพเพอร์ตี้ monetizationDetails.cuepointSchedule.pauseAdsUntil ข้อผิดพลาดนี้อาจเกิดขึ้นจากสาเหตุต่อไปนี้
  • ค่า monetizationDetails.cuepointSchedule.pauseAdsUntil ไม่ได้ระบุไว้ในรูปแบบ ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ)
  • ค่า monetizationDetails.cuepointSchedule.pauseAdsUntil ไม่ใช่ค่าในอนาคต
  • ค่า monetizationDetails.cuepointSchedule.pauseAdsUntil อยู่ห่างจากเวลาปัจจุบันมากกว่า 10 นาที
invalidValue (400) invalidPrivacyStatus ทรัพยากร liveBroadcast ไม่ได้ระบุสถานะความเป็นส่วนตัวที่ถูกต้อง ดูค่า privacyStatus ที่ถูกต้อง
invalidValue (400) invalidProjection ทรัพยากรการถ่ายทอดสดมีค่าที่ไม่ถูกต้องสำหรับพร็อพเพอร์ตี้ contentDetails.projection ไม่สามารถตั้งค่าการฉายภาพของการออกอากาศแบบถาวรเป็น 360 ได้
invalidValue (400) invalidScheduledEndTime ทรัพยากร LiveBroadcast มีค่าที่ไม่ถูกต้องสำหรับพร็อพเพอร์ตี้ snippet.scheduledEndTime เวลาสิ้นสุดที่กำหนดไว้ต้องเป็นไปตามเวลาเริ่มต้นที่กำหนดไว้
invalidValue (400) invalidScheduledStartTime ทรัพยากรการถ่ายทอดสดมีค่าที่ไม่ถูกต้องสำหรับพร็อพเพอร์ตี้ snippet.scheduledStartTime เวลาเริ่มต้นที่กำหนดไว้ต้องเป็นเวลาในอนาคต
invalidValue (400) invalidTitle ทรัพยากรการถ่ายทอดสดไม่ได้ระบุค่าที่ถูกต้องสำหรับพร็อพเพอร์ตี้ snippet.title snippet.title ต้องมีความยาวระหว่าง 1 ถึง 100 อักขระ
notFound (404) liveBroadcastNotFound พร็อพเพอร์ตี้ id ที่ระบุในทรัพยากรการถ่ายทอดสดไม่ได้ระบุการออกอากาศ
required (400) broadcastStreamDelayMsRequired ทรัพยากรการถ่ายทอดสดไม่ได้ระบุพร็อพเพอร์ตี้ contentDetails.monitorStream.broadcastStreamDelayMs
required (400) enableMonitorStreamRequired แหล่งข้อมูล LiveBroadcast ไม่ได้ระบุพร็อพเพอร์ตี้ contentDetails.monitorStream.enableMonitorStream
required (400) idRequired ทรัพยากรการถ่ายทอดสดต้องมีและระบุค่าสำหรับพร็อพเพอร์ตี้ id
required (400) scheduledEndTimeRequired ทรัพยากรการถ่ายทอดสดไม่ได้ระบุพร็อพเพอร์ตี้ snippet.scheduledEndTime
required (400) scheduledStartTimeRequired ทรัพยากรการถ่ายทอดสดไม่ได้ระบุพร็อพเพอร์ตี้ snippet.scheduledStartTime

ลองใช้งาน

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