แสดงผลคอลเล็กชันรูปภาพของเพลย์ลิสต์ที่ตรงกับพารามิเตอร์คำขอ API คุณสามารถเรียกรูปภาพเพลย์ลิสต์ของเพลย์ลิสต์ที่ระบุ หรือเรียกรูปภาพเพลย์ลิสต์อย่างน้อย 1 รูปตามรหัสที่ไม่ซ้ำกัน
ผลกระทบจากโควต้า: การเรียกใช้วิธีการนี้มีต้นทุนโควต้า 1 หน่วย
ส่งคำขอ
คำขอ HTTP
GET https://www.googleapis.com/youtube/v3/playlistImages
การให้สิทธิ์
คำขอนี้ต้องได้รับการให้สิทธิ์ที่มีขอบเขตต่อไปนี้อย่างน้อย 1 ขอบเขต (อ่านเพิ่มเติมเกี่ยวกับการตรวจสอบสิทธิ์และการให้สิทธิ์)
ขอบเขต |
---|
https://www.googleapis.com/auth/youtubepartner |
https://www.googleapis.com/auth/youtube |
https://www.googleapis.com/auth/youtube.force-ssl |
พารามิเตอร์
ตารางต่อไปนี้แสดงพารามิเตอร์ที่คำค้นหานี้รองรับ พารามิเตอร์ทั้งหมดที่แสดงคือพารามิเตอร์การค้นหา
พารามิเตอร์ | ||
---|---|---|
พารามิเตอร์ที่จำเป็น | ||
part |
string พารามิเตอร์ |
|
ตัวกรอง (ระบุหนึ่งในพารามิเตอร์ต่อไปนี้เท่านั้น) | ||
id |
string พารามิเตอร์ id ระบุรายการรหัสรูปภาพเพลย์ลิสต์ที่ไม่ซ้ำกันอย่างน้อย 1 รหัสที่คั่นด้วยคอมมา |
|
playlistId |
string พารามิเตอร์ playlistId ระบุรหัสที่ไม่ซ้ำกันของเพลย์ลิสต์ที่คุณต้องการเรียกรูปภาพจากเพลย์ลิสต์ โปรดทราบว่าแม้ว่าจะเป็นพารามิเตอร์ที่ไม่บังคับ แต่ทุกคำขอในการเรียกรูปภาพของเพลย์ลิสต์ต้องระบุค่าสำหรับพารามิเตอร์ id หรือพารามิเตอร์ playlistId |
|
พารามิเตอร์ที่ไม่บังคับ | ||
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#playlistImageListResponse", "nextPageToken": string, "prevPageToken": string, "pageInfo": { "totalResults": integer, "resultsPerPage": integer }, "items": [ playlistImages Resource ] }
พร็อพเพอร์ตี้
ตารางต่อไปนี้จะระบุพร็อพเพอร์ตี้ที่ปรากฏในทรัพยากรนี้
พร็อพเพอร์ตี้ | |
---|---|
kind |
string ระบุประเภทของทรัพยากร API ค่าจะเป็น youtube#playlistImageListResponse |
nextPageToken |
string โทเค็นที่สามารถใช้เป็นค่าของพารามิเตอร์ pageToken เพื่อดึงข้อมูลหน้าถัดไปในชุดผลลัพธ์ |
prevPageToken |
string โทเค็นที่สามารถใช้เป็นค่าของพารามิเตอร์ pageToken เพื่อดึงข้อมูลหน้าก่อนหน้าในชุดผลลัพธ์ |
pageInfo |
object ออบเจ็กต์ pageInfo สรุปข้อมูลการแบ่งหน้าสำหรับชุดผลลัพธ์ |
pageInfo.totalResults |
integer จำนวนผลลัพธ์ทั้งหมดในชุดผลลัพธ์ |
pageInfo.resultsPerPage |
integer จำนวนผลลัพธ์ที่รวมอยู่ในการตอบกลับ API |
items[] |
list รายการรูปภาพเพลย์ลิสต์ที่ตรงกับเกณฑ์คำขอ |