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 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, những người dùng khác sẽ thấy các danh sách phát công khai, nhưng các 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 (đượ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á mục khỏi các danh sách đó bằng cách gọi phương thức playlistItems.insert và playlistItems.delete.
Phương thức
API 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 khớp với các tham số yêu cầu của 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 họ. Thử ngay.
- chèn
- Tạo danh sách phát. Thử ngay.
- cập nhật
- Điều chỉnh 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
- Xóa một danh sách phát. Thử ngay.
Trình bày tài nguyên
Cấu trúc JSON dưới đây thể hiện đị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
},
"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 |
stringXác định loại tài nguyên API. Giá trị sẽ là youtube#playlist. |
etag |
etagThẻ Etag của tài nguyên này. |
id |
stringMã 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 |
datetimeNgày và giờ tạo danh sách phát. Giá trị được chỉ định theo định dạng ISO 8601. |
snippet.channelId |
stringMã 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 |
stringTiêu đề của danh sách phát. |
snippet.description |
stringNội dung mô tả của danh sách phát. |
snippet.thumbnails |
objectBản đồ 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) |
objectCác giá trị khoá hợp lệ là:
|
snippet.thumbnails.(key).url |
stringURL của hình ảnh. |
snippet.thumbnails.(key).width |
unsigned integerChiều rộng của hình ảnh. |
snippet.thumbnails.(key).height |
unsigned integerChiều cao của hình ảnh. |
snippet.channelTitle |
stringTiêu đề kênh của kênh chứa video. |
snippet.tags[] |
listTài sản này không còn được dùng nữa. Các thẻ từ khóa liên kết với danh sách phát. |
snippet.defaultLanguage |
stringNgôn ngữ của văn bản trong các 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 chứa 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 |
stringTiêu đề của danh sách phát đã bản địa hoá. |
snippet.localized.description |
stringNội dung mô tả danh sách phát đã 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 |
stringTrạng thái quyền riêng tư của danh sách phát. Các giá trị hợp lệ của tài sản 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 integerSố 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 |
stringMột thẻ <iframe> dùng để 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 các bản dịch siêu dữ liệu của danh sách phát. |
localizations.(key) |
objectNgôn ngữ của văn bản đã bản địa hoá liên kết với khoá-giá trị. Giá trị là một chuỗi chứa mã ngôn ngữ BCP-47. |
localizations.(key).title |
stringTiêu đề của danh sách phát đã bản địa hoá. |
localizations.(key).description |
stringNội dung mô tả danh sách phát đã bản địa hoá. |