LiveStreams: list

Trả về danh sách các luồng video khớp với các 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

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 liveStream 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 danh sách mã luồng được phân tách bằng dấu phẩy trên YouTube nhằm xác định các luồng đ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ể dùng thông số này trong một yêu cầu được uỷ quyền đúng cách. Bạn có thể dùng tham số mine để hướng dẫn API chỉ trả về các luồng thuộc sở hữu của người dùng đã xác thực. Hãy đặt giá trị thông số thành true để chỉ truy xuất luồng dữ liệu của riêng bạn.
Thông số không bắt buộc
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.
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. Chỉ có thể sử 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.
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#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
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 sự kiện phát trực tiếp đáp ứng 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ả
insufficientPermissions insufficientLivePermissions Yêu cầu này không được phép truy xuất luồng trực tuyến đã chỉ định.
insufficientPermissions liveStreamingNotEnabled Người dùng đã cho phép yêu cầu không được phép phát trực tuyến video 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ử!

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.