LiveStreams: list

Trả về danh sách các luồng video khớp với tham số yêu cầu API.

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

Ủy quyền

Yêu cầu này cần được uỷ quyền với ít nhất một trong các phạm vi sau (đọc thêm về quy trình xác thực và uỷ quyền).

Phạm vi
https://www.googleapis.com/auth/youtube.readonly
https://www.googleapis.com/auth/youtube
https://www.googleapis.com/auth/youtube.force-ssl

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ả 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 gồm một hoặc nhiều thuộc tính tài nguyên liveStream được phân tách bằng dấu phẩy mà phản hồi API sẽ bao gồm. Các tên part mà bạn có thể đưa vào giá trị tham số là id, snippet, cdn và status.
Bộ lọc (chỉ định chính xác một trong các tham số sau)
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 luồng phát trên YouTube để xác định các luồng phát đang được truy xuất. Trong tài nguyên liveStream, thuộc tính id chỉ định mã nhận dạng của luồng.
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. Bạn có thể sử dụng tham số mine để hướng dẫn API chỉ trả về các sự kiện phát trực tiếp do người dùng đã xác thực sở hữu. Đặt giá trị tham số thành true để chỉ truy xuất các luồng của riêng bạn.
Thông số tuỳ chọn
maxResults	unsigned integer Tham số maxResults chỉ định số lượng tối đa các mục sẽ được trả về trong tập kết quả. Giá trị được chấp nhận là từ 0 đến 50. Giá trị mặc định là 5.
onBehalfOfContentOwner	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 các đối tác nội dung của YouTube. Tham số onBehalfOfContentOwner cho biết thông tin xác thực của yêu cầu 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ị 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. 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ụ thể 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. 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. Tham số này là bắt buộc khi một yêu cầu chỉ định giá trị cho tham số onBehalfOfContentOwner và chỉ có thể được dùng 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.
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ề nội dung phản hồi có cấu trúc như sau:

{
  "kind": "youtube#liveStreamListResponse",
  "etag": etag,
  "nextPageToken": string,
  "prevPageToken": string,
  "pageInfo": {
    "totalResults": integer,
    "resultsPerPage": integer
  },
  "items": [
    liveStream 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#liveStreamListResponse.
etag	etag Etag của tài nguyên này.
nextPageToken	string Mã thông báo có thể 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 hợ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 sự kiện phát trực tiếp 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ề để 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	Thông tin chi tiết về lỗi	Mô tả
insufficientPermissions	insufficientLivePermissions	Yêu cầu không được phép truy xuất sự kiện phát trực tiếp đã chỉ định.
insufficientPermissions	liveStreamingNotEnabled	Người dùng đã uỷ quyền cho yêu cầu không được phép phát video trực tiếp trên YouTube. Người dùng có thể tìm thêm thông tin tại https://www.youtube.com/features.

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.