Liệt kê các thành viên (trước đây gọi là "nhà tài trợ") cho một kênh. Yêu cầu API phải do chủ sở hữu kênh uỷ quyền.
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à 2 đơn vị.
Yêu cầu
Yêu cầu HTTP
GET https://www.googleapis.com/youtube/v3/members
Ủy quyền
Yêu cầu này cần được cho phép với phạm vi sau:
Phạm vi |
---|
https://www.googleapis.com/auth/youtube.channel-memberships.creator |
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 các thuộc tính tài nguyên member mà phản hồi API sẽ đưa vào. Đặt giá trị thông số thành snippet . |
|
Tham số không bắt buộc | ||
mode |
string Tham số mode cho biết thành viên nào sẽ được đưa vào phản hồi của API. Đặt giá trị tham số thành một trong các giá trị sau:
|
|
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 1000 , bao gồm cả hai giá trị này. Giá trị mặc định là 5 . |
|
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ề. Mã thông báo này dành riêng cho mode được dùng trong yêu cầu API ban đầu. Vì vậy, bạn không thể dùng mã thông báo trang được truy xuất bằng một chế độ để chuyển sang chế độ khác.
|
|
hasAccessToLevel |
string Giá trị thông số hasAccessToLevel là mã nhận dạng cấp độ nêu rõ cấp độ tối thiểu mà các thành viên trong tập hợp kết quả phải có. |
|
filterByMemberChannelId |
string Tham số filterByMemberChannelId chỉ định danh sách
các mã nhận dạng kênh được phân tách bằng dấu phẩy có thể dùng để kiểm tra trạng thái tư cách thành viên của những người dùng cụ thể. Ví dụ: UC_1,UC_2,UC_3 . Bạn có thể chỉ định tối đa 100 kênh cho mỗi cuộc gọi. |
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#memberListResponse", "etag": etag, "nextPageToken": string, "pageInfo": { "totalResults": integer, "resultsPerPage": integer }, "items": [ member 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#memberListResponse . |
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ả. Mã thông báo trang có thể hết hạn và ứng dụng của bạn sẽ thả mã thông báo rồi gọi API mà không cần pageToken để bắt đầu một yêu cầu mới. |
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 các thành viên 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ả |
---|---|---|
badRequest (400) |
channelMembershipsNotEnabled |
Kênh của nhà sáng tạo cho phép yêu cầu chưa bật tính năng hội viên của kênh. |
badRequest (400) |
invalidMode |
Giá trị tham số mode không hợp lệ.
Lỗi này có thể xảy ra nếu tham số pageToken chỉ định một mã thông báo được truy xuất bằng chế độ khác với chế độ đã chỉ định. |
badRequest (400) |
invalidPageToken |
Giá trị tham số pageToken không hợp lệ. Lỗi này có thể xảy ra nếu mã thông báo trang được dùng trong yêu cầu đã hết hạn hoặc không
nhận dạng được. |
badRequest (400) |
invalidHasAccessToLevel |
Giá trị tham số hasAccessToLevel không hợp lệ. Không có cấp nào có id được chỉ định. |
badRequest (400) |
invalidFilterByMemberChannelId |
Giá trị tham số filterByMemberChannelId không hợp lệ. Lỗi này xảy ra nếu giá trị tham số filterByMemberChannelId chỉ định hơn 100 kênh. |