REST Resource: adBreak.networks.assets.adBreaks

Tài nguyên: AdBreak

Siêu dữ liệu điểm chèn quảng cáo dùng để quyết định quảng cáo cho một điểm chèn quảng cáo trong sự kiện video trực tiếp.

Biểu diễn dưới dạng JSON 
{
  "name": string,
  "createTime": string,
  "expectedDuration": string,
  "customParams": string,
  "scte35CueOut": string,
  "podTemplateName": string,
  "breakState": enum (BreakState),
  "expectedStartTime": string,
  "expireDuration": string,
  "breakSequence": string,
  "breakParams": {
    object (BreakParams)
  },
  "matchParams": {
    object (MatchParams)
  },
  "servedBreak": {
    object (ServedBreak)
  }
}
Trường
name

string

Chỉ có đầu ra. Tên tài nguyên của Điểm chèn quảng cáo. Trường này sẽ có định dạng "networks//assets//adBreaks/".

network_code là mã mạng trong Google Ad Manager mà nội dung này thuộc về.

asset_key là khoá của Sự kiện phát trực tiếp trong Google Ad Manager mà Khoảng thời gian quảng cáo được tạo.

adBreakId là khoá của Điểm chèn quảng cáo. CHỈ CÓ ĐẦU RA.
createTime

string (Timestamp format)

Chỉ có đầu ra. Thời gian tạo Điểm chèn quảng cáo.

Hãy dùng RFC 3339, trong đó dữ liệu đầu ra được tạo sẽ luôn được chuẩn hoá theo múi giờ và sử dụng 0, 3, 6 hoặc 9 chữ số thập phân. Các khoảng lệch khác ngoài "Z" cũng được chấp nhận. Ví dụ: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" hoặc "2014-10-02T15:01:23+05:30".
expectedDuration

string (Duration format)

Bắt buộc. Thời lượng nghỉ dự kiến.

Thời lượng tính bằng giây, có tối đa 9 chữ số thập phân, kết thúc bằng "s". Ví dụ: "3.5s".
customParams
(deprecated)

string

Không bắt buộc. Cặp khoá-giá trị cần được đưa vào yêu cầu quảng cáo cho điểm chèn này để nhắm mục tiêu theo tiêu chí tuỳ chỉnh trong Ad Manager. Ví dụ: "key1=value&key2=value2,value22" Không dùng nữa: Vui lòng đặt cust_params trong breakParams.ad_tag_params bằng cách sử dụng khoá "cust_params".
scte35CueOut

string

Không bắt buộc. Dữ liệu được mã hoá Base 64 từ điểm cue out scte35. Có thể bao gồm lệnh splice_insert() hoặc time_signal(). Ví dụ: – với time_signal(): "/DA0AAAAAAAA///wBQb+cr0AUAAeAhxDVUVJSAAAjn/PAAGlmbAICAAAAAAsoKGKNAIAmsnRfg==" – với splice_insert(): "/DAvAAAAAAAA///wFAVIAACPf+/+c2nALv4AUsz1AAAAAAAKAAhDVUVJAAABNWLbowo="
podTemplateName
(deprecated)

string

Không bắt buộc. Tên mẫu nhóm Google Ad Manager. Không dùng nữa: Vui lòng đặt cust_params trong breakParams.ad_tag_params bằng cách sử dụng khoá "ptpln".
breakState

enum (BreakState)

Chỉ có đầu ra. Trạng thái hiện tại của Điểm chèn quảng cáo.
expectedStartTime

string (Timestamp format)

Không bắt buộc. Thời gian bắt đầu dự kiến của Điểm chèn quảng cáo.

Hãy dùng RFC 3339, trong đó dữ liệu đầu ra được tạo sẽ luôn được chuẩn hoá theo múi giờ và sử dụng 0, 3, 6 hoặc 9 chữ số thập phân. Các khoảng lệch khác ngoài "Z" cũng được chấp nhận. Ví dụ: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" hoặc "2014-10-02T15:01:23+05:30".
expireDuration

string (Duration format)

Không bắt buộc. Hết hạn điểm chèn quảng cáo tại expectedStartTime + expireDuration. Nếu bạn không đặt expectedStartTime, Điểm chèn quảng cáo sẽ hết hạn sau expireDuration kể từ khi bắt đầu đưa ra quyết định. Mặc định: 30 phút Tối thiểu: 5 phút Tối đa: 6 giờ

Thời lượng tính bằng giây, có tối đa 9 chữ số thập phân, kết thúc bằng "s". Ví dụ: "3.5s".
breakSequence

string (int64 format)

Chỉ có đầu ra. Mã nhận dạng trình tự quảng cáo trong video của Điểm chèn quảng cáo. Nhiều điểm chèn quảng cáo có thể có cùng breakSequence nếu được chỉ định rõ ràng thông qua breakParams.ad_tag_params bằng khoá mridx. Điều này giúp liên kết hiệu quả 2 điểm chèn quảng cáo trên GAM.
breakParams

