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 hoặc nhiều danh sách phát theo mã nhận dạng duy nhất của danh sách phát đó.
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
Thông 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.
| Thông 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 mà phản hồi của API sẽ bao gồm.Nếu tham số 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, thì 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 các 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 API chỉ nên trả về danh sách phát của kênh được 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ã nhận dạng 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 của danh sách phát trên YouTube. |
|
mine |
booleanBạn chỉ có thể sử dụng tham 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 thuộc sở hữu của người dùng đã xác thực. |
|
| Thông số tuỳ chọn | ||
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 do phương thức i18nLanguages.list trả về.Nếu thông tin chi tiết về tài nguyên được bản địa hoá có sẵn bằng ngôn ngữ đó, thì đối tượng snippet.localized của tài nguyên sẽ chứa các giá trị được bản địa hoá. Tuy nhiên, nếu không có thông tin chi tiết được bản địa hoá, thì đối tượng snippet.localized sẽ chứa thông tin chi tiết 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 trả về trong tập kết quả. Giá trị được chấp nhận là từ 0 đến 50. Giá trị mặc định là 5. |
|
onBehalfOfContentOwner |
stringBạn chỉ có thể sử dụng tham số này trong một yêu cầu được uỷ quyền đúng cách. Lưu ý: Tham số này chỉ dành cho các đối tác nội dung của YouTube. Tham số onBehalfOfContentOwner cho biết thông tin xác thực uỷ quyền của yêu cầu xác định một người dùng YouTube CMS đang thay mặt cho chủ sở hữu nội dung được chỉ định trong giá trị tham số. Tham 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. 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 video và kênh của họ mà không cần cung cấp thông tin xác thực cho từng kênh riêng lẻ. 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 được chỉ định trên YouTube. |
|
onBehalfOfContentOwnerChannel |
stringBạn chỉ có thể sử dụng tham 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ố onBehalfOfContentOwnerChannel chỉ định mã nhận dạng kênh YouTube của kênh mà video đang được thêm vào. Bạn phải cung cấp tham số này khi yêu cầu chỉ định một giá trị cho tham số onBehalfOfContentOwner và chỉ có thể sử dụng tham số này cùng với tham số đó. Ngoài ra, yêu cầu phải được uỷ quyền bằng tài khoản CMS được 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 những đối tác nội dung trên YouTube sở hữu và quản lý nhiều kênh YouTube. Tham số 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 các hành động thay mặt cho kênh được chỉ định trong giá trị tham số mà không cần 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 tập kết quả cần được trả về. Trong phản hồi của API, các thuộc tính nextPageToken và prevPageToken xác định các trang khác có thể được truy xuất. |
|
Nội dung yêu cầu
Khô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ề một nội dung phản hồi có cấu trúc 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 của API. Giá trị sẽ là youtube#playlistListResponse. |
etag |
etagEtag của tài nguyên này. |
nextPageToken |
stringMã thông báo có thể dùng làm giá trị của tham số pageToken để truy xuất trang tiếp theo trong tậ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 kết quả. |
pageInfo |
objectĐối tượng pageInfo đóng gói thông tin phân trang cho tập kết quả. |
pageInfo.totalResults |
integerTổng số kết quả trong tập kết quả. |
pageInfo.resultsPerPage |
integerSố lượng kết quả có trong phản hồi của API. |
items[] |
listDanh sách phát khớp với tiêu chí 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 một 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 | Thông tin chi tiết về lỗi | 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 tham số channelId đã bị tạm ngưng. |
forbidden (403) |
playlistForbidden |
Danh sách phát được xác định bằng tham 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 uỷ quyền đúng cách. |
notFound (404) |
channelNotFound |
Không tìm thấy kênh được chỉ định trong tham số channelId. |
notFound (404) |
playlistNotFound |
Không tìm thấy danh sách phát được xác định bằng tham số id của yêu cầu. |
invalidValue (400) |
playlistOperationUnsupported |
API không hỗ trợ việc liệt kê danh sách phát đã chỉ định. Ví dụ: bạn không thể liệt kê danh sách phát Xem sau. |
Hãy dùng thử!
Sử dụng APIs Explorer để gọi API này và xem Yêu cầu API cũng như phản hồi của API.