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

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

ระบุทรัพยากร LiveBroadcast ในเนื้อหาคำขอ สำหรับแหล่งข้อมูลดังกล่าว

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

    • 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

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

คำตอบ

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

ข้อผิดพลาด

ตารางต่อไปนี้ระบุข้อความแสดงข้อผิดพลาดที่ 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 แหล่งข้อมูล Live Broadcast มีค่าที่ไม่ถูกต้องสำหรับพร็อพเพอร์ตี้ contentDetails.enableAutoStart คุณไม่สามารถแก้ไขการตั้งค่า enableAutoStart สำหรับการออกอากาศอย่างต่อเนื่อง
invalidValue (400) invalidAutoStop แหล่งข้อมูล Live Broadcast มีค่าที่ไม่ถูกต้องสำหรับพร็อพเพอร์ตี้ contentDetails.enableAutoStop คุณ แก้ไขการตั้งค่า enableAutoStop สำหรับการออกอากาศต่อเนื่องไม่ได้
invalidValue (400) invalidDescription ทรัพยากร LiveBroadcast ไม่ได้ระบุค่าที่ถูกต้องสำหรับพร็อพเพอร์ตี้ snippet.description snippet.description มีอักขระได้สูงสุด 5,000 ตัว
invalidValue (400) invalidEmbedSetting ทรัพยากร LiveBroadcast มีค่าที่ไม่ถูกต้องสำหรับพร็อพเพอร์ตี้ contentDetails.enable_embed คุณไม่สามารถฝังการออกอากาศนี้
invalidValue (400) invalidEnableClosedCaptions ในทรัพยากร LiveBroadcast ค่าของพร็อพเพอร์ตี้ contentDetails.enableClosedCaptions ใช้ไม่ได้กับการตั้งค่า contentDetails.closedCaptionType แก้ไขทรัพยากรให้รวมพร็อพเพอร์ตี้รายการใดรายการหนึ่งจาก 2 รายการเท่านั้น แล้วส่งคำขออีกครั้ง
invalidValue (400) invalidLatencyPreferenceOptions แหล่งข้อมูล Live Broadcast มีค่าที่ไม่ถูกต้องสำหรับพร็อพเพอร์ตี้ contentDetails.latencyPreference ค่ากำหนดเวลาในการตอบสนองนี้ไม่รองรับการตั้งค่าบางอย่าง
invalidValue (400) invalidPauseAdsUntil แหล่งข้อมูล Live Broadcast มีค่าที่ไม่ถูกต้องสำหรับ พร็อพเพอร์ตี้ 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 ทรัพยากร LiveBroadcast มีค่าที่ไม่ถูกต้องสำหรับพร็อพเพอร์ตี้ contentDetails.projection ตั้งค่าการฉายภาพของการออกอากาศต่อเนื่องเป็น 360 ไม่ได้
invalidValue (400) invalidScheduledEndTime ทรัพยากร LiveBroadcast มีค่าที่ไม่ถูกต้องสำหรับพร็อพเพอร์ตี้ snippet.scheduledEndTime เวลาสิ้นสุดที่กำหนดไว้ต้องเป็นไปตามเวลาเริ่มต้นที่กำหนดไว้
invalidValue (400) invalidScheduledStartTime ทรัพยากร LiveBroadcast มีค่าที่ไม่ถูกต้องสำหรับพร็อพเพอร์ตี้ snippet.scheduledStartTime เวลาเริ่มต้นที่กำหนดไว้ต้องเป็นวันที่ในอนาคต
invalidValue (400) invalidTitle ทรัพยากร LiveBroadcast ไม่ได้ระบุค่าที่ถูกต้องสำหรับพร็อพเพอร์ตี้ snippet.title snippet.title ต้องมีความยาวระหว่าง 1 ถึง 100 อักขระ
notFound (404) liveBroadcastNotFound พร็อพเพอร์ตี้ id ที่ระบุในแหล่งข้อมูลการถ่ายทอดสดไม่ได้ระบุการออกอากาศ
required (400) broadcastStreamDelayMsRequired แหล่งข้อมูล LiveBroadcast ไม่ได้ระบุพร็อพเพอร์ตี้ contentDetails.monitorStream.broadcastStreamDelayMs
required (400) enableMonitorStreamRequired แหล่งข้อมูล LiveBroadcast ไม่ได้ระบุพร็อพเพอร์ตี้ contentDetails.monitorStream.enableMonitorStream
required (400) idRequired ทรัพยากร LiveBroadcast ต้องมีและระบุค่าสำหรับพร็อพเพอร์ตี้ id
required (400) scheduledEndTimeRequired แหล่งข้อมูล LiveBroadcast ไม่ได้ระบุพร็อพเพอร์ตี้ snippet.scheduledEndTime
required (400) scheduledStartTimeRequired แหล่งข้อมูล LiveBroadcast ไม่ได้ระบุพร็อพเพอร์ตี้ snippet.scheduledStartTime

ลองใช้งาน

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