Playlists

Tài nguyên playlist đại diện cho một danh sách phát trên YouTube. Danh sách phát là một bộ sưu tập video mà bạn có thể xem theo thứ tự và chia sẻ với người dùng khác. Theo mặc định, danh sách phát sẽ hiển thị công khai cho những người dùng khác, nhưng danh sách phát có thể ở chế độ công khai hoặc riêng tư.

YouTube cũng sử dụng danh sách phát để xác định các bộ sưu tập video đặc biệt của một kênh, chẳng hạn như:

  • video đã tải lên
  • video được đánh giá tích cực (đã thích)
Cụ thể hơn, những danh sách này được liên kết với một kênh. Kênh là một tập hợp các video, danh sách phát và thông tin khác trên YouTube của một người, nhóm hoặc công ty. Bạn có thể truy xuất mã nhận dạng danh sách phát cho từng danh sách này từ channel resource của một kênh cụ thể.

Sau đó, bạn có thể dùng phương thức playlistItems.list để truy xuất bất kỳ danh sách nào trong số đó. Bạn cũng có thể thêm hoặc xoá các mục khỏi những danh sách đó bằng cách gọi phương thức playlistItems.insertplaylistItems.delete.

Phương thức

API này hỗ trợ các phương thức sau cho tài nguyên playlists:

list
Trả về một tập hợp các danh sách phát phù hợp với các tham số yêu cầu API. Ví dụ: bạn có thể truy xuất tất cả danh sách phát mà người dùng đã xác thực sở hữu hoặc bạn có thể truy xuất một hoặc nhiều danh sách phát theo mã nhận dạng duy nhất của chúng. Thử ngay.
chèn
Tạo danh sách phát. Thử ngay.
update
Sửa đổi một danh sách phát. Ví dụ: bạn có thể thay đổi tiêu đề, nội dung mô tả hoặc trạng thái quyền riêng tư của một danh sách phát. Thử ngay.
xóa
Xoá một danh sách phát. Thử ngay.

Cách trình bày tài nguyên

Cấu trúc JSON sau đây cho thấy định dạng của tài nguyên 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
    }
  }
}

Thuộc tính

Bảng sau đây xác định các thuộc tính xuất hiện trong tài nguyên này:

Thuộc tính
kind string
Xác định loại tài nguyên API. Giá trị sẽ là youtube#playlist.
etag etag
Etag của tài nguyên này.
id string
Mã nhận dạng mà YouTube dùng để xác định riêng biệt danh sách phát.
snippet object
Đối tượng snippet chứa các thông tin cơ bản về danh sách phát, chẳng hạn như tiêu đề và nội dung mô tả.
snippet.publishedAt datetime
Ngày và giờ tạo danh sách phát. Giá trị được chỉ định ở định dạng ISO 8601.
snippet.channelId string
Mã nhận dạng mà YouTube dùng để xác định riêng biệt kênh xuất bản danh sách phát.
snippet.title string
Tiêu đề của danh sách phát.
snippet.description string
Nội dung mô tả của danh sách phát.
snippet.thumbnails object
Bản đồ gồm các hình thu nhỏ liên kết với danh sách phát. Đối với mỗi đối tượng trong bản đồ, khoá là tên của hình thu nhỏ và giá trị là một đối tượng chứa thông tin khác về hình thu nhỏ.
snippet.thumbnails.(key) object
Các giá trị khoá hợp lệ là:
  • default – Hình thu nhỏ mặc định. Hình thu nhỏ mặc định cho một video (hoặc một tài nguyên đề cập đến video, chẳng hạn như một mục trong danh sách phát hoặc kết quả tìm kiếm) có chiều rộng 120 pixel và chiều cao 90 pixel. Hình thu nhỏ mặc định của kênh có kích thước rộng 88 pixel và cao 88 pixel.
  • medium – Phiên bản có độ phân giải cao hơn của hình thu nhỏ. Đối với video (hoặc tài nguyên đề cập đến video), hình ảnh này có chiều rộng 320 px và chiều cao 180 px. Đối với kênh, hình ảnh này có chiều rộng 240 px và chiều cao 240 px.
  • high – Phiên bản có độ phân giải cao của hình thu nhỏ. Đối với video (hoặc tài nguyên đề cập đến video), hình ảnh này có chiều rộng 480 pixel và chiều cao 360 pixel. Đối với kênh, hình ảnh này có chiều rộng 800px và chiều cao 800px.
  • standard – Phiên bản hình thu nhỏ có độ phân giải cao hơn cả hình ảnh có độ phân giải high. Hình ảnh này xuất hiện ở một số video và các tài nguyên khác có liên quan đến video, chẳng hạn như các mục trong danh sách phát hoặc kết quả tìm kiếm. Hình ảnh này có chiều rộng 640 px và chiều cao 480 px.
  • maxres – Phiên bản có độ phân giải cao nhất của hình thu nhỏ. Kích thước hình ảnh này có ở một số video và các tài nguyên khác có liên quan đến video, chẳng hạn như các mục trong danh sách phát hoặc kết quả tìm kiếm. Hình ảnh này có chiều rộng 1280px và chiều cao 720px.
