VAST 广告代码网址参数

VAST 广告代码网址参数

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
ad_rule
ad_type
addtl_consent
afvsz
allcues
an
ciu_szs
correlator
cmsid
cust_params
description_url
dth
env
excl_cat
gdfp_req
gdpr
gdpr_consent
givn

hl
iabexcl
idtype
ipd
ipe
is_lat
iu
lip
ltd
max_ad_duration
min_ad_duration
mridx
msid
nofb
npa
omid_p
output
paln
plcmt

pmad
pmnd
pmxd
pod
pp
ppt
ppid
ppos
ppsj
ptpl
ptpln
pubf
pvid
pvid_s
pvtf
rdid
rdp
schain
scor

sdk_apis
sdmax
sid
ssss
sz
tfcd
trt
unviewed_position_start
url
vad_type
vconp
vid
vid_d
vpa
vpi
vpmute
vpos
wta

参数 详细说明
aconp

(音频连续播放)

建议使用,请参阅 MRC 音频衡量指南

“音频连续播放”参数接受常量值,用于指明播放器是否会继续播放音频内容。

如果该参数未知,则应使其保持未设置状态。

用法示例

开启连续播放:
aconp=2

关闭连续播放:
aconp=1

ad_rule

(广告规则)

“广告规则”参数接受常量值,用于指明是返回 VAST 广告素材还是返回广告规则响应。

广告规则的默认设置取决于 Ad Manager 广告联盟设置。您可按照下方示例覆盖特定广告代码的设置。

用法示例

针对 VAST 广告素材的请求:
ad_rule=0

针对广告规则 (VMAP) 的请求:
ad_rule=1

是否必需

必需 对于视频广告规则是必需参数

ad_type

(广告类型)

广告类型参数接受常量值,用于指明应为请求返回的广告类型。

只有音频广告需要使用此参数。

ad_type 设置为 audioaudio_video 时,必须将 vpmute 参数设置为 0

用法示例:

仅允许投放音频广告:
ad_type=audio

既允许投放可跳过的视频广告,也允许投放不可跳过的视频广告:
ad_type=video

既允许投放音频广告,也允许投放视频广告:
ad_type=audio_video
(此值允许这两种格式进行竞争,但只能投放一种。)

audio_video 广告类型仅适用于将视频广告素材投放到支持视频广告播放的音频内容;或者将音频广告素材投放到播放在自然环境中“可听”内容的插播视频广告播放器。例如,体育在线播放、视频播报、新闻等。详细了解视频内容中的音频

仅允许投放可跳过的视频广告:
ad_type=skippablevideo

仅允许投放不可跳过的视频广告:
ad_type=standardvideo

是否必需

必需 对于音频广告为必需参数

afvsz

(非线性广告尺寸)

“非线性广告尺寸”参数接受常量值,这些值应为可在视频广告位中展示的非线性广告尺寸的列表(以英文逗号分隔)。

这些尺寸只能是下列任一受支持的尺寸:

  • 200x200
  • 250x250
  • 300x250
  • 336x280
  • 450x50
  • 468x60
  • 480x90
  • 729x90

当使用 IMA SDK 时,此字段中的值将改为介于 nonLinearAdSlotWidthnonLinearAdSlotHeight 之间所有受支持的尺寸。

如果不支持任何非线性尺寸,则可以省略该参数或将其留空。

用法示例

支持所有尺寸:
afvsz=200x200,250x250,300x250,336x280,
450x50,468x60,480x90,728x90

最大宽度为 250:
afvsz=200x200,250x250

最大高度为 60:
afvsz=450x50,468x60

最大宽度为 100:
//empty; no values supported

 

是否必需

必需 对于未使用 IMA SDK 的非线性视频广告,是必需参数

allcues

(所有广告插入点)

此参数接受变量值,这些值是以英文逗号分隔的广告插入点(以毫秒为单位)的列表。对于每个值,Ad Manager 都会返回一个广告插播时间点。

vid_dallcues 参数用于在不进行内容提取的情况下投放中贴片广告。您还需设置广告规则才能返回中贴片广告。

如果您的广告规则中使用了基于时间的广告插入点(例如,“每 N 秒插播一次”或“在固定的时间”),系统会使用广告规则中设定的广告插入点,并忽略传递到 allcues 的广告插入点。中贴片广告仍需设置时长,因此 vid_d 仍是必须传递的参数。

用法示例

