การใช้งาน: เพลย์ลิสต์

ตัวอย่างต่อไปนี้แสดงวิธีใช้ YouTube Data API (v3) เพื่อดำเนินการต่างๆ ที่เกี่ยวข้องกับเพลย์ลิสต์และรายการในเพลย์ลิสต์

เรียกข้อมูลเพลย์ลิสต์ของผู้ใช้ปัจจุบัน

เรียกใช้เมธอด playlists.list เพื่อเรียกข้อมูลเพลย์ลิสต์ของผู้ใช้ที่ตรวจสอบสิทธิ์ในปัจจุบัน ในคําขอ ให้ตั้งค่าพารามิเตอร์ mine เป็น true โปรดทราบว่าคําขอที่ใช้พารามิเตอร์ mine จะต้องได้รับสิทธิ์โดยใช้ OAuth 2.0

https://developers.google.com/apis-explorer/#p/youtube/v3/youtube.playlists.list?
        part=snippet,contentDetails
        &mine=true

เรียกข้อมูลเพลย์ลิสต์ของผู้ใช้

ตัวอย่างนี้จะดึงข้อมูลเพลย์ลิสต์ที่สร้างโดยช่องหนึ่งๆ ตัวอย่างนี้มี 2 ขั้นตอน ดังนี้

เรียกข้อมูลเกี่ยวกับเพลย์ลิสต์ที่เฉพาะเจาะจง

หากต้องการเรียกข้อมูลเกี่ยวกับเพลย์ลิสต์ที่เฉพาะเจาะจงอย่างน้อย 1 รายการ ให้เรียกใช้เมธอด playlists.list และตั้งค่าพารามิเตอร์ id เป็นรายการรหัสเพลย์ลิสต์ YouTube ที่คั่นด้วยคอมมาซึ่งระบุแหล่งข้อมูลที่คุณต้องการ Use Case ที่พบบ่อยสำหรับฟังก์ชันนี้คือคำขอเรียกข้อมูลอื่นๆ เกี่ยวกับกลุ่มเพลย์ลิสต์ที่แสดงในชุดผลการค้นหา เช่น คุณอาจต้องการดึงข้อมูลจํานวนรายการในเพลย์ลิสต์แต่ละรายการ

คําขอด้านล่างเรียกใช้เมธอด playlists.list เพื่อดึงข้อมูลจํานวนรายการในเพลย์ลิสต์ 2 รายการที่ตรงกับคําค้นหา "GoogleDevelopers" ข้อมูลนี้อยู่ในพร็อพเพอร์ตี้ contentDetails.itemCount ของทรัพยากร playlist ดังนั้นคําขอจึงตั้งค่าพารามิเตอร์ part เป็น contentDetails 

https://developers.google.com/apis-explorer/#p/youtube/v3/youtube.playlists.list?
        part=contentDetails
        &id=PLOU2XLYxmsIIM9h1Ybw2DuRw6o2fkNMeR,PLyYlLs02rgBYRWBzYpoHz7m2SE8mEZ68w

เพิ่มเพลย์ลิสต์

ตัวอย่างนี้จะเรียกใช้เมธอด playlists.insert เพื่อสร้างเพลย์ลิสต์ส่วนตัวในช่องของผู้ใช้ที่ตรวจสอบสิทธิ์แล้ว คำขอ API ใดก็ตามที่ส่งไปยังเมธอดนี้ต้องได้รับสิทธิ์โดยใช้ OAuth 2.0

https://developers.google.com/apis-explorer/#p/youtube/v3/youtube.playlists.insert?
        part=snippet,status

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

{
  "snippet": {
    "title": "New playlist",
    "description": "New playlist description"
  },
  "status": {
    "privacyStatus": "private"
  }
}

ตัวอย่างต่อไปนี้จะทําเครื่องหมายเพลย์ลิสต์ใหม่เป็นรายการพอดแคสต์

{
  "snippet": {
    "title": "New playlist",
    "description": "New playlist description"
  },
  "status": {
    "podcastStatus": "enabled"
  }
}

ตัวอย่างโค้ดที่เกี่ยวข้อง: Java, JavaScript, .NET, PHP, Python

อัปเดตเพลย์ลิสต์

