ทรัพยากร playlistItem
จะระบุทรัพยากรอื่น เช่น วิดีโอ ที่รวมอยู่ในเพลย์ลิสต์ นอกจากนี้ แหล่งข้อมูล playlistItem
ยังมีรายละเอียดเกี่ยวกับแหล่งข้อมูลที่รวมอยู่ด้วยซึ่งเกี่ยวข้องกับวิธีใช้แหล่งข้อมูลนั้นในเพลย์ลิสต์นั้นโดยเฉพาะ
นอกจากนี้ YouTube ยังใช้เพลย์ลิสต์เพื่อระบุรายการวิดีโอที่อัปโหลดของช่อง โดยแต่ละplaylistItem
ในรายการจะแสดงถึงวิดีโอที่อัปโหลด 1 รายการ คุณสามารถเรียกดูรหัสเพลย์ลิสต์ของรายการนั้นได้จากchannel
แหล่งข้อมูลของช่องหนึ่งๆ จากนั้นคุณจะใช้เมธอด playlistItems.list
กับลิสต์ได้
เมธอด
API รองรับวิธีการต่อไปนี้สำหรับทรัพยากร playlistItems
- list
- แสดงผลคอลเล็กชันรายการเพลย์ลิสต์ที่ตรงกับพารามิเตอร์คำขอ API คุณสามารถดึงข้อมูลรายการเพลย์ลิสต์ทั้งหมดในเพลย์ลิสต์ที่ระบุ หรือดึงข้อมูลรายการเพลย์ลิสต์อย่างน้อย 1 รายการตามรหัสที่ไม่ซ้ำกันได้ ลองใช้เลย
- แทรก
- เพิ่มทรัพยากรลงในเพลย์ลิสต์ ลองใช้เลย
- update
- แก้ไขรายการเพลย์ลิสต์ เช่น อัปเดตตำแหน่งของรายการในเพลย์ลิสต์ ลองใช้เลย
- ลบ
- ลบรายการในเพลย์ลิสต์ ลองใช้เลย
การนําเสนอทรัพยากร
โครงสร้าง JSON ต่อไปนี้แสดงรูปแบบของแหล่งข้อมูล playlistItems
{ "kind": "youtube#playlistItem", "etag": etag, "id": string, "snippet": { "publishedAt": datetime, "channelId": string, "title": string, "description": string, "thumbnails": { (key): { "url": string, "width": unsigned integer, "height": unsigned integer } }, "channelTitle": string, "videoOwnerChannelTitle": string, "videoOwnerChannelId": string, "playlistId": string, "position": unsigned integer, "resourceId": { "kind": string, "videoId": string, } }, "contentDetails": { "videoId": string, "startAt": string, "endAt": string, "note": string, "videoPublishedAt": datetime }, "status": { "privacyStatus": string } }
พร็อพเพอร์ตี้
ตารางต่อไปนี้จะกำหนดพร็อพเพอร์ตี้ที่ปรากฏในทรัพยากรนี้
พร็อพเพอร์ตี้ | |
---|---|
kind |
string ระบุประเภทของทรัพยากร API ค่าจะเป็น youtube#playlistItem |
etag |
etag Etag ของทรัพยากรนี้ |
id |
string รหัสที่ YouTube ใช้เพื่อระบุรายการเพลย์ลิสต์โดยไม่ซ้ำกัน |
snippet |
object ออบเจ็กต์ snippet มีรายละเอียดพื้นฐานเกี่ยวกับรายการในเพลย์ลิสต์ เช่น ชื่อและตำแหน่งในเพลย์ลิสต์ |
snippet.publishedAt |
datetime วันที่และเวลาที่เพิ่มรายการลงในเพลย์ลิสต์ ค่าที่ระบุอยู่ในรูปแบบ ISO 8601 |
snippet.channelId |
string รหัสที่ YouTube ใช้เพื่อระบุผู้ใช้ที่เพิ่มรายการลงในเพลย์ลิสต์โดยไม่ซ้ำกัน |
snippet.title |
string ชื่อของสินค้า |
snippet.description |
string คําอธิบายของสินค้า |
snippet.thumbnails |
object แผนที่รูปภาพขนาดย่อที่เชื่อมโยงกับรายการเพลย์ลิสต์ สำหรับออบเจ็กต์แต่ละรายการในแผนที่ คีย์คือชื่อรูปภาพขนาดย่อ และค่าคือออบเจ็กต์ที่มีข้อมูลอื่นๆ เกี่ยวกับรูปภาพขนาดย่อ |
snippet.thumbnails.(key) |
object คีย์-ค่าที่ใช้ได้มีดังนี้
|
snippet.thumbnails.(key).url |
string URL ของรูปภาพ |
snippet.thumbnails.(key).width |
unsigned integer ความกว้างของรูปภาพ |
snippet.thumbnails.(key).height |
unsigned integer ความสูงของรูปภาพ |
snippet.channelTitle |
string ชื่อช่องของช่องที่เป็นของรายการเพลย์ลิสต์ |
snippet.videoOwnerChannelTitle |
string ชื่อช่องของช่องที่อัปโหลดวิดีโอนี้ |
snippet.videoOwnerChannelId |
string รหัสช่องของช่องที่อัปโหลดวิดีโอนี้ |
snippet.playlistId |
string รหัสที่ YouTube ใช้เพื่อระบุเพลย์ลิสต์ที่มีรายการเพลย์ลิสต์อยู่โดยไม่ซ้ำกัน |
snippet.position |
unsigned integer ลําดับที่รายการปรากฏในเพลย์ลิสต์ ค่าใช้ดัชนีฐาน 0 ดังนั้นรายการแรกจะมีตำแหน่งเป็น 0 รายการที่ 2 จะมีตำแหน่งเป็น 1 และต่อๆ ไป |
snippet.resourceId |
object ออบเจ็กต์ id มีข้อมูลที่สามารถใช้เพื่อระบุทรัพยากรที่รวมอยู่ในเพลย์ลิสต์เป็นรายการเพลย์ลิสต์ได้อย่างไม่ซ้ำกัน |
snippet.resourceId.kind |
string ประเภทหรือชนิดของทรัพยากรที่อ้างอิง |
snippet.resourceId.videoId |
string หากค่าของพร็อพเพอร์ตี้ snippet.resourceId.kind คือ youtube#video พร็อพเพอร์ตี้นี้จะแสดงอยู่และค่าของพร็อพเพอร์ตี้จะมีรหัสที่ YouTube ใช้เพื่อระบุวิดีโอในเพลย์ลิสต์อย่างเจาะจง |
contentDetails |
object ออบเจ็กต์ contentDetails จะรวมอยู่ในทรัพยากรหากรายการที่รวมเป็นวิดีโอ YouTube ออบเจ็กต์นี้มีข้อมูลเพิ่มเติมเกี่ยวกับวิดีโอ |
contentDetails.videoId |
string รหัสที่ YouTube ใช้เพื่อระบุวิดีโอที่ไม่ซ้ำกัน หากต้องการดึงข้อมูลทรัพยากร video ให้ตั้งค่าพารามิเตอร์การค้นหา id เป็นค่านี้ในคําขอ API |
contentDetails.startAt |
string หมายเหตุ: ระบบเลิกใช้งานพร็อพเพอร์ตี้นี้แล้ว และหากมีการตั้งค่า ระบบจะไม่สนใจค่าของพร็อพเพอร์ตี้ เวลาที่วิดีโอควรเริ่มเล่น ซึ่งวัดเป็นวินาทีนับจากจุดเริ่มต้นของวิดีโอ (เจ้าของเพลย์ลิสต์สามารถระบุเวลาที่วิดีโอควรเริ่มและหยุดเล่นเมื่อวิดีโอเล่นในบริบทของเพลย์ลิสต์) ค่าเริ่มต้นคือ 0 |
contentDetails.endAt |
string หมายเหตุ: ระบบเลิกใช้งานพร็อพเพอร์ตี้นี้แล้ว และหากมีการตั้งค่า ระบบจะไม่สนใจค่าของพร็อพเพอร์ตี้ เวลาที่วัดเป็นวินาทีนับจากจุดเริ่มต้นของวิดีโอ ซึ่งวิดีโอควรหยุดเล่น (เจ้าของเพลย์ลิสต์สามารถระบุเวลาที่วิดีโอควรเริ่มและหยุดเล่นเมื่อวิดีโอเล่นในบริบทของเพลย์ลิสต์) โดยค่าเริ่มต้น ระบบจะถือว่า video.endTime คือจุดสิ้นสุดของวิดีโอ |
contentDetails.note |
string หมายเหตุที่ผู้ใช้สร้างขึ้นสำหรับรายการนี้ ค่าพร็อพเพอร์ตี้มีความยาวได้สูงสุด 280 อักขระ |
contentDetails.videoPublishedAt |
datetime วันที่และเวลาที่เผยแพร่วิดีโอลงใน YouTube ค่าที่ระบุอยู่ในรูปแบบ ISO 8601 |
status |
object ออบเจ็กต์ status มีข้อมูลเกี่ยวกับสถานะความเป็นส่วนตัวของรายการเพลย์ลิสต์ |
status.privacyStatus |
string สถานะความเป็นส่วนตัวของรายการในเพลย์ลิสต์ ช่องที่อัปโหลดวิดีโอที่รายการเพลย์ลิสต์แสดงจะตั้งค่านี้ได้โดยใช้เมธอด videos.insert หรือ videos.update |