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

Channels: list

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

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: 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/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ã uỷ quyền chứa phạm vi https://www.googleapis.com/auth/youtubepartner-channel-audit. Ngoài ra, mọi mã thông báo sử dụng phạm vi đó phải bị thu hồi khi MCN quyết định chấp nhận hoặc từ chối kênh hoặc trong vòng hai tuần kể từ ngày mã thông báo được phát hành.

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

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` mà phản hồi API sẽ bao gồm. Nếu tham số xác định một tài sản chứa các tài sản con, thì các tài sản 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` Thông 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ể được 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 một 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 đầu 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 trên YouTube, nhờ đó yêu cầu kênh được liên kết với tên người dùng đó.
`id`	`string` Tham số `id` chỉ định danh sách(các) mã nhận dạng kênh 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 `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ể sử dụng tham số này trong một yêu cầu được uỷ quyền hợp lệ. Lưu ý: Tham số này chỉ dành 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 mà tham số `onBehalfOfContentOwner` chỉ định quản lý. Người dùng phải được xác thực là tài khoản CMS được liên kết với chủ sở hữu nội dung được chỉ định và phải cung cấp `onBehalfOfContentOwner`.
`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 hợp lệ. Đặt giá trị của tham số này thành `true` để hướng dẫn API chỉ trả về những kênh thuộc sở hữu của người dùng đã xác thực.
Thông số tuỳ chọn
`hl`	`string` Thông 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 do phương thức `i18nLanguages.list` trả về. Nếu có thông tin chi tiết về tài nguyên được 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ị được bản địa hoá. Tuy nhiên, nếu không có thông tin chi tiết được bản địa hoá, thì đối tượng `snippet.localized` sẽ chứa thông tin chi tiết 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 sẽ được trả về trong tập hợp kết quả. Giá trị có thể chấp nhận là từ `0` đến `50`. Giá trị mặc định là `5`.
`onBehalfOfContentOwner`	`string` Bạn chỉ có thể sử dụng tham số này trong một yêu cầu được uỷ quyền hợp lệ. 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 uỷ quyền của yêu cầu xác định một người dùng CMS của YouTube đ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 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à có quyền truy cập vào tất cả dữ liệu về 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 được chỉ định trên YouTube.
`pageToken`	`string` Tham số `pageToken` xác định một trang cụ thể trong tập hợp kết quả cần được trả về. Trong phản hồi 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

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ề một nội dung phản hồi có cấu trúc 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` 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ả. Xin lưu ý rằng thuộc tính này không có trong phản hồi 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 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 kênh phù hợp với tiêu chí yêu cầu.

Lỗi

Bảng sau đây xác định 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. Để biết thêm thông tin chi tiết, hãy xem bài viết YouTube Data API – Lỗi.

Loại lỗi	Thông tin chi tiết về lỗi	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 thông 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 tham 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 thông số `id`.

Hãy dùng thử!

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