PlaylistItems: insert

เพิ่มทรัพยากรลงในเพลย์ลิสต์

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

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

ส่งคำขอ

คำขอ HTTP

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

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

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

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

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

    • snippet.playlistId
    • snippet.resourceId

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

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

คำตอบ

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

ข้อผิดพลาด

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

ประเภทข้อผิดพลาด รายละเอียดข้อผิดพลาด คำอธิบาย
forbidden (403) playlistContainsMaximumNumberOfVideos เพลย์ลิสต์มีรายการถึงจำนวนสูงสุดที่อนุญาตแล้ว
forbidden (403) playlistItemsNotAccessible คำขอไม่ได้รับอนุญาตอย่างถูกต้องในการแทรกรายการเพลย์ลิสต์ที่ระบุ
invalidValue (400) invalidContentDetails พร็อพเพอร์ตี้ contentDetails ในคำขอไม่ถูกต้อง เหตุผลที่เป็นไปได้คือฟิลด์ contentDetails.note มีความยาวมากกว่า 280 อักขระ
invalidValue (400) invalidPlaylistItemPosition คำขอพยายามตั้งค่าตำแหน่งของรายการเพลย์ลิสต์เป็นค่าที่ไม่ถูกต้องหรือไม่รองรับ ตรวจสอบค่าของพร็อพเพอร์ตี้ position ใน snippet ของทรัพยากร
invalidValue (400) invalidResourceType type ที่ระบุสำหรับรหัสทรัพยากรไม่รองรับการดำเนินการนี้ รหัสทรัพยากรจะระบุรายการที่เพิ่มลงในเพลย์ลิสต์ เช่น youtube#video
invalidValue (400) manualSortRequired คำขอพยายามตั้งค่าตำแหน่งของรายการเพลย์ลิสต์ แต่เพลย์ลิสต์ไม่ได้ใช้การจัดเรียงด้วยตนเอง (เช่น รายการเพลย์ลิสต์อาจจัดเรียงตามวันที่หรือความนิยม) คุณแก้ไขข้อผิดพลาดได้โดยนำองค์ประกอบ snippet.position ออกจากทรัพยากรที่คำขอพยายามแทรก หากต้องการให้รายการเพลย์ลิสต์มีตำแหน่งที่เฉพาะเจาะจงในรายการ คุณต้องอัปเดตตัวเลือกการจัดลำดับ ของเพลย์ลิสต์เป็นด้วยตนเอง ในการตั้งค่าของเพลย์ลิสต์ก่อน คุณปรับการตั้งค่านี้ได้ในเครื่องมือจัดการวิดีโอของ YouTube
invalidValue (400) videoAlreadyInAnotherSeriesPlaylist วิดีโอที่คุณพยายามเพิ่มลงในเพลย์ลิสต์อยู่ในรายการซีรีส์อื่นแล้ว
notFound (404) playlistNotFound ไม่พบเพลย์ลิสต์ที่ระบุด้วยพารามิเตอร์ playlistId ของคำขอ
notFound (404) videoNotFound ไม่พบวิดีโอที่คุณพยายามเพิ่มลงในเพลย์ลิสต์ ตรวจสอบค่าของพร็อพเพอร์ตี้ videoId เพื่อให้แน่ใจว่าถูกต้อง
required (400) channelIdRequired คำขอไม่ได้ระบุค่าสำหรับพร็อพเพอร์ตี้ channelId ที่จำเป็น
required (400) playlistIdRequired คำขอไม่ได้ระบุค่าสำหรับพร็อพเพอร์ตี้ playlistId ที่จำเป็น
required (400) resourceIdRequired คำขอต้องมีทรัพยากรซึ่งออบเจ็กต์ snippet ระบุ resourceId
invalidValue (400) playlistOperationUnsupported API ไม่รองรับความสามารถในการแทรกวิดีโอลงในเพลย์ลิสต์ที่ระบุ เช่น คุณไม่สามารถแทรกวิดีโอลงในเพลย์ลิสต์วิดีโอที่อัปโหลด

ลองใช้งาน

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