参数
页面级参数说明
这些参数只需为每个网页指定一次。 它们会影响网页上的所有单元。
必需
参数 | 说明和示例 |
---|---|
adPage
|
当用户导航到下一个结果页或上一个结果页时,此为必需参数。
|
pubId
|
必需 这是您的 AdSense 客户 ID。您的 pubId 是 Client-ID 中“partner-”后面的部分。例如,如果您的 Client-ID 为“partner-test-property”,则您的 pubId 就是“test-property”。这是自定义搜索广告的标准协议。 示例: 'pubId' : 'test-property' |
query
|
必需,但“内容”页面上的相关搜索除外。 这是由用户输入的搜索查询。查询参数的值应采用未编码格式。 注意:在内容页面上的相关搜索中使用此参数会导致意外结果。 示例: 'query' : 'flowers' 'query' : 'black & decker' 'query' : myQuery // myQuery is a variable containing the search query |
resultsPageBaseUrl
|
当网页上有相关搜索单元时,此属性为必需属性。 指定搜索结果页的网址,其中搜索查询是用户点击过的相关搜索字词。除搜索查询(将自动附加)外,resultsPageBaseUrl 可包含自己的参数。 示例: 'resultsPageBaseUrl' : 'http://www.example.com/search?a=v1&b=v2' |
relatedSearchTargeting
|
当网页上有相关搜索单元时,此属性为必需属性。 在请求相关搜索单元时,此参数是必需的。它会根据网页上下文控制要显示的相关搜索体验类型:
注意:relatedSearchTargeting 页面参数默认会自动设置为“query”。但请务必注意,此默认值是专为搜索结果页(Google 搜索上的相关搜索)设计的。如果您要对任何其他类型的网页(例如文章、博文)使用相关搜索,则必须将该参数明确设置为“content”。 注意:此参数的使用应遵循以下准则:
示例: 'relatedSearchTargeting' : 'content' 'relatedSearchTargeting' : 'query' |
styleId
|
必需属性 用于指定要应用于网页上的广告单元或相关搜索单元的自定义搜索广告样式的 ID。 详细了解如何使用自定义搜索广告样式。请注意,为请求设置 styleId 后,广告或相关搜索查询将使用该样式呈现,而旧版样式参数将被忽略。如果请求中未指定 styleId,则将呈现系统默认样式。 示例: 'styleId': '1234567890' |
可选
参数 | 说明和示例 |
---|---|
linkTarget
|
可选参数 指定点击广告时是在同一窗口中打开,还是在新窗口中打开。默认值为“_top”。此参数也可以在单元级别使用。
示例: 'linkTarget' : '_blank' |
maxTermLength
|
可选参数 用于指定相关搜索字词(包括空格)的最大字符数。 如果未设置,则无上限。 示例: 'maxTermLength' : 50 |
referrerAdCreative
|
可选参数 如果用户通过点击其他网站上的广告或链接到达包含内容相关搜索单元的内容页面,并且该广告或链接在您的控制之下,则此参数应设为该广告或链接的广告素材文字。 使用此参数时需遵循以下准则:
注意:使用 示例: 'referrerAdCreative': 'search for ads related to dental implants' 'referrerAdCreative': 'The Early Signs of Psoriatic Arthritis' |
resultsPageQueryParam
|
可选参数 用于指定搜索结果页上的搜索查询对应的网址参数的名称。 如果未指定,则默认为“q”。 示例: 'resultsPageQueryParam' : 'query' |
terms
|
可选参数 此参数可让您提供以英文逗号分隔的相关搜索字词列表,这些字词将随相关搜索请求一起返回,但 Google 不一定会使用此处提供的字词。
注意:使用此参数时, 示例: 'terms' : 'cars rental, flight ticket' |
ignoredPageParams
|
可选参数 用于指定包含可安全忽略且不会影响核心内容或用户体验的相关搜索单元的内容页的网址参数列表。 注意:相关搜索字词才会出现在您的网站上,Google 需要抓取您的网页,以确保这些字词与内容相关。如果 AdSense 抓取工具尚未抓取或阻止抓取某个网页(例如已被 robots.txt 禁止抓取),我们不会显示您向 Google 提供的建议相关搜索字词。 “内容相关搜索”产品依靠 Google 的内容抓取系统来将网页编入索引并生成相关搜索字词。包含查询参数(例如跟踪变量、用户 ID、会话 ID 或其他动态标识符)的内容页网址可能会影响抓取工具评估网页核心内容的能力,并且可能会导致相关搜索字词不准确或不相关。此网页参数可指示 Google 抓取工具忽略这些不重要的参数,从而确保将内容编入索引并减少不必要的抓取负载。这样,Google 就可以更好地将网页识别为已被抓取,并开始显示建议的字词(如果符合条件,Google 和合作伙伴的字词均包括在内)。 使用此参数时需遵循以下准则:
示例:
http://example.com/content?utm_medium=social&page_id=123&click_id=456提供以下可忽略的网址参数: 'ignoredPageParams' : 'utm_medium,click_id,session_ref'系统会将该内容网页的网址视为: http://example.com/content?page_id=123 |
配置设置
参数 | 说明和示例 | |||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
adsafe
|
可选参数 用于指定 Google 应对符合搜索查询条件的广告应用的过滤规则。以下是 adsafe 的有效设置,以及每个值对返回的广告的影响:
默认情况下,adsafe 设置为“高”。 示例: 'adsafe': 'medium' |
|||||||||||||||||||||||||||||||||||||||||||||||||||
adtest
|
可选参数 adtest 参数用于指明广告请求属于测试类。如果 adtest 参数的值为 on,Google 会将相应请求视为测试,并且不会统计广告展示次数,也不会跟踪点击结果。 当 adtest 参数的值为 on 时,您不会获得任何收入。 如果广告请求中的 adtest 参数设为 on,但这些广告请求来自尚未 在“网站”标签页中获得批准的网域,则会返回包含“测试广告”叠加层且无法点击的广告。 此参数应在测试时使用,而不能用于实际生产系统,否则您将不会通过展示的广告获得收入。 “adtest”的默认值为 off。 示例: 'adtest' : 'on' |
|||||||||||||||||||||||||||||||||||||||||||||||||||
channel
|
可选 您可以添加 AdSense 搜索广告渠道,以跟踪不同网页的效果。请使用在您的 AdSense 帐号中或由您的技术支持客户经理创建的唯一渠道 ID。点击此处详细了解渠道。 多个频道应以“+”号分隔。 示例: 'channel' : 'testA' 'channel' : 'testA+testB' |
|||||||||||||||||||||||||||||||||||||||||||||||||||
hl
|
可选参数 此参数用于指定所请求的广告或相关搜索应定位的语言。默认值为 en。 Google 支持所有 AdWords API 语言代码。 注意:广告所定位的语言由相应广告客户指定。如果您在请求中加入此参数,Google 将仅返回定位到相应语言或所有语言的广告,但 Google 不保证其广告文字也采用所指定的语言。 通常情况下,您应该将 hl 参数设置为发送此参数的网页所使用的主要语言。 示例: 'hl' : 'es' |
|||||||||||||||||||||||||||||||||||||||||||||||||||
ie
|
可选
|
|||||||||||||||||||||||||||||||||||||||||||||||||||
oe
|
可选
|
|||||||||||||||||||||||||||||||||||||||||||||||||||
ivt
|
可选参数 通过此参数,您可以提供一个布尔值,告知 Google 您希望允许针对已征得用户同意和未征得用户同意的流量使用仅用于检测无效流量的 Cookie 和本地存储的广告。
默认情况下,IVT 设置为 true。 示例: 'ivt': false |
单元级参数说明
这些参数会影响网页上各个广告单元向用户展示的方式,您可以分别为每个广告单元设置各项参数。
必需
参数 | 说明和示例 |
---|---|
container
|
必需参数 用于展示广告的空广告容器 <div> 的 ID。
示例: 'container' : 'afscontainer1' |
maxTop
|
当广告单元位于搜索结果上方时,此属性为必需属性。 使用此参数指定要在顶部广告单元中展示的广告数量。 注意: 此参数可代替“number”参数。此广告单元应足够宽,以确保广告的第一行不会换行。在页面上的任何其他展示位置使用 maxTop 参数都属于违规行为。 例如: 'maxTop' : 4 |
width
|
必需属性 用于指定广告或相关搜索单元的宽度(以像素为单位)。 示例: 'width' : '700px' 'width' : 700 |
配置设置
参数 | 说明和示例 | ||||||||
---|---|---|---|---|---|---|---|---|---|
adLoadedCallback
|
可选参数 指定在加载广告或相关搜索或者没有投放广告或相关搜索时调用的 JavaScript 函数。该参数应设为由您实现的 JavaScript 回调函数,以便在广告调用完成时执行某项操作。 该回调函数采用以下参数:
注意:请测试您的回调函数,以确保它不会生成任何错误,尤其是那些可能会干扰网页加载的错误。 JavaScript 回调示例: var adblock1 = { 'container' : 'adblock1_div_id', 'adLoadedCallback' : function(containerName, adsLoaded, isExperimentVariant, callbackOptions) { if (adsLoaded) { try { // most likely do nothing } catch (e) { alert ("Error in callback function"); // Do something to handle error gracefully } } else { // as you always do when there is no ad coverage from Google } } }; |
||||||||
number
|
可选参数 此广告单元中应展示的广告数量。默认值为 2。 示例: 'number' : 4 |
||||||||
relatedSearches
|
可选参数 此广告单元中应显示的相关搜索的数量。如果未指定,则默认为 0。 示例: 'relatedSearches' : 4 |