object (BreakParams)

Không bắt buộc. Các tham số của điểm chèn quảng cáo sẽ được đưa vào yêu cầu quảng cáo cho điểm chèn này.
matchParams

object (MatchParams)

Không bắt buộc. Được dùng cho DAI kết hợp để xác định cách một khoảng thời gian quảng cáo được tạo thông qua API khớp với một khoảng thời gian quảng cáo trong tệp kê khai. Khi phát hiện thấy một điểm chèn mới, một hàm so khớp sẽ chạy trên tất cả các điểm chèn quảng cáo của một sự kiện có breakState là SCHEDULED hoặc DECISIONED để kiểm tra xem tất cả các thông số đã đặt trong matchParams của một Điểm chèn quảng cáo có khớp với điểm chèn được phát hiện hay không. Trường hợp trùng khớp xảy ra nếu một trong các điều kiện sau được đáp ứng: 1. Điểm chèn quảng cáo có trường matchParams và tất cả các thông số được đặt trong trường này đều khớp với điểm chèn mới. 2. Điểm chèn quảng cáo là DECISIONED và không có trường matchParams.

Để ngăn hành vi "khớp tất cả" xảy ra do vô tình (sẽ xảy ra với matchParams trống nhưng hiện tại), matchParams không được trống nếu được đặt. Nếu trường này xuất hiện trong một yêu cầu, bạn phải đặt ít nhất một trong các trường riêng của trường này.

Các điểm chèn quảng cáo được kiểm tra theo thứ tự sau: 1. có matchParams, được sắp xếp theo expectedStartTime tăng dần, createTime tăng dần, trong đó các điểm chèn quảng cáo không có expectedStartTime được ưu tiên khi sắp xếp 2. không có matchParams, được sắp xếp theo expectedStartTime tăng dần, createTime tăng dần, trong đó các điểm chèn quảng cáo không có expectedStartTime được ưu tiên khi sắp xếp

Nếu tất cả EABN đang chờ xử lý không khớp, DAI sẽ quay lại hành vi quyết định JIT bằng cách sử dụng chỉ mục quảng cáo trong video tiếp theo có sẵn
servedBreak

object (ServedBreak)

Chỉ có đầu ra. Thông tin này phản ánh thông tin thực tế của điểm chèn quảng cáo được phân phát. Chỉ đặt cho các điểm chèn quảng cáo có COMPLETE breakState.

BreakState

Trạng thái của Điểm chèn quảng cáo.

Enum
BREAK_STATE_UNSPECIFIED Không xác định được trạng thái của Điểm chèn quảng cáo.
BREAK_STATE_DECISIONED Quyết định về Điểm chèn quảng cáo đã bắt đầu nhưng chưa được gửi đến người dùng.
BREAK_STATE_COMPLETE Khoảng thời gian chèn quảng cáo đã được phân phối cho người dùng.
BREAK_STATE_SCHEDULED Điểm chèn quảng cáo được lên lịch để đưa ra quyết định.
BREAK_STATE_EXPIRED Điểm chèn quảng cáo đã hết hạn và không sử dụng được. Theo mặc định, Điểm chèn quảng cáo sẽ hết hạn sau 30 phút kể từ expectedStartTime hoặc 30 phút sau khi Điểm chèn quảng cáo bắt đầu đưa ra quyết định nếu bạn không đặt expectedStartTime. Bạn có thể đặt thời gian hết hạn một cách rõ ràng bằng cách sử dụng trường expireDuration.

BreakParams

Các tham số liên kết với một thời điểm hiển thị quảng cáo.

Biểu diễn dưới dạng JSON 
{
  "macros": [
    {
      object (KeyValue)
    }
  ],
  "adTagParams": [
    {
      object (KeyValue)
    }
  ]
}
Trường
macros[]

object (KeyValue)

Không bắt buộc. Giá trị macro tuỳ chỉnh thay thế một trình giữ chỗ tuỳ ý trong thẻ quảng cáo. Tại thời điểm yêu cầu quảng cáo, DAI sẽ mở rộng các macro thẻ quảng cáo ở dạng %%DAI_PATTERN:[MACRO_KEY]%%, trong đó MACRO_KEY là khoá.

Nếu được đặt, các macro này sẽ được ưu tiên hơn các macro được đặt trong yêu cầu Phân phát nhóm.
adTagParams[]

object (KeyValue)

Không bắt buộc. Ghi đè các thông số thẻ quảng cáo trong yêu cầu quảng cáo chính.

Các tham số này được dùng để quyết định xem có kích hoạt trước các yêu cầu Phân phát nhóm quảng cáo với cust_params được đặt hay không.

