Trang này được dịch bởi Cloud Translation API.

Channels: list

Lưu ý: Chúng tôi đã cập nhật giá trị thuộc tính statistics.subscriberCount của tài nguyên channel để phản ánh một thay đổi về chính sách của YouTube. Sự thay đổi này ảnh hưởng đến cách hiển thị số người đăng ký. Vui lòng xem Nhật ký sửa đổi hoặc Trung tâm trợ giúp của YouTube để biết thêm thông tin.

Trả về một tập hợp gồm 0 hoặc nhiều tài nguyên channel khớp với tiêu chí yêu cầu.

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/channels

Ủy quyền

Yêu cầu truy xuất phần auditDetails cho tài nguyên channel phải cung cấp mã thông báo uỷ quyền chứa phạm vi https://www.googleapis.com/auth/youtubepartner-channel-audit. Ngoài ra, bạn phải thu hồi mọi mã thông báo sử dụng phạm vi đó khi mạng đa kênh quyết định chấp nhận hoặc từ chối kênh hoặc trong vòng 2 tuần kể từ ngày phát hành mã thông báo.

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 `channel` 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 `channel`, thuộc tính `contentDetails` chứa các thuộc tính khác, chẳng hạn như thuộc tính `uploads`. Do đó, nếu bạn đặt `part=contentDetails`, 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ố: `auditDetails` `brandingSettings` `contentDetails` `contentOwnerDetails` `id` `localizations` `snippet` `statistics` `status` `topicDetails`
Bộ lọc (chỉ định chính xác một trong các tham số sau)
`categoryId`	`string` Tham số này không còn được dùng nữa. Tham số `categoryId` đã chỉ định một danh mục hướng dẫn trên YouTube và có thể dùng để yêu cầu các kênh YouTube liên kết với danh mục đó.
`forHandle`	`string` Tham số `forHandle` chỉ định tên người dùng trên YouTube, từ đó yêu cầu kênh liên kết với tên người dùng đó. Bạn có thể thêm ký hiệu `@` vào trước giá trị tham số. Ví dụ: để truy xuất tài nguyên cho kênh "Google for Developers", hãy đặt giá trị tham số `forHandle` thành `GoogleDevelopers` hoặc `@GoogleDevelopers`.
`forUsername`	`string` Tham số `forUsername` chỉ định một tên người dùng YouTube, do đó yêu cầu kênh liên kết với tên người dùng đó.
`id`	`string` Tham số `id` chỉ định một danh sách được phân tách bằng dấu phẩy gồm(các) mã nhận dạng kênh YouTube của(các) tài nguyên đang được truy xuất. Trong tài nguyên `channel`, thuộc tính `id` chỉ định mã nhận dạng kênh YouTube của kênh.
`managedByMe`	`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. Lưu ý: Đây là tham số dành riêng cho các đối tác nội dung của YouTube. Đặt giá trị của tham số này thành `true` để hướng dẫn API chỉ trả về những kênh do chủ sở hữu nội dung quản lý mà tham số `onBehalfOfContentOwner` chỉ định. Người dùng phải được xác thực là tài khoản CMS liên kết với chủ sở hữu nội dung đã chỉ định và phải cung cấp `onBehalfOfContentOwner`.
`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` để hướng dẫn API chỉ trả về các kênh do người dùng đã xác thực sở hữu.
Thông số không bắt buộc
`hl`	`string` Tham số `hl` hướng dẫn API truy xuất siêu dữ liệu tài nguyên đã bản địa hoá cho một ngôn ngữ ứng dụng cụ thể mà trang web YouTube hỗ trợ. Giá trị tham số phải là mã ngôn ngữ có trong danh sách mà phương thức `i18nLanguages.list` trả về. Nếu có thông tin chi tiết về tài nguyên đã bản địa hoá bằng ngôn ngữ đó, thì đối tượng `snippet.localized` của tài nguyên sẽ chứa các giá trị đã bản địa hoá. Tuy nhiên, nếu không có thông tin chi tiết đã bản địa hoá, thì đối tượng `snippet.localized` sẽ chứa thông tin về tài nguyên bằng ngôn ngữ mặc định của tài nguyên.
`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` 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 ý: Thông số này chỉ dành cho các đối tác nội dung của 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.
`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#channelListResponse",
  "etag": etag,
  "nextPageToken": string,
  "prevPageToken": string,
  "pageInfo": {
    "totalResults": integer,
    "resultsPerPage": integer
  },
  "items": [
    channel 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#channelListResponse`.
`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ả. Lưu ý rằng thuộc tính này không được đưa vào phản hồi của API nếu yêu cầu API tương ứng đặt tham số `managedByMe` thành `true`.
`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 kênh phù hợp với 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)`	`invalidCriteria`	Bạn có thể chỉ định tối đa một trong các bộ lọc sau:`id`, `categoryId`, `mine`, `managedByMe`, `forHandle`, `forUsername`. Trong trường hợp xác thực chủ sở hữu nội dung qua tham số `onBehalfOfContentOwner`, bạn chỉ có thể chỉ định `id` hoặc `managedByMe`.
`forbidden (403)`	`channelForbidden`	Kênh do tham số `id` chỉ định không hỗ trợ yêu cầu hoặc yêu cầu không được uỷ quyền đúng cách.
`notFound (404)`	`categoryNotFound`	Không tìm thấy danh mục được xác định bằng thông số `categoryId`. Sử dụng phương thức guideCategories.list để truy xuất danh sách các giá trị hợp lệ.
`notFound (404)`	`channelNotFound`	Không tìm thấy kênh được chỉ định trong tham số `id`.

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.