LiveBroadcasts: list

Trả về danh sách các chương trình phát sóng trên YouTube khớp với các tham số của 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/liveBroadcasts

Ủ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, hãy xem bài viết Triển khai quy trình xác thực OAuth 2.0.

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 liveBroadcast được phân tách bằng dấu phẩy mà phản hồi API sẽ bao gồm. Tên part mà bạn có thể đưa vào giá trị tham số là id, snippet, contentDetails, monetizationDetails và status.
Bộ lọc (chỉ định chính xác một trong các tham số sau)
broadcastStatus string
Tham số broadcastStatus lọc phản hồi của API để chỉ bao gồm những chương trình phát sóng có trạng thái được chỉ định.

Các giá trị được chấp nhận là:
  • active – Trả về các sự kiện phát sóng trực tiếp hiện tại.
  • all – Trả về tất cả chương trình phát sóng.
  • completed – Trả về những chương trình phát sóng đã kết thúc.
  • upcoming – Trả về các chương trình phát sóng chưa bắt đầu.
id string
Tham số id chỉ định danh sách mã sự kiện phát sóng trên YouTube được phân tách bằng dấu phẩy để xác định các sự kiện phát sóng đang được truy xuất. Trong tài nguyên liveBroadcast, thuộc tính id chỉ định mã nhận dạng của chương trình phát sóng.
mine boolean
Bạn có thể dùng tham số mine để hướng dẫn API chỉ trả về những sự kiện phát sóng thuộc quyền sở hữu của người dùng đã xác thực. Đặt giá trị tham số thành true để chỉ truy xuất các chương trình phát sóng của riêng bạn.
Thông số tuỳ chọn
broadcastType string
Tham số broadcastType lọc phản hồi của API để chỉ bao gồm những thông báo có loại được chỉ định. Bạn nên sử dụng tham số này trong các yêu cầu đặt tham số mine thành true hoặc sử dụng tham số broadcastStatus. Giá trị mặc định là event.

Các giá trị được chấp nhận là:
  • all – Trả về tất cả chương trình phát sóng.
  • event – Chỉ trả về các sự kiện phát sóng đã lên lịch.
  • persistent – Chỉ trả về các chương trình phát sóng liên tục.
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ả. 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 người dùng Hệ thống quản lý nội dung (CMS) của YouTube đ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 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ụ thể trên YouTube.
onBehalfOfContentOwnerChannel string
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.
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ố 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 trên 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

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#liveBroadcastListResponse",
  "etag": etag,
  "nextPageToken": string,
  "prevPageToken": string,
  "pageInfo": {
    "totalResults": integer,
    "resultsPerPage": integer
  },
  "items": [
    liveBroadcast 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#liveBroadcastListResponse.
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 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 chương trình phát sóng khớ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 một lệnh gọi đến phương thức này. Để biết thêm thông tin, hãy xem thông báo lỗi.

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 sóng trực tiếp.
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. Để biết thêm thông tin, hãy xem phần Trạng thái đủ điều kiện để sử dụng tính năng.

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.