LiveBroadcasts: control

Lưu ý: Phương thức liveBroadcasts.control không còn được dùng nữa và sẽ ngừng hoạt động kể từ ngày 1 tháng 10 năm 2020. Sau ngày đó, tất cả lệnh gọi đến phương thức này sẽ trả về lỗi bị cấm (403) và sau đó sẽ bị xoá hoàn toàn.

Ứng dụng vẫn có thể triển khai phương thức truyền dẫn của riêng mình bằng cách thêm lớp phủ vào video được gửi đến máy chủ truyền dẫn của YouTube. Xem thông báo về việc ngừng sử dụng.

Kiểm soát chế độ cài đặt của một phương tiện chặn có thể hiển thị trong luồng phát sóng.

Các trường hợp sử dụng phổ biến

Yêu cầu

Yêu cầu HTTP

POST https://www.googleapis.com/youtube/v3/liveBroadcasts/control

Ủ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
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
id string
Tham số id chỉ định mã phát sóng trực tiếp trên YouTube, giúp xác định duy nhất chương trình phát sóng có phương tiện chặn được cập nhật.
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 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 và status.
Thông số không bắt buộc
displaySlate boolean
Tham số displaySlate chỉ định liệu phương tiện chặn đang được bật hay tắt.
offsetTimeMs unsigned long
Tham số offsetTimeMs chỉ định độ lệch thời gian dương khi xảy ra thay đổi phương tiện chặn được chỉ định. Giá trị này được tính bằng mili giây kể từ lúc bắt đầu luồng giám sát của thông báo truyền tin, đây là thời gian mà giai đoạn thử nghiệm cho thông báo truyền tin bắt đầu. Mặc dù được chỉ định bằng mili giây nhưng giá trị này thực sự là giá trị gần đúng và YouTube sẽ hoàn thành tác vụ yêu cầu gần nhất có thể so với thời gian đó.

Nếu bạn không chỉ định giá trị cho tham số này thì YouTube sẽ thực hiện thao tác càng sớm càng tốt. Hãy xem hướng dẫn Bắt đầu sử dụng để biết thêm thông tin.

Lưu ý quan trọng: Bạn chỉ nên chỉ định giá trị cho thông số này nếu sự kiện phát sóng của bạn bị trễ.
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.
walltime datetime
Tham số walltime chỉ định thời gian của đồng hồ treo tường mà tại thời điểm đó sẽ xảy ra thay đổi phương tiện chặn đã chỉ định. Giá trị được chỉ định theo định dạng ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ).

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 tài nguyênliveBroadcast trong nội dung phản hồi.

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ả
backendError errorDisplaySlate Đã xảy ra lỗi khi thực thi hành động được yêu cầu.
forbidden (403) liveBroadcastControlNotAllowed Hành động đã yêu cầu chỉ được phép nếu trạng thái của thông báo truyền tin là live.
insufficientPermissions insufficientLivePermissions Người dùng không được phép thực hiện thao tác được yêu cầu, có thể là do người dùng không có quyền phát trực tiếp.
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.
invalidValue (400) conflictingTimeFields Bạn chỉ có thể chỉ định một trong hai trong số offsetTimeMs và walltime.
invalidValue (400) invalidOffsetTimeMs Giá trị của tham số offsetTimeMs không hợp lệ. Giá trị thông số phải là số dương, nhưng bạn chỉ có thể chỉ định thông số này nếu bật luồng giám sát của thông báo truyền tin.
invalidValue (400) invalidWalltime Giá trị của tham số walltime không hợp lệ.
notFound (404) liveBroadcastNotFound Thông báo truyền tin do tham số id chỉ định không tồn tại.
required (400) actionRequired Yêu cầu API cần chỉ định ít nhất một hành động. Tại thời điểm này, thao tác duy nhất được hỗ trợ là khả năng bật hoặc tắt phương tiện chặn.
required (400) idRequired Tham số id bắt buộc phải xác định thông báo truyền tin đang được cập nhật.

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.