snippet.thumbnails.(key).url string
URL của hình ảnh.
snippet.thumbnails.(key).width unsigned integer
Chiều rộng của hình ảnh.
snippet.thumbnails.(key).height unsigned integer
Chiều cao của hình ảnh.
snippet.channelTitle string
Tiêu đề của kênh có video đó.
snippet.tags[] list
Thuộc tính này không được dùng nữa.

Thẻ từ khoá liên kết với danh sách phát.
snippet.defaultLanguage string
Ngôn ngữ của văn bản trong các thuộc tính snippet.titlesnippet.description của tài nguyên playlist.
snippet.localized object
Đối tượng snippet.localized chứa tiêu đề và nội dung mô tả được bản địa hoá cho danh sách phát hoặc tiêu đề bằng ngôn ngữ mặc định cho siêu dữ liệu của danh sách phát.
  • Văn bản đã bản địa hoá sẽ được trả về trong đoạn tài nguyên nếu yêu cầu playlists.list sử dụng tham số hl để chỉ định một ngôn ngữ mà văn bản đã bản địa hoá sẽ được trả về văn bản đã bản địa hoá có sẵn bằng ngôn ngữ đó.
  • Siêu dữ liệu cho ngôn ngữ mặc định sẽ được trả về nếu bạn không chỉ định giá trị tham số hl hoặc chỉ định một giá trị nhưng siêu dữ liệu được bản địa hoá không có sẵn cho ngôn ngữ được chỉ định.
Thuộc tính này chứa một giá trị chỉ đọc. Sử dụng đối tượng localizations để thêm, cập nhật hoặc xoá tiêu đề bằng ngôn ngữ địa phương.
snippet.localized.title string
Tiêu đề danh sách phát đã được bản địa hoá.
snippet.localized.description string
Nội dung mô tả danh sách phát được bản địa hoá.
status object
Đối tượng status chứa thông tin trạng thái của danh sách phát.
status.privacyStatus string
Trạng thái riêng tư của danh sách phát.

Các giá trị hợp lệ cho thuộc tính này là:
  • private
  • public
  • unlisted
status.podcastStatus string
Trạng thái podcast của danh sách phát. Nếu giá trị là enabled, thì danh sách phát đó được đánh dấu là một chương trình podcast. Để đặt trạng thái podcast của một danh sách phát thành enabled, danh sách phát đó phải có hình ảnh danh sách phát.

Các giá trị hợp lệ cho thuộc tính này là:
  • enabled
  • disabled
  • unspecified
contentDetails object
Đối tượng contentDetails chứa thông tin về nội dung trong danh sách phát, bao gồm cả số lượng video trong danh sách phát.
contentDetails.itemCount unsigned integer
Số lượng video trong danh sách phát.
player object
Đối tượng player chứa thông tin mà bạn sẽ dùng để phát danh sách phát trong một trình phát được nhúng.
player.embedHtml string
Thẻ <iframe> nhúng một trình phát sẽ phát danh sách phát.
localizations object
Đối tượng localizations đóng gói bản dịch siêu dữ liệu của danh sách phát.
localizations.(key) object
Ngôn ngữ của văn bản bản địa hoá được liên kết với giá trị khoá. Giá trị này là một chuỗi chứa mã ngôn ngữ BCP-47.
localizations.(key).title string
Tiêu đề danh sách phát đã được bản địa hoá.
localizations.(key).description string
Nội dung mô tả danh sách phát được bản địa hoá.