将 10 秒处和 20 秒处设为广告插入点:
allcues=10000,20000

ciu_szs

(随播广告尺寸)

“随播广告尺寸”参数接受变量值,这些值是随播广告尺寸的列表(以英文逗号分隔)。

以竖线 (|) 分隔的值表示多尺寸广告位。

用法示例

ciu_szs=728x90,300x250

多尺寸广告位的尺寸:
ciu_szs=728x90,300x200|300x250

cmsid

(内容来源 ID)

vid

(视频 ID)

“内容来源 ID”和“视频 ID”参数接受变量值。

将广告定位到视频内容,主视频广告代码必须同时包含这两个参数。

cmsid 是每个内容来源的唯一编号。若要在 Ad Manager 中找到它,请依次点击视频 > 内容来源,然后点击相应来源的名称。

vid 是用于标识特定视频的字符串或编号。此 ID 由托管内容的 CMS 分配。若要在 Ad Manager 中找到它,请依次点击视频 > 内容,然后点击特定视频内容。

用法示例

cmsid=[value]&vid=[value]

如果您要为包含视频点播内容的动态广告插播构建代码,则应使用可动态插入正确内容来源和视频 ID 的

例如:cmsid=%%CMS_ID%%&vid=%%VIDEO_ID%%

是否必需

必需 对于视频内容定位为必需参数

correlator

(Correlator)

“Correlator”参数接受变量值,源于同一次网页浏览的多项请求会共用此值。在进行竞争排除(包括在没有 Cookie 的环境中)时会用到此参数。

如果您使用 IMA SDK,系统会自动设置 Correlator 值。如果您的播放器尝试设置此值,SDK 会将其替换成自己的值。

如果您未使用 IMA SDK,请确保将此值设置为当前没有被多次网页浏览重复使用的真正随机的正整数值。

用法示例

correlator=4345645667

是否必需

必需 对于网站应用为必需参数

推荐 对于程序化变现为推荐参数

cust_params

(自定义键值对参数)

“自定义参数”参数接受变量值,您可以通过这些键值对来设置具体的定位条件,例如受众特征、网页上的某些位置,或一个或多个特定网页。

用法示例

查看添加键值对的方法示例。

description_url

(说明网址)

“说明网址”参数接受变量值,此值应该用于描述在网页上播放的视频。用 1-3 段描述性内容概述网页。例如,从预定义的块中动态拼接 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,是必需参数

推荐 对于程序化变现而言,是推荐项

dth

(设备类型提示)

设备类型提示参数接受常量值,有助于减少设备分类错误,尤其是在联网电视和机顶盒环境中。

设备误分类可能是由于发布商或联网电视 OEM 的意外错误造成的。此参数将与其他信号结合使用,以便 Google 自动标记可能需要对联网电视广告资源进行重新分类的情况。

用法示例

请求来源:

  • 非智能手机:dth=1
  • 智能手机:dth=2
  • 桌面设备:dth=3
  • 平板电脑:dth=4
  • 联网电视:dth=5
  • 游戏机:dth=6
  • 机顶盒:dth=7

是否必需

推荐 对于联网电视上的程序化变现,此参数为推荐参数。

对于 PAL 和 PAI(非 SDK)实现方案,此参数为推荐参数。IMA SDK 和 DAI SDK 不需要此参数。

env

(环境)

“环境”参数接受常量值,用于指明这是一项插播广告请求或者该请求是明确来自视频播放器。

可能的值包括 instream(可用于视频和音频广告)或 vp(仅可用于视频广告)。

用法示例

视频和/或音频:
env=instream

仅限视频:
env=vp

是否必需

必需 对于网站应用为必需参数

excl_cat

(排除类别)

“排除类别”参数接受变量值,用于屏蔽包含相关排除标签的所有订单项,使其不符合给定广告请求的条件。此参数可与 cust_params 结合使用。

用法示例

&cust_params=excl_cat%3Dairline_excl_label%7C

gdfp_req

(Ad Manager 架构指示器)

“Ad Manager 架构指示器”参数接受常量值,用于指明用户在 Ad Manager 架构中。

用法示例

gdfp_req=1

是否必需

必需 对于网站应用为必需参数

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=1

GDPR 不适用:
gdpr=0

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 paln parameter, it is strongly recommended to migrate to the givn parameter and stop sending paln. Do not include both parameters.

Usage example

You 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 中根据语言定位广告时指定的任一语言。

