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

ตัวอย่างต่อไปนี้แสดงวิธีใช้ API ข้อมูลของ YouTube (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 ที่คั่นด้วยคอมมาซึ่งระบุทรัพยากรที่ต้องการ กรณีการใช้งานทั่วไปของฟังก์ชันนี้คือคำขอเพื่อดึงข้อมูลเพิ่มเติมเกี่ยวกับกลุ่มเพลย์ลิสต์ที่แสดงในชุดผลการค้นหา เช่น คุณอาจต้องการดูจำนวนรายการในเพลย์ลิสต์แต่ละรายการ

คำขอด้านล่างเรียกใช้เมธอด 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 Explorer จะตั้งค่าพารามิเตอร์ที่ระบุส่วนเนื้อหาของคำขอ 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 Explorer จะตั้งค่าพารามิเตอร์ที่ระบุเนื้อหาคำขอ 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 Explorer คุณจะต้องใช้รหัสเพลย์ลิสต์ที่ถูกต้องในเนื้อหาทรัพยากร หากต้องการรับรหัสเพลย์ลิสต์ เราขอแนะนำให้คุณส่งคำขอเพิ่มเพลย์ลิสต์ที่แสดงอยู่ด้านบนก่อน ดึงรหัสเพลย์ลิสต์จากการตอบกลับของ 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 Explorer คุณจะต้องตั้งค่าสำหรับพร็อพเพอร์ตี้ 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 Explorer ได้ เนื่องจาก API Explorer ไม่สนับสนุนความสามารถในการอัปโหลดไฟล์สื่อ ซึ่งเป็นข้อกำหนดสำหรับวิธีการนี้

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

ตัวอย่างนี้อัปเดตรายการในเพลย์ลิสต์เพื่อให้เป็นรายการแรกในเพลย์ลิสต์ คำขอนี้ต้องได้รับสิทธิ์โดยใช้ 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 Explorer คุณจะต้องตั้งค่าสำหรับพร็อพเพอร์ตี้ 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 Explorer ได้ เนื่องจาก API Explorer ไม่สนับสนุนความสามารถในการอัปโหลดไฟล์สื่อ ซึ่งเป็นข้อกำหนดสำหรับวิธีการนี้

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

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

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

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

ในการดำเนินการตามคำขอใน API Explorer ให้เสร็จสมบูรณ์ คุณต้องตั้งค่าพร็อพเพอร์ตี้ id

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 Explorer คุณจะต้องแทนที่ค่าพารามิเตอร์ id ด้วยรหัสเพลย์ลิสต์ที่ถูกต้อง

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

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

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

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

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

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

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

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

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

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