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

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

คําขอด้านล่างเรียกเมธอด 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"
  }
}

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

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

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

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

    เรียกใช้เมธอด playlist.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"
      }
    }

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

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

ตัวอย่างนี้เพิ่มรายการไปยังเพลย์ลิสต์ คําขอนี้ต้องได้รับอนุญาตโดยใช้ OAuth 2.0 ตัวอย่างนี้มี 2 ขั้นตอน ดังนี้

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

    เรียกใช้เมธอด playlist.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 จะระบุค่าพร็อพเพอร์ตี้อื่นๆ ที่คุณตั้งค่าไว้เมื่อเพิ่มรายการเพลย์ลิสต์

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

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

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

    เรียกใช้เมธอด playlist.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

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

ตัวอย่างนี้ลบวิดีโอออกจากเพลย์ลิสต์ คําขอนี้ต้องได้รับอนุญาตโดยใช้ 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: ดึงข้อมูลรหัสเพลย์ลิสต์

    เรียกใช้เมธอด playlist.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

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