用法示例

hl=it

是否必需

推荐 对于程序化变现为推荐参数

iabexcl

(IAB 排除网址)

网址参数 iabexcl 接受逗号分隔类别列表。

用法示例

iabexcl=3,14,527 不包括“商用卡车”“越野车”和“橄榄球”。

详细了解 IAB 内容类目

ipd

(广告资源合作伙伴网域)

“广告资源合作伙伴网域”参数接受变量值,这些值应设置为发布商 app-ads.txt(或 ads.txt)文件中声明的 inventorypartnerdomain

inventorypartnerdomain 参数是一种 IAB 规范,可帮助发布商指定共享广告资源的合作伙伴的网域,以便进行 ads.txt/app-ads.txt 验证。

在广告资源共享用例中,发出广告请求的广告资源可能归其他合作伙伴(共享广告资源的合作伙伴)所有,此时 IPD 声明就尤为重要。

详细了解 ads.txt/app-ads.txt 和共享广告资源的合作伙伴

ipe

(展示 ping 实体)

“展示 ping 实体”参数接受常量值,以用于指明源自服务器(而非客户端)的展示 ping 和转化。

用法示例

服务器端信标 (SSB):
ipe=ssb

iu

(广告单元)

“广告单元”参数接受变量值,此值应设为当前广告单元,格式为:

/network_code/.../ad_unit

用法示例

iu=/6062/videodemo

是否必需

必需 对于网站应用为必需参数

lip

(广告连播中的最后一个位置)

“广告连播中的最后一个位置”参数接受常量值,用于指明从广告连播中的最后一个位置发出的广告请求。

此参数仅适用于标准广告连播。

用法示例

lip=true

ltd

(受限广告)

“受限广告”参数接受常量值,用于指明在未就使用 Cookie 或其他本地标识符征得用户同意的情况下,是否要通过一种受限的方式投放广告

警告

与其他网址参数不同,设置 ltd=1 会更改 IMA SDK 的行为,以便将相应请求视为不含 ID 并禁止存储。

用法示例

ltd=1

min_ad_duration

(广告时长下限)

max_ad_duration

(广告时长上限)

“广告时长”参数接受变量值,结合使用此类参数可指定广告的时长范围(以毫秒为单位)。

使用此参数可以限制单个广告和优化型广告连播请求的单个广告时长。

用法示例

min_ad_duration=15000&max_ad_duration=30000

mridx

(中贴片广告位编号)

“中贴片广告位编号”参数接受变量值,用于指明中贴片广告位的顺序编号(例如,中贴片广告位 1、中贴片广告位 2 等)。

用法示例

mridx=2

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

是否必需

必需 应用需要这两个参数

推荐 对于程序化变现为推荐参数

nofb

(后备广告已停用)

“后备广告已停用”参数接受常量值,用于指明广告请求应返回视频后备广告的播放列表。

用法示例

后备广告已停用:
nofb=1

npa

(非个性化广告)

“非个性化广告”参数接受常量值,用于指明应将广告请求视为非个性化广告请求。

要将相应请求标记为非个性化广告请求,您必须明确设置 npa=1,或直接添加 npa(不设置任何值)。缺少此参数或设为 nap=0 的广告请求会默认为请求投放个性化广告

用法示例

非个性化广告:
npa=1

omid_p

(OMID 合作伙伴名称)

OMID 合作伙伴名称参数接受变量值,此值用于指明集成 OMID 衡量功能的合作伙伴的名称以及合作伙伴版本。

此参数仅适用于使用 Open Measurement SDK (OM SDK) 时需要 Active View 衡量功能的发布商。使用 IMA SDK 时,切勿使用此参数,因为它是自动设置的。

如要在使用 Programmatic Access Library (PAL) 时指明 OMID 支持,您需要使用 omidPartnerNameomidPartnerVersion API 来设置合作伙伴名称和版本。如果您不使用 PAL 或 IMA,则必须设置 omid_psdk_apis 参数(受支持的 API,其中可能包括其他以英文逗号分隔的 API)。

用法示例

使用 PAL 时:
request.omidPartnerName = 'examplepartnername'
request.omidPartnerVersion = '1.0.0.0'

不使用 PAL 时:
omid_p=examplepartnername/1.0.0.0&sdk_apis=7

output

(广告输出格式)

“广告输出格式”参数接受常量值,此值应设为广告的输出格式。

