Playlists: list

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

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

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

ส่งคำขอ

คำขอ HTTP

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

พารามิเตอร์

ตารางต่อไปนี้จะแสดงพารามิเตอร์ที่คําค้นหานี้รองรับ พารามิเตอร์ทั้งหมดที่แสดงคือพารามิเตอร์การค้นหา

พารามิเตอร์
พารามิเตอร์ที่จําเป็น
part string
พารามิเตอร์ part ระบุรายการที่คั่นด้วยคอมมาของพร็อพเพอร์ตี้ทรัพยากร playlist อย่างน้อย 1 รายการที่จะตอบกลับ API

หากพารามิเตอร์ระบุพร็อพเพอร์ตี้ที่มีพร็อพเพอร์ตี้ย่อย พร็อพเพอร์ตี้ย่อยจะรวมอยู่ในการตอบกลับ ตัวอย่างเช่น ในทรัพยากร playlist พร็อพเพอร์ตี้ snippet ประกอบด้วยพร็อพเพอร์ตี้อย่าง author, title, description และ timeCreated ดังนั้น หากตั้งค่า part=snippet การตอบกลับ API จะมีพร็อพเพอร์ตี้เหล่านั้นทั้งหมด

รายการต่อไปนี้มีชื่อ part ที่สามารถรวมในค่าพารามิเตอร์ได้
  • contentDetails
  • id
  • localizations
  • player
  • snippet
  • status
ตัวกรอง (ระบุพารามิเตอร์ตัวใดตัวหนึ่งต่อไปนี้)
channelId string
ค่านี้บ่งชี้ว่า API ควรแสดงเฉพาะเพลย์ลิสต์ของช่องที่ระบุ
id string
พารามิเตอร์ id ระบุรายการที่คั่นด้วยรหัสของรหัสเพลย์ลิสต์ YouTube สําหรับทรัพยากรที่กําลังดึงมา ในทรัพยากร playlist พร็อพเพอร์ตี้ id ระบุรหัสเพลย์ลิสต์ YouTube ของเพลย์ลิสต์
mine boolean
พารามิเตอร์นี้ใช้ได้เฉพาะในคําขอที่ได้รับอนุญาตอย่างถูกต้อง ตั้งค่าของพารามิเตอร์นี้เป็น true เพื่อกําหนดให้ API แสดงเฉพาะเพลย์ลิสต์ที่เป็นของผู้ใช้ที่ผ่านการตรวจสอบสิทธิ์เท่านั้น
พารามิเตอร์ที่ไม่บังคับ
hl string
พารามิเตอร์ hl จะสั่งให้ API ดึงข้อมูลข้อมูลเมตาของทรัพยากรที่แปลแล้วสําหรับภาษาของแอปพลิเคชันที่เว็บไซต์ YouTube รองรับ ค่าพารามิเตอร์ต้องเป็นรหัสภาษาที่อยู่ในรายการที่แสดงโดยเมธอด i18nLanguages.list

หากมีรายละเอียดทรัพยากรที่แปลเป็นภาษาดังกล่าว ออบเจ็กต์ snippet.localized ของทรัพยากรจะมีค่าที่แปลแล้ว อย่างไรก็ตาม หากไม่มีรายละเอียดที่แปลเป็นภาษาท้องถิ่น ออบเจ็กต์ snippet.localized จะมีรายละเอียดทรัพยากรอยู่ในภาษาเริ่มต้นของทรัพยากรนั้นๆ
maxResults unsigned integer
พารามิเตอร์ maxResults จะระบุจํานวนรายการสูงสุดที่ควรแสดงผลในชุดผลลัพธ์ ค่าที่ยอมรับคือ 0 ถึง 50 ค่าเริ่มต้นคือ 5
onBehalfOfContentOwner string
พารามิเตอร์นี้ใช้ได้เฉพาะในคําขอที่ได้รับอนุญาตอย่างถูกต้อง หมายเหตุ: พารามิเตอร์นี้มีไว้สําหรับพาร์ทเนอร์เนื้อหาของ YouTube เท่านั้น

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

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

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

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

ไม่ต้องให้เนื้อหาคําขอเมื่อเรียกใช้วิธีการนี้

คำตอบ

หากสําเร็จ วิธีนี้จะแสดงผลเนื้อหาการตอบกลับที่มีโครงสร้างต่อไปนี้

{
  "kind": "youtube#playlistListResponse",
  "etag": etag,
  "nextPageToken": string,
  "prevPageToken": string,
  "pageInfo": {
    "totalResults": integer,
    "resultsPerPage": integer
  },
  "items": [
    playlist Resource
  ]
}

พร็อพเพอร์ตี้

ตารางต่อไปนี้กําหนดพร็อพเพอร์ตี้ที่ปรากฏในทรัพยากรนี้

พร็อพเพอร์ตี้
kind string
ระบุประเภทของทรัพยากร API ค่านี้จะเป็น youtube#playlistListResponse
etag etag
Etag ของทรัพยากรนี้
nextPageToken string
โทเค็นที่ใช้เป็นค่าของพารามิเตอร์ pageToken เพื่อดึงหน้าถัดไปในชุดผลลัพธ์ได้
prevPageToken string
โทเค็นที่ใช้เป็นค่าของพารามิเตอร์ pageToken เพื่อดึงหน้าก่อนหน้าในชุดผลลัพธ์ได้
pageInfo object
ออบเจ็กต์ pageInfo จะสรุปข้อมูลการแบ่งหน้าสําหรับชุดผลลัพธ์
pageInfo.totalResults integer
จํานวนผลลัพธ์ทั้งหมดในชุดผลลัพธ์
pageInfo.resultsPerPage integer
จํานวนผลลัพธ์ที่รวมอยู่ในการตอบกลับ API
items[] list
รายการเพลย์ลิสต์ที่ตรงกับเกณฑ์คําขอ

ข้อผิดพลาด

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

ประเภทข้อผิดพลาด รายละเอียดข้อผิดพลาด คำอธิบาย
forbidden (403) channelClosed ช่องที่ระบุในพารามิเตอร์ channelId ปิดอยู่
forbidden (403) channelSuspended ช่องที่ระบุในพารามิเตอร์ channelId ถูกระงับ
forbidden (403) playlistForbidden เพลย์ลิสต์ที่ระบุด้วยพารามิเตอร์ id ของคําขอไม่รองรับคําขอหรือคําขอไม่ได้รับอนุญาตอย่างถูกต้อง
notFound (404) channelNotFound ไม่พบแชแนลที่ระบุในพารามิเตอร์ channelId
notFound (404) playlistNotFound ไม่พบเพลย์ลิสต์ที่ระบุด้วยพารามิเตอร์ id ของคําขอ
invalidValue (400) playlistOperationUnsupported API ไม่รองรับความสามารถในการแสดงรายการเพลย์ลิสต์ที่ระบุ เช่น คุณไม่สามารถแสดงรายการเพลย์ลิสต์ดูภายหลังได้

ลองใช้เลย

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