Trả về một tập hợp hình ảnh danh sách phát phù hợp với tham số yêu cầu API. Bạn có thể truy xuất hình ảnh của một danh sách phát cụ thể hoặc truy xuất một hay nhiều hình ảnh trong danh sách phát theo mã nhận dạng duy nhất của các 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ị.
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ó sự uỷ quyền với ít nhất một trong các phạm vi sau (đọc thêm về tính năng 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 |
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 |
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 gồm một hoặc nhiều mã hình ảnh danh sách phát duy nhất được phân tách bằng dấu phẩy. |
|
playlistId |
string
Tham số playlistId chỉ định ID duy nhất của danh sách phát mà bạn muốn truy xuất hình ảnh trong danh sách phát. Lưu ý rằng mặc dù đây là 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 . |
|
Tham 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 nhóm 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ể 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 đối tác nội dung của YouTube.Tham số onBehalfOfContentOwner cho biết thông tin uỷ quyền của yêu cầu 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 của 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 toàn bộ dữ liệu video và kênh của mình mà không 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 được chỉ định. |
|
onBehalfOfContentOwnerChannel |
string
Bạn chỉ có thể 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 đối tác nội dung của YouTube.
Tham số onBehalfOfContentOwnerChannel
chỉ định ID kênh YouTube của kênh có video đang được phát
đã thêm. Bạn phải sử dụng tham số này khi yêu cầu chỉ định một giá trị cho thuộc tính
onBehalfOfContentOwner và chỉ có thể dùng trong
kết hợp với tham số đó. Ngoài ra, yêu cầu gỡ bỏ
đượ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
Chỉ định tham số onBehalfOfContentOwner . 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
Chỉ định tham số onBehalfOfContentOwner .Đây dành cho các đối tác nội dung YouTube sở hữu và quản lý nhiều các kênh YouTube khác nhau. Cho phép chủ sở hữu nội dung xác thực một lần và thực hiện hành động thay mặt cho kênh được chỉ định trong thông số mà không phải cung cấp thông tin xác thực cho mỗi riêng biệt. |
|
pageToken |
string
Tham số pageToken xác định một trang cụ thể trong tập hợp kết quả cần được trả về. Trong phản hồi của API, thuộc tính nextPageToken và prevPageToken sẽ xác định các 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ề nội dung phản hồi có cấu trúc như 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ể đượ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 |
string
Mã 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 nhóm 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 của API. |
items[] |
list
Danh sách hình ảnh danh sách phát phù hợp với tiêu chí yêu cầu. |