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