ตัวอย่างนี้จะอัปเดตสถานะความเป็นส่วนตัวของเพลย์ลิสต์จาก private เป็น public ตัวอย่างนี้มี 2 ขั้นตอน ดังนี้

  • ขั้นตอนที่ 1: เรียกข้อมูลรหัสเพลย์ลิสต์

    เรียกใช้เมธอด playlists.list เพื่อเรียกข้อมูลเพลย์ลิสต์ในช่องของผู้ใช้ที่ตรวจสอบสิทธิ์ในปัจจุบัน ตัวอย่างคําขอด้านบนสําหรับการเรียกข้อมูลเพลย์ลิสต์ของผู้ใช้ปัจจุบันแสดงคําขอนี้ แอปพลิเคชันที่เรียก API สามารถประมวลผลการตอบกลับของ API เพื่อแสดงรายการเพลย์ลิสต์ได้โดยใช้รหัสของเพลย์ลิสต์แต่ละรายการเป็นคีย์

  • ขั้นตอนที่ 2: การอัปเดตเพลย์ลิสต์

    เรียกใช้เมธอด playlists.update เพื่อแก้ไขเพลย์ลิสต์ที่เฉพาะเจาะจง วิธีนี้ต้องใช้โทเค็นการให้สิทธิ์ OAuth 2.0 ที่ถูกต้อง

    เนื้อความของคำขอต้องมีส่วน snippet ของทรัพยากร playlist เนื่องจากต้องใช้พร็อพเพอร์ตี้ snippet.title เมื่อเรียกใช้เมธอดนี้ นอกจากนี้ หากทรัพยากรเพลย์ลิสต์ที่อัปเดตระบุค่าสำหรับพร็อพเพอร์ตี้ snippet.description หรือ snippet.tags คุณจะต้องระบุค่าเหล่านั้นอีกครั้งในคำขออัปเดต ไม่เช่นนั้นระบบจะลบค่าเหล่านั้น

    https://developers.google.com/apis-explorer/#p/youtube/v3/youtube.playlists.update?
        part=snippet,status

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

    {
  "id": "PLAYLIST_ID",
  "snippet": {
    "title": "New playlist",
    "description": "New playlist description"
  },
  "status": {
    "privacyStatus": "public"
  }
}

    ตัวอย่างต่อไปนี้จะทําเครื่องหมายเพลย์ลิสต์เป็นรายการพอดแคสต์

    {
  "id": "PLAYLIST_ID",
  "snippet": {
    "title": "New playlist",
    "description": "New playlist description"
  },
  "status": {
    "podcastStatus": "enabled"
  }
}

    หมายเหตุ: หากทดสอบการค้นหานี้ในโปรแกรมสำรวจ API คุณจะต้องแทนที่รหัสเพลย์ลิสต์ที่ถูกต้องลงในเนื้อหาของทรัพยากร หากต้องการรับรหัสเพลย์ลิสต์ เราขอแนะนำให้คุณเรียกใช้คําขอที่แสดงด้านบนสําหรับการเพิ่มเพลย์ลิสต์ก่อน ดึงรหัสเพลย์ลิสต์จากการตอบกลับของ API และใช้ค่านั้นกับเพลย์ลิสต์ที่ต้องการอัปเดต ชื่อและคำอธิบายเพลย์ลิสต์ที่ใช้ในตัวอย่างนี้เหมือนกับที่ใช้ในตัวอย่างนั้น

เพิ่มรายการเพลย์ลิสต์

ตัวอย่างนี้จะเพิ่มรายการลงในเพลย์ลิสต์ คำขอนี้ต้องได้รับสิทธิ์โดยใช้ OAuth 2.0 ตัวอย่างนี้มี 2 ขั้นตอน ดังนี้

  • ขั้นตอนที่ 1: เรียกข้อมูลรหัสเพลย์ลิสต์ที่เหมาะสม

    เรียกใช้เมธอด playlists.list เพื่อเรียกข้อมูลเพลย์ลิสต์ในช่องของผู้ใช้ที่ตรวจสอบสิทธิ์ในปัจจุบัน คําขอตัวอย่างด้านบนสําหรับการเรียกข้อมูลเพลย์ลิสต์ของผู้ใช้ปัจจุบันแสดงคําขอนี้ แอปพลิเคชันที่เรียก API สามารถประมวลผลการตอบกลับของ API เพื่อแสดงรายการเพลย์ลิสต์ได้โดยใช้รหัสของเพลย์ลิสต์แต่ละรายการเป็นคีย์

  • ขั้นตอนที่ 2: เพิ่มวิดีโอลงในเพลย์ลิสต์

    เรียกใช้เมธอด playlistItems.insert เพื่อเพิ่มวิดีโอลงในเพลย์ลิสต์ คำขอนี้ต้องได้รับสิทธิ์โดยใช้ OAuth 2.0 เนื้อหาคําขอคือแหล่งข้อมูล playlistItem ที่ระบุค่าต่อไปนี้เป็นอย่างน้อย

    • snippet.playlistId จะระบุเพลย์ลิสต์ที่คุณเพิ่มวิดีโอ นี่คือรหัสเพลย์ลิสต์ที่คุณได้รับในขั้นตอนที่ 1
    • snippet.resourceId.kind มีค่า youtube#video
    • snippet.resourceId.videoId จะระบุวิดีโอที่คุณเพิ่มลงในเพลย์ลิสต์ ค่าพร็อพเพอร์ตี้คือรหัสวิดีโอ YouTube ที่ไม่ซ้ำกัน

    คำขอ API ด้านล่างจะเพิ่มวิดีโอลงในเพลย์ลิสต์ เนื้อหาของคําขอคือ

    {
  "snippet": {
    "playlistId": "PLAYLIST_ID",
    "resourceId": {
      "kind": "youtube#video",
      "videoId": "VIDEO_ID"
    }
  }
}

    หากต้องการส่งคําขอในโปรแกรมสํารวจ API ให้เสร็จสมบูรณ์ คุณต้องกําหนดค่าสําหรับพร็อพเพอร์ตี้ snippet.playlistId และ snippet.resourceId.videoId

    https://developers.google.com/apis-explorer/#p/youtube/v3/youtube.playlistItems.insert?
        part=snippet

    หมายเหตุ: เอกสารประกอบสำหรับเมธอด playlistItems.insert จะระบุค่าพร็อพเพอร์ตี้อื่นๆ ที่คุณตั้งค่าได้เมื่อเพิ่มรายการเพลย์ลิสต์

