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 Ad Manager 中创建广告插播时所用的直播活动键。

adBreakId 是广告插播的键。仅限输出。
createTime

string (Timestamp format)

仅限输出。广告插播时间点的创建时间。

采用 RFC 3339 标准，生成的输出将始终进行 Z 规范化（即转换为 UTC 零时区格式并在末尾附加 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)

必需。预期中断时长。

该时长以秒为单位，最多包含九个小数位，以“s”结尾。示例："3.5s"。
customParams
(deprecated)

string

可选。这些键值对会加入到此广告插播时间点的广告请求中，以便在 Ad Manager 中执行自定义条件定位。示例：'key1=value&key2=value2,value22' 已弃用：请使用“cust_params”键在 breakParams.ad_tag_params 中设置 cust_params。
scte35CueOut

string

可选。scte35 cue out 中采用 Base-64 编码的数据。可以包含 splice_insert() 或 time_signal() 命令。示例：- 包含 time_signal()： “/DA0AAAAAAAA///wBQb+cr0AUAAeAhxDVUVJSAAAjn/PAAGlmbAICAAAAAAsoKGKNAIAmsnRfg==”- 包含 splice_insert()： “/DAvAAAAAAAA///wFAVIAACPf+/+c2nALv4AUsz1AAAAAAAKAAhDVUVJAAABNWLbowo=”
podTemplateName
(deprecated)

string

可选。Google Ad Manager Pod 模板名称。已弃用：请使用“ptpln”键在 breakParams.ad_tag_params 中设置 cust_params。
breakState

enum (BreakState)

仅限输出。广告插播时段的当前状态。
expectedStartTime

string (Timestamp format)

可选。广告插播的预计开始时间。

采用 RFC 3339 标准，生成的输出将始终进行 Z 规范化（即转换为 UTC 零时区格式并在末尾附加 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 小时

该时长以秒为单位，最多包含九个小数位，以“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 的广告插播时间点进行设置。

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 Serving 请求中设置的宏。
adTagParams[]

object (KeyValue)

可选。替换主要广告请求中的广告代码参数。

如果决策在设置了 cust_params 的 Pod Serving 请求之前触发，则这些参数用于决策。

通常，参数会替换插播广告的主要广告请求中的查询字符串参数。对于采用自定义网址格式的某些广告服务器，参数可能会替换广告代码中的特定位置，以符合广告服务器的要求。如果 AdBreak 中的“mridx”值是有效的正整数，则设置该值会使用提供的值覆盖 breakSequence 字段。即使是非 GAM 广告服务器，也是如此。

如果设置了这些参数，它们将优先于在 Pod Serving 请求中设置的参数。

KeyValue

表示键值对。

JSON 表示法 
{
  "key": string,
  "value": string
}
字段
key

string

必需。相应键值对的键。
value

string

必需。相应键值对的值。

MatchParams

用于与检测到的拼接 DAI 广告插播时间点相匹配的参数。

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

string

可选。SCTE-35 二进制。若要匹配此字段，清单中的广告插播时间点必须具有相同的 SCTE-35 二进制字符串（采用 base64 编码）。如果为空，则跳过此步骤。
scte35Upid

string

可选。SCTE-35 UPID（唯一节目标识符）。若要匹配此字段，清单内广告插播时间点必须具有相同的 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)

仅限输出。检测到匹配的广告插播时间点。对于广告连播投放，这是请求广告连播的第一个片段/清单的时间。对于拼接 DAI，这是指在清单中首次检测到广告插播时间点的时间。

采用 RFC 3339 标准，生成的输出将始终进行 Z 规范化（即转换为 UTC 零时区格式并在末尾附加 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)

仅限输出。检测到的时长已传递到匹配的广告插播时间点。

该时长以秒为单位，最多包含九个小数位，以“s”结尾。示例："3.5s"。
scte35CueOut

string

仅限输出。检测到的 base64 编码的 SCTE-35 消息在匹配的广告插播时间点传递。

方法

create

 用于在直播中创建广告插播时间点的 API。

delete

 用于删除直播中的广告插播时间点的 API。

get

 用于获取直播中的广告插播时间点的 API。

list

 用于列出直播中的广告插播时间点的 API。

patch

 用于更新直播中的广告插播时间点的 API。