PlaylistItems: update

แก้ไขรายการเพลย์ลิสต์ เช่น อัปเดตตำแหน่งของรายการในเพลย์ลิสต์

ผลกระทบของโควต้า: การเรียกใช้วิธีการนี้มีค่าใช้จ่ายโควต้า 50 หน่วย

Use Case ทั่วไป

ส่งคำขอ

คำขอ 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 ที่คุณรวมไว้ในค่าพารามิเตอร์ได้
  • contentDetails
  • id
  • snippet
  • status
พารามิเตอร์ที่ไม่บังคับ
onBehalfOfContentOwner string
หมายเหตุ: พารามิเตอร์ onBehalfOfContentOwner มีไว้สำหรับพาร์ทเนอร์เนื้อหาของ YouTube โดยเฉพาะ และใช้ได้ในคำขอที่ได้รับอนุญาตที่เหมาะสมเท่านั้น

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

เมื่อมีพารามิเตอร์อยู่ ค่าของพารามิเตอร์จะระบุเจ้าของเนื้อหา และข้อมูลเข้าสู่ระบบการให้สิทธิ์ของคำขอจะระบุผู้ใช้ YouTube ที่ได้รับอนุญาตให้ดำเนินการในนามของเจ้าของเนื้อหารายนั้น บัญชีที่ผู้ใช้ตรวจสอบสิทธิ์ต้องลิงก์กับเจ้าของเนื้อหาที่ระบุในการตั้งค่า YouTube Creator Studio

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

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

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

    • id
    • snippet.playlistId
    • snippet.resourceId

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

    • snippet.position
    • contentDetails.note
    • contentDetails.startAt
    • contentDetails.endAt

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

คำตอบ

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

ข้อผิดพลาด

ตารางต่อไปนี้ระบุข้อความแสดงข้อผิดพลาดที่ 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