REST Resource: adBreak.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 的廣告插播 2. 不含 matchParams，依預期開始時間升序排序，再依建立時間升序排序，其中排序時會優先處理不含 expectedStartTime 的廣告插播

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

object (ServedBreak)

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

BreakState

廣告插播的狀態。

列舉
BREAK_STATE_UNSPECIFIED 廣告插播狀態不明。
BREAK_STATE_DECISIONED 系統已開始決定插播廣告，但尚未向使用者放送。
BREAK_STATE_COMPLETE 廣告插播已放送給使用者。
BREAK_STATE_SCHEDULED 系統已排定廣告插播時間點的決策時間。
BREAK_STATE_EXPIRED 廣告插播已過期，無法使用。根據預設，廣告時段會在 expectedStartTime 後 30 分鐘到期，如果未設定 expectedStartTime，則會在廣告時段開始決策後 30 分鐘到期。您可以使用 expireDuration 欄位明確設定有效期限。

BreakParams

與廣告中斷相關聯的參數。

JSON 表示法 
{
  "macros": [
    {
      object (KeyValue)
    }
  ],
  "adTagParams": [
    {
      object (KeyValue)
    }
  ]
}
欄位
macros[]

object (KeyValue)

(選用步驟) 自訂巨集值，可取代廣告代碼中的任意預留位置。在廣告請求時，DAI 會以 %%DAI_PATTERN:[MACRO_KEY]%% 形式展開廣告代碼巨集，其中 MACRO_KEY 是鍵。

如果已設定，這些巨集會優先於 Pod 放送要求中設定的巨集。
adTagParams[]

object (KeyValue)

(選用步驟) 覆寫主要廣告請求中的廣告代碼參數。

如果這些值是在設定 cust_params 的 Pod 供應要求之前觸發，系統就會使用這些值來做出決策。

一般來說，參數會覆寫插播主要廣告請求中的查詢字串參數。對於採用自訂網址格式的部分廣告伺服器，參數可能會覆寫廣告代碼中的特定位置，以符合廣告伺服器規定。在 AdBreak 上設定「mridx」值時，如果該值是有效的正整數，系統會以該值覆寫 breakSequence 欄位。即使是非 GAM 廣告伺服器，也是如此。

如果設定這些參數，系統會優先參照這些參數，而非 Pod 放送要求中設定的參數。

KeyValue

代表鍵/值組合。

JSON 表示法 
{
  "key": string,
  "value": string
}
欄位
key

string

必填。這個鍵/值組合的鍵。
value

string

必填。這個鍵/值組合的值。

MatchParams

與偵測到的縫合動態廣告插播相符的參數。

JSON 表示法 
{
  "scte35Binary": string,
  "scte35Upid": string,
  "scte35EventId": integer,
  "breakDuration": boolean
}
欄位
scte35Binary

string

(選用步驟) SCTE-35 二進位檔。如要比對這個欄位，資訊清單中的廣告插播必須具有相同的 SCTE-35 二進位字串 (Base64 編碼)。如果為空，系統會略過此步驟。
scte35Upid

string

(選用步驟) SCTE-35 UPID (專屬節目 ID)。如要比對這個欄位，資訊清單中的廣告插播必須具有相同的 SCTE-35 UPID。UPID 是從 SCTE-35 二進位檔剖析的值，如果為空，系統會略過此步驟。
scte35EventId

integer (uint32 format)

(選用步驟) SCTE-35 事件 ID。如要比對這個欄位，資訊清單中的廣告插斷必須具有相同的事件 ID (接合事件 ID/區隔事件 ID)。事件 ID 是從 SCTE-35 二進位檔剖析的值。如果為空，系統會略過此步驟。
breakDuration

boolean

(選用步驟) 插播長度。如要比對這個欄位，資訊清單中的廣告插斷必須與廣告插斷的 expectedDuration 具有相同的插斷時間長度，容許誤差為 1 毫秒。如果為 false，系統會略過這項設定。

ServedBreak

代表放送的廣告插播實際資訊。

JSON 表示法 
{
  "breakDetectTime": string,
  "detectedDuration": string,
  "scte35CueOut": string
}
欄位
breakDetectTime

string (Timestamp format)

僅供輸出。系統偵測到相符廣告插播的時間。如果是 Pod Serving，這是指系統要求廣告 Pod 的第一個片段/資訊清單的時間。如果是縫合式 DAI，這是指系統首次在資訊清單中偵測到廣告插播時段。

使用 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"。
detectedDuration

string (Duration format)

僅供輸出。系統偵測到的時間長度已傳送至相符的廣告插播。

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

string

僅供輸出。系統偵測到的 Base64 編碼 SCTE-35 訊息，已傳遞至相符的廣告插播。

方法

create

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

delete

 API 可刪除直播活動中的廣告插播。

get

 API 可在直播中取得廣告插播。

list

 API 可列出直播中的廣告插播。

patch

 API，用於更新直播活動中的廣告插播。