Tài nguyên playlist đại diện cho danh sách phát trên YouTube. Danh sách phát là tập hợp video mà bạn có thể xem tuần tự và chia sẻ với người dùng khác. Theo mặc định, người dùng khác có thể xem danh sách phát nhưng công khai hoặc riêng tư danh sách phá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 cho một kênh, chẳng hạn như:
- video đã tải lên
- video được đánh giá tích cực (thích)
channel resource cho một kênh nhất định.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.insert và playlistItems.delete.
Phương pháp
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 phù hợp với 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 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
- 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
- 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
},
"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 |
etagEtag của tài nguyên này. |
id |
stringMã nhận dạng mà YouTube sử dụng để nhận dạng riêng 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ị này được chỉ định ở định dạng ISO 8601. |
snippet.channelId |
stringMã nhận dạng mà YouTube sử dụng để nhận dạng duy nhấ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 đồ 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à đố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 đề của kênh có chứa video đó. |
snippet.tags[] |
listTài sản này không còn được dùng nữa. Thẻ từ khoá 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á 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.
localizations để thêm, cập nhật hoặc xoá các tiêu đề đã bản địa hoá. |
snippet.localized.title |
stringTiêu đề của danh sách phát đã bản địa hoá. |
snippet.localized.description |
stringThông tin mô tả của danh sách phát đã bản địa hoá. |
status |
objectĐối tượng status chứa thông tin trạng thái cho 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ệ cho tài sản này là:
|
contentDetails |
objectĐối tượng contentDetails chứa thông tin về nội dung 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ẽ sử dụng để phát danh sách phát trong trình phát được nhúng. |
player.embedHtml |
stringMột 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 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 giá trị khoá. 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 |
stringThông tin mô tả của danh sách phát đã bản địa hoá. |