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