请根据您为广告联盟设置的默认 VAST 版本来使用 output=vast。对于您网站中的特定广告代码或特定部分,您可以请求特定 VAST 或 VMAP 版本。

对于 VAST,如果您的视频播放器使用 IMA SDK,那么视频广告请求的输出参数将始终设为 output=xml_vast4。这不会导致可靠性方面的风险,因为此 SDK 可向后兼容任何第三方广告服务器可能投放的所有 VAST 版本。

若要返回您为广告联盟启用的默认 VMAP 版本(如 VMAP 1),请使用 output=vmap。如果您要在 VMAP 内部返回 VAST,则可以使用 xml_vmap1_vast3xml_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

是否必需

必需 对于网站应用为必需参数

plcmt

(展示位置)

展示位置参数接受常量值,用于指明插播广告资源是声明为插播广告资源还是随播广告资源,详情请参阅IAB 规范

对于非插播请求,此字段会由系统根据声明的广告资源格式自动为买家填充,并将替换任何插播或随播内容声明。

用法示例

插播广告请求:
plcmt=1

随播内容请求:
plcmt=2

是否必需

必需 对于网站程序化变现是必需的

pmad

(广告连播中的广告数量上限)

“广告连播中的广告数量上限”参数接受变量值,用于指明广告连播中的广告数量上限。

此参数专用于面向拥有高级视频产品包的发布商提供的优化型广告连播,不应该用于 VMAP(当 ad_rule=1 时)。

用法示例

pmad=4

pmnd

(广告连播时长下限)

pmxd

(广告连播时长上限)

“广告连播时长”参数接受变量值,结合使用此类参数可指定广告连播的时长范围(以毫秒为单位)。

此类参数用于请求多个广告。它们专用于优化广告连播,适用于使用高级视频产品包的发布商,不应该用于 VMAP(当 ad_rule=1 时)。

用法示例

pmnd=0&pmxd=60000

广告联播

(广告连播编号)

“广告连播编号”参数接受变量值,用于表示广告连播在视频中的顺序编号(例如,广告连播 1、广告连播 2 等)。

用法示例

pod=3

是否必需

必需 必须传递此参数,以便将来可以正常使用竞争排除频次上限和相关功能。

pp

(广告素材配置文件)

“广告素材配置文件”参数接受变量值,用于控制哪些广告素材能够根据视频和音频广告素材配置文件中设置的配置进行投放。

用法示例

pp=creative_profile

是否必需

推荐 对于程序化获利为推荐参数

ppt

(发布商隐私保护处理措施)

“发布商隐私保护处理措施”参数接受常量值,用于指明是否针对广告请求关闭广告个性化功能。

详细了解发布商隐私保护处理措施

用法示例

关闭广告个性化功能:
ppt=1

ppid

(发布商提供的标识符 [PPID])

“发布商提供的标识符”(PPID) 参数接受对此标识符使用变量值,以便跨设备实现频次上限、受众群细分和定位、依序广告轮播以及基于受众群体的其他广告投放控制功能。

用法示例

ppid=12JD92JD8078S8J29SDOAKC0EF230337

ppos

(在广告连播中的位置)

“在广告连播中的位置”参数接受变量值,用于表示在广告连播中的位置(例如,位置 1、位置 2 等)。

此参数仅适用于标准广告连播,随播广告自动填充功能需要使用此参数。

用法示例

ppos=2

是否必需

必需 必须传递此参数,以便将来可以正常使用竞争排除频次上限和相关功能。

ppsj

(发布商提供的信号 JSON)

发布商提供的信号 JSON 参数接受采用 base64 编码的 JSON 对象(其中包含发布商提供的受众群体和情境数据),以提高程序化变现能力。

详细了解发布商提供的信号支持的类目

如需详细了解有效的 JSON 键值对,请参阅
HTML5 IMA SDK 示例

用法示例

JSON 对象:
{
  "PublisherProvidedTaxonomySignals": [{
     "taxonomy": "IAB_AUDIENCE_1_1",
     "values": ["6", "284"]
  }]
}

Base64 编码值:
eyJQdWJsaXNoZXJQcm92aWRlZFRheG9ub215U2lnbmFscyI6W3s
idGF4b25vbXkiOiJJQUJfQVVESUVOQ0VfMV8xIiwidmFsdWVzIj
pbIjEiLCIyODQiXX1dfQ

ptpl

(广告插播模板 ID)

