PlaylistItems: update

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

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

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

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

เนื้อความของคำขอ

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

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

    • 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