Playlists: update

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

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

กรณีการใช้งานทั่วไป

ส่งคำขอ

คำขอ HTTP

PUT https://www.googleapis.com/youtube/v3/playlists

การให้สิทธิ์

คำขอนี้ต้องมีการให้สิทธิ์ด้วยขอบเขตต่อไปนี้อย่างน้อย 1 รายการ อ่านเพิ่มเติมเกี่ยวกับการตรวจสอบสิทธิ์และการให้สิทธิ์ได้ที่การใช้การให้สิทธิ์ OAuth 2.0

ขอบเขต
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 จะรวมไว้

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

รายการต่อไปนี้คือชื่อ part ที่คุณใส่ไว้ในค่าพารามิเตอร์ได้
  • contentDetails
  • id
  • localizations
  • player
  • snippet
  • status
พารามิเตอร์ที่ไม่บังคับ
onBehalfOfContentOwner string
พารามิเตอร์นี้ใช้ได้เฉพาะในคำขอที่ได้รับอนุญาตอย่างถูกต้องเท่านั้น

หมายเหตุ: พารามิเตอร์นี้มีไว้สำหรับพาร์ทเนอร์เนื้อหา YouTube โดยเฉพาะ

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

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

ระบุแหล่งข้อมูล playlist ในเนื้อหาคําขอ

สําหรับแหล่งข้อมูลนั้น ให้ทำดังนี้

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

    • id
    • snippet.title

  • คุณตั้งค่าพร็อพเพอร์ตี้ต่อไปนี้ได้

    • snippet.title
    • snippet.description
    • status.privacyStatus
    • status.podcastStatus
    • snippet.defaultLanguage
    • localizations.(key)
    • localizations.(key).title
    • localizations.(key).description

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

คำตอบ

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

ข้อผิดพลาด

ตารางต่อไปนี้ระบุข้อความแสดงข้อผิดพลาดที่ API อาจแสดงเมื่อมีการเรียกใช้เมธอดนี้ ดูรายละเอียดเพิ่มเติมได้ที่ YouTube Data API - ข้อผิดพลาด

ประเภทข้อผิดพลาด รายละเอียดข้อผิดพลาด คำอธิบาย
badRequest (400) defaultLanguageNotSetError คุณต้องตั้งค่า defaultLanguage เพื่ออัปเดต localizations
badRequest (400) localizationValidationError ค่าหนึ่งในออบเจ็กต์การแปลไม่ผ่านการตรวจสอบ ใช้เมธอด playlists.list เพื่อดึงค่าที่ถูกต้อง และอย่าลืมอัปเดตค่าตามหลักเกณฑ์ในเอกสารประกอบเกี่ยวกับทรัพยากรเพลย์ลิสต์
forbidden (403) playlistForbidden การดำเนินการนี้ถูกห้ามหรือคำขอไม่ได้รับอนุญาตอย่างเหมาะสม
invalidValue (400) invalidPlaylistSnippet คำขอระบุข้อมูลโค้ดเพลย์ลิสต์ที่ไม่ถูกต้อง
notFound (404) playlistNotFound ไม่พบเพลย์ลิสต์ที่ระบุด้วยพารามิเตอร์ id ของคำขอ
required (400) playlistTitleRequired โดยคำขอต้องระบุชื่อเพลย์ลิสต์
invalidValue (400) playlistOperationUnsupported API ไม่รองรับความสามารถในการอัปเดตเพลย์ลิสต์ที่ระบุ เช่น คุณจะอัปเดตพร็อพเพอร์ตี้ของเพลย์ลิสต์วิดีโอที่อัปโหลดไม่ได้

ลองใช้งาน

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