Subscriptions: list

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

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ị.

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

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 một 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 có trong phản hồi API.

Nếu tham số này xác định một thuộc tính chứa các thuộc tính con, thì các 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, 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 tên part 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 tham số sau)
channelId string
Tham số channelId chỉ định một mã nhận dạng kênh YouTube. API sẽ chỉ trả về các gói thuê bao của kênh đó.
id string
Tham số id chỉ định một danh sách(các) mã 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, thuộc tính id chỉ định mã nhận dạng gói thuê bao trên YouTube.
mine boolean
Bạn chỉ có thể dùng thông số này trong một yêu cầu được uỷ quyền đúng cách. Đặt giá trị của tham số này thành true để truy xuất nguồn cấp dữ liệu về gói thuê bao của người dùng đã xác thực.
myRecentSubscribers boolean
Bạn chỉ có thể dùng thông số này trong một yêu cầu được uỷ quyền đúng cách. Đặ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ự 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ề qua API này có thể bị giới hạn.
mySubscribers boolean
Bạn chỉ có thể dùng thông số này trong một yêu cầu được uỷ quyền đúng cách. Đặ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 không theo thứ tự 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ị giới hạn.
Thông số không bắt buộc
forChannelId string
Tham 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. Sau đó, phản hồi của API sẽ chỉ chứa các gói thuê bao khớp với những kênh đó.
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 50 (bao gồm cả hai giá trị này). Giá trị mặc định là 5.
onBehalfOfContentOwner string
Lưu ý: Đây là thông số dành riêng cho các đối tác nội dung trên YouTube.

Thông số onBehalfOfContentOwner cho biết thông tin uỷ quyền của yêu cầu giúp 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 trên 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à có quyền truy cập vào tất cả dữ liệu kênh cũng như video của mình 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 đã chỉ định trên YouTube.
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 đúng cách. Lưu ý: Đây là tham số dành riêng cho các đối tác nội dung của YouTube.

Tham số onBehalfOfContentOwnerChannel chỉ định mã nhận dạng kênh YouTube của kênh có video được thêm vào. Tham số này là bắt buộc khi yêu cầu chỉ định một giá trị cho tham số onBehalfOfContentOwner và chỉ có thể dùng cùng với tham số đó. Ngoài ra, yêu cầu phải được uỷ quyền 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 trên 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à thực hiện thao tác thay mặt cho kênh được chỉ định trong giá trị thông số mà không phải cung cấp thông tin xác thực cho từng kênh riêng biệt.
order string
Tham số order chỉ định phương thức sẽ dùng để sắp xếp các 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 nhóm kết quả sẽ được trả về. Trong một phản hồi API, thuộc tính nextPageToken và prevPageToken xác định những trang khác có thể truy xuất.

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#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
Thẻ 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 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 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 các gói thuê bao phù hợp với tiêu chí 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ả
forbidden (403) accountClosed Không thể truy xuất đăng ký vì tài khoản của người đăng ký đã bị đó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 vào các gói thuê bao được yêu cầu.
notFound (404) subscriberNotFound Không thể tìm thấy người đăng ký được xác định có yêu cầu.

Hãy dùng thử!

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.