LiveCuepoints

Tài nguyên liveCuepoint và phương thức liveCuepoints.insert không còn được dùng nữa và được thay thế bằng phương thức liveBroadcasts.cuepoint.

Tài nguyên liveCuepoint chèn một điểm truy cập trong luồng video phát có thể kích hoạt điểm chèn quảng cáo.

Lưu ý: Lệnh API này thực ra là một phần của API Content ID của YouTube và có các yêu cầu uỷ quyền khác với các yêu cầu quản lý tài nguyên liveBroadcast và liveStream.

Phương pháp

API hỗ trợ các phương thức sau cho tài nguyên liveCuepoints:

chèn
Chèn điểm dừng vào thông báo phát trực tiếp. Hiện tại, yêu cầu sử dụng phương thức này phải được một tài khoản liên kết với chủ sở hữu nội dung trên YouTube cấp phép. Thử ngay.

Biểu diễn tài nguyên

Cấu trúc JSON sau đây cho thấy định dạng của tài nguyên liveCuepoints:

{
  "id": string,
  "kind": "youtubePartner#liveCuepoint",
  "broadcastId": string,
  "settings": {
    "offsetTimeMs": long,
    "walltime": datetime,
    "cueType": string,
    "durationSecs": unsigned integer
  }
}

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
id string
Một giá trị mà YouTube gán để nhận dạng duy nhất điểm dừng.
kind string
Loại tài nguyên API. Đối với tài nguyên liveCuepoint, giá trị là youtubePartner#liveCuepoint.
broadcastId string
Mã nhận dạng mà YouTube gán để nhận dạng riêng nội dung truyền phát mà điểm dừng đang được chèn vào.
settings object
Đối tượng settings xác định chế độ cài đặt của điểm dừng.
settings.offsetTimeMs long
Giá trị này chỉ định một thời điểm trong video khi người xem nhìn thấy một quảng cáo hoặc phương tiện chặn trong luồng. Giá trị thuộc tính xác định độ lệch thời gian, tính bằng mili giây, từ đầu luồng giám sát. Mặc dù được đo bằng mili giây, nhưng giá trị thực sự là giá trị gần đúng và YouTube sẽ chèn điểm dừng gần nhất có thể vào thời điểm đó. Bạn không được chỉ định giá trị cho tham số này nếu chương trình phát sóng của bạn không có luồng giám sát.

Giá trị mặc định của thuộc tính này là 0, cho biết rằng phải chèn điểm dừng càng sớm càng tốt. Nếu luồng phát của bạn không bị trì hoãn, thì 0 cũng là giá trị hợp lệ duy nhất. Tuy nhiên, nếu luồng phát trực tiếp của bạn bị trễ, thì giá trị thuộc tính có thể chỉ định thời gian nên chèn điểm dừng. Xem hướng dẫn Bắt đầu để biết thêm thông tin chi tiết.

Lưu ý: Nếu thông báo của bạn có giai đoạn thử nghiệm, thì độ lệch sẽ được đo từ thời điểm bắt đầu của giai đoạn thử nghiệm đó.
settings.walltime datetime
Giá trị này chỉ định thời gian của đồng hồ treo tường mà tại đó điểm dừng sẽ được chèn vào. Giá trị này được chỉ định ở định dạng ISO 8601 (YYYY-MM-DDThh:mm:ss.sssZ).

API trả về một lỗi nếu yêu cầu cố gắng chèn một điểm dừng chỉ định một giá trị cho thuộc tính này và cho thuộc tính settings.offsetTimeMs.
settings.cueType string
Loại điểm dừng. Xem hướng dẫn Bắt đầu để biết nội dung giải thích về các loại điểm dừng khác nhau. Ngoài ra, hãy xem tài liệu Vòng đời của chương trình phát sóng để biết các phương pháp hay nhất về cách chèn điểm dừng trong quá trình phát.

Các giá trị hợp lệ cho thuộc tính này là:
  • ad
settings.durationSecs unsigned integer
Thời lượng của điểm dừng, tính bằng giây. Giá trị này phải được chỉ định nếu cueType là ad và bị bỏ qua nếu không.