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 tập hợp các video mà bạn có thể xem theo tuần 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 với người dùng khác. Tuy nhiên, 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 tuyển 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 (được thích)
channel resource của một kênh cụ thể.Sau đó, bạn có thể sử 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 các danh sách đó bằng cách gọi các phương thức playlistItems.insert và playlistItems.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 danh sách phát khớp với các tham số của 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 hay nhiều danh sách phát theo mã nhận dạng duy nhất của danh sách phát. Thử ngay.
- chèn
- Tạo danh sách phát. Thử ngay.
- cập nhật
- Sửa đổi 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 danh sách phát. Thử ngay.
- xóa
- Xoá danh sách phát. Thử ngay.
Biểu diễn 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 sử dụng để xác định chính xác danh sách phát. |
snippet |
object
Đối tượng snippet chứa thông tin chi tiết 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 để nhận dạng riêng 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
Sơ đồ 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 ả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à:
|
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 đề kênh của kênh chứa video đó. |
snippet.tags[] |
list
Thuộc tính này không được dùng nữa.Các thẻ từ khóa liên kết với danh sách phát. |
snippet.defaultLanguage |
string
Ngôn ngữ của văn bản trong thuộc tính snippet.title và snippet.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ả đã bản địa hoá của 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.
localizations để thêm, cập nhật hoặc xoá các bộ phim/chương trình đã bản địa hoá. |
snippet.localized.title |
string
Tiêu đề danh sách phát được bản địa hoá. |
snippet.localized.description |
string
Mô tả danh sách phát được bản địa hóa. |
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 quyền 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à:
|
status.podcastStatus |
string
Trạng thái podcast của danh sách phát. Nếu giá trị là enabled, danh sách phát đó sẽ được đánh dấu là chương trình podcast. Để đặt trạng thái podcast của một danh sách phát thành enabled thì danh sách phát đó phải có một hình ảnh danh sách phát.Các giá trị hợp lệ cho thuộc tính này là:
|
contentDetails |
object
Đối tượng contentDetails chứa thông tin về nội dung của 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ẽ sử dụng để phát danh sách phát trong trình phát được nhúng. |
player.embedHtml |
string
Thẻ <iframe> nhúng trình phát sẽ phát danh sách phát. |
localizations |
object
Đối tượng localizations đóng gói các 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á liên kết với giá trị khoá. Giá trị 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
Mô tả danh sách phát được bản địa hóa. |