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
  },
  "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 – ภาพขนาดย่อเริ่มต้น ภาพขนาดย่อเริ่มต้นของวิดีโอหรือทรัพยากรที่อ้างอิงไปยังวิดีโอ เช่น รายการเพลย์ลิสต์หรือผลการค้นหา มีความกว้าง 120px และสูง 90px ภาพขนาดย่อเริ่มต้นของช่องคือกว้าง 88 พิกเซลและสูง 88 พิกเซล
  • medium – ภาพปกเวอร์ชันที่มีความละเอียดสูงกว่า สำหรับวิดีโอ (หรือทรัพยากรที่อ้างถึงวิดีโอ) รูปภาพนี้จะกว้าง 320px และสูง 180px สำหรับช่อง รูปภาพนี้จะกว้าง 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.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
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
คำอธิบายเพลย์ลิสต์ที่มีการแปลภาษา