Trả về một tập hợp hình ảnh của danh sách phát khớp với các tham số yêu cầu API. Bạn có thể truy xuất hình ảnh danh sách phát của một danh sách phát cụ thể hoặc truy xuất một hoặc nhiều hình ảnh danh sách phát theo mã nhận dạng duy nhất của chúng.
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ị.
Yêu cầu
Yêu cầu HTTP
GET https://www.googleapis.com/youtube/v3/playlistImages
Ủy quyền
Yêu cầu này cần được uỷ quyền bằng ít nhất một trong các phạm vi sau (đọc thêm về quy trình xác thực và uỷ quyền).
Phạm vi |
---|
https://www.googleapis.com/auth/youtubepartner |
https://www.googleapis.com/auth/youtube |
https://www.googleapis.com/auth/youtube.force-ssl |
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ả các tham số được liệt kê đều là tham số truy vấn.
Thông số | ||
---|---|---|
Tham số bắt buộc | ||
part |
string Tham số |
|
Bộ lọc (chỉ định chính xác một trong các tham số sau) | ||
id |
string Tham số id 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 mã nhận dạng hình ảnh duy nhất của danh sách phát. |
|
playlistId |
string Tham số playlistId chỉ định mã nhận dạng duy nhất của danh sách phát mà bạn muốn truy xuất hình ảnh. Xin lưu ý rằng mặc dù đây là một tham số không bắt buộc, nhưng mọi yêu cầu truy xuất hình ảnh danh sách phát đều phải chỉ định một giá trị cho tham số id hoặc tham số playlistId . |
|
Thông số không bắt buộc | ||
maxResults |
unsigned integer Tham số maxResults chỉ định số lượng hình ảnh tối đa cần được trả về trong tập kết quả. Giá trị có thể chấp nhận là từ 0 đến 50 . 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 đú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 CMS của YouTube đ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 của YouTube sở hữu và quản lý nhiều kênh YouTube. Công cụ 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 về 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 |
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 đúng cách. Lưu ý: Thông số này chỉ dành cho đố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 mà video được thêm vào. Tham số này là bắt buộc khi một yêu cầu chỉ định giá trị cho tham số onBehalfOfContentOwner và chỉ có thể được dùng 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 của YouTube sở hữu và quản lý nhiều kênh YouTube. Phương thức 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 |
string Tham số pageToken xác định một trang cụ thể trong tập kết quả cần được trả về. Trong một phản hồi API, các 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
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 phần nội dung phản hồi có cấu trúc sau:
{ "kind": "youtube#playlistImageListResponse", "nextPageToken": string, "prevPageToken": string, "pageInfo": { "totalResults": integer, "resultsPerPage": integer }, "items": [ playlistImages 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#playlistImageListResponse . |
nextPageToken |
string Mã 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 |
string Mã thông báo có thể 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 bao bọc 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 kết quả. |
pageInfo.resultsPerPage |
integer Số lượng kết quả có trong phản hồi của API. |
items[] |
list Danh sách hình ảnh danh sách phát phù hợp với tiêu chí của yêu cầu. |