VAST 广告代码网址会被播放器用来检索视频广告和音频广告。您可以使用下述参数手动组建 VAST 广告代码网址或修改现有的网址,然后使用 VAST 套件检查器测试该网址。您也可参考这些代码示例来检查和测试网址。
一般网址要求
- 协议:VAST 广告代码既支持 http 也支持 https。展示跟踪网址会遵循当前 SSL 设置,并相应地作为 http 或 https 网址返回。由于点击后到达网址和点击跟踪网址是从另一网页经重定向到达的,因此它们使用 http。
- 网域:不允许使用通过模式匹配宏或任何其他动态方法创建的动态网域;如果使用,则会导致错误。
- 直播流量:为了确保能够处理所有插播广告同时投放时产生的繁重流量,直播视频广告代码网址的路径中必须包含
/live
。
VAST 广告代码示例
下面列举了一个包含参数和指定值的 VAST 广告代码网址:
https://securepubads.g.doubleclick.net/gampad/ads?env=vp&gdfp_req=1&output=vast&iu=/1234/video-demo&sz=400x300&unviewed_position_start=1&ciu_szs=728x90,300x250
跳转到列表中的特定参数
参数 | 详细说明 | |
---|---|---|
aconp
(音频连续播放) |
建议使用,请参阅 MRC 音频衡量指南 “音频连续播放”参数接受常量值,用于指明播放器是否会继续播放音频内容。 如果该参数未知,则应使其保持未设置状态。 用法示例开启连续播放: 关闭连续播放: |
|
ad_rule
(广告规则) |
“广告规则”参数接受常量值,用于指明是返回 VAST 广告素材还是返回广告规则响应。 广告规则的默认设置取决于 Ad Manager 广告联盟设置。您可按照下方示例覆盖特定广告代码的设置。 用法示例针对 VAST 广告素材的请求: 针对广告规则 (VMAP) 的请求: 是否必需对于视频广告规则是必需参数 |
|
ad_type
(广告类型) |
广告类型参数接受常量值,用于指明应为请求返回的广告类型。 只有音频广告需要使用此参数。 用法示例:仅允许投放音频广告: 既允许投放可跳过的视频广告,也允许投放不可跳过的视频广告: 既允许投放音频广告,也允许投放视频广告: audio_video 广告类型仅适用于将视频广告素材投放到支持视频广告播放的音频内容;或者将音频广告素材投放到播放在自然环境中“可听”内容的插播视频广告播放器。例如,体育在线播放、视频播报、新闻等。详细了解视频内容中的音频。
仅允许投放可跳过的视频广告: 仅允许投放不可跳过的视频广告: 是否必需对于音频广告为必需参数 |
|
addtl_consent
(更多意见征求方式) |
“更多意见征求方式”参数接受变量值,适用于以下发布商:想集成 IAB TCF v2.0,且使用尚未注册加入 IAB Europe 全球供应商列表 (GVL) 但已包含在 Google 广告技术提供商 (ATP) 列表中的供应商。直接 VAST 请求不会自动读取这些值,但系统会在这些值添加到广告代码后接受它们。 您可在“更多意见征求方式”技术规范中详细了解向此参数传递的值。 用法示例
|
|
afvsz
(非线性广告尺寸) |
“非线性广告尺寸”参数接受常量值,这些值应为可在视频广告位中展示的非线性广告尺寸的列表(以英文逗号分隔)。 这些尺寸只能是下列任一受支持的尺寸:
当使用 IMA SDK 时,此字段中的值将改为介于 nonLinearAdSlotWidth 和 nonLinearAdSlotHeight 之间所有受支持的尺寸。 如果不支持任何非线性尺寸,则可以省略该参数或将其留空。 用法示例支持所有尺寸: 最大宽度为 250: 最大高度为 60: 最大宽度为 100:
是否必需对于未使用 IMA SDK 的非线性视频广告,是必需参数 |
|
allcues
(所有广告插入点) |
此参数接受变量值,这些值是以英文逗号分隔的广告插入点(以毫秒为单位)的列表。对于每个值,Ad Manager 都会返回一个广告插播时间点。
如果您的广告规则中使用了基于时间的广告插入点(例如,“每 N 秒插播一次”或“在固定的时间”),系统会使用广告规则中设定的广告插入点,并忽略传递到 用法示例将 10 秒处和 20 秒处设为广告插入点: |
|
ciu_szs
(随播广告尺寸) |
“随播广告尺寸”参数接受变量值,这些值是随播广告尺寸的列表(以英文逗号分隔)。 以竖线 ( 用法示例
多尺寸广告位的尺寸: |
|
cmsid
(内容来源 ID) vid
(视频 ID) |
“内容来源 ID”和“视频 ID”参数接受变量值。 要将广告定位到视频内容,主视频广告代码必须同时包含这两个参数。
用法示例
如果您要为包含视频点播内容的动态广告插播构建代码,则应使用可动态插入正确内容来源和视频 ID 的宏。 例如: 是否必需对于视频内容定位为必需参数 |
|
correlator
(Correlator) |
||
cust_params
(自定义键值对参数) |
||
description_url
(说明网址) |
“说明网址”参数接受变量值,此值应该用于描述在网页上播放的视频。用 1-3 段描述性内容概述网页。例如,从预定义的块中动态拼接 对于网页视频播放器和 CTV/OTT 设备, 此参数不是由 IMA SDK 自动设置的,需要手动设置。 用法示例经过网址编码: 未经网址编码: 是否必需对于网站、应用和 Ad Exchange,是必需参数 对于程序化变现而言,是推荐项 |
|
dth
(设备类型提示) |
设备类型提示参数接受常量值,有助于减少设备分类错误,尤其是在联网电视和机顶盒环境中。 设备误分类可能是由于发布商或联网电视 OEM 的意外错误造成的。此参数将与其他信号结合使用,以便 Google 自动标记可能需要对联网电视广告资源进行重新分类的情况。 用法示例请求来源:
是否必需对于联网电视上的程序化变现,此参数为推荐参数。 对于 PAL 和 PAI(非 SDK)实现方案,此参数为推荐参数。IMA SDK 和 DAI SDK 不需要此参数。 |
|
env
(环境) |
||
excl_cat
(排除类别) |
“排除类别”参数接受变量值,用于屏蔽包含相关排除标签的所有订单项,使其不符合给定广告请求的条件。此参数可与 用法示例
|
|
gdfp_req
(Ad Manager 架构指示器) |
||
gdpr
(GDPR) |
GDPR 参数接受常量值,适用于想集成 IAB TCF v2.0 的发布商。直接 VAST 请求不会自动读取这些值,但系统会在这些值添加到广告代码后接受它们。 此参数的有效值只有 0 和 1,其中 0 表示 GDPR 不适用,1 表示 GDPR 适用。如果 GDPR 适用,您还必须使用 gdpr_consent 参数提供有效的 TC 字符串。 您可在关于如何实现该框架的通用指南中或在 IAB TCF v2.0 规范的 TC 字符串部分中详细了解向此参数传递的值。 用法示例GDPR 适用: GDPR 不适用: |
|
gdpr_consent
(依照 GDPR 征求用户意见) |
“依照 GDPR 征求用户意见”参数接受变量值,适用于想集成 IAB TCF v2.0 的发布商。直接 VAST 请求不会自动读取这些值,但系统会在这些值添加到广告代码后接受它们。 您可在关于如何实现该框架的通用指南中或在 IAB TCF v2.0 规范的 TC 字符串部分中详细了解向此参数传递的值。 用法示例
|
|
givn paln
(视频 Nonce) |
For integrations that use the Programmatic Access Library (PAL), the video nonce parameter accepts a variable string value. The nonce is URL safe—you don't need to URL-encode it.
Note: If you previously provided a nonce using the legacy Usage exampleYou can read more about the value passed to this parameter in the getting started guides for PAL. |
|
hl
(语言) |
“语言”参数接受常量值,用于请求使用该语言的广告,在对 Ad Exchange 或 AdSense 视频进行动态分配的过程中,此参数用于指定在进行广告选择和视频广告呈现时所使用的语言。 参数值可以是任意的 ISO 639-1(两个字母)或 ISO 639-2(三个字母)代码。请参阅有效代码列表。 如果省略,参数值默认为在 Ad Exchange 中根据语言定位广告时指定的任一语言。 用法示例
是否必需对于程序化变现为推荐参数 |
|
iabexcl
(IAB 排除网址) |
||
ipd
(广告资源合作伙伴网域) |
||
ipe
(展示 ping 实体) |
||
iu
(广告单元) |
||
lip
(广告连播中的最后一个位置) |
||
ltd
(受限广告) |
“受限广告”参数接受常量值,用于指明在未就使用 Cookie 或其他本地标识符征得用户同意的情况下,是否要通过一种受限的方式投放广告。
用法示例
|
|
min_ad_duration
(广告时长下限) max_ad_duration
(广告时长上限) |
“广告时长”参数接受变量值,结合使用此类参数可指定广告的时长范围(以毫秒为单位)。 使用此参数可以限制单个广告和优化型广告连播请求的单个广告时长。 用法示例
|
|
mridx
(中贴片广告位编号) |
||
msid
(应用 ID) an
(应用名称) |
“应用 ID”参数和“应用名称”参数接受变量值,它们应该应用于从移动应用和联网电视设备发送的请求,因为大多数程序化视频广告都需要使用它们。 IMA SDK 会自动填充这两个参数,但必须在非 SDK 环境(包括直接 VAST 调用)中或者使用 Programmatic Access Library (PAL) 或发布商身份经过验证的广告资源 (PAI) 时手动指定这些参数。 虽然应用名称应该会是人类可读的名称,但在 iOS 和 tvOS 上,SDK 却无法获取应用 ID。在这些情况下,系统不会发送 用法示例
应用 ID 在不同应用商店中采用不同的命名方式和格式。查看应用识别的 IAB 指南或常见唯一标识符示例。 对于没有应用商店的平台,IAB 建议发布商使用以下格式的商店 ID: 是否必需应用需要这两个参数 对于程序化变现为推荐参数 |
|
nofb
(后备广告已停用) |
||
npa
(非个性化广告) |
||
omid_p
(OMID 合作伙伴名称) |
OMID 合作伙伴名称参数接受变量值,此值用于指明集成 OMID 衡量功能的合作伙伴的名称以及合作伙伴版本。 此参数仅适用于使用 Open Measurement SDK (OM SDK) 时需要 Active View 衡量功能的发布商。使用 IMA SDK 时,切勿使用此参数,因为它是自动设置的。 如要在使用 Programmatic Access Library (PAL) 时指明 OMID 支持,您需要使用 用法示例使用 PAL 时: 不使用 PAL 时: |
|
output
(广告输出格式) |
“广告输出格式”参数接受常量值,此值应设为广告的输出格式。 请根据您为广告联盟设置的默认 VAST 版本来使用 对于 VAST,如果您的视频播放器使用 IMA SDK,那么视频广告请求的输出参数将始终设为 若要返回您为广告联盟启用的默认 VMAP 版本(如 VMAP 1),请使用 用法示例您广告联盟的默认 VAST 设置: VAST 4: 您广告联盟的默认 VMAP 设置: VMAP 1: VMAP 1,返回 VAST 4: 是否必需 |
|
plcmt
(展示位置) |
||
pmad
(广告连播中的广告数量上限) |
“广告连播中的广告数量上限”参数接受变量值,用于指明广告连播中的广告数量上限。 此参数专用于面向拥有高级视频产品包的发布商提供的优化型广告连播,不应该用于 VMAP(当 用法示例
|
|
pmnd
(广告连播时长下限) pmxd
(广告连播时长上限) |
“广告连播时长”参数接受变量值,结合使用此类参数可指定广告连播的时长范围(以毫秒为单位)。 此类参数用于请求多个广告。它们专用于优化广告连播,适用于使用高级视频产品包的发布商,不应该用于 VMAP(当 用法示例
|
|
广告联播
(广告连播编号) |
||
pp
(广告素材配置文件) |
||
ppt
(发布商隐私保护处理措施) |
||
ppid
(发布商提供的标识符 [PPID]) |
||
ppos
(在广告连播中的位置) |
||
ppsj
(发布商提供的信号 JSON) |
发布商提供的信号 JSON 参数接受采用 base64 编码的 JSON 对象(其中包含发布商提供的受众群体和情境数据),以提高程序化变现能力。 如需详细了解有效的 JSON 键值对,请参阅 用法示例JSON 对象: Base64 编码值: |
|
ptpl
(广告插播模板 ID) ptpln
(广告插播模板名称) |
广告插播模板 ID 和名称接受变量值,并指明应将哪个广告插播模板应用于优化型广告连播请求。借助广告插播模板,您可配置广告插播时间点处应包含哪些广告插播位或自定义广告插播位,以及这些插播位应按什么顺序投放。 用法示例如需详细了解如何设置和请求广告插播模板,请点击此处。 |
|
pubf
(Ad Exchange 代码中的公开底价) pvtf
(Ad Exchange 代码中的不公开底价) |
用法示例
|
|
pvid
(应用组 ID) pvid_s
(应用组范围) |
||
rdid
(可重置的设备标识符) |
可重置设备标识符接受变量值。 对于内置应用(而非网站或移动网站),SDK 会通过以下各项的参数将用于用户定位的可重置设备标识符传递到视频流请求: 几乎所有程序化视频广告都需要这些值。
用法示例查看可重置设备标识符的详细示例。 是否必需对于应用为必需参数 对于程序化获利为推荐参数 |
|
rdp
(限制数据处理) |
||
schain
(供应链) |
“供应链”参数接受一个变量值,此值应为序列化的 SupplyChain 对象。包含此参数时,Google 会在将任何收到的 如需了解如何通过代码(而非 OpenRTB)传达 SupplyChain 信息,请参阅完整的 IAB 文档。 查看正确解析schain 需遵循的要求
下面根据 IAB 文档定义了
序列化顺序
注意:
ext 的内容因广告交易平台而异。Google Ad Manager 不会解析此属性。有关如何序列化 SupplyChain 对象的示例以下是序列化上述 对空的可选字段进行序列化时使用英文逗号
对空的可选字段进行序列化时不使用英文逗号
详细了解 SupplyChain 对象。
用法示例
如果
是否必需对于在向 Google Ad Manager 发出请求之前利用支付中间方的发布商,此属性为必需属性。这包括使用第三方广告服务器技术的发布商。 |
|
scor
(视频流 Correlator) |
||
sdk_apis
(SDK API 框架) |
SDK API 框架参数接受由以英文逗号分隔的常量整数值构成的列表,这些整数值表示播放器支持的所有 API 框架。 不妨查看一下可能的 API 框架值的列表。 此参数支持 Programmatic Access Library (PAL) 中的 API,适合不使用 IMA SDK 的发布商使用。IMA SDK 会使用其支持的值替换已设置的所有值。 用法示例
|
|
sdmax
(Skippable max ad duration) |
它是一个时长(以毫秒为单位),表示针对该特定广告请求,允许可跳过式视频/音频广告素材的时长上限。 您可以为可跳过式广告单独使用 用法示例使用以下设置:
对于以下广告素材:
结果:
|
|
sid
(会话 ID) |
“会话 ID”参数接受变量值,它是一种保护用户隐私的广告标识符,仅用于实现频次上限。 来自联网电视的插播视频请求和来自移动应用设备的插播视频广告资源均支持会话 ID。Web 应用目前不支持此 ID。 根据 IAB 的 IFA 指南,此参数必须以 UUID 格式填充。详细了解用于用户定位的可重置设备标识符。 您可以通过设置 用法示例
是否必需对于程序化变现为推荐参数 |
|
ssss
(服务器端拼接来源) |
||
sz
(尺寸) |
||
tfcd
(“面向儿童的内容”标记) |
||
trt
(流量类型) |
流量类型参数接受常量值,用于请求所购流量或自然流量。 如果请求中缺少流量类型参数,IMA SDK 不会填充默认值。在这类情况下,服务器会提供默认值 用法示例针对所购流量的请求: 针对自然流量的请求: |
|
unviewed_position_start
(延迟记录展示次数) |
||
url
(网址) |
“网址”参数接受一个变量值,此值应设为发送请求的完整网址。买方需要使用此值来协助确定和了解该请求是在何种情境下发送的。您应尽可能在广告请求中动态地填充此值。 在网页中,这是显示视频播放器的网页的网址。如果您使用 IMA SDK,它会自动设置网址值。如果您的播放器设置了此值,IMA SDK 将会遵循所设置的值。 在应用(移动应用或联网电视应用)内,此值应设为一个最能准确体现正被用来变现的视频/音频广告资源的网址。例如,如果用户正在一款移动应用内观看某个视频,而等效的桌面版网址上也提供了该视频。* 此参数的值应进行编码。 用法示例
*对于应用,如果无法将该参数设为一个变量网址值,最好使用以下格式来设置它: 是否必需对于程序化变现为推荐参数 |
|
vad_type
(视频广告类型) |
||
vid_d
(视频时长) |
此参数接受变量值,以用于指定内容的时长(以秒为单位)。
用法示例视频内容时长为 90000 秒(25 小时): |
|
vconp
(视频连续播放) |
建议使用,请参阅 MRC 视频衡量指南 “视频连续播放”参数接受常量值,用于指明播放器是否会继续播放视频内容(类似于电视广播)。 如果该参数未知,则应使其保持未设置状态。 用法示例开启连续播放: 关闭连续播放: |
|
vpa
(视频自动播放) |
||
vpi
(视频播放列表 inred) |
||
vpmute
(视频播放静音) |
||
vpos
(视频内位置) |
||
wta
(为什么显示该广告) |
“为什么显示该广告?”参数接受常量值,用于指明视频播放器是否支持呈现广告标示。如果未发送 当使用 IMA SDK 时,系统会自动支持广告标示功能。当未使用 IMA SDK 时,视频播放器必须实现 VAST 如果发布商不会呈现 VAST 响应中提供的“广告选项”图标,则必须发送 如果 VAST 响应中提供的“广告选项”图标将在随播广告上呈现或以其他方式提供给用户,音频广告请求可能会发送 对于来自欧洲经济区 (EEA) 的流量,如果请求中设置了 广告必须符合在欧洲经济区投放广告需遵循的适用法规要求。这包括为用户提供举报非法内容的机制。发布商必须使用相应表单,将收到的任何非法内容举报信息告知 Google。 用法示例支持:
不支持: 是否必需对 Ad Exchange 而言,是必需项 对于程序化变现而言,是推荐项 |