playlist ทรัพยากรแสดงถึงเพลย์ลิสต์ YouTube เพลย์ลิสต์คือคอลเล็กชันวิดีโอที่ดูตามลำดับและแชร์กับผู้ใช้รายอื่นได้ โดยค่าเริ่มต้น เพลย์ลิสต์จะแสดงต่อผู้ใช้รายอื่นแบบสาธารณะ แต่คุณจะตั้งค่าเพลย์ลิสต์เป็นแบบสาธารณะหรือส่วนตัวก็ได้
นอกจากนี้ YouTube ยังใช้เพลย์ลิสต์เพื่อระบุคอลเล็กชันวิดีโอพิเศษสำหรับช่องด้วย เช่น
- วิดีโอที่อัปโหลด
- วิดีโอที่ได้รับการจัดประเภทในเชิงบวก (ชอบ)
channel resourceของช่องที่ต้องการจากนั้นคุณจะใช้วิธี
playlistItems.list เพื่อดึงข้อมูลรายการใดก็ได้ นอกจากนี้ คุณยังเพิ่มหรือนำรายการออกจากลิสต์เหล่านั้นได้โดยเรียกใช้เมธอด playlistItems.insert และ playlistItems.delete
เมธอด
API รองรับวิธีการต่อไปนี้สำหรับทรัพยากร playlists
- list
- แสดงผลคอลเล็กชันเพลย์ลิสต์ที่ตรงกับพารามิเตอร์คำขอ API เช่น คุณสามารถดึงข้อมูลเพลย์ลิสต์ทั้งหมดที่ผู้ใช้ที่ผ่านการตรวจสอบสิทธิ์เป็นเจ้าของ หรือดึงข้อมูลเพลย์ลิสต์อย่างน้อย 1 รายการตามรหัสที่ไม่ซ้ำกันของเพลย์ลิสต์นั้นๆ ลองใช้เลย
- แทรก
- สร้างเพลย์ลิสต์ ลองใช้เลย
- อัปเดต
- แก้ไขเพลย์ลิสต์ เช่น คุณอาจเปลี่ยนชื่อ คำอธิบาย หรือสถานะความเป็นส่วนตัวของเพลย์ลิสต์ได้ ลองใช้เลย
- ลบ
- ลบเพลย์ลิสต์ ลองใช้เลย
การแสดงทรัพยากร
โครงสร้าง JSON ต่อไปนี้แสดงรูปแบบของทรัพยากร playlists
{
"kind": "youtube#playlist",
"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,
"defaultLanguage": string,
"localized": {
"title": string,
"description": string
}
},
"status": {
"privacyStatus": string,
"podcastStatus": enum
},
"contentDetails": {
"itemCount": unsigned integer
},
"player": {
"embedHtml": string
},
"localizations": {
(key): {
"title": string,
"description": string
}
}
}พร็อพเพอร์ตี้
ตารางต่อไปนี้กำหนดพร็อพเพอร์ตี้ที่ปรากฏในทรัพยากรนี้
| พร็อพเพอร์ตี้ | |
|---|---|
kind |
stringระบุประเภทของทรัพยากร API ค่าจะเป็น youtube#playlist |
etag |
etagEtag ของทรัพยากรนี้ |
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 |
stringURL ของรูปภาพ |
snippet.thumbnails.(key).width |
unsigned integerความกว้างของรูปภาพ |
snippet.thumbnails.(key).height |
unsigned integerความสูงของรูปภาพ |
snippet.channelTitle |
stringชื่อช่องของช่องที่เป็นเจ้าของวิดีโอ |
snippet.tags[] |
listเลิกใช้งานพร็อพเพอร์ตี้นี้แล้ว แท็กคีย์เวิร์ดที่เชื่อมโยงกับเพลย์ลิสต์ |
snippet.defaultLanguage |
stringภาษาของข้อความในพร็อพเพอร์ตี้ snippet.title และ snippet.description ของทรัพยากร playlist |
snippet.localized |
objectออบเจ็กต์ snippet.localized มีทั้งชื่อและคำอธิบายที่แปลแล้วสำหรับเพลย์ลิสต์ หรือชื่อในภาษาเริ่มต้นสำหรับข้อมูลเมตาของเพลย์ลิสต์
localizations เพื่อเพิ่ม อัปเดต หรือลบชื่อที่แปลแล้ว |
snippet.localized.title |
stringชื่อเพลย์ลิสต์ที่แปลแล้ว |
snippet.localized.description |
stringคำอธิบายเพลย์ลิสต์ที่แปลแล้ว |
status |
objectออบเจ็กต์ status มีข้อมูลสถานะสำหรับเพลย์ลิสต์ |
status.privacyStatus |
stringสถานะความเป็นส่วนตัวของเพลย์ลิสต์ ค่าที่ใช้ได้สำหรับพร็อพเพอร์ตี้นี้มีดังนี้
|
status.podcastStatus |
stringสถานะพอดแคสต์ของเพลย์ลิสต์ หากค่าเป็น enabled ระบบจะทำเครื่องหมายเพลย์ลิสต์เป็นรายการพอดแคสต์ หากต้องการตั้งค่าสถานะพอดแคสต์ของเพลย์ลิสต์เป็น enabled เพลย์ลิสต์ต้องมีรูปภาพเพลย์ลิสต์ค่าที่ถูกต้องสำหรับพร็อพเพอร์ตี้นี้มีดังนี้
|
contentDetails |
objectออบเจ็กต์ contentDetails มีข้อมูลเกี่ยวกับเนื้อหาเพลย์ลิสต์ รวมถึงจำนวนวิดีโอในเพลย์ลิสต์ |
contentDetails.itemCount |
unsigned integerจำนวนวิดีโอในเพลย์ลิสต์ |
player |
objectออบเจ็กต์ player มีข้อมูลที่คุณจะใช้เพื่อเล่นเพลย์ลิสต์ในโปรแกรมเล่นแบบฝัง |
player.embedHtml |
stringแท็ก <iframe> ที่ฝังเพลเยอร์ซึ่งจะเล่นเพลย์ลิสต์ |
localizations |
objectออบเจ็กต์ localizations จะห่อหุ้มคำแปลของข้อมูลเมตาของเพลย์ลิสต์ |
localizations.(key) |
objectภาษาของข้อความที่แปลแล้วซึ่งเชื่อมโยงกับค่าคีย์ ค่านี้เป็นสตริงที่มีรหัสภาษา BCP-47 |
localizations.(key).title |
stringชื่อเพลย์ลิสต์ที่แปลแล้ว |
localizations.(key).description |
stringคำอธิบายเพลย์ลิสต์ที่แปลแล้ว |