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ọ.
Tác động đến hạn mức: Lệnh gọi đến phương thức này có chi phí hạn mức là 1 đơn vị.
Các trường hợp sử dụng phổ biến
Yêu cầu
Yêu cầu HTTP
GET https://www.googleapis.com/youtube/v3/playlists
Tham số
Bảng sau đây liệt kê các tham số mà truy vấn này hỗ trợ. Tất cả tham số được liệt kê đều là tham số truy vấn.
| Tham số | ||
|---|---|---|
| Tham số bắt buộc | ||
part |
stringTham số part chỉ định một danh sách được phân tách bằng dấu phẩy gồm một hoặc nhiều thuộc tính tài nguyên playlist có trong phản hồi API.Nếu tham số này xác định một thuộc tính chứa các thuộc tính con, thì các thuộc tính con sẽ được đưa vào phản hồi. Ví dụ: trong tài nguyên playlist, thuộc tính snippet chứa các thuộc tính như author, title, description và timeCreated. Do đó, nếu bạn đặt part=snippet, phản hồi của API sẽ chứa tất cả các thuộc tính đó.Danh sách sau đây chứa tên part mà bạn có thể đưa vào giá trị tham số:
|
|
| Bộ lọc (chỉ định chính xác một trong các tham số sau) | ||
channelId |
stringGiá trị này cho biết rằng API chỉ trả về danh sách phát của kênh đã chỉ định. |
|
id |
stringTham số id chỉ định một danh sách được phân tách bằng dấu phẩy gồm(các) mã danh sách phát trên YouTube cho(các) tài nguyên đang được truy xuất. Trong tài nguyên playlist, thuộc tính id chỉ định mã nhận dạng danh sách phát trên YouTube của danh sách phát. |
|
mine |
booleanBạn chỉ có thể dùng thông số này trong một yêu cầu được uỷ quyền đúng cách. Đặt giá trị của tham số này thành true để hướng dẫn API chỉ trả về danh sách phát do người dùng đã xác thực sở hữu. |
|
| Thông số không bắt buộc | ||
hl |
stringTham số hl hướng dẫn API truy xuất siêu dữ liệu tài nguyên đã bản địa hoá cho một ngôn ngữ ứng dụng cụ thể mà trang web YouTube hỗ trợ. Giá trị tham số phải là mã ngôn ngữ có trong danh sách mà phương thức i18nLanguages.list trả về.Nếu có thông tin chi tiết về tài nguyên đã bản địa hoá bằng ngôn ngữ đó, thì đối tượng snippet.localized của tài nguyên sẽ chứa các giá trị đã bản địa hoá. Tuy nhiên, nếu không có thông tin chi tiết đã bản địa hoá, thì đối tượng snippet.localized sẽ chứa thông tin về tài nguyên bằng ngôn ngữ mặc định của tài nguyên. |
|
maxResults |
unsigned integerTham số maxResults chỉ định số lượng mục tối đa cần được trả về trong tập hợp kết quả. Các giá trị được chấp nhận là từ 0 đến 50 (bao gồm cả hai giá trị này). Giá trị mặc định là 5. |
|
onBehalfOfContentOwner |
stringBạn chỉ có thể dùng thông số này trong một yêu cầu được uỷ quyền đúng cách. Lưu ý: Thông số này chỉ dành cho các đối tác nội dung của YouTube. Thông số onBehalfOfContentOwner cho biết thông tin uỷ quyền của yêu cầu giúp xác định một người dùng YouTube CMS đang hành động thay mặt cho chủ sở hữu nội dung được chỉ định trong giá trị thông số. Thông số này dành cho những đối tác nội dung trên YouTube sở hữu và quản lý nhiều kênh YouTube khác nhau. Tính năng này cho phép chủ sở hữu nội dung xác thực một lần và có quyền truy cập vào tất cả dữ liệu kênh cũng như video của mình mà không cần phải cung cấp thông tin xác thực cho từng kênh. Tài khoản CMS mà người dùng xác thực phải được liên kết với chủ sở hữu nội dung đã chỉ định trên YouTube. |
|
onBehalfOfContentOwnerChannel |
stringBạn chỉ có thể dùng thông số này trong một yêu cầu được uỷ quyền đúng cách. Lưu ý: Đây là tham số dành riêng cho các đối tác nội dung của YouTube. Tham số onBehalfOfContentOwnerChannel chỉ định mã nhận dạng kênh YouTube của kênh có video được thêm vào. Tham số này là bắt buộc khi yêu cầu chỉ định một giá trị cho tham số onBehalfOfContentOwner và chỉ có thể dùng cùng với tham số đó. Ngoài ra, yêu cầu phải được uỷ quyền bằng một tài khoản CMS liên kết với chủ sở hữu nội dung mà tham số onBehalfOfContentOwner chỉ định. Cuối cùng, kênh mà giá trị tham số onBehalfOfContentOwnerChannel chỉ định phải được liên kết với chủ sở hữu nội dung mà tham số onBehalfOfContentOwner chỉ định.Tham số này dành cho các đối tác nội dung trên YouTube sở hữu và quản lý nhiều kênh YouTube. Tính năng này cho phép chủ sở hữu nội dung xác thực một lần và thực hiện thao tác thay mặt cho kênh được chỉ định trong giá trị thông số mà không phải cung cấp thông tin xác thực cho từng kênh riêng biệt. |
|
pageToken |
stringTham số pageToken xác định một trang cụ thể trong nhóm kết quả sẽ được trả về. Trong một phản hồi API, thuộc tính nextPageToken và prevPageToken xác định những trang khác có thể truy xuất. |
|
Nội dung yêu cầu
Đừng cung cấp nội dung yêu cầu khi gọi phương thức này.
Phản hồi
Nếu thành công, phương thức này sẽ trả về nội dung phản hồi có cấu trúc như sau:
{
"kind": "youtube#playlistListResponse",
"etag": etag,
"nextPageToken": string,
"prevPageToken": string,
"pageInfo": {
"totalResults": integer,
"resultsPerPage": integer
},
"items": [
playlist Resource
]
}
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#playlistListResponse. |
etag |
etagThẻ Etag của tài nguyên này. |
nextPageToken |
stringMã thông báo có thể được dùng làm giá trị của tham số pageToken để truy xuất trang tiếp theo trong tập hợp kết quả. |
prevPageToken |
stringMã thông báo có thể được dùng làm giá trị của tham số pageToken để truy xuất trang trước đó trong tập hợp kết quả. |
pageInfo |
objectĐối tượng pageInfo đóng gói thông tin phân trang cho tập hợp kết quả. |
pageInfo.totalResults |
integerTổng số kết quả trong nhóm kết quả. |
pageInfo.resultsPerPage |
integerSố lượng kết quả có trong phản hồi của API. |
items[] |
listDanh sách các danh sách phát đáp ứng các tiêu chí của yêu cầu. |
Lỗi
Bảng sau đây xác định các thông báo lỗi mà API có thể trả về để phản hồi lệnh gọi đến phương thức này. Vui lòng xem tài liệu về thông báo lỗi để biết thêm chi tiết.
| Loại lỗi | Chi tiết lỗi | Nội dung mô tả |
|---|---|---|
forbidden (403) |
channelClosed |
Kênh được chỉ định trong tham số channelId đã bị đóng. |
forbidden (403) |
channelSuspended |
Kênh được chỉ định trong thông số channelId đã bị tạm ngưng. |
forbidden (403) |
playlistForbidden |
Danh sách phát được xác định bằng thông số id của yêu cầu không hỗ trợ yêu cầu hoặc yêu cầu không được cấp phép đúng. |
notFound (404) |
channelNotFound |
Không tìm thấy kênh được chỉ định trong tham số channelId. |
notFound (404) |
playlistNotFound |
Không thể tìm thấy danh sách phát được xác định bằng thông số id của yêu cầu. |
invalidValue (400) |
playlistOperationUnsupported |
API không hỗ trợ tính năng liệt kê danh sách phát được chỉ định. Ví dụ: Bạn không thể liệt kê danh sách phát xem sau. |
Hãy dùng thử!
Dùng APIs Explorer để gọi API này cũng như xem yêu cầu và phản hồi của API.