Playlists: list

Trả về một tập hợp các danh sách phát khớp với tham số 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ọ.

Mức tác động cho hạn mức: Một lệnh gọi đến phương thức này có chi phí định 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

Các tham số

Bảng sau trình bày các tham số mà truy vấn này hỗ trợ. Tất cả thông số được liệt kê đều là thông số truy vấn.

Các tham số
Các thông số bắt buộc
part string
Tham số part chỉ định 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 API sẽ đưa vào.

Nếu tham số này xác định một thuộc tính chứa thuộc tính con, thì 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 API sẽ chứa tất cả các thuộc tính đó.

Danh sách sau đây chứa part tên mà bạn có thể đưa vào giá trị tham số:
  • contentDetails
  • id
  • localizations
  • player
  • snippet
  • status
Bộ lọc (chỉ định chính xác một trong các thông số sau)
channelId string
Giá trị này cho biết API chỉ được trả về danh sách phát của kênh đã chỉ định.
id string
Thông số id chỉ định danh sách(các) mã nhận dạng danh sách phát trên YouTube được phân tách bằng dấu phẩy 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ã danh sách phát trên YouTube của danh sách phát.
mine boolean
Bạn chỉ có thể sử dụng thông số này trong một yêu cầu được uỷ quyền phù hợp. Đặt giá trị của thông 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.
Tham số không bắt buộc
hl string
Thông số hl hướng dẫn API truy xuất siêu dữ liệu của tài nguyên đã bản địa hóa 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 được phương thức i18nLanguages.list trả về.

Nếu có thông tin chi tiết về tài nguyên được 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ị đã được bản địa hoá đó. Tuy nhiên, nếu không có thông tin đã bản địa hoá thì đối tượng snippet.localized sẽ chứa các thông tin chi tiết về tài nguyên theo ngôn ngữ mặc định của tài nguyên.
maxResults unsigned integer
Tham số maxResults chỉ định số lượng mục tối đa cần trả về trong tập hợp kết quả. 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 string
Bạn chỉ có thể sử dụng thông số này trong một yêu cầu được uỷ quyền phù hợp. 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 rằng thông tin cấp phép của yêu cầu xác định người dùng CMS của YouTube đang thay mặt chủ sở hữu nội dung được chỉ định trong giá trị tham số. Tham số này dành cho các đối tác nội dung 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à truy cập vào tất cả dữ liệu video và kênh của họ 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 YouTube đã chỉ định.
onBehalfOfContentOwnerChannel string
Bạn chỉ có thể sử dụng thông số này trong một yêu cầu được uỷ quyền phù hợp. Lưu ý: Tham số này chỉ dành cho các đối tác nội dung trên YouTube.

Tham số onBehalfOfContentOwnerChannel chỉ định mã nhận dạng kênh YouTube của kênh mà bạn sẽ thêm video vào. Bạn bắt buộc phải sử dụng 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 này phải được cho phép 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 YouTube sở hữu và quản lý nhiều kênh YouTube. Cho phép chủ sở hữu nội dung xác thực một lần và thay mặt kênh được chỉ định trong giá trị tham số mà không phải cung cấp thông tin xác thực cho từng kênh.
pageToken string
Tham số pageToken xác định một trang cụ thể trong tập hợp kết quả nên được trả về. Trong phản hồi API, 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ề nội dung phản hồi với 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 string
Xác định loại tài nguyên API. Giá trị sẽ là youtube#playlistListResponse.
etag etag
Etag của tài nguyên này.
nextPageToken string
Mã thông báo có thể được dùng làm giá trị của thông số pageToken để truy xuất trang tiếp theo trong tập hợp kết quả.
prevPageToken string
Mã thông báo có thể được dùng làm giá trị của thông 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 integer
Tổng số kết quả trong tập hợp kết quả.
pageInfo.resultsPerPage integer
Số lượng kết quả có trong phản hồi API.
items[] list
Danh sách phát phù hợp với 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ề khi 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 thông tin 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 được cấp phép không đú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ợ chức năng 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ử!

Hãy 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.