PlaylistItems

playlistItem ทรัพยากรจะระบุทรัพยากรอื่น เช่น วิดีโอ ที่รวมอยู่ในเพลย์ลิสต์ นอกจากนี้ playlistItem resource ยังมีรายละเอียดเกี่ยวกับทรัพยากรที่รวมไว้ซึ่งเกี่ยวข้องโดยเฉพาะกับวิธีใช้ทรัพยากรนั้น ในเพลย์ลิสต์นั้น

นอกจากนี้ YouTube ยังใช้เพลย์ลิสต์เพื่อระบุรายการวิดีโอที่อัปโหลดของช่อง โดยแต่ละplaylistItemในรายการนั้นจะแสดงถึงวิดีโอที่อัปโหลด 1 รายการ คุณสามารถดึงข้อมูล รหัสเพลย์ลิสต์สำหรับรายการนั้นจากchannel แหล่งข้อมูลของช่องที่ต้องการ จากนั้นคุณจะใช้ 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
ค่าคีย์ที่ใช้ได้มีดังนี้
  • default - รูปภาพขนาดย่อเริ่มต้น ภาพปกเริ่มต้นสำหรับวิดีโอหรือแหล่งข้อมูลที่อ้างอิงถึงวิดีโอ เช่น รายการในเพลย์ลิสต์หรือผลการค้นหา มีความกว้าง 120 พิกเซลและความสูง 90 พิกเซล ภาพปกเริ่มต้นของช่องมีความกว้าง 88 พิกเซลและความสูง 88 พิกเซล
  • medium - รูปภาพขนาดย่อเวอร์ชันที่มีความละเอียดสูงกว่า สำหรับวิดีโอ (หรือแหล่งข้อมูลที่อ้างอิงถึงวิดีโอ) รูปภาพนี้มีความกว้าง 320 พิกเซลและความสูง 180 พิกเซล สำหรับช่อง รูปภาพนี้จะมีความกว้าง 240 พิกเซลและสูง 240 พิกเซล
  • high – เวอร์ชันความละเอียดสูงของรูปภาพขนาดย่อ สำหรับวิดีโอ (หรือทรัพยากรที่อ้างอิงถึงวิดีโอ) รูปภาพนี้จะมีความกว้าง 480 พิกเซลและความสูง 360 พิกเซล สำหรับช่อง รูปภาพนี้จะมีความกว้าง 800 พิกเซลและความสูง 800 พิกเซล
  • standard - รูปภาพขนาดย่อเวอร์ชันที่มีความละเอียดสูงกว่ารูปภาพความละเอียด high รูปภาพนี้พร้อมใช้งานสำหรับวิดีโอบางรายการและแหล่งข้อมูลอื่นๆ ที่อ้างอิงถึงวิดีโอ เช่น รายการในเพลย์ลิสต์หรือผลการค้นหา รูปภาพนี้กว้าง 640 พิกเซลและสูง 480 พิกเซล
  • maxres - รูปภาพขนาดย่อเวอร์ชันที่มีความละเอียดสูงสุด ขนาดรูปภาพนี้ใช้ได้กับวิดีโอบางรายการและแหล่งข้อมูลอื่นๆ ที่อ้างอิงถึงวิดีโอ เช่น รายการในเพลย์ลิสต์หรือผลการค้นหา รูปภาพนี้มีความกว้าง 1280 พิกเซลและสูง 720 พิกเซล
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 รายการที่สองจะมีตำแหน่งเป็น 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