Thông thường, các thông số sẽ ghi đè một thông số chuỗi truy vấn trong yêu cầu quảng cáo chính cho khoảng thời gian hiển thị quảng cáo. Đối với một số máy chủ quảng cáo có định dạng URL tuỳ chỉnh, các tham số có thể ghi đè những vị trí cụ thể trong thẻ quảng cáo để tuân thủ các yêu cầu của máy chủ quảng cáo. Việc đặt giá trị "mridx" trên AdBreak sẽ ghi đè trường breakSequence bằng giá trị được cung cấp, nếu đó là một số nguyên dương hợp lệ. Điều này vẫn áp dụng ngay cả đối với các máy chủ quảng cáo không phải GAM.

Nếu được đặt, các thông số này sẽ được ưu tiên hơn các thông số được đặt trong yêu cầu Phân phát nhóm.

KeyValue

Đại diện cho một cặp khoá-giá trị.

Biểu diễn dưới dạng JSON 
{
  "key": string,
  "value": string
}
Trường
key

string

Bắt buộc. Khoá của cặp khoá-giá trị này.
value

string

Bắt buộc. Giá trị của cặp khoá-giá trị này.

MatchParams

Các tham số cần khớp với một điểm chèn quảng cáo DAI được phát hiện.

Biểu diễn dưới dạng JSON 
{
  "scte35Binary": string,
  "scte35Upid": string,
  "scte35EventId": integer,
  "breakDuration": boolean
}
Trường
scte35Binary

string

Không bắt buộc. Nhị phân SCTE-35. Để khớp với trường này, điểm chèn quảng cáo trong tệp kê khai phải có cùng chuỗi nhị phân SCTE-35 (được mã hoá base64). Nếu trống, bước này sẽ bị bỏ qua.
scte35Upid

string

Không bắt buộc. UPID (Giá trị nhận dạng chương trình duy nhất) theo chuẩn SCTE-35. Để khớp với trường này, điểm chèn quảng cáo trong tệp kê khai phải có cùng UPID SCTE-35. UPID là một giá trị được phân tích cú pháp từ tệp nhị phân SCTE-35. Nếu trống, bước này sẽ bị bỏ qua.
scte35EventId

integer (uint32 format)

Không bắt buộc. Mã sự kiện SCTE-35. Để khớp trường này, điểm chèn quảng cáo trong tệp kê khai phải có cùng mã sự kiện (mã sự kiện chèn/mã sự kiện phân đoạn). Mã sự kiện là một giá trị được phân tích cú pháp từ tệp nhị phân SCTE-35. Nếu trống, bước này sẽ bị bỏ qua.
breakDuration

boolean

Không bắt buộc. Thời lượng của khoảng thời gian nghỉ. Để khớp với trường này, điểm chèn quảng cáo trong tệp kê khai phải có thời lượng điểm chèn giống như expectedDuration của Điểm chèn quảng cáo, với dung sai là 1 mili giây. Nếu là false, bước này sẽ bị bỏ qua.

ServedBreak

Thể hiện thông tin thực tế của Điểm chèn quảng cáo được phân phát.

Biểu diễn dưới dạng JSON 
{
  "breakDetectTime": string,
  "detectedDuration": string,
  "scte35CueOut": string
}
Trường
breakDetectTime

string (Timestamp format)

Chỉ có đầu ra. Thời gian phát hiện thấy điểm chèn quảng cáo phù hợp. Đối với tính năng Phân phát nhóm quảng cáo, đây là thời điểm phân đoạn/tệp kê khai đầu tiên của nhóm quảng cáo được yêu cầu. Đối với DAI được ghép, đây là thời điểm hệ thống phát hiện thấy điểm chèn quảng cáo lần đầu tiên trên tệp kê khai.

Hãy dùng RFC 3339, trong đó dữ liệu đầu ra được tạo sẽ luôn được chuẩn hoá theo múi giờ và sử dụng 0, 3, 6 hoặc 9 chữ số thập phân. Các khoảng lệch khác ngoài "Z" cũng được chấp nhận. Ví dụ: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" hoặc "2014-10-02T15:01:23+05:30".
detectedDuration

string (Duration format)

Chỉ có đầu ra. Thời lượng được phát hiện đã truyền trên điểm chèn quảng cáo phù hợp.

Thời lượng tính bằng giây, có tối đa 9 chữ số thập phân, kết thúc bằng "s". Ví dụ: "3.5s".
scte35CueOut

string

Chỉ có đầu ra. Thông báo SCTE-35 được mã hoá base64 đã phát hiện được truyền trên điểm chèn quảng cáo khớp.

Phương thức

create

 API để tạo Điểm chèn quảng cáo trong luồng phát trực tiếp.

delete

 API để xoá một điểm chèn quảng cáo trong luồng phát trực tiếp.

get

 API để lấy một Điểm chèn quảng cáo trong sự kiện phát trực tiếp.

list

 API để liệt kê các điểm chèn quảng cáo trong luồng phát trực tiếp.

patch

 API để cập nhật Điểm chèn quảng cáo trong luồng phát trực tiếp.