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
ตัวกรอง (ระบุพารามิเตอร์ต่อไปนี้เพียง 1 รายการ)
channelId string
ค่านี้บ่งชี้ว่า API ควรแสดงผลเพลย์ลิสต์ของช่องที่ระบุเท่านั้น
id string
พารามิเตอร์ id ระบุรายการรหัสเพลย์ลิสต์ YouTube อย่างน้อย 1 รายการที่คั่นด้วยคอมมาสำหรับทรัพยากรที่จะดึงข้อมูล ในทรัพยากร 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 บ่งชี้ว่าข้อมูลเข้าสู่ระบบเพื่อขอสิทธิ์ของคำขอระบุผู้ใช้ YouTube CMS ที่ดำเนินการในนามของเจ้าของเนื้อหาที่ระบุไว้ในค่าพารามิเตอร์ พารามิเตอร์นี้มีไว้สำหรับพาร์ทเนอร์เนื้อหาของ YouTube ที่เป็นเจ้าของและจัดการช่อง YouTube หลายช่อง ซึ่งช่วยให้เจ้าของเนื้อหาตรวจสอบสิทธิ์ได้เพียงครั้งเดียวและเข้าถึงข้อมูลวิดีโอและช่องทั้งหมดได้โดยไม่ต้องระบุข้อมูลรับรองการตรวจสอบสิทธิ์สำหรับแต่ละช่อง บัญชี CMS ที่ผู้ใช้ตรวจสอบสิทธิ์ต้องลิงก์กับเจ้าของเนื้อหา YouTube ที่ระบุ
onBehalfOfContentOwnerChannel string
พารามิเตอร์นี้ใช้ได้เฉพาะในคำขอที่ได้รับอนุญาตอย่างถูกต้อง หมายเหตุ: พารามิเตอร์นี้มีไว้สำหรับพาร์ทเนอร์เนื้อหาของ YouTube เท่านั้น

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

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