Members: list

Lưu ý: Chỉ từng nhà sáng tạo mới có thể sử dụng điểm cuối này để gửi yêu cầu cho kênh YouTube của riêng mình đã bật tính năng hội viên của kênh. Hãy liên hệ với người đại diện của Google hoặc YouTube để yêu cầu cấp quyền truy cập.

Liệt kê các hội viên (trước đây gọi là "nhà tài trợ") của một kênh. Yêu cầu API phải được chủ sở hữu kênh cho phép.

Tác động đến hạn mức: Lệnh gọi đến phương thức này sẽ có chi phí hạn 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 uỷ quyền với phạm vi sau:

Phạm vi
https://www.googleapis.com/auth/youtube.channel-memberships.creator

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ố part chỉ định các thuộc tính tài nguyên member mà phản hồi API sẽ bao gồm. Đặt giá trị tham số thành snippet.
Thông số không bắt buộc
mode string
Tham số mode cho biết thành phần nào sẽ được đưa vào phản hồi của API. Đặt giá trị thông số thành một trong các giá trị sau:
  • all_current (mặc định) – Liệt kê các thành viên hiện tại, theo thứ tự từ mới nhất đến cũ nhất. Khi sử dụng giá trị này, danh sách sẽ đến cuối khi phản hồi của API không chứa nextPageToken.
  • updates – Chỉ liệt kê các thành viên đã tham gia hoặc nâng cấp kể từ lệnh gọi API trước đó. Xin lưu ý rằng lệnh gọi đầu tiên bắt đầu một luồng nội dung cập nhật mới nhưng không thực sự trả về bất kỳ thành viên nào. Để bắt đầu truy xuất các nội dung cập nhật cho gói thành viên, bạn cần thăm dò điểm cuối bằng cách sử dụng nextPageToken theo tần suất mong muốn.

    Xin lưu ý rằng khi giá trị này được sử dụng, phản hồi của API luôn chứa nextPageToken.
maxResults unsigned integer
Tham số maxResults chỉ định số lượng mục tối đa cần được trả về trong tập hợp kết quả. Các 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 nhóm kết quả sẽ được trả về. Mã thông báo này là dành riêng cho mode được dùng với yêu cầu API ban đầu. Vì vậy, bạn không thể sử dụng mã thông báo trang được truy xuất bằng một chế độ để sau đó chuyển sang một chế độ khác.
hasAccessToLevel string
Giá trị tham số hasAccessToLevel là một mã cấp độ chỉ định cấp độ tối thiểu mà các thành phần trong tập kết quả phải có.
filterByMemberChannelId string
Tham số filterByMemberChannelId chỉ định một danh sách mã nhận dạng kênh được phân tách bằng dấu phẩy. Bạn có thể dùng danh sách này để kiểm tra trạng thái hội 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

Đừ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#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
Thẻ Etag của tài nguyên này.
nextPageToken string
Mã 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ả. Mã thông báo trang có thể hết hạn và ứng dụng của bạn cần bỏ mã thông báo đó và gọi API mà không có 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 nhóm 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 thành viên đáp ứng các 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ề để phản hồi 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 Chi tiết lỗi Nội dung mô tả
badRequest (400) channelMembershipsNotEnabled Kênh của nhà sáng tạo uỷ quyền cho 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ị thông 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ế độ được chỉ định.
badRequest (400) invalidPageToken Giá trị thông 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ị thông số hasAccessToLevel không hợp lệ. Không có cấp độ nào với id được chỉ định.
badRequest (400) invalidFilterByMemberChannelId Giá trị thông 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.