แก้ไขรายการเพลย์ลิสต์ เช่น อัปเดตตําแหน่งของรายการในเพลย์ลิสต์
ผลกระทบจากโควต้า: การเรียกใช้วิธีการนี้มีต้นทุนโควต้า 50 หน่วย
กรณีการใช้งานทั่วไป
ส่งคำขอ
คำขอ HTTP
PUT https://www.googleapis.com/youtube/v3/playlistItems
การให้สิทธิ์
คําขอนี้ต้องมีการให้สิทธิ์กับขอบเขตต่อไปนี้อย่างน้อย 1 ขอบเขต (อ่านเพิ่มเติมเกี่ยวกับการตรวจสอบสิทธิ์และการให้สิทธิ์)
ขอบเขต |
---|
https://www.googleapis.com/auth/youtubepartner |
https://www.googleapis.com/auth/youtube |
https://www.googleapis.com/auth/youtube.force-ssl |
พารามิเตอร์
ตารางต่อไปนี้จะแสดงพารามิเตอร์ที่คําค้นหานี้รองรับ พารามิเตอร์ทั้งหมดที่แสดงคือพารามิเตอร์การค้นหา
พารามิเตอร์ | ||
---|---|---|
พารามิเตอร์ที่จําเป็น | ||
part |
string พารามิเตอร์ part มีจุดประสงค์ 2 ประการในการดําเนินการนี้ ค่านี้ระบุพร็อพเพอร์ตี้ที่การดําเนินการเขียนจะตั้งค่า รวมถึงพร็อพเพอร์ตี้ที่การตอบกลับ API จะรวมโปรดทราบว่าวิธีการนี้จะลบล้างค่าที่มีอยู่สําหรับพร็อพเพอร์ตี้ที่เปลี่ยนแปลงได้ทั้งหมดที่อยู่ในส่วนใดก็ตามที่ค่าพารามิเตอร์ระบุ ตัวอย่างเช่น รายการเพลย์ลิสต์สามารถระบุเวลาเริ่มต้นและเวลาสิ้นสุดได้ ซึ่งจะระบุเวลาของวิดีโอที่ควรเล่นเมื่อผู้ใช้ดูวิดีโอในเพลย์ลิสต์ หากคําขออัปเดตรายการเพลย์ลิสต์ที่กําหนดค่าเหล่านี้และค่าพารามิเตอร์ part ของคําขอมีส่วน contentDetails ระบบจะอัปเดตเวลาเริ่มต้นและเวลาสิ้นสุดของรายการเพลย์ลิสต์ให้เป็นค่าใดก็ตามที่เนื้อหาคําขอระบุ หากส่วนเนื้อหาของคําขอไม่ได้ระบุค่า ระบบจะนําเวลาเริ่มต้นและเวลาสิ้นสุดที่มีอยู่ออกและแทนที่ด้วยการตั้งค่าเริ่มต้นรายการต่อไปนี้มีชื่อ part ซึ่งคุณรวมในค่าพารามิเตอร์ได้
|
|
พารามิเตอร์ที่ไม่บังคับ | ||
onBehalfOfContentOwner |
string หมายเหตุ: พารามิเตอร์ onBehalfOfContentOwner มีไว้สําหรับพาร์ทเนอร์เนื้อหา YouTube โดยเฉพาะและใช้ได้ในคําขอที่ได้รับอนุญาตที่เหมาะสมเท่านั้นพารามิเตอร์นี้ออกแบบมาเพื่อพาร์ทเนอร์เนื้อหา YouTube ที่เป็นเจ้าของและจัดการช่อง YouTube ต่างๆ จํานวนมาก ช่วยให้ผู้ใช้ที่เชื่อมโยงกับเจ้าของเนื้อหาตรวจสอบสิทธิ์ได้ 1 ครั้ง จากนั้นสามารถเข้าถึงและจัดการข้อมูลวิดีโอและช่องทั้งหมดของเจ้าของเนื้อหา โดยไม่ต้องระบุข้อมูลเข้าสู่ระบบของแต่ละช่อง เมื่อมีพารามิเตอร์ปรากฏขึ้น ค่าจะระบุเจ้าของเนื้อหาและข้อมูลเข้าสู่ระบบของการให้สิทธิ์จะระบุตัวตนของผู้ใช้ YouTube ที่ได้รับอนุญาตให้ดําเนินการในนามของเจ้าของเนื้อหานั้น บัญชีที่ผู้ใช้ตรวจสอบสิทธิ์ด้วยต้องลิงก์กับเจ้าของเนื้อหาที่ระบุในการตั้งค่า YouTube Creator Studio |
เนื้อหาของคำขอ
ระบุแหล่งข้อมูลเพลย์ลิสต์ในส่วนเนื้อหาคําขอ สําหรับทรัพยากรดังกล่าว ให้ทําดังนี้
-
คุณต้องระบุค่าสําหรับพร็อพเพอร์ตี้เหล่านี้
id
snippet.playlistId
snippet.resourceId
-
คุณตั้งค่าพร็อพเพอร์ตี้เหล่านี้ได้
snippet.position
contentDetails.note
contentDetails.startAt
contentDetails.endAt
หากส่งคําขออัปเดตและคําขอไม่ได้ระบุพร็อพเพอร์ตี้ที่มีค่าอยู่แล้ว ระบบจะลบค่าที่มีอยู่แล้วของพร็อพเพอร์ตี้นั้น
คำตอบ
หากใช้วิธีนี้ วิธีนี้จะแสดงทรัพยากรเป็นเพลย์ลิสต์ในส่วนเนื้อหาของการตอบกลับ
ข้อผิดพลาด
ตารางต่อไปนี้ระบุข้อความแสดงข้อผิดพลาดที่ API อาจแสดงเพื่อตอบสนองต่อการเรียกเมธอดนี้ โปรดดูรายละเอียดเพิ่มเติมในเอกสารประกอบข้อความแสดงข้อผิดพลาด
ประเภทข้อผิดพลาด | รายละเอียดข้อผิดพลาด | คำอธิบาย |
---|---|---|
forbidden (403) |
playlistItemsNotAccessible |
คําขอไม่ได้รับอนุญาตอย่างถูกต้องให้อัปเดตรายการเพลย์ลิสต์ที่ระบุ |
invalidValue (400) |
invalidPlaylistItemPosition |
คําขอพยายามกําหนดตําแหน่งของรายการเพลย์ลิสต์เป็นค่าที่ไม่ถูกต้องหรือไม่รองรับ ตรวจสอบค่าของพร็อพเพอร์ตี้ position ใน snippet ของทรัพยากร |
invalidValue (400) |
invalidResourceType |
การดําเนินการนี้ไม่รองรับ type ที่ระบุสําหรับรหัสทรัพยากร รหัสทรัพยากรจะระบุรายการที่กําลังเพิ่มลงในเพลย์ลิสต์ เช่น youtube#video |
invalidValue (400) |
invalidSnippet |
คําขอไม่ได้ระบุพร็อพเพอร์ตี้ snippet ที่ถูกต้อง |
invalidValue (400) |
manualSortRequired |
คําขอพยายามกําหนดตําแหน่งของรายการเพลย์ลิสต์ แต่เพลย์ลิสต์ไม่ได้ใช้การจัดเรียงด้วยตนเอง (ตัวอย่างเช่น รายการเพลย์ลิสต์อาจจัดเรียงตามวันที่หรือความนิยม) คุณแก้ไขข้อผิดพลาดได้โดยการนําองค์ประกอบ snippet.position ออกจากทรัพยากรที่คําขอแทรก หากต้องการให้รายการเพลย์ลิสต์มีตําแหน่งที่เฉพาะเจาะจงในรายการ คุณต้องอัปเดตตัวเลือกการจัดลําดับของเพลย์ลิสต์เป็นด้วยตนเองในการตั้งค่าของเพลย์ลิสต์ก่อน คุณปรับการตั้งค่านี้ได้ในเครื่องมือจัดการวิดีโอ YouTube |
notFound (404) |
playlistItemNotFound |
ไม่พบรายการเพลย์ลิสต์ที่ระบุด้วยพร็อพเพอร์ตี้ id ของคําขอ |
notFound (404) |
playlistNotFound |
ไม่พบเพลย์ลิสต์ที่ระบุด้วยพารามิเตอร์ playlistId ของคําขอ |
required (400) |
channelIdRequired |
คําขอไม่ได้ระบุค่าสําหรับพร็อพเพอร์ตี้ channelId ที่จําเป็น |
required (400) |
playlistIdRequired |
คําขอไม่ได้ระบุค่าสําหรับพร็อพเพอร์ตี้ playlistId ที่จําเป็น |
required (400) |
playlistItemIdRequired |
ทรัพยากรรายการเพลย์ลิสต์ที่ระบุในคําขอต้องใช้พร็อพเพอร์ตี้ id ในการระบุรายการเพลย์ลิสต์ที่กําลังอัปเดต |
invalidValue (400) |
playlistOperationUnsupported |
API ไม่รองรับความสามารถในการอัปเดตวิดีโอในเพลย์ลิสต์ที่ระบุ เช่น คุณไม่สามารถอัปเดตวิดีโอในเพลย์ลิสต์วิดีโอที่อัปโหลด |
ลองใช้เลย
ใช้ APIs Explorer เพื่อเรียกใช้ API นี้และดูคําขอและการตอบกลับ API