本文列出了用于在音频广告植入中投放广告的 VAST 广告代码所需和建议的参数。
本页内容
适用于音频的必需参数和建议参数
广告投放所需的参数
ad_type(广告类型)
说明
“广告类型”参数 (ad_type) 接受常量值,用于指明应针对该请求返回哪类广告。
当 ad_type 设置为 audio 或 audio_video 时,必须将 vpmute 参数设置为 0。
用法示例
仅允许投放音频广告:
ad_type=audio
既允许投放可跳过的视频广告,也允许投放不可跳过的视频广告:
ad_type=video
既允许投放音频广告,也允许投放视频广告:
ad_type=audio_video
此
audio_video值允许这两种格式进行竞争,但只能投放一种。此广告类型仅适用于将视频广告素材投放到支持视频广告播放的音频内容;或者将音频广告素材投放到播放在自然环境中“可听”内容的插播视频广告播放器,例如体育在线播放、视频播报、新闻等。不妨了解视频内容中的音频。
仅允许投放可跳过的视频广告:
ad_type=skippablevideo
仅允许投放不可跳过的视频广告:
ad_type=standardvideo
要求和建议
- 如果您的应用包含视频内容,请将此参数设置为
video、audio_video,或不设置此参数。 - 如果您的应用仅包含音频内容(例如电台或语音应用),则必须将此参数设置为
audio。如果未设置此参数,系统将不会返回任何音频广告。
correlator(correlator)
说明
“Correlator”参数 (correlator) 接受变量值,源于同一次网页浏览的多项请求会共用此值。在进行竞争排除(包括在没有 Cookie 的环境中)时会用到此参数。
用法示例
correlator=4345645667
env(环境)
说明
“环境”参数 (env) 接受常量值,用于指明这是一项插播广告请求或者该请求是明确来自视频播放器。
可能的值包括 instream(可用于视频和音频广告)或 vp(仅可用于视频广告)。
用法示例
视频和/或音频:
env=instream
仅限视频:
env=vp
gdfp_req(架构指示器)
iu(广告单元)
output(输出)
说明
“输出格式”参数 (output) 接受常量值,此值应设为广告的输出格式。
用法示例
output=vast
使用 VAST 4(您可为特定代码设置特定版本):
output=xml_vast4
使用您广告资源网的默认 VMAP 设置:
output=vmap
使用 VMAP 1:
output=xml_vmap1
使用 VMAP 1,返回 VAST 4(如果您要在 VMAP 内部返回 VAST):
output=xml_vmap1_vast4
要求和建议
若要在网站、移动应用、联网电视、音频和数字户外广告中实现广告投放,则必须使用此参数。 必须输出正确的广告投放响应格式。
SDK 使用情况
对于 VAST,如果您的视频播放器使用 IMA SDK,那么视频广告请求的输出参数将始终设为 output=xml_vast4。这不会导致可靠性方面的风险,因为此 SDK 可向后兼容任何第三方广告服务器可能投放的所有 VAST 版本。
Authorized Buyers 和公开出价的 VAST 版本
如果您想针对 Authorized Buyers 和公开出价严格按 VAST 版本进行过滤,可以在您的广告资源网设置中启用“严格滤除 VAST 版本”设置。
url(网址)
说明
“网址”参数 (url) 接受一个变量值,此值应设为发送请求的完整网址。买方需要使用此值来协助确定和了解该请求是在何种情境下发送的。您应尽可能在广告请求中动态地填充此值。
- 在网站上,这是显示视频播放器的网页的网址。
- 在非网站环境中,此值应设为一个最能准确体现正被用来变现的视频/音频广告资源的网址。例如,如果用户正在一款移动应用内观看某个视频,而等效的桌面版网址上也提供了该视频。*
注意:url 与 description_url 不同,url 是指发出广告请求的位置,而 description_url 是可抓取的网页,用于描述视频内容。
此参数的值应进行编码。
用法示例
url=https%3A%2F%2Fwww.example.com%2Fvideo.html
*对于应用,如果无法将该参数设为一个变量网址值,建议使用以下格式:url=https%3A%2F%2F<app/bundleid>.example.com
程序化交易所需的参数
idtype(设备类型)
说明
可重置的设备标识符参数(rdid、idtype、is_lat)接受变量值。此值也称为广告标识符 (IFA)。
对于使用适用于 Android 或 iOS 的 IMA SDK 的移动应用,IMA SDK 会通过以下各项的参数将用于用户定位的可重置设备标识符传递到视频流请求:rdid、idtype 和 is_lat。
如果未使用 IMA SDK 或使用服务器端信标 (SSB),您必须将这些参数作为显式参数传递。详细了解设备标识符。
几乎所有程序化视频广告都需要这些值。
|
从 iOS 14.5 开始,Apple 已弃用 |
用法示例
查看可重置的设备标识符 (RDID) 的详细示例。
is_lat(限制广告跟踪)
说明
可重置的设备标识符参数(rdid、idtype、is_lat)接受变量值。此值也称为广告标识符 (IFA)。
对于使用适用于 Android 或 iOS 的 IMA SDK 的移动应用,IMA SDK 会通过以下各项的参数将用于用户定位的可重置设备标识符传递到视频流请求:rdid、idtype 和 is_lat。
如果未使用 IMA SDK 或使用服务器端信标 (SSB),您必须将这些参数作为显式参数传递。详细了解设备标识符。
几乎所有程序化视频广告都需要这些值。
|
从 iOS 14.5 开始,Apple 已弃用 |
用法示例
查看可重置的设备标识符 (RDID) 的详细示例。
plcmt(展示位置)
说明
展示位置参数 (plcmt) 接受常量值,用于指明插播广告资源是声明为插播广告资源还是随播广告资源,详情请参阅 IAB 规范。
对于非插播请求,此字段会由系统根据声明的广告资源格式自动为买家填充,并将替换任何插播或随播声明。
用法示例
插播广告请求:
plcmt=1
随播内容请求:
plcmt=2
rdid(可重置的设备标识符)
说明
可重置的设备标识符参数(rdid、idtype、is_lat)接受变量值。此值也称为广告标识符 (IFA)。
对于使用适用于 Android 或 iOS 的 IMA SDK 的移动应用,IMA SDK 会通过以下各项的参数将用于用户定位的可重置设备标识符传递到视频流请求:rdid、idtype 和 is_lat。
如果未使用 IMA SDK 或使用服务器端信标 (SSB),您必须将这些参数作为显式参数传递。详细了解设备标识符。
几乎所有程序化视频广告都需要这些值。
|
从 iOS 14.5 开始,Apple 已弃用 |
用法示例
查看可重置的设备标识符 (RDID) 的详细示例。
vpa(视频自动播放)
说明
“视频自动播放”(vpa) 参数接受常量值,用于指明广告中的视频内容是会自动开始播放还是在用户点击后开始播放。
可能的值包括:click(如果网页等待用户操作)或 auto(如果视频自动播放)。此参数不会更改视频播放器的状态,播放行为必须由视频播放器直接处理。
用法示例
自动播放:
vpa=auto
点击播放:
vpa=click
如果该参数未知,则应使其保持未设置状态。
vpmute(视频播放静音)
说明
“视频播放静音”参数 (vpmute) 接受常量值,用于指明在开始播放广告时是否将视频播放器设为静音状态。此参数不会更改视频播放器的状态,播放行为必须由视频播放器直接处理。
用法示例
播放开始时设为静音:
vpmute=1
播放开始时不设为静音:
vpmute=0
适用于程序化交易的推荐参数
aconp(音频连续播放)
说明
“音频连续播放”参数 (aconp) 接受常量值,用于指明播放器是否会继续播放音频内容。这有助于 Google Ad Manager 选择最适合用户体验的广告。
用法示例
开启连续播放:
aconp=2
关闭连续播放:
aconp=1
如果您不知道音频是否会连续播放,则应使此参数保持未设置状态或将其设置为 aconp=0。
(应用名称)
说明
“应用 ID”参数 (msid) 和“应用名称”参数 (an) 接受变量值,它们应该应用于从移动应用和联网电视设备发送的请求,因为大多数程序化视频广告都需要使用它们。
应用名称应采用人类可读的名称。
用法示例
msid=com.package.publisher&an=sample%20app
应用 ID 在不同应用商店中采用不同的命名方式和格式。查看应用识别的 IAB 指南或常见唯一标识符示例。
对于没有应用商店的平台,IAB 建议发布商使用以下格式的商店 ID:com.publisher.deviceplatform
要求和建议
虽然此参数不是向任何特定实现投放广告的必需参数,但建议在移动应用、联网电视、音频和数字户外广告中进行程序化变现时使用此参数。
为了保障广告不会投放到不利于品牌形象的内容中并让买方更清楚地了解广告投放情况,强烈建议您添加应用信息。
SDK 使用情况
除了 iOS 和 tvOS 之外,IMA SDK 会自动填充这两个参数,但必须在非 SDK 环境(包括直接 VAST 调用)中,或者在使用 Programmatic Access Library (PAL) 或发布商身份经过验证的广告资源 (PAI) 时手动指定这些参数。
在 iOS 和 tvOS 上,IMA SDK 或 PAL 无法获取应用 ID。在这些情况下,系统不会发送 msid 参数,而 SDK 会通过 an 参数发送 app bundle。
注意:如果使用的是 HTML5 IMA SDK,则不会使用应用信息。
dth(设备类型提示)
说明
设备类型提示参数 (dth) 接受常量值,有助于减少设备分类错误,尤其是在联网电视和机顶盒环境中。
设备误分类可能是由于发布商或联网电视 OEM 的意外错误造成的。 此参数将与其他信号结合使用,以便 Google 自动标记可能需要对联网电视广告资源进行重新分类的情况。
用法示例
请求来自:
- 非智能手机:
dth=1 - 智能手机:
dth=2 - 桌面设备:
dth=3 - 平板电脑:
dth=4 - 联网电视:
dth=5 - 游戏机:
dth=6 - 机顶盒:
dth=7
givn(视频 Nonce)
说明
对于使用 Programmatic Access Library (PAL) 的集成,视频 Nonce 参数接受变量字符串值。
Nonce 适合包含在网址中,因此您无需对其进行网址编码。
注意:如果您之前使用旧版 paln 参数提供过 Nonce,我们强烈建议您迁移到 givn 参数并停止发送 paln。请勿同时包含这两个参数。
用法示例
如需详细了解向此参数传递的值,请参阅 PAL 的相关入门指南。
hl(语言)
说明
“语言”参数 (hl) 接受常量值,用于请求使用该语言的广告,在对 Ad Exchange 或 AdSense 视频进行动态分配的过程中,此参数用于指定在进行广告选择和视频广告呈现时所使用的语言。
用法示例
请求以意大利语投放广告:
hl=it
参数值可以是任意的 ISO 639-1(两个字母)或 ISO 639-2(三个字母)代码。请参阅有效代码列表。
如果省略,参数值默认为在 Ad Exchange 中根据语言定位广告时指定的任一语言。
msid(应用 ID)
说明
“应用 ID”参数 (msid) 和“应用名称”参数 (an) 接受变量值,它们应该应用于从移动应用和联网电视设备发送的请求,因为大多数程序化视频广告都需要使用它们。
应用名称应采用人类可读的名称。
用法示例
msid=com.package.publisher&an=sample%20app
应用 ID 在不同应用商店中采用不同的命名方式和格式。查看应用识别的 IAB 指南或常见唯一标识符示例。
对于没有应用商店的平台,IAB 建议发布商使用以下格式的商店 ID:com.publisher.deviceplatform
要求和建议
虽然此参数不是向任何特定实现投放广告的必需参数,但建议在移动应用、联网电视、音频和数字户外广告中进行程序化变现时使用此参数。
为了保障广告不会投放到不利于品牌形象的内容中并让买方更清楚地了解广告投放情况,强烈建议您添加应用信息。
SDK 使用情况
除了 iOS 和 tvOS 之外,IMA SDK 会自动填充这两个参数,但必须在非 SDK 环境(包括直接 VAST 调用)中,或者在使用 Programmatic Access Library (PAL) 或发布商身份经过验证的广告资源 (PAI) 时手动指定这些参数。
在 iOS 和 tvOS 上,IMA SDK 或 PAL 无法获取应用 ID。在这些情况下,系统不会发送 msid 参数,而 SDK 会通过 an 参数发送 app bundle。
注意:如果使用的是 HTML5 IMA SDK,则不会使用应用信息。
omid_p(Omid 合作伙伴名称)
说明
OMID 合作伙伴名称参数 (omid_p) 接受变量值,以用于指明集成 OMID 衡量功能的合作伙伴的名称以及合作伙伴版本。
“支持的 SDK API”参数 (sdk_apis) 接受变量值,这些值可以是单个支持的 API,也可以是逗号分隔的支持的 API 列表。
这些参数是用于衡量广告可见度和进行广告验证的一组参数的一部分。
用法示例
不使用 PAL 时:
omid_p=examplepartnername/1.0.0.0&sdk_apis=7
不妨查看一下可能的 API 框架值的列表。
使用 PAL 时:
request.omidPartnerName = 'examplepartnername'
request.omidPartnerVersion = '1.0.0.0'
要求和建议
虽然此参数不是向任何特定实现投放广告的必需参数,但建议在网站、移动应用、联网电视、音频和数字户外广告中进行程序化创收时使用此参数。
SDK 使用情况
- 此参数仅适用于使用 Open Measurement SDK (OM SDK) 时需要 Active View 衡量功能的发布商。
- 如要在使用 Programmatic Access Library (PAL) 时指明 OMID 支持,您需要使用
omidPartnerName和omidPartnerVersion来设置合作伙伴名称和版本。如果您不使用 PAL 或 IMA SDK,则必须设置omid_p和sdk_apis参数。 - 使用 IMA SDK 时,不应使用此参数,因为系统会自动设置它。
sid(会话 ID)
说明
“会话 ID”(sid) 参数接受变量值,它是一种可保护隐私的广告标识符,仅用于实现频次上限。
会话 ID 适用于来自联网电视的插播视频广告请求,以及来自移动应用设备的插播视频广告资源。Web 应用目前不支持此 ID。
如果选择不传递会话 ID,您可以设置 sid=0。
vconp(视频连续播放)
说明
“视频连续播放”(vconp) 参数接受常量值,用于指明播放器是否会继续播放视频内容(类似于电视广播)。
用法示例
开启连续播放:
vconp=2
关闭连续播放:
vconp=1
如果该参数未知,则应使其保持未设置状态。
vpos(视频内位置)
说明
“视频内位置”(vpos) 参数接受常量值,用于指明广告请求是从前贴片广告位、中贴片广告位还是后贴片广告位发出的。
用法示例
前贴片广告位:
vpos=preroll
中贴片广告位:
vpos=midroll
后贴片广告位:
vpos=postroll
wta(为什么显示该广告)
说明
“为什么显示该广告?”参数 (wta) 接受常量值,用于指明视频播放器是否支持呈现广告标示。
用法示例
如果播放器应呈现 VAST 响应中提供的“广告选项”图标,请使用:
wta=1(或省略wta参数,或传递未设置值的wta)如果 VAST 响应中提供的“广告选项”图标将在随播广告上呈现或以其他方式提供给用户,音频请求应使用
wta=1。
如果播放器不应呈现 VAST 响应中提供的“广告选项”图标,请使用:
wta=0
要求和建议
虽然对于任何特定实现类型而言,无需此参数即可投放广告,但对于网站、移动应用、联网电视和音频中的程序化变现而言,此参数为推荐参数。
使用此参数时:
&wta=0流量不符合条件,无法使用 Google 需求来源的某些类型的个性化功能。- 来自欧洲经济区 (EEA) 的
&wta=0流量不符合条件,无法在预订型订单项和由发布商管理的有保证程序化订单项中投放启用了广告标示的广告素材。
广告必须符合在欧洲经济区投放广告需遵循的适用法规要求。这包括为用户提供举报非法内容的机制。发布商必须使用举报 Google 上的内容表单,将收到的所有针对非法内容的举报信息告知 Google。
SDK 使用情况
当使用 IMA SDK 时,系统会自动支持广告标示功能。当未使用 IMA SDK 时,视频播放器必须实现 VASTIcon 和 IconClickFallbackImage 支持,如 IAB VAST 标准中所述。