ptpln

(广告插播模板名称)

广告插播模板 ID 和名称接受变量值,并指明应将哪个广告插播模板应用于优化型广告连播请求。借助广告插播模板,您可配置广告插播时间点处应包含哪些广告插播位或自定义广告插播位,以及这些插播位应按什么顺序投放。

只需提供 2 个参数(名称或 ID)中的一个即可请求广告插播模板。

用法示例

如需详细了解如何设置和请求广告插播模板,请点击此处
 
pubf

(Ad Exchange 代码中的公开底价)

pvtf

(Ad Exchange 代码中的不公开底价)

pubf 相当于 google_ad_public_floorpvtf 相当于 google_ad_private_floor。它们用于向 Ad Exchange 代码添加底价

用法示例

pubf=123
pvtf=123

pvid

(应用组 ID)

pvid_s

(应用组范围)

如果用户在 Android 设备上选择停用个性化功能,就需使用应用组 ID 值创收。

pvid 参数接受变量值,此值设为 Android 应用组 ID;pvid_s 参数接受常量值,此值表示应用组 ID 的范围(可以是 scope_appscope_developer)。

当 IMA/PAL SDK 自动传递此字段时,采用非 SDK 实现方案的发布商必须调用应用组 SDK,并在广告请求中手动传递这些参数。

请参阅有关如何检索应用组 ID 的 Android 文档

用法示例

pvid=[AppSetID_value]
pvid_s=scope_app

是否必需

必需 对于应用,是必需参数

推荐 对于程序化获利,是推荐参数

rdid
idtype
is_lat

(可重置的设备标识符)

可重置设备标识符接受变量值。

对于内置应用(而非网站或移动网站),SDK 会通过以下各项的参数将用于用户定位的可重置设备标识符传递到视频流请求:rdididtypeis_lat。在 SSB 视频流中,您必须将这些标识符作为显式参数进行传递,就像处理客户端广告请求时一样。详细了解设备标识符

几乎所有程序化视频广告都需要这些值。

警告

从 iOS 14.5 开始,Apple 已弃用 LAT 信号。Google 则改为依靠非零 IDFA 来表明用户已同意在支持应用跟踪透明度的 iOS 版本上进行跟踪。因此,有效的 UserAgent 表示需要提供正确的操作系统版本。

用法示例

查看可重置设备标识符的详细示例。

是否必需

必需 对于应用为必需参数

推荐 对于程序化获利为推荐参数

rdp

(限制数据处理)

“受限的数据处理”参数接受常量值,用于指明广告请求应限制数据处理。

您必须明确设置 rdp=1 或仅添加 rdp(不设置任何值),才能限制数据处理。缺少此参数或设置了 rdp=0 的广告请求不会限制数据处理,除非启用了限制数据处理这项广告联盟设置。

用法示例

rdp=1

schain

(供应链)

“供应链”参数接受一个变量值,此值应为序列化的 SupplyChain 对象。包含此参数时,Google 会在将任何收到的 schain 对象发送给买方之前,向其附加一个节点。

如需了解如何通过代码(而非 OpenRTB)传达 SupplyChain 信息,请参阅完整的 IAB 文档。

查看正确解析 schain 需遵循的要求

下面根据 IAB 文档定义了 SupplyChain 对象的序列化:

  • {SupplyChainObject}!{SupplyChainNode array}。SupplyChainObjectSupplyChainNode 属性都以英文逗号分隔,因此可选字段可以省略,并且可以选择性地排除相应的英文逗号分隔符。
  • 各个 SupplyChainNode 元素间用“!”分隔。
  • 如果任何媒体资源的值包含需要进行网址编码的字符(例如“,”或“!”),则应先对该值进行网址编码,然后再进行序列化。

序列化顺序

SupplyChainObject 属性按以下顺序进行序列化:

ver,complete

SupplyChainNode 属性按以下顺序进行序列化:

asi,sid,hp,rid,name,domain,ext

注意ext 的内容因广告交易平台而异。Google Ad Manager 不会解析此属性。

有关如何序列化 SupplyChain 对象的示例

以下是序列化上述 SupplyChain 对象的两种方法示例:

对空的可选字段进行序列化时使用英文逗号

1.0,1!exchange1,12345,1,bid-request-1,publisher1,publisher1.com!google.com,pub-12345678910,1,,,,

对空的可选字段进行序列化时不使用英文逗号

