Google sử dụng công nghệ AI để dịch nội dung sang ngôn ngữ bạn ưu tiên. Bản dịch bằng AI có thể có lỗi.

Subscriptions: list

Trả về những tài nguyên gói thuê bao đáp ứng tiêu chí của 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à 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

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 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` mà phản hồi của API sẽ bao gồm. Nếu tham số 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ị cho gói thuê bao. Nếu bạn đặt `part=snippet`, thì phản hồi của 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ã nhận dạng kênh YouTube. API này sẽ chỉ trả về danh sách kênh mà người dùng đã đăng ký.
`id`	`string` Tham số `id` chỉ định một danh sách 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`, 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ể sử dụng tham 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 một nguồn cấp dữ liệu gồm các kênh mà người dùng đã xác thực đăng ký theo dõi.
`myRecentSubscribers`	`boolean` Bạn chỉ có thể sử dụng tham 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 danh sách 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 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ể dùng tham 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 một nguồn cấp dữ liệu gồm những người đăng ký của người dùng đã xác thực mà 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.
Tham 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 những lượt đăng ký trùng 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 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 ý: Tham số này chỉ dành cho đối tác nội dung của YouTube. Tham số `onBehalfOfContentOwner` cho biết thông tin xác thực uỷ quyền của yêu cầu xác định một người dùng YouTube CMS đang thay mặt cho chủ sở hữu nội dung được chỉ định trong giá trị tham số. Tham số này dành cho những đối tác nội dung của YouTube sở hữu và quản lý nhiều kênh YouTube. Công cụ 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 về video và kênh của họ mà không cần 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 được chỉ định trên YouTube.
`onBehalfOfContentOwnerChannel`	`string` Bạn chỉ có thể dùng tham số này trong một yêu cầu được uỷ quyền đúng cách. Lưu ý: Tham số này chỉ dành cho đố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 mà video đang được thêm vào. Bạn phải cung cấp 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 phải được uỷ quyền bằng tài khoản CMS được 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 những đối tác nội dung của YouTube sở hữu và quản lý nhiều kênh YouTube. Tham số 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 các hành động thay mặt cho kênh được chỉ định trong giá trị tham số mà không cần 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ẽ được dùng để sắp xếp tài nguyên trong phản hồi của 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 kết quả cần được trả về. Trong phản hồi của API, các 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

Đừ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ề một nội dung phản hồi có 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 của 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 tham số `pageToken` để truy xuất trang tiếp theo trong tập kết quả.
`prevPageToken`	`string` Mã thông báo có thể dùng làm giá trị của tham số `pageToken` để truy xuất trang trước trong tập kết quả.
`pageInfo`	`object` Đối tượng `pageInfo` đóng gói 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 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 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 gói thuê bao vì tài khoản của người đăng ký đã bị đóng.
`forbidden (403)`	`accountSuspended`	Không thể truy xuất gói thuê bao 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 tìm thấy người đăng ký được xác định trong yêu cầu.

Hãy dùng thử!

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

Subscriptions: list Sử dụng bộ sưu tập để sắp xếp ngăn nắp các trang Lưu và phân loại nội dung dựa trên lựa chọn ưu tiên của bạn.