อัปเดตประกาศ ตัวอย่างเช่น คุณจะแก้ไขการตั้งค่าการออกอากาศที่กําหนดไว้ในออบเจ็กต์ contentDetails
ของทรัพยากร liveBroadcast
ได้
กรณีการใช้งานทั่วไป
ส่งคำขอ
คำขอ HTTP
PUT https://www.googleapis.com/youtube/v3/liveBroadcasts
การให้สิทธิ์
คําขอนี้ต้องมีการให้สิทธิ์กับขอบเขตต่อไปนี้อย่างน้อย 1 ขอบเขต (อ่านเพิ่มเติมเกี่ยวกับการตรวจสอบสิทธิ์และการให้สิทธิ์)
ขอบเขต |
---|
https://www.googleapis.com/auth/youtube |
https://www.googleapis.com/auth/youtube.force-ssl |
พารามิเตอร์
ตารางต่อไปนี้จะแสดงพารามิเตอร์ที่คําค้นหานี้รองรับ พารามิเตอร์ทั้งหมดที่แสดงคือพารามิเตอร์การค้นหา
พารามิเตอร์ | ||
---|---|---|
พารามิเตอร์ที่จําเป็น | ||
part |
string พารามิเตอร์ part มีจุดประสงค์ 2 ประการในการดําเนินการนี้ ค่านี้ระบุพร็อพเพอร์ตี้ที่การดําเนินการเขียนจะตั้งค่า รวมถึงพร็อพเพอร์ตี้ที่การตอบกลับ API จะรวมพร็อพเพอร์ตี้ part ที่คุณใส่ในค่าพารามิเตอร์ได้คือ id , snippet , contentDetails และ 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 ต่างๆ จํานวนมาก ช่วยให้เจ้าของเนื้อหาตรวจสอบสิทธิ์ได้ 1 ครั้งและดําเนินการในนามของช่องที่ระบุไว้ในค่าพารามิเตอร์ โดยไม่ต้องระบุข้อมูลเข้าสู่ระบบของแต่ละช่อง |
เนื้อหาของคำขอ
ระบุแหล่งข้อมูล LiveBroadcast ในส่วนเนื้อหาของคําขอ สําหรับทรัพยากรดังกล่าว ให้ทําดังนี้
-
คุณต้องระบุค่าสําหรับพร็อพเพอร์ตี้เหล่านี้
id
snippet.title
snippet.scheduledStartTime
status.privacyStatus
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
หากส่งคําขออัปเดตและคําขอไม่ได้ระบุพร็อพเพอร์ตี้ที่มีค่าอยู่แล้ว ระบบจะลบค่าที่มีอยู่แล้วของพร็อพเพอร์ตี้นั้น
คำตอบ
หากใช้วิธีนี้ วิธีนี้จะแสดงทรัพยากร LiveBroadcast ในเนื้อหาการตอบกลับ
ข้อผิดพลาด
ตารางต่อไปนี้ระบุข้อความแสดงข้อผิดพลาดที่ API อาจแสดงเพื่อตอบสนองต่อการเรียกเมธอดนี้ โปรดดูรายละเอียดเพิ่มเติมในเอกสารประกอบข้อความแสดงข้อผิดพลาด
ประเภทข้อผิดพลาด | รายละเอียดข้อผิดพลาด | คำอธิบาย |
---|---|---|
forbidden (403) |
closedCaptionsTypeModificationNotAllowed |
ค่า contentDetails.closedCaptionsType จะแก้ไขได้เฉพาะเมื่อการออกอากาศอยู่ในสถานะ created หรือ ready เท่านั้น |
forbidden (403) |
enableAutoStartModificationNotAllowed |
ค่า contentDetails.enableAutoStart จะแก้ไขได้เฉพาะเมื่อสตรีมไม่ทํางานและการออกอากาศอยู่ในสถานะ created หรือ ready |
forbidden (403) |
enableClosedCaptionsModificationNotAllowed |
ค่า contentDetails.enableClosedCaptions จะแก้ไขได้เฉพาะเมื่อสถานะของการออกอากาศเป็น created หรือ ready เท่านั้น |
forbidden (403) |
enableDvrModificationNotAllowed |
ค่า contentDetails. จะแก้ไขได้เฉพาะเมื่อสถานะของการออกอากาศเป็น created หรือ ready เท่านั้น |
forbidden (403) |
enableMonitorStreamModificationNotAllowed |
ค่า contentDetails. จะแก้ไขได้เฉพาะเมื่อสถานะของการออกอากาศเป็น created หรือ ready เท่านั้น |
forbidden (403) |
recordFromStartModificationNotAllowed |
ค่า contentDetails. จะแก้ไขได้เฉพาะเมื่อสถานะของการออกอากาศเป็น created หรือ ready เท่านั้น |
insufficientPermissions |
insufficientLivePermissions |
คําขอไม่ได้รับอนุญาตให้อัปเดตการถ่ายทอดสดที่ระบุ โปรดดูข้อมูลเพิ่มเติมที่หัวข้อการใช้การตรวจสอบสิทธิ์ OAuth2 |
insufficientPermissions |
liveStreamingNotEnabled |
ผู้ใช้ที่ให้สิทธิ์คําขอไม่ได้เปิดใช้สตรีมวิดีโอสดบน YouTube ผู้ใช้จะดูข้อมูลเพิ่มเติมได้ที่ https://www.youtube.com/features |
invalidValue (400) |
invalidAutoStart |
ทรัพยากร liveBroadcast มีค่าที่ไม่ถูกต้องสําหรับพร็อพเพอร์ตี้ contentDetails.enableAutoStart
คุณไม่สามารถแก้ไขการตั้งค่า enableAutoStart สําหรับการออกอากาศถาวร |
invalidValue (400) |
invalidAutoStop |
ทรัพยากร liveBroadcast มีค่าที่ไม่ถูกต้องสําหรับพร็อพเพอร์ตี้ 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 ไม่ได้ แก้ไขทรัพยากรให้รวมพร็อพเพอร์ตี้ 1 รายการจาก 2 รายการ แล้วส่งคําขออีกครั้ง |
invalidValue (400) |
invalidLatencyPreferenceOptions |
ทรัพยากร liveBroadcast มีค่าที่ไม่ถูกต้องสําหรับพร็อพเพอร์ตี้ contentDetails.latencyPreference
การตั้งค่าเวลาในการตอบสนองบางอย่างอาจไม่รองรับการตั้งค่าบางอย่าง
|
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 ที่ระบุในทรัพยากร LiveBroadcast ไม่ได้ระบุการออกอากาศ |
required (400) |
broadcastStreamDelayMsRequired |
ทรัพยากร liveBroadcast ไม่ได้ระบุพร็อพเพอร์ตี้ contentDetails. |
required (400) |
enableMonitorStreamRequired |
ทรัพยากร liveBroadcast ไม่ได้ระบุพร็อพเพอร์ตี้ contentDetails. |
required (400) |
idRequired |
ทรัพยากร liveBroadcast ต้องรวมและระบุค่าสําหรับพร็อพเพอร์ตี้ id |
required (400) |
privacyStatusRequired |
ทรัพยากร liveBroadcast ไม่ได้ระบุสถานะความเป็นส่วนตัว ดูสําหรับค่า privacyStatus ที่ถูกต้อง |
required (400) |
scheduledEndTimeRequired |
ทรัพยากร liveBroadcast ไม่ได้ระบุพร็อพเพอร์ตี้ snippet.scheduledEndTime |
required (400) |
scheduledStartTimeRequired |
ทรัพยากร liveBroadcast ไม่ได้ระบุพร็อพเพอร์ตี้ snippet.scheduledStartTime |
required (400) |
titleRequired |
ทรัพยากร liveBroadcast ไม่ได้ระบุพร็อพเพอร์ตี้ snippet.title |
ลองใช้เลย
ใช้ APIs Explorer เพื่อเรียกใช้ API นี้และดูคําขอและการตอบกลับ API