1.0,1!exchange1,12345,1,bid-request-1,publisher1,publisher1.com!google.com,pub-12345678910,1

详细了解 SupplyChain 对象

用法示例

schain=1.0,1!exchange1,12345,1,bid-request-1,publisher1,publisher1.com!google.com,pub-12345678910,1,,,,

如果 asi 的值为 asi,则使用转义字符进行序列化后的结果如下所示:

1.0,1!exchange%2C1,12345,1,bid-request-1,publisher1,publisher1.com!google.com,pub-12345678910,1

是否必需

必需 对于在向 Google Ad Manager 发出请求之前利用支付中间方的发布商,此属性为必需属性。这包括使用第三方广告服务器技术的发布商。

scor

(视频流 Correlator)

“视频流 Correlator”参数接受变量值,此值应该是针对每个视频流生成的整数。如果是在视频流中,此数值必须相同;如果是在网页浏览中,此数值必须是唯一的。如果用户在同一网页上观看多个视频,此参数可用于竞争排除、频次上限和相关功能。

用法示例

scor=17

是否必需

必需 必须传递此参数,以便将来可以正常使用竞争排除频次上限和相关功能。

sdk_apis

(SDK API 框架)

SDK API 框架参数接受由以英文逗号分隔的常量整数值构成的列表,这些整数值表示播放器支持的所有 API 框架。

不妨查看一下可能的 API 框架值的列表

此参数支持 Programmatic Access Library (PAL) 中的 API,适合不使用 IMA SDK 的发布商使用。IMA SDK 会使用其支持的值替换已设置的所有值。

用法示例

sdk_apis=2,7,9

sdmax

(Skippable max ad duration)

sdmax(可跳过式广告时长上限)广告请求参数接受变量值,允许发布商为可跳过式广告指定所需的广告时长上限。

它是一个时长(以毫秒为单位),表示针对该特定广告请求,允许可跳过式视频/音频广告素材的时长上限。

您可以为可跳过式广告单独使用 sdmax,也可以与现有的 max_ad_duration 参数结合使用,为可跳过式广告和不可跳过式广告提供不同的时长上限。

用法示例

使用以下设置:

  • max_ad_duration = 15000(15 秒)
  • sdmax = 45000(45 秒)

对于以下广告素材:

  • 广告素材 A:不可跳过;30 秒
  • 广告素材 B:可跳过;30 秒

结果:

  • 广告素材 A 因不可跳过且时长超出(不可跳过)时长上限而被滤除。
  • 广告素材 B 将不会被滤除,因为虽然其时长超过了 max_ad_duration,但它是可跳过式广告,并且其时长未超过可跳过式广告时长上限。
sid

(会话 ID)

“会话 ID”参数接受变量值,它是一种保护用户隐私的广告标识符,仅用于实现频次上限。

来自联网电视的插播视频请求和来自移动应用设备的插播视频广告资源均支持会话 ID。Web 应用目前不支持此 ID。

根据 IAB 的 IFA 指南,此参数必须以 UUID 格式填充。详细了解用于用户定位的可重置设备标识符

您可以通过设置 sid=0 选择不传递会话 ID。

用法示例

123e4567-e89b-12d3-a456-426614174000

是否必需

推荐 对于程序化变现为推荐参数

ssss

(服务器端拼接来源)

服务器端拼接来源参数接受一个常量值,该值应设为 Google 为您的视频拼接技术供应商提供的一个认可的值。

如果视频拼接技术供应商使用 Google 的服务器到服务器集成服务,此值会由 Google 提供,以便供应商为您提供该值。如果您对用来设置此参数的值有任何疑问,可以与 Google 客户经理联系。

用法示例

ssss=mystitcher

是否必需

必需 对于服务器端实现为必需参数

sz

(尺寸)

“尺寸”参数接受变量值,此值应设为主视频广告位的尺寸。

多个尺寸应以竖线 (|) 字符进行分隔。

请勿在尺寸后面添加“v”。

用法示例

sz=400x300

是否必需

必需 对于网站应用为必需参数

如果仅请求 ad_type=audio,此参数为可选参数。

tfcd

(“面向儿童的内容”标记)

“面向儿童的内容”参数接受常量值,用于将广告请求标记为面向儿童的内容

用法示例

tfcd=1

trt

(流量类型)

流量类型参数接受常量值,用于请求所购流量或自然流量。

