Subscriptions: list

Trả về tài nguyên gói thuê bao khớp với tiêu chí của yêu cầu API.

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à 1 đơn vị.

Các trường hợp sử dụng phổ biến

Yêu cầu

Yêu cầu HTTP

GET https://www.googleapis.com/youtube/v3/subscriptions

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 danh sách được phân tách bằng dấu phẩy gồm một hoặc nhiều thuộc tính tài nguyên subscription mà phản hồi API sẽ đưa vào.

Nếu tham số này xác định một thuộc tính chứa thuộc tính con, thì thuộc tính con sẽ được đưa vào phản hồi. Ví dụ: trong tài nguyên subscription, thuộc tính snippet chứa các thuộc tính khác, chẳng hạn như tiêu đề hiển thị của gói thuê bao. Nếu bạn đặt part=snippet, thì phản hồi API cũng sẽ chứa tất cả các thuộc tính lồng nhau đó.

Danh sách sau đây chứa part tên mà bạn có thể đưa vào giá trị tham số:
  • contentDetails
  • id
  • snippet
  • subscriberSnippet
Bộ lọc (chỉ định chính xác một trong các thông số sau)
channelId string
Thông số channelId chỉ định mã nhận dạng kênh YouTube. API sẽ chỉ trả về gói thuê bao của kênh đó.
id string
Thông số id chỉ định danh sách(các) mã nhận dạng gói thuê bao trên YouTube được phân tách bằng dấu phẩy cho(các) tài nguyên đang được truy xuất. Trong tài nguyên subscription, tài sản id chỉ định mã nhận dạng gói thuê bao trên YouTube.
mine boolean
Bạn chỉ có thể sử dụng thông số này trong một yêu cầu được uỷ quyền phù hợp. Đặt giá trị của thông số này thành true để truy xuất nguồn cấp dữ liệu từ các gói thuê bao của người dùng đã xác thực.
myRecentSubscribers boolean
Bạn chỉ có thể sử dụng thông số này trong một yêu cầu được uỷ quyền phù hợp. Hãy đặt giá trị của thông số này thành true để truy xuất nguồn cấp dữ liệu về người đăng ký của người dùng đã xác thực theo thứ tự thời gian đảo ngược (mới nhất xếp trước).

Xin lưu ý rằng số lượng người đăng ký tối đa được trả về thông qua API này có thể bị giới hạn.
mySubscribers boolean
Bạn chỉ có thể sử dụng thông số này trong một yêu cầu được uỷ quyền phù hợp. Đặt giá trị của tham số này thành true để truy xuất nguồn cấp dữ liệu về người đăng ký của người dùng đã xác thực theo thứ tự không cụ thể. Xin lưu ý rằng số lượng người đăng ký tối đa được trả về thông qua API này có thể bị hạn chế.
Tham số không bắt buộc
forChannelId string
Thông số forChannelId chỉ định danh sách mã nhận dạng kênh được phân tách bằng dấu phẩy. Phản hồi của API sẽ chỉ chứa các gói thuê bao khớp với các kênh đó.
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 50, bao gồm cả hai giá trị này. Giá trị mặc định là 5.
onBehalfOfContentOwner string
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 rằng thông tin cấp phép của yêu cầu xác định người dùng CMS của YouTube đang thay mặt chủ sở hữu nội dung được chỉ định trong giá trị tham số. Tham số này dành cho các đối tác nội dung YouTube sở hữu và quản lý nhiều kênh YouTube khác nhau. 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à truy cập vào tất cả dữ liệu video và kênh của họ mà không cần 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 đã chỉ định.
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 phù hợp. Lưu ý: Tham số này chỉ dành cho các đối tác nội dung trên YouTube.

Tham số onBehalfOfContentOwnerChannel chỉ định mã nhận dạng kênh YouTube của kênh mà bạn sẽ thêm video vào. Bạn bắt buộc phải sử dụng tham số này khi yêu cầu chỉ định một giá trị cho tham số onBehalfOfContentOwner và chỉ có thể sử dụng tham số này cùng với tham số đó. Ngoài ra, yêu cầu này phải được cho phép bằng một tài khoản CMS 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 các đối tác nội dung YouTube sở hữu và quản lý nhiều kênh YouTube. Cho phép chủ sở hữu nội dung xác thực một lần và thay mặt kênh được chỉ định trong giá trị tham số mà không phải cung cấp thông tin xác thực cho từng kênh.
order string
Thông số order chỉ định phương thức sẽ dùng để sắp xếp tài nguyên trong phản hồi API. Giá trị mặc định là SUBSCRIPTION_ORDER_RELEVANCE.

Các giá trị được chấp nhận là:
  • alphabetical – Sắp xếp theo thứ tự bảng chữ cái.
  • relevance – Sắp xếp theo mức độ liên quan.
  • unread – Sắp xếp theo thứ tự hoạt động.
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ề. Trong phản hồi API, thuộc tính nextPageToken và prevPageToken xác định các trang khác có thể được 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 với cấu trúc sau:

{
  "kind": "youtube#subscriptionListResponse",
  "etag": etag,
  "nextPageToken": string,
  "prevPageToken": string,
  "pageInfo": {
    "totalResults": integer,
    "resultsPerPage": integer
  },
  "items": [
    subscription 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#subscriptionListResponse.
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ả.
prevPageToken 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 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 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 gói thuê bao khớ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ả
forbidden (403) accountClosed Không thể truy xuất đăng ký vì tài khoản của người đăng ký đã đóng.
forbidden (403) accountSuspended Không thể truy xuất đăng ký vì tài khoản của người đăng ký bị tạm ngưng.
forbidden (403) subscriptionForbidden Người yêu cầu không được phép truy cập các gói thuê bao đã yêu cầu.
notFound (404) subscriberNotFound Không thể tìm thấy người đăng ký được xác định theo yêu cầu.

Hãy dùng thử!

Hãy dùng APIs Explorer để gọi API này cũng như xem yêu cầu và phản hồi của API.