Members: list

Lưu ý: Điểm cuối này chỉ có thể được nhà sáng tạo cá nhân sử dụng để gửi yêu cầu cho kênh YouTube của riêng họ (kênh đã bật tính năng hội viên). 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. Chủ sở hữu kênh phải cấp quyền cho yêu cầu API.

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

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

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

Loại lỗi Chi tiết lỗi Mô tả
badRequest (400) channelMembershipsNotEnabled Kênh của nhà sáng tạo uỷ quyền cho yêu cầu này chưa bật tính năng hội viên.
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 một chế độ khác với chế độ được 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 được nhận dạng.
badRequest (400) invalidHasAccessToLevel Giá trị tham số hasAccessToLevel không hợp lệ. Không có cấp độ nào có được chỉ địnhid.
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ố chỉ định hơn 100 kênh.filterByMemberChannelId