如果请求中缺少流量类型参数,IMA SDK 不会填充默认值。在这类情况下,服务器会提供默认值 0(未定义的流量)。

用法示例

针对所购流量的请求:
trt=1

针对自然流量的请求:
trt=2

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

是否必需

必需 对于网站应用为必需参数

推荐 对于程序化变现为推荐参数

vad_type

(视频广告类型)

“视频广告类型”参数接受常量值,用于指明应返回线性广告还是非线性广告。

用法示例

返回线性广告:
vad_type=linear

返回非线性广告:
vad_type=nonlinear

vid_d

(视频时长)

此参数接受变量值,以用于指定内容的时长(以秒为单位)。

vid_dallcues 参数用于在不进行内容提取的情况下投放中贴片广告。您还需设置广告规则才能返回中贴片广告。

用法示例

视频内容时长为 90000 秒(25 小时):
vid_d=90000

vconp

(视频连续播放)

建议使用,请参阅 MRC 视频衡量指南

“视频连续播放”参数接受常量值,用于指明播放器是否会继续播放视频内容(类似于电视广播)。

如果该参数未知,则应使其保持未设置状态。

用法示例

开启连续播放:
vconp=2

关闭连续播放:
vconp=1

vpa

(视频自动播放)

建议使用,请参阅 MRC 视频衡量指南

“视频自动播放”参数接受常量值,用于指明广告中的视频内容是会自动开始播放还是在用户点击后开始播放。

可能的值包括:click(如果网页等待用户操作)或 auto(如果视频自动播放)。

如果该参数未知,则应使其保持未设置状态。

用法示例

自动播放:
vpa=auto

点击播放:
vpa=click

是否必需

推荐 对于程序化变现为推荐参数

vpi

(视频播放列表 inred)

“视频播放列表 inred”参数接受常量值,用于指明是否投放内嵌 VMAP(在 VMAP 内部返回 VAST)。

该参数可用于缩短延迟时间,并保证在视频流中实现频次上限和竞争性排除规则。

用法示例

返回 VAST:
vpi=1

返回重定向代码:
vpi=0

vpmute

(视频播放静音)

建议使用,请参阅 MRC 视频衡量指南

“静音视频”参数接受常量值,用于指明在开始播放广告时是否将视频播放器设为静音状态。

用法示例

设为静音:
vpmute=1

不设为静音:
vpmute=0

是否必需

必需 对于网站程序化变现是必需的

vpos

(视频内位置)

“视频内位置”参数接受常量值,用于指明广告请求是从前贴片广告位、中贴片广告位还是后贴片广告位发出的。

用法示例

前贴片广告位:
vpos=preroll

中贴片广告位:
vpos=midroll

后贴片广告位:
vpos=postroll

是否必需

推荐 对于程序化获利为推荐参数

wta

(为什么显示该广告)

“为什么显示该广告?”参数接受常量值,用于指明视频播放器是否支持呈现广告标示。如果未发送 &wta 参数,则此参数默认为 &wta=1

当使用 IMA SDK 时,系统会自动支持广告标示功能。当未使用 IMA SDK 时,视频播放器必须实现 VAST IconIconClickFallbackImage 支持,如 IAB VAST 标准中所述。

如果发布商不会呈现 VAST 响应中提供的“广告选项”图标,则必须发送 &wta=0。如果广告请求中设置了 &wta=1 或未设置 &wta 参数,则可以认为发布商将呈现所提供的“广告选项”信息。

如果 VAST 响应中提供的“广告选项”图标将在随播广告上呈现或以其他方式提供给用户,音频广告请求可能会发送 wta=1

对于来自欧洲经济区 (EEA) 的流量,如果请求中设置了 &wta=0,则无法投放启用了 Google 标示的预订型广告素材。

广告必须符合在欧洲经济区投放广告需遵循的适用法规要求。这包括为用户提供举报非法内容的机制。发布商必须使用相应表单,将收到的任何非法内容举报信息告知 Google。

用法示例

支持:

wta=1 或未设置 wta 参数

不支持:
wta=0

是否必需

必需Ad Exchange 而言,是必需项

必需 对来自欧洲经济区的网站应用流量而言,是必需项

推荐 对于程序化变现而言,是推荐项

该内容对您有帮助吗?

您有什么改进建议?
搜索
清除搜索内容
关闭搜索框
主菜单
10407889460049676708
true
搜索支持中心
true
true
true
true
true
148
false
false