下表列出了视频广告解决方案可以在 XML Feed 中识别(在某些情况下要求在其中包含)的所有字段。只有这些元素可被识别出来。
跳转到列表中的特定元素
必需元素
推荐元素和可选元素
动态广告插播相关元素
以下是专门用于动态广告插播的元素,需要与上述元素结合使用。
如需查看这些元素在 Feed 中出现时的上下文,请参阅示例 Feed。
内容 ID 现在区分大小写。系统会将同时包含大写和小写字母的
内容 ID 与仅包含小写字母的相同 ID 视为不同的 ID。您的 Ad Manager 报表也体现了这一点。
必需元素
元素 |
父元素 |
是否必需 |
<atom:link> |
<channel> |
必需 |
说明
标识 Feed 的分页信息。Ad Manager 会读取该元素的以下两个属性:rel 和 href 。
rel 用于指明 href 属性中的网址与 Feed 结果集的关系。
rel='next' :用于指明 href 网址指向 Feed 结果集的下一页。如果 Feed 包含指定了 rel='next' 的 <atom:link> 代码,则表示还有另一页结果。否则,当前页为结果集中的最后一页。
href 用于指定在 <atom:link> 代码中标识相应资源的网址。
示例
<atom:link rel='next' href='http://www.feedprovider.com/video/account/vids?page3'/
重要提示:
- Ad Manager 首次创建内容来源时,会要求 Feed 网址集返回 Feed 的第一个结果集。建议按每页 100 项内容显示结果集。
- 如果 Feed 的某一页中没有
<atom:link> 元素,Ad Manager 会将该页视为 Feed 的最后一页。
|
返回页首
返回页首
元素 |
父元素 |
是否必需 |
<dfpvideo:contentId> |
<item> |
必需 |
说明
在 Ad Manager 中存储为 CMS 内容 ID。这是一个非常重要的请求参数,将被用作广告请求的一部分来确定 Ad Manager 可向相应视频投放哪些广告。
内容 ID 值应为字符串,并且区分大小写。此值可用于视频广告请求中的 vid 参数。
示例
<dfpvideo:contentId>sdjfbadfb8w3489y</dfpvideo:contentId>
|
返回页首
元素 |
父元素 |
是否必需 |
<dfpvideo:lastModifiedDate> |
<item> |
必需 |
说明
用于指明视频的任何方面或视频元数据的上次修改时间。
为了让 Ad Manager 提取修改后的内容,应指定 lastModifiedDate ,并且 Feed 中的内容必须按修改时间由新到旧降序排列。
所有时间戳都必须符合 RFC 822 规范或遵循 ISO 8601 格式。如果时区未包含在时间戳字符串中,则默认为太平洋标准时间 (PST)。
示例
<dfpvideo:lastModifiedDate>2021-01-15T08:00:00+01:00</dfpvideo:lastModifiedDate>
<dfpvideo:lastModifiedDate>Fri, 15 Jan 2021 08:00:00 EST
</dfpvideo:lastModifiedDate>
查看每种日期格式的示例
示例
RFC 822
Fri, 15 Jan 2021 08:00:00 EST
Fri, 15 Jan 2021 13:00:00 GMT
Fri, 15 Jan 2021 15:00:00 +0200
ISO 8601
2021-01-15T12:00:00Z
2021-01-15T08:00:00+01:00
|
返回页首
元素 |
父元素 |
是否必需 |
<dfpvideo:version> |
<channel> |
必需 |
说明
用于指明此 Feed 所用 MRSS 规范的当前版本。该元素的值应是整数,并且在每个 Feed 中都应仅设置 1 次。
目前,该字段的唯一有效值是 2。
示例
<dfpvideo:version>2</dfpvideo:version>
|
返回页首
元素 |
父元素 |
是否必需 |
<title> |
<item> |
必需 |
说明
视频条目的名称。
示例
<title>My video</title>
|
返回页首
推荐元素和可选元素
元素 |
父元素 |
是否必需 |
<dfpvideo:cuepoints> |
<item> |
视具体情况而定* |
说明
*如果视频包含广告插播时间点,则是必需元素。
用于标识广告插入点(以秒为单位),各插入点之间用英文逗号分隔。广告插入点是用时间表示的视频中可以插入广告的位置。
秒数最多只能包含 3 位小数(例如 55.532 秒)。超出 3 位的其他数字都将被截断。
视频广告中的广告插入点数量上限为 1,000。当视频广告达到此上限后,我们会截断所有广告插入点。
示例
<dfpvideo:cuepoints>55.532,109</dfpvideo:cuepoints>
|
返回页首
元素 |
父元素 |
是否必需 |
<dfpvideo:keyvalues> |
<item> |
可选 |
说明
标识视频的所有自定义元数据。它具有以下属性:key、value 和 type (仅限 string 数据类型)。
通过 MRSS Feed 提取的键值对必须与在 Ad Manager 界面中指定的键值对遵循相同的格式要求。请确保您的键值对符合相关 格式要求。
示例
<dfpvideo:keyvalues key="episode" value="5" type="string"/>
<dfpvideo:keyvalues key="season" value="2" type="string"/>
<dfpvideo:keyvalues key="title" value="Example Title" type="string"/>
<dfpvideo:keyvalues key="recommended count" value="5" type="string"/>
<dfpvideo:keyvalues key="description" value="A lot of text here" type="string"/>
|
返回页首
元素 |
父元素 |
是否必需 |
<dfpvideo:thirdPartyContentId> |
<item> |
可选 |
说明
您需要先启用此功能,然后才能使用它。要使用此功能,请与您的客户经理联系。
如果您的自定义 MRSS Feed 包含 YouTube 视频,则需使用该元素。您的广告资源网中,不同 MRSS 内容所指定的 YouTube 视频不能重复。
该元素只有 1 个必需属性:
“id” 属性:此属性必须引用 YouTube 内容来源中的 contentId 。
示例
<dfpvideo:thirdPartyContentId cms="youtube" id='vNclnVLp_c0'/>
|
返回页首
元素 |
父元素 |
是否必需 |
<media:content> |
<item> |
推荐 |
说明
该元素具有一些用于提供实用元数据信息的属性,例如来源网址和时长。该元素是 <item> 的可选子元素。
Ad Manager 可以读取 <media:content> 元素的以下属性:
示例
<media:content url='http://www.feedprovider.com/video?8eqe7e' duration='39'/>
|
返回页首
元素 |
父元素 |
是否必需 |
<media:status> |
<media:content> 或 <item> |
可选 |
说明
用于确定视频在 Ad Manager 中是被标记为“有效”“无效”还是“已归档”。如果没有该元素,则默认状态为“有效”。该元素的值不区分大小写,可包含以下状态:
- 有效(在 Ad Manager 中标记为“有效”)
- 已删除(在 Ad Manager 中标记为“已归档”;Ad Manager 不会提取新的“已删除”视频)
- 已屏蔽(在 Ad Manager 中标记为“无效”)
如果用户在 Ad Manager 内更改了视频的状态,那么 Ad Manager 会忽略 Feed 中的所有后续状态更改。用户可通过点击 Ad Manager 界面中的使用源设置来取消这种覆盖操作;这样做之后,Ad Manager 将恢复使用 Feed 中的状态更新。
发布商和 CMS 合作伙伴可以执行以下任一操作,以防止 Ad Manager 重新调整已上传但处于无效/已弃用状态的内容:
- (建议)支持在 MRSS Feed 中使用
<media:status state="deleted"/> 。
- 保留 Feed 中的内容,但从内容中移除所有与动态广告插播相关的元素,以使内容不符合 VOD 提取的条件。如需了解要移除的具体元素,请前往“动态广告插播元素”部分。
通过动态广告插播技术投放广告时的投放状态
如果通过动态广告插播技术进行广告投放,那么在确定投放状态时,将会同时考虑内容来源的状态和内容本身的状态。下面是在同时考虑来源状态值和内容状态值的情况下,应该会出现的行为:
内容来源状态 |
内容状态 |
投放状态 |
有效 |
有效 |
将会在相应内容中投放广告 |
有效 |
无效 |
将会在相应内容中投放广告 |
有效 |
已归档 |
不会在相应内容中投放广告(404 错误) |
无效 |
有效 |
不会在相应内容中投放广告(404 错误) |
无效 |
无效 |
不会在相应内容中投放广告(404 错误) |
无效 |
已归档 |
不会在相应内容中投放广告(404 错误) |
已归档 |
有效 |
不会在相应内容中投放广告(404 错误) |
已归档 |
无效 |
不会在相应内容中投放广告(404 错误) |
已归档 |
已归档 |
不会在相应内容中投放广告(404 错误) |
- 有效:符合投放广告的条件。
- 无效:不符合投放广告的条件。
- 已归档:不符合投放内容定位广告的条件,但或许仍可投放网络随机广告 (RON)。
如果内容来源状态被标记为“无效”或“已归档”,或者某个内容状态被标记为“已归档”,系统将不会通过动态广告插播技术来投放广告。
示例
<media:status state="blocked" reason="http://www.reasonforblocking.com"/>
<media:status state="deleted"/>
<media:status state="active"/>
(Ad Manager 不会提取 reason 属性。)
|
返回页首
元素 |
父元素 |
是否必需 |
<media:thumbnail> |
<media:content> 或 <item> |
推荐 |
说明
允许视频缩略图显示在 Ad Manager 界面中。虽然 Ad Manager 目前只需读取该元素的网址属性,但您可根据需要提供更多属性:高度、宽度和时间(缩略图所代表的图片在视频中的显示时长)。
Ad Manager 界面绝不会显示大于 280x190 像素(宽度 x 高度)的缩略图。如果网址链接到更大的图片,那么 Ad Manager 会链接到原始版本,但仍会使用内嵌 CSS 缩放图片,以使图片能够在界面中显示。
示例
<media:thumbnail url='http://www.myfeed.com/account/sdjfbadfb8w3489y/bigtn.jpg' width='280' height='190'/>
|
返回页首
元素 |
父元素 |
是否必需 |
<pubDate> |
<item> |
可选 |
说明
标识内容的发布日期。该元素仅用于视频广告规则。
所有时间戳都必须符合 RFC 822 规范或遵循 ISO 8601 格式。如果时区未包含在时间戳字符串中,则默认为太平洋标准时间 (PST)。
示例
<pubDate>2006-02-19T04:22:39+05:00</pubDate>
<pubDate>Sun, 19 Feb 2006 09:22:39 +0000</pubDate>
查看每种日期格式的示例
示例
RFC 822
Wed, 31 Oct 2016 08:00:00 EST
Wed, 31 Oct 2016 13:00:00 GMT
Wed, 31 Oct 2016 15:00:00 +0200
ISO 8601
20161031
2016-10-31
2016-10-31T08:00:00+01:00
|
返回页首
元素 |
父元素 |
是否必需 |
<dfpvideo:ingestUrl> |
<item> |
必需* |
说明
*对于动态广告插播,是必需元素。
一个节点,用于指定指向主 m3u8 文件(用于调节内容和生成播放列表)的视频提取网址。
示例
对于 HLS
<dfpvideo:ingestUrl type="application/x-mpegURL" preconditioned="false">https://cdn.example.com/?v=123.m3u8</dfpvideo:ingestUrl>
对于 DASH
<dfpvideo:ingestUrl type="application/dash+xml" preconditioned="true">
https://cdn.example.com//playlist.mpd
</dfpvideo:ingestUrl>
单个视频内容可以同时具有 HLS 和 DASH。建议使用安全 (https) 提取网址。
|
返回页首
元素 |
父元素 |
是否必需 |
<dfpvideo:lastMediaModifiedDate> |
<item> |
推荐 |
说明
用于指明 <dfpvideo:ingestUrl> 中引用的视频文件的上次修改时间。一旦在 Feed 中更新了该值,则相应内容的 lastModifiedDate 也需要更新。
所有时间戳都必须符合 RFC 822 规范或遵循 ISO 8601 格式。如果时区未包含在时间戳字符串中,则默认为太平洋标准时间 (PST)。
示例
<dfpvideo:lastMediaModifiedDate>2006-02-19T04:22:39+05:00</dfpvideo:lastMediaModifiedDate>
<dfpvideo:lastMediaModifiedDate>Sun, 19 Feb 2006 09:22:39
+0000</dfpvideo:lastMediaModifiedDate>
查看每种日期格式的示例
示例
RFC 822
Wed, 31 Oct 2016 08:00:00 EST
Wed, 31 Oct 2016 13:00:00 GMT
Wed, 31 Oct 2016 15:00:00 +0200
ISO 8601
20161031
2016-10-31
2016-10-31T08:00:00+01:00
|
返回页首
元素 |
父元素 |
是否必需 |
<dfpvideo:closedCaptionUrl> |
<item> |
视具体情况而定* |
说明
*仅当您已在界面中启用字幕时才是必需的。
用于为字幕/翻译字幕文件指定网址的节点。所有可用的字幕文件都应在 Feed 的各个 closedCaptionUrl 元素中指明,每种语言对应 1 个字幕文件。
针对视频点播的 HLS 清单字幕
如果存在此 Feed 元素,系统将仅提取 Feed 中的字幕,并忽略 HLS 清单中指定的字幕。只有在字幕 Feed 元素不存在的情况下,才会提取 HLS 清单字幕。
支持的格式为 TTML/DXFP (application/ttaf+xml ) 和 WebVTT (text/vtt )。
“language” 属性:必填(不得留空),且应设为字幕文件的语言。此属性必须符合 RFC5646,且不能包含字符串“$$$$$” 。它的用法与 XML 中详细说明的 xml:lang 属性的用法类似。
“name” 属性:不能包含字符串“$$$$$” 。
“type” 属性:应设为字幕文件的 MIME 类型。
“characteristics” 属性:应设为下列值之一(也可留空):**
“public.accessibility.transcribes-spoken-dialog”
“public.accessibility.describes-music-and-sound”
“public.easy-to-read”
**如果 "characteristics" 未设为上述任何值,系统会显示警告,但此属性仍能正常发挥作用。
对于同一个内容来源,每个字幕文件的 language 与 name 组合都应是独一无二的。例如 [language="en", name="English" ] 和 [language="en", name="English (CC)" ]。
示例
<dfpvideo:closedCaptionUrl language="en" name="English" type="text/vtt">http://cdn.com/subtitle.vtt</dfpvideo:closedCaptionUrl>
<dfpvideo:closedCaptionUrl language="en" name="English (CC)" characteristics="public.accessibility.describes-music-and-sound" type="text/vtt">http://cdn.com/subtitle.vtt</dfpvideo:closedCaptionUrl
|
返回页首
元素 |
父元素 |
是否必需 |
<dfpvideo:fw_caid> |
<item> |
视具体情况而定* |
说明
*仅对 Freewheel 用户是必需的。
用于指定广告定位所用的 Freewheel 自定义素材资源 ID 的节点。
示例
<dfpvideo:fw_caid>621160003648<dfpvideo:fw-caid>
|
返回页首