Playlists

playlist ทรัพยากรแสดงถึงเพลย์ลิสต์ YouTube เพลย์ลิสต์คือคอลเล็กชันวิดีโอที่ดูตามลำดับและแชร์กับผู้ใช้คนอื่นๆ ได้ โดยค่าเริ่มต้น เพลย์ลิสต์จะแสดงต่อ��ู้ใช้รายอื่นแบบสาธารณะ แต่คุณจะตั้งค่าเพลย์ลิสต์เป็นแบบสาธารณะหรือส่วนตัวก็ได้

นอกจากนี้ 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 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 พิกเซล
  • fhd – รูปภาพขนาดย่อเวอร์ชันความละเอียดสูงเต็มประสิทธิภาพ (1080p) ขนาดภาพนี้พร้อมใช้งานสำหรับวิดีโอบางรายการ รูปภาพนี้มีความกว้าง 1920 พิกเซลและสูง 1080 พิกเซล
  • qhd – ภาพขนาดย่อเวอร์ชัน Quad High Definition (1440p / 2K) ขนาดภาพนี้พร้อมใช้งานสำหรับวิดีโอบางรายการ รูปภาพนี้มีความกว้าง 2560 พิกเซล และสูง 1440 พิกเซล
  • uhd – รูปภาพขนาดย่อเวอร์ชันความละเอียดสูงพิเศษ (4K) ขนาดภาพนี้พร้อมใช้งานสำหรับวิดีโอบางรายการ รูปภาพนี้มีความกว้าง 3840 พิกเซลและสูง 2160 พิกเซล
snippet.thumbnails.(key).url string
URL ของรูปภาพ
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 มีชื่อและคำอธิบายที่แปลแล้วสำหรับเพลย์ลิสต์ หรือชื่อในภาษาเริ่มต้นสำหรับข้อมูลเมตาของเพลย์ลิสต์
  • ระบบจะแสดงข้อความที่แปลแล้วในข้อมูลโค้ดของทรัพยากร หากคำขอ playlists.list ใช้พารามิเตอร์ hl เพื่อระบุภาษาที่ควรแสดงข้อความที่แปลแล้ว และมีข้อความที่แปลแล้วในภาษานั้น
  • ระบบจะแสดงข้อมูลเมตาสำหรับภาษาเริ่มต้นหากไม่ได้ระบุhlค่าพารามิเตอร์หรือระบุค่าแล้ว แต่ไม่มีข้อมูลเมตาที่แปลเป็นภาษาท้องถิ่นสำหรับภาษาที่ระบุ
พร็อพเพอร์ตี้มีค่าแบบอ่านอย่างเดียว ใช้ออบเจ็กต์ localizations เพื่อเพิ่ม อัปเดต หรือลบชื่อที่แปลแล้ว
snippet.localized.title string
ชื่อเพลย์ลิสต์ที่แปลแล้ว
snippet.localized.description string
คำอธิบายเพลย์ลิสต์ที่แปลแล้ว
status object
ออบเจ็กต์ status มีข้อมูลสถานะสำหรับเพลย์ลิสต์
status.privacyStatus string
สถานะความเป็นส่วนตัวของเพลย์ลิสต์

ค่าที่ใช้ได้สำหรับพร็อพเพอร์ตี้นี้มีดังนี้
  • private
  • public
  • unlisted
status.podcastStatus string
สถานะพอดแคสต์ของเพลย์ลิสต์ หากค่าเป็น enabled ระบบจะทำเครื่องหมายเพลย์ลิสต์เป็นรายการพอดแคสต์ หากต้องการตั้งค่าสถานะพอดแคสต์ของเพลย์ลิสต์เป็น enabled เพลย์ลิสต์ต้องมีรูปภาพเพลย์ลิสต์

ค่าที่ถูกต้องสำหรับพร็อพเพอร์ตี้นี้มีดังนี้
  • enabled
  • disabled
  • unspecified
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
คำอธิบายเพลย์ลิสต์ที่แปลแล้ว