เพิ่มรูปภาพเพลย์ลิสต์

คุณสามารถใช้เมธอด playlistImages.insert ของ v3 API เพื่ออัปโหลดรูปภาพปกที่กำหนดเองและตั้งค่าสำหรับเพลย์ลิสต์ ในคำขอ ค่าของพารามิเตอร์ playlistId จะระบุเพลย์ลิสต์ที่จะใช้ภาพปก

ไม่สามารถทดสอบการค้นหานี้โดยใช้โปรแกรมสำรวจ API เนื่องจากโปรแกรมสำรวจ API ไม่รองรับการอัปโหลดไฟล์สื่อ ซึ่งเป็นข้อกำหนดสำหรับวิธีการนี้

อัปเดตรายการในเพลย์ลิสต์

ตัวอย่างนี้จะอัปเดตรายการเพลย์ลิสต์เพื่อให้เป็นรายการแรกในเพลย์ลิสต์ คำขอนี้ต้องได้รับสิทธิ์โดยใช้ OAuth 2.0 ตัวอย่างนี้มี 3 ขั้นตอนดังนี้

  • ขั้นตอนที่ 1: เรียกข้อมูลรหัสเพลย์ลิสต์ที่เหมาะสม

    เรียกใช้เมธอด playlists.list เพื่อเรียกข้อมูลเพลย์ลิสต์ในช่องของผู้ใช้ที่ตรวจสอบสิทธิ์ในปัจจุบัน ตัวอย่างคําขอด้านบนสําหรับการเรียกข้อมูลเพลย์ลิสต์ของผู้ใช้ปัจจุบันแสดงคําขอนี้ แอปพลิเคชันที่เรียก API สามารถประมวลผลการตอบกลับของ API เพื่อแสดงรายการเพลย์ลิสต์ได้โดยใช้รหัสของเพลย์ลิสต์แต่ละรายการเป็นคีย์

  • ขั้นตอนที่ 2: ดึงข้อมูลรายการในเพลย์ลิสต์ที่เลือก

    เรียกใช้เมธอด playlistItems.list เพื่อดึงข้อมูลรายการวิดีโอในเพลย์ลิสต์ที่เลือก ตั้งค่าพารามิเตอร์ playlistId เป็นรหัสเพลย์ลิสต์ที่คุณได้รับในขั้นตอนที่ 1

    ทรัพยากรแต่ละรายการในการตอบกลับของ API จะมีพร็อพเพอร์ตี้ id ซึ่งระบุรหัสรายการเพลย์ลิสต์ที่ระบุรายการนั้นได้อย่างไม่ซ้ำกัน คุณจะใช้ค่าดังกล่าวเพื่อนำรายการออกจากรายการในขั้นตอนถัดไป

  • ขั้นตอนที่ 3: อัปเดตรายการเพลย์ลิสต์ที่เลือก

    เรียกใช้เมธอด playlistItems.update เพื่อเปลี่ยนตำแหน่งของวิดีโอในเพลย์ลิสต์ ตั้งค่าพารามิเตอร์ part เป็น snippet เนื้อหาของคําขอต้องเป็นทรัพยากร playlistItem ที่ตั้งค่าต่อไปนี้เป็นอย่างน้อย

    • ตั้งค่าพร็อพเพอร์ตี้ id เป็นรหัสรายการเพลย์ลิสต์ที่ได้ในขั้นตอนที่ 2
    • ตั้งค่าพร็อพเพอร์ตี้ snippet.playlistId เป็นรหัสเพลย์ลิสต์ที่ได้ในขั้นตอนที่ 1
    • ตั้งค่าพร็อพเพอร์ตี้ snippet.resourceId.kind เป็น youtube#video
    • ตั้งค่าพร็อพเพอร์ตี้ snippet.resourceId.videoId เป็นรหัสวิดีโอที่ระบุวิดีโอที่รวมอยู่ในเพลย์ลิสต์โดยไม่ซ้ำกัน
    • ตั้งค่าพร็อพเพอร์ตี้ snippet.position เป็น 0 หรือตำแหน่งใดก็ตามที่ต้องการให้รายการปรากฏ (โดยใช้ดัชนีฐาน 0)

    คำขอ API ด้านล่างจะอัปเดตรายการเพลย์ลิสต์ให้เป็นรายการแรกในเพลย์ลิสต์ เนื้อหาของคําขอคือ

    {
  "id": "PLAYLIST_ITEM_ID",
  "snippet": {
    "playlistId": "PLAYLIST_ID",
    "resourceId": {
      "kind": "youtube#video",
      "videoId": "VIDEO_ID"
    },
    "position": 0
  }
}

    หากต้องการส่งคําขอในโปรแกรมสํารวจ API ให้เสร็จสมบูรณ์ คุณต้องกําหนดค่าสําหรับพร็อพเพอร์ตี้ id, snippet.playlistId และ snippet.resourceId.videoId

    https://developers.google.com/apis-explorer/#p/youtube/v3/youtube.playlistItems.update?
        part=snippet

