LiveBroadcasts: list

Trả về danh sách các tin truyền phát trên YouTube 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/liveBroadcasts

Ủy quyền

Yêu cầu này cần có sự uỷ quyền với ít nhất một trong các phạm vi sau. Để đọc thêm về xác thực và uỷ quyền, hãy xem phần Triển khai phương thức 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 (đượ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 liveBroadcast mà phản hồi của 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, contentDetails, monetizationDetailsstatus.
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 các thông báo truyền tin có trạng thái đã chỉ định.

Các giá trị có thể chấp nhận là:
  • active – Trả về các chương trình phát sóng trực tiếp hiện tại.
  • all – Trả về tất cả thông báo truyền tin.
  • completed – Trả về các thông báo truyền phát đã kết thúc.
  • upcoming – Trả về các tin truyền chưa bắt đầu.
id string
Tham số id chỉ định một danh sách mã nhận dạng nội dung truyền phát của YouTube được phân tách bằng dấu phẩy, giúp xác định các nội dung truyền phát đ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 thông báo truyền tin.
mine boolean
Bạn có thể dùng tham số mine để hướng dẫn API chỉ trả về các thông báo truyền tin do người dùng đã xác thực sở hữu. Thiết lập giá trị thông số thành true để chỉ truy xuất thông báo truyền tin của riêng bạn.
Tham số không bắt buộc
broadcastType string
Tham số broadcastType lọc phản hồi của API để chỉ bao gồm các thông báo truyền tin 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ả thông báo truyền tin.
  • event – Chỉ trả về các tin truyền phát sự kiện đã lên lịch.
  • persistent – Chỉ trả về các thông báo truyền tin liên tụ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ả. 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ể dùng thông số này trong một yêu cầu được uỷ quyền phù hợp.
Lưu ý: Tham số này chỉ dành cho đối tác nội dung YouTube.

Tham 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 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ố. Thông 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. 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 toàn bộ dữ liệu video và kênh của mình mà không 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 YouTube được chỉ định.
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 phù hợp.
Lưu ý: Tham số này chỉ dành cho đối tác nội dung của YouTube.

Tham số onBehalfOfContentOwnerChannel chỉ định ID kênh YouTube của kênh mà video được thêm vào. Tham số này bắt buộc phải có khi một yêu cầu chỉ định một giá trị cho tham số onBehalfOfContentOwner và chỉ có thể được sử 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 các đối tác nội dung YouTube sở hữu và quản lý nhiều kênh YouTube khác nhau. Thẻ 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 hành động 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 tập hợp kết quả cần được trả về. Trong phản hồi của API, thuộc tính nextPageTokenprevPageToken sẽ xác định các trang khác có thể 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ề nội dung phản hồi có cấu trúc như 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 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ể đượ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 nhóm 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 của API.
items[] list
Danh sách các thông báo truyền tin phù hợ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 lệnh gọi đến phương thức này. Để biết thêm thông tin chi tiết, hãy xem thông báo lỗi.

Loại lỗi Chi tiết về lỗi Mô tả
insufficientPermissions insufficientLivePermissions Yêu cầu không được phép truy xuất chương trình phát sóng trực tiếp.
insufficientPermissions liveStreamingNotEnabled Người dùng đã uỷ quyền cho yêu cầu này 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 bài viết Đ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 cũng như xem yêu cầu và phản hồi của API.