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