REST Resource: networks.assets.adBreaks

資源：AdBreak

廣告插播中繼資料，用於決定直播影片活動廣告插播的廣告。

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)
  }
}
欄位
name

string

僅供輸出。廣告插播的資源名稱。這個欄位的格式為「networks//assets//adBreaks/」。

network_code 是 Google Ad Manager 中這個內容所屬的聯播網代碼。

asset_key 是在 Google 廣告管理工具中建立廣告插播的直播活動金鑰。

adBreakId 是廣告插播的鍵。僅供輸出。
createTime

string (Timestamp format)

僅供輸出。廣告插播的建立時間。

使用 RFC 3339，產生的輸出內容一律會經過 Z 正規化，並使用 0、3、6 或 9 個小數位數，也接受「Z」以外的偏移量。範例："2014-10-02T15:01:23Z"、"2014-10-02T15:01:23.045123456Z" 或 "2014-10-02T15:01:23+05:30"。
expectedDuration

string (Duration format)

必填。預計休息時間長度。

時間長度以秒為單位，最多可有 9 個小數位數，並應以「s」結尾，例如："3.5s"。
customParams
(deprecated)

string

(選用步驟) 針對這個廣告插播的廣告請求加入的鍵/值組合 (適用於 Ad Manager 中的自訂條件指定目標)。示例：'key1=value&key2=value2,value22' 已淘汰：請使用「cust_params」鍵，在 breakParams.ad_tag_params 中設定 cust_params。
scte35CueOut

string

(選用步驟) 來自 scte35 結束提示點的 Base64 編碼資料。可能包含 splice_insert() 或 time_signal() 指令。範例： - 使用 time_signal()： 「/DA0AAAAAAAA///wBQb+cr0AUAAeAhxDVUVJSAAAjn/PAAGlmbAICAAAAAAsoKGKNAIAmsnRfg==」 - 使用 splice_insert()： 「/DAvAAAAAAAA///wFAVIAACPf+/+c2nALv4AUsz1AAAAAAAKAAhDVUVJAAABNWLbowo="」
podTemplateName
(deprecated)

string

(選用步驟) Google Ad Manager 廣告連播範本名稱。已淘汰：請使用「ptpln」鍵，在 breakParams.ad_tag_params 中設定 cust_params。
breakState

enum (BreakState)

僅供輸出。廣告插播的目前狀態。
expectedStartTime

string (Timestamp format)

(選用步驟) 廣告插播的預計開始時間。

使用 RFC 3339，產生的輸出內容一律會經過 Z 正規化，並使用 0、3、6 或 9 個小數位數，也接受「Z」以外的偏移量。範例："2014-10-02T15:01:23Z"、"2014-10-02T15:01:23.045123456Z" 或 "2014-10-02T15:01:23+05:30"。
expireDuration

string (Duration format)

(選用步驟) 在 expectedStartTime + expireDuration 時，廣告插播會過期。如果未設定 expectedStartTime，廣告插播會在決策開始後 expireDuration 到期。預設值：30 分鐘。最小值：5 分鐘。最大值：6 小時。

時間長度以秒為單位，最多可有 9 個小數位數，並應以「s」結尾，例如："3.5s"。
breakSequence

string (int64 format)

僅供輸出。廣告插播的片中廣告序列 ID。如果透過 breakParams.ad_tag_params 和 mridx 鍵明確指定，多個廣告插播可能會具有相同的 breakSequence。這會有效連結兩個 GAM 廣告插播時間。
breakParams

object (BreakParams)

(選用步驟) 要納入這個廣告時段廣告請求的廣告時段參數。
matchParams

object (MatchParams)

(選用步驟) 用於縫合 DAI，判斷透過 API 建立的廣告插播，如何與資訊清單中的廣告插播相符。系統偵測到新的插播時，會針對事件中 breakState 為 SCHEDULED 或 DECISIONED 的所有廣告插播執行比對函式，檢查廣告插播 matchParams 中設定的所有參數是否與偵測到的插播相符。只要符合下列任一條件，系統就會視為相符：1. 廣告插播有 matchParams 欄位，其中設定的所有參數都與新插播相符。2. 廣告插播為 DECISIONED，且沒有 matchParams 欄位。

為避免發生「比對所有項目」的意外行為 (如果 matchParams 存在但為空白，就會發生這種情況)，matchParams 設好後就不得為空白。如果要求中包含這個欄位，則必須設定至少一個自有欄位。

系統會依下列順序檢查廣告插播：1. 含有 matchParams，依 expectedStartTime 升序和 createTime 升序排序，其中排序時會優先處理沒有 expectedStartTime 的廣告插播 2. 沒有 matchParams，依 expectedStartTime 升序和 createTime 升序排序，其中排序時會優先處理沒有 expectedStartTime 的廣告插播

如果所有待處理的 EABN 都不相符，DAI 會改用 JIT 決策行為，並使用下一個可用的中插索引
servedBreak

object (ServedBreak)

僅供輸出。這項資訊反映放送廣告時段的實際情況。僅適用於具有 COMPLETE breakState 的廣告插播時間點。

方法

create

 API，可在直播中建立廣告插播。

list

 API，用於列出直播中的廣告插播。