LiveBroadcasts: list

Trả về danh sách các thông báo trên YouTube khớp với tham số yêu cầu của 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).

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

Các 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.

Các tham số
Tham số bắt buộc
part string
Tham số part chỉ định 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 API sẽ đưa vào. Những tên part mà bạn có thể đưa vào giá trị thông 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 API để chỉ bao gồm các tin truyền có trạng thái đã chỉ định.

Các giá trị được chấp nhận là:
  • active – Trả lại các chương trình phát sóng trực tiếp hiện tại.
  • all – Trả về tất cả tin truyền.
  • completed – Trả lại thông báo truyền tin đã kết thúc.
  • upcoming – Trả về thông báo truyền tin chưa bắt đầu.
id string
Tham số id chỉ định danh sách mã truyền tin của YouTube được phân tách bằng dấu phẩy để xác định các tin truyền đượ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ể sử dụng tham số mine để hướng dẫn API chỉ trả về các tin truyền 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 thông báo 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 API để chỉ bao gồm các thông báo thuộc loại đã chỉ định. Bạn nên dùng tham số này trong các yêu cầu đặt tham số mine thành true hoặc các yêu cầu 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ả tin truyền.
  • event – Chỉ trả về các chương trình phát sóng sự kiện đã lên lịch.
  • persistent – Chỉ trả về các tin nhắn truyền phát 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 nhóm 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ể sử dụng thông số này trong yêu cầu được uỷ quyền hợp lệ. 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 rằng thông tin xác thực uỷ quyền 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ị thông số. Thông số này dành cho những đối tác nội dung YouTube sở hữu và quản lý nhiều kênh YouTube khác nhau. Dịch vụ 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 phải cung cấp thông tin xác thực cho từng kênh riêng lẻ. Tài khoản CMS mà người dùng sử dụng để xác thực phải được liên kết với chủ sở hữu nội dung YouTube đã chỉ định.
onBehalfOfContentOwnerChannel string
Bạn chỉ có thể sử dụng thông số này trong yêu cầu được uỷ quyền hợp lệ. Bạn chỉ có thể sử dụng thông số này trong yêu cầu được cho phép đú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.

Tham số onBehalfOfContentOwnerChannel chỉ định mã kênh YouTube của kênh mà video sẽ đượ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ể được sử dụng kết hợp 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 đượ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.

Thông 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 khác nhau. Giá trị 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 nhóm kết quả sẽ được trả về. Trong phản hồi API, thuộc tính nextPageTokenprevPageToken xác định các trang khác có thể truy xuất được.

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ề một 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 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 thông báo 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ề khi 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 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 đã ủy quyền yêu cầu chưa được bật để 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ử!

Hãy 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.