อัปเดตรูปภาพเพลย์ลิสต์

คุณสามารถใช้เมธอด playlistImages.update ของ v3 API เพื่ออัปเดตรูปภาพปกของเพลย์ลิสต์ได้ ในคำขอ ค่าของพารามิเตอร์ playlistId จะระบุเพลย์ลิสต์ที่จะใช้ภาพปก

ไม่สามารถทดสอบการค้นหานี้โดยใช้โปรแกรมสำรวจ API เนื่องจากโปรแกรมสำรวจ API ไม่รองรับการอัปโหลดไฟล์สื่อ ซึ่งเป็นข้อกำหนดสำหรับวิธีการนี้

นำรายการเพลย์ลิสต์ออก

ตัวอย่างนี้จะลบวิดีโอออกจากเพลย์ลิสต์ คำขอนี้ต้องได้รับสิทธิ์โดยใช้ OAuth 2.0 ตัวอย่างนี้มี 3 ขั้นตอน 2 ขั้นตอนแรกจะเหมือนกับขั้นตอนในตัวอย่างด้านบนสำหรับการอัปเดตรายการในเพลย์ลิสต์

หลังจากทำตามขั้นตอนดังกล่าวแล้ว ให้เรียกใช้เมธอด playlistItems.delete เพื่อนำวิดีโอออกจากเพลย์ลิสต์ ตั้งค่าพารามิเตอร์ id ของคำขอเป็นรหัสรายการเพลย์ลิสต์ของรายการที่ต้องการนำออก คำขอนี้ต้องได้รับสิทธิ์โดยใช้ OAuth 2.0

โปรดทราบว่ารหัสรายการเพลย์ลิสต์ที่ใช้ระบุวิดีโอในเพลย์ลิสต์นั้นแตกต่างจากรหัสวิดีโอ YouTube ที่ระบุวิดีโอนั้นๆ ได้อย่างไม่ซ้ำกัน รหัสรายการเพลย์ลิสต์จะระบุวิดีโอว่าเป็นรายการในเพลย์ลิสต์หนึ่งๆ

คุณต้องตั้งค่าพร็อพเพอร์ตี้ id เพื่อให้คําขอในเครื่องมือสํารวจ API ทํางานได้

https://developers.google.com/apis-explorer/#p/youtube/v3/youtube.playlistItems.delete?
        id=PLAYLIST_ITEM_ID

นำรูปภาพเพลย์ลิสต์ออก

