ทรัพยากร playlistItem
จะระบุทรัพยากรอื่น เช่น วิดีโอที่อยู่ในเพลย์ลิสต์ นอกจากนี้ ทรัพยากร playlistItem
ยังมีรายละเอียดเกี่ยวกับทรัพยากรที่รวมไว้ซึ่งเกี่ยวข้องกับวิธีการใช้ทรัพยากรดังกล่าวในเพลย์ลิสต์ดังกล่าวโดยเฉพาะ
นอกจากนี้ YouTube ยังใช้เพลย์ลิสต์เพื่อระบุรายการวิดีโอที่อัปโหลดของช่อง โดย playlistItem
แต่ละรายการในรายการดังกล่าวจะแสดงถึงวิดีโอที่อัปโหลด 1 รายการ คุณเรียกดูรหัสเพลย์ลิสต์สำหรับรายการดังกล่าวได้จาก channel resource
ของช่องหนึ่งๆ จากนั้นคุณจะใช้เมธอด playlistItems.list
ในรายการได้
วิธีการ
API รองรับเมธอดต่อไปนี้สำหรับทรัพยากร playlistItems
รายการ
- list
- แสดงผลคอลเล็กชันรายการเพลย์ลิสต์ที่ตรงกับพารามิเตอร์คำขอ API คุณสามารถดึงรายการเพลย์ลิสต์ทั้งหมดในเพลย์ลิสต์ที่ระบุ หรือดึงรายการเพลย์ลิสต์อย่างน้อยหนึ่งรายการตามรหัสที่ไม่ซ้ำกัน ลองใช้เลย
- แทรก
- เพิ่มแหล่งข้อมูลลงในเพลย์ลิสต์ ลองใช้เลย
- อัปเดต
- แก้ไขรายการเพลย์ลิสต์ เช่น อัปเดตตำแหน่งของรายการในเพลย์ลิสต์ ลองใช้เลย
- ลบ
- ลบรายการเพลย์ลิสต์ ลองใช้เลย
การนำเสนอทรัพยากร
โครงสร้าง 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 |