用于应用的必需参数

在不使用 IMA SDK 的情况下实施基于代码的视频广告解决方案来满足 Ad Exchange 需求是一项 Beta 版功能，未必可供您的广告联盟使用。如需了解详情，请与您的客户经理联系。

下方列出了一部分 VAST 广告代码网址参数。在应用中实施基于代码的视频广告解决方案时，如果未集成 IMA SDK，这些参数则为必需参数。

请查看用于网站的必需参数或用于程序化变现的推荐参数列表。

跳转到列表中的特定参数

an correlator description_url env gdfp_req idtype

is_lat iu msid output pvid pvid_s

rdid sz unviewed_position_start url wta

 

参数	详细说明
correlator (Correlator)	“Correlator”参数接受变量值，源于同一次网页浏览的多项请求会共用此值。在进行竞争排除（包括在没有 Cookie 的环境中）时会用到此参数。 如果您使用 IMA SDK，系统会自动设置 Correlator 值。如果您的播放器尝试设置此值，SDK 会将其替换成自己的值。 如果您未使用 IMA SDK，请确保将此值设置为当前没有被多次网页浏览重复使用的真正随机的正整数值。 用法示例 correlator=4345645667 是否必需 对于网站和应用为必需参数 对于程序化变现为推荐参数
description_url （说明网址）	“说明网址”参数接受变量值，此值应该用于描述在网页上播放的视频。该网页通常是包含视频播放器的网页，但也可以是包含视频介绍文字的网页。 对于网页视频播放器和 CTV/OTT 设备，description_url 值必须经过网址编码；对于移动应用内视频播放器，此值必须未经网址编码。 此参数不是由 IMA SDK 自动设置的，需要手动设置。 用法示例 经过网址编码： description_url= https%3A%2F%2Fwww.sample.com%2Fgolf.html 未经网址编码： description_url= https://www.sample.com/golf.html 是否必需 对于网站、应用和 Ad Exchange，是必需参数 对于程序化变现为推荐参数
env （环境）	“环境”参数接受常量值，用于指明这是一项插播广告请求或者该请求是明确来自视频播放器。 可能的值包括 instream（可用于视频和音频广告）或 vp（仅可用于视频广告）。 用法示例 视频和/或音频： env=instream 仅限视频： env=vp 是否必需 对于网站和应用为必需参数
gdfp_req （Ad Manager 架构指示器）	“Ad Manager 架构指示器”参数接受常量值，用于指明用户在 Ad Manager 架构中。 用法示例 gdfp_req=1 是否必需 对于网站和应用为必需参数
iu （广告单元）	“广告单元”参数接受变量值，此值应设为当前广告单元，格式为： /network_id/.../ad_unit 用法示例 iu=/6062/videodemo 是否必需 对于网站和应用为必需参数
msid （应用 ID） an （应用名称）	“应用 ID”参数和“应用名称”参数接受变量值，它们应该应用于从移动应用和联网电视设备发送的请求，因为大多数程序化视频广告都需要使用它们。 IMA SDK 会自动填充这两个参数，但必须在非 SDK 环境（包括直接 VAST 调用）中或者使用 Programmatic Access Library (PAL) 或发布商身份经过验证的广告资源 (PAI) 时手动指定这些参数。 虽然应用名称应该会是人类可读的名称，但在 iOS 和 tvOS 上，SDK 却无法获取应用 ID。在这些情况下，系统不会发送 msid 参数，而 SDK 会通过 an 参数发送 app bundle。 用法示例 msid=com.package.publisher&an=sample%20app 应用 ID 在不同应用商店中采用不同的命名方式和格式。查看应用识别的 IAB 指南或常见唯一标识符示例。 对于没有应用商店的平台，IAB 建议发布商使用以下格式的商店 ID：com.publisher.deviceplatform 是否必需 应用需要这两个参数 对于程序化变现为推荐参数
output （广告输出格式）	“广告输出格式”参数接受常量值，此值应设为广告的输出格式。 请根据您为广告联盟设置的默认 VAST 版本来使用 output=vast。对于您网站中的特定广告代码或特定部分，您可以请求特定 VAST 或 VMAP 版本。 对于 VAST，如果您的视频播放器使用 IMA SDK，那么视频广告请求的输出参数将始终设为 output=xml_vast4。这不会导致可靠性方面的风险，因为此 SDK 可向后兼容任何第三方广告服务器可能投放的所有 VAST 版本。 若要返回您为广告联盟启用的默认 VMAP 版本（如 VMAP 1），请使用 output=vmap。如果您要在 VMAP 内部返回 VAST，则可以使用 xml_vmap1_vast3 或 xml_vmap1_vast4 指定要返回的 VAST 版本。 用法示例 您广告联盟的默认 VAST 设置： output=vast VAST 4： output=xml_vast4 您广告联盟的默认 VMAP 设置： output=vmap VMAP 1： output=xml_vmap1 VMAP 1，返回 VAST 4： output=xml_vmap1_vast4 是否必需 对于网站和应用为必需参数
pvid （应用组 ID） pvid_s （应用组范围）	如果用户在 Android 设备上选择停用个性化功能，就需使用应用组 ID 值创收。 pvid 参数接受变量值，此值设为 Android 应用组 ID；pvid_s 参数接受常量值，此值表示应用组 ID 的范围（可以是 scope_app 或 scope_developer）。 当 IMA/PAL SDK 自动传递此字段时，采用非 SDK 实现方案的发布商必须调用应用组 SDK，并在广告请求中手动传递这些参数。 请参阅有关如何检索应用组 ID 的 Android 文档。 用法示例 pvid=[AppSetID_value] pvid_s=scope_app 是否必需 对于应用，是必需参数 对于程序化获利，是推荐参数
rdid idtype is_lat （可重置的设备标识符）	可重置设备标识符接受变量值。 对于内置应用（而非网站或移动网站），SDK 会通过以下各项的参数将用于用户定位的可重置设备标识符传递到视频流请求：rdid、idtype 和 is_lat。在 SSB 视频流中，您必须将这些标识符作为显式参数进行传递，就像处理客户端广告请求时一样。详细了解设备标识符。 几乎所有程序化视频广告都需要这些值。 从 iOS 14.5 开始，Apple 已弃用 LAT 信号。Google 则改为依靠非零 IDFA 来表明用户已同意在支持应用跟踪透明度的 iOS 版本上进行跟踪。因此，有效的 UserAgent 表示需要提供正确的操作系统版本。 用法示例 查看可重置设备标识符的详细示例。 是否必需 对于应用为必需参数 对于程序化获利为推荐参数
sz （尺寸）	“尺寸”参数接受变量值，此值应设为主视频广告位的尺寸。 多个尺寸应以竖线 (|) 字符进行分隔。 请勿在尺寸后面添加“v”。 用法示例 sz=400x300 是否必需 对于网站和应用为必需参数 如果仅请求 ad_type=audio，此参数为可选参数。
unviewed_position_start （延迟记录展示次数）	“延迟记录展示次数”参数接受常量值，用于指明为视频延迟记录展示次数。 用法示例 unviewed_position_start=1 是否必需 对于网站和应用为必需参数
url （网址）	“网址”参数接受一个变量值，此值应设为发送请求的完整网址。买方需要使用此值来协助确定和了解该请求是在何种情境下发送的。您应尽可能在广告请求中动态地填充此值。 在网页中，这是显示视频播放器的网页的网址。如果您使用 IMA SDK，它会自动设置网址值。如果您的播放器设置了此值，IMA SDK 将会遵循所设置的值。 在应用（移动应用或联网电视应用）内，此值应设为一个最能准确体现正被用来变现的视频/音频广告资源的网址。例如，如果用户正在一款移动应用内观看某个视频，而等效的桌面版网址上也提供了该视频。* 此参数的值应进行编码。 用法示例 url=https%3A%2F%2Fwww.videoad.com%2Fgolf.html *对于应用，如果无法将该参数设为一个变量网址值，最好使用以下格式来设置它： url=https%3A%2F%2F<app/bundleid>.adsenseformobileapps.com 是否必需 对于网站和应用为必需参数 对于程序化变现为推荐参数
wta （为什么显示该广告）	“为什么显示该广告？”参数接受常量值，该值旨在指明视频播放器对呈现“为什么显示该广告？”的支持能力。 当使用 IMA SDK 时，系统会自动支持“为什么显示该广告？”功能。当未使用 IMA SDK 时，视频播放器必须实现 VAST Icon 和 IconClickFallbackImage 支持，如 IAB VAST 标准中所述。 如果“广告选项”图标（如 VAST 响应中所含）将在随播广告上呈现或以其他方式提供给用户，音频广告请求应发送 wta=1。 为了能够对接欧洲经济区 (EEA) 境内的 Google 需求来源和 Google 托管的预订流量，广告请求必须发送 wta=1 以表明：对于所有广告素材，“广告选项”图标（如 VAST 响应中所含）都将在视频广告上、在随播广告上或以其他方式提供给用户。 用法示例 支持： wta=1 不支持： wta=0 是否必需 对 Ad Exchange 而言，是必需 对网站和应用 EEA 流量而言，是必需 对于程序化变现为推荐参数