ตัวอย่างนี้จะลบรูปภาพเพลย์ลิสต์ ตัวอย่างนี้มี 2 ขั้นตอน ดังนี้

  • ขั้นตอนที่ 1: เรียกข้อมูลเพลย์ลิสต์

    เรียกใช้เมธอด playlists.list เพื่อเรียกข้อมูลเพลย์ลิสต์ในช่องของผู้ใช้ที่ตรวจสอบสิทธิ์ในปัจจุบัน ตัวอย่างคําขอด้านบนสําหรับการเรียกข้อมูลเพลย์ลิสต์ของผู้ใช้ปัจจุบันแสดงคําขอนี้ แอปพลิเคชันที่เรียก API สามารถประมวลผลการตอบกลับของ API เพื่อแสดงรายการเพลย์ลิสต์ได้โดยใช้รหัสของเพลย์ลิสต์แต่ละรายการเป็นคีย์

  • ขั้นตอนที่ 2: เรียกข้อมูลรหัสรูปภาพเพลย์ลิสต์

    เรียกใช้เมธอด playlistImages.list เพื่อดึงข้อมูลภาพปกของเพลย์ลิสต์ ใช้รหัสเพลย์ลิสต์สำหรับเพลย์ลิสต์ที่ต้องการเปลี่ยน

  • ขั้นตอนที่ 3: การลบรูปภาพเพลย์ลิสต์

    เรียกใช้เมธอด playlistImages.delete เพื่อลบรูปภาพเพลย์ลิสต์ที่เฉพาะเจาะจง ในคำขอ พารามิเตอร์ id จะระบุรหัสของรูปภาพเพลย์ลิสต์ที่จะลบ วิธีนี้ต้องใช้โทเค็นการให้สิทธิ์ OAuth 2.0 ที่ถูกต้อง หากทดสอบการค้นหานี้ในโปรแกรมสำรวจ API คุณจะต้องแทนที่ค่าพารามิเตอร์ id ด้วยรหัสเพลย์ลิสต์ที่ถูกต้อง

    https://developers.google.com/apis-explorer/#p/youtube/v3/youtube.playlistImages.delete?
        id=ID

    หมายเหตุ: หากทดสอบการค้นหานี้ในโปรแกรมสำรวจ API คุณจะต้องแทนที่ค่าพารามิเตอร์ id ด้วยรหัสรูปภาพเพลย์ลิสต์ที่ถูกต้อง

นำเพลย์ลิสต์ออก

ตัวอย่างนี้จะลบเพลย์ลิสต์ ตัวอย่างนี้มี 2 ขั้นตอน ดังนี้

  • ขั้นตอนที่ 1: เรียกข้อมูลรหัสเพลย์ลิสต์

    เรียกใช้เมธอด playlists.list เพื่อเรียกข้อมูลเพลย์ลิสต์ในช่องของผู้ใช้ที่ตรวจสอบสิทธิ์ในปัจจุบัน ตัวอย่างคําขอด้านบนสําหรับการเรียกข้อมูลเพลย์ลิสต์ของผู้ใช้ปัจจุบันแสดงคําขอนี้ แอปพลิเคชันที่เรียก API สามารถประมวลผลการตอบกลับของ API เพื่อแสดงรายการเพลย์ลิสต์ได้โดยใช้รหัสของเพลย์ลิสต์แต่ละรายการเป็นคีย์

  • ขั้นตอนที่ 2: การลบเพลย์ลิสต์

    เรียกใช้เมธอด playlists.delete เพื่อลบเพลย์ลิสต์ที่เฉพาะเจาะจง ในคำขอ พารามิเตอร์ id จะระบุรหัสเพลย์ลิสต์ของเพลย์ลิสต์ที่จะลบ วิธีนี้ต้องใช้โทเค็นการให้สิทธิ์ OAuth 2.0 ที่ถูกต้อง หากทดสอบการค้นหานี้ในโปรแกรมสำรวจ API คุณจะต้องแทนที่ค่าพารามิเตอร์ id ด้วยรหัสเพลย์ลิสต์ที่ถูกต้อง

    https://developers.google.com/apis-explorer/#p/youtube/v3/youtube.playlists.delete?
        id=PLAYLIST_ID

    หมายเหตุ: หากทดสอบการค้นหานี้ในโปรแกรมสำรวจ API คุณจะต้องแทนที่ค่าพารามิเตอร์ id ด้วยรหัสเพลย์ลิสต์ที่ถูกต้อง หากต้องการรับรหัสเพลย์ลิสต์ เราขอแนะนำให้คุณเรียกใช้คําขอที่แสดงด้านบนสําหรับการเพิ่มเพลย์ลิสต์ก่อน ดึงรหัสเพลย์ลิสต์จากการตอบกลับของ API และใช้ค่านั้นกับเพลย์ลิสต์ที่ต้องการลบ