Dokumentacja

参数

页面级参数说明

每个网页只需指定一次这些参数。 它们会影响网页上的所有广告单元。

必填

参数 说明和示例
adPage 当用户导航到下一个结果页或上一个结果页时，此为必需参数。

adPage 参数用于指定展示广告的结果页。当用户浏览到搜索结果第一页之后，系统就会使用此参数。例如，如果系统请求了 5 个广告，并且 adPage 参数设为 2，那么返回的广告将会是第 5 个广告的第 2 页。

pubId 必需
这是您的 AdSense Client-ID。pubId 是 Client-ID 中“partner-”之后的部分。例如，如果您的客户 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 当网页上有相关搜索单元时，此属性为必需属性。
在请求相关搜索单元时，此参数是必需的。它可控制 系统会根据网页内容显示相关搜索体验： <ph type="x-smartling-placeholder">
    </ph>
  • 'content'此选项适用于内容页面上的相关搜索（例如，文章、 博文）。
  • 'query' 此选项只能用于以下平台上的相关搜索： 搜索结果页。

注意：relatedSearchTargeting 页面参数会自动设置为 “查询”默认情况。不过，请务必注意，此默认值 仅适用于搜索结果页（Google 搜索上的相关搜索）。如果您 在任何其他类型的网页（例如文章、博文）上使用相关搜索，您必须 将参数明确设置为“content”。

注意：此参数的使用应遵循以下准则：

  • 某些相关搜索功能可能已启用或禁用，具体取决于 page 参数。
  • 虚假陈述网页类型或依赖于默认“查询”适用于 非搜索结果页中的 relatedSearchTargeting 参数会被视为违反了 这些书面说明。
  • 无论是否设置了此值，Google 都会定期验证此值的准确性 或使用默认值

示例：

'relatedSearchTargeting' : 'content'
 
'relatedSearchTargeting' : 'query'
styleId 必需
指定要应用于其中的广告或相关搜索单元的自定义搜索广告样式的 ID 页面。 <ph type="x-smartling-placeholder"></ph> 不妨详细了解如何使用自定义搜索广告样式。请注意，为请求设置 styleId 后， 广告或相关搜索会以样式呈现，而旧版样式参数则会 已忽略。如果请求中未指定 styleId，则将呈现系统默认样式。

示例：

'styleId': '1234567890'

可选

参数 说明和示例
linkTarget 可选
指定点击广告是在同一窗口中打开，还是在新窗口中打开 窗口。默认值为“_top”。此参数也可以在单元级别使用。
  • '_top' 在同一窗口中打开。
  • '_blank' 在新窗口中打开。

示例：

'linkTarget' : '_blank'
maxTermLength 可选
指定相关搜索字词的最大字符数（包括空格）。 如果未设置，则无上限。

示例：

'maxTermLength' : 50
referrerAdCreative 可选
如果用户到达的内容页面包含内容相关搜索单元 点击广告或链接，且该广告或链接处于您的控制之下； 此参数应设为该广告或链接的广告素材文字。

使用此参数时需遵循以下准则：

  • 该参数只应在“内容相关搜索”请求中提供， 在所有其他请求上都会被忽略。
  • 它只能用于您有意从其他来源获取的流量 网站，不应该用于自然流量。
  • 它应包含标题行、广告内容描述和/或广告或 链接广告素材。
  • 从广告或链接广告素材中省略值（或加入其他值）是 视为违反这些书面说明。
  • 不区分大小写。
  • 接受有效的 UTF-8 编码；支持 Unicode 字符 / 变音符号。
  • Google 可能会使用或忽略您提交的参数。使用时，可能会影响选择 字词和排名。

注意：使用 terms 参数。

示例： 

'referrerAdCreative': 'search for ads related to dental implants'

'referrerAdCreative': 'The Early Signs of Psoriatic Arthritis'
resultsPageQueryParam 可选
指定搜索结果页上的搜索查询的网址参数名称。 如果未指定，则默认为“q”。

示例：

'resultsPageQueryParam' : 'query'
terms 可选
通过此参数，您可以提供以英文逗号分隔的相关搜索字词列表 与相关搜索请求一起返回，尽管 Google 不一定会使用 此处提供的条款。

注意：使用此参数时，referrerAdCreative 也 必需，relatedSearchTargeting 是必需项，且必须设置 更改为“content”。

示例： 

'terms' : 'cars rental, flight ticket'
ignoredPageParams 可选
为包含内容相关搜索的内容页指定网址参数列表 可以放心地忽略这类广告单元，而不影响核心内容或用户体验。

注意：要使相关搜索字词在您的网站上显示，Google 需要先完成以下操作： 抓取您的网页，以确保这些字词与内容相关。如果某个网页尚未被 或被 robots.txt 禁止抓取 AdSense 抓取工具、 我们不会显示您向 Google 提供的建议相关搜索字词。

“内容相关搜索”产品依靠 Google 的内容抓取系统编制索引 网页并生成相关搜索字词。包含查询参数（例如 因为跟踪变量、用户 ID、会话 ID 或其他动态标识符可能会干扰 抓取工具评估网页核心内容的能力，可能会导致不准确或 相关的搜索字词。此网页参数可指示 Google 抓取工具忽略 这些非必要的参数，确保将内容编入索引并减少不必要的抓取 加载。这样，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 的有效设置，以及每个值对返回的广告的影响： <ph type="x-smartling-placeholder">
    </ph>
  • 'high' 返回内容健康的广告。不返回内容不健康或包含色情和成人内容的广告。
  • 'medium'返回内容健康和内容不健康的广告。不返回包含色情和成人内容的广告。
  • 'low' 返回所有类型的广告。

默认情况下，adsafe 设置为“高”。

示例：

'adsafe': 'medium'
adtest 可选
adtest 参数用于表明广告请求属于测试性质。如果 adtest 参数的值为 on，Google 会将相应请求视为测试，不会统计广告展示次数，也不会跟踪点击结果。

当 adtest 参数的值为 on 时，您不会获得任何收入。

如果广告请求中的 adtest 参数设为 on，但相应网域尚未 在“网站”标签页中获得批准，则系统将返回包含“测试广告”的广告叠加层，且无法点击。

此参数应在测试时使用，而不能用于实际生产系统，否则您将不会通过展示的广告获得收入。

“adtest”的默认值为 off。

示例： 

'adtest' : 'on'
channel 可选
您可以加入 AdSense 搜索广告渠道，以跟踪不同网页的效果。使用唯一的频道 ID 在您的 AdSense 账号中创建或由您的技术支持客户经理创建。 点击此处详细了解渠道。

多个渠道应以“+”符号。

示例：

'channel' :  'testA'  
'channel' :  'testA+testB'
hl 可选
此参数用于指定所请求的广告或相关搜索应定位的语言。默认值为 en。

Google 支持所有 AdWords API 语言代码。

注意：广告所定位的语言由相应广告客户指定。如果您在请求中包含此参数，Google 将仅返回针对相应语言或所有语言定位的广告，但 Google 不保证其广告文字也采用指定的语言。

通常情况下，您应当将 hl 参数设置为发送此参数的网页所使用的主要语言。

示例： 

'hl' : 'es'
ie 可选

ie 参数用于设置解读查询字符串时应使用的字符编码方案。

ie 的默认值为 utf-8。

值 标准名称 支持的相关语言
latin1 ISO-8859-1 西欧语言（加泰罗尼亚语、丹麦语、荷兰语、英语、芬兰语、法语、德语、印度尼西亚语、意大利语、挪威语、葡萄牙语、西班牙语、瑞典语）
latin2 ISO-8859-2 东欧语言（克罗地亚语、捷克语、匈牙利语、波兰语、罗马尼亚语、塞尔维亚语、斯洛伐克语、斯洛文尼亚语）
latin3 ISO-8859-3  
latin4 ISO-8859-4 波罗的语（爱沙尼亚语、拉脱维亚语、立陶宛语）
cyrillic ISO-8859-5 保加利亚语、俄语
arabic ISO-8859-6  
greek ISO-8859-7 希腊语
hebrew ISO-8859-8 希伯来语
latin5 ISO-8859-9  
latin6 ISO-8859-10 冰岛语
euc-jp EUC-JP 日语
euc-kr EUC-KR 韩语
sjis Shift_JIS 日语
big5 Big5 繁体中文
gb GB2312 简体中文
utf-8 UTF-8 全部
oe 可选

oe 参数用于设置 Google 在对广告文字进行编码时应采用的字符编码方案。尽管从技术层面来讲，它是可选的，但最好为该形参传递一个值。

oe 的默认值为 utf-8。

值 标准名称 支持的相关语言
latin1 ISO-8859-1 西欧语言（加泰罗尼亚语、丹麦语、荷兰语、英语、芬兰语、法语、德语、印度尼西亚语、意大利语、挪威语、葡萄牙语、西班牙语、瑞典语）
latin2 ISO-8859-2 东欧语言（克罗地亚语、捷克语、匈牙利语、波兰语、罗马尼亚语、塞尔维亚语、斯洛伐克语、斯洛文尼亚语）
latin3 ISO-8859-3  
latin4 ISO-8859-4 波罗的语（爱沙尼亚语、拉脱维亚语、立陶宛语）
cyrillic ISO-8859-5 保加利亚语、俄语
arabic ISO-8859-6  
greek ISO-8859-7 希腊语
hebrew ISO-8859-8 希伯来语
latin5 ISO-8859-9  
latin6 ISO-8859-10 冰岛语
euc-jp EUC-JP 日语
euc-kr EUC-KR 韩语
sjis Shift_JIS 日语
gb GB2312 简体中文
utf-8 UTF-8 全部
ivt 可选
通过此参数，您可以提供一个布尔值，告知 Google 您希望允许投放使用仅用于检测无效流量的 Cookie 的广告，并且针对已征得用户同意和未征得用户同意的流量进行本地存储。
  • true。当此参数不存在或您将其设置为“true”时，我们将设置仅用于检测无效流量的 Cookie，并仅在已征得用户同意的流量中使用本地存储。
  • false 将此参数设置为“false”时我们将设置仅用于检测无效流量的 Cookie，并针对已征得用户同意和未征得用户同意的流量使用本地存储。

默认情况下，IVT 设置为 true。

示例：

'ivt': false

单元级参数说明

这些参数会影响网页上各个广告单元向用户展示的方式，您可以分别为每个广告单元设置各项参数。

必填

参数 说明和示例
container 必需
用于展示广告的空广告容器 <div> 的 ID。

示例：

'container' : 'afscontainer1'
maxTop 当广告单元位于搜索结果上方时，此属性为必需属性。

使用此参数指定要在顶部广告单元中展示的广告数量。

注意：此参数可用于替代“number”参数，参数。此广告单元 应足够宽，以免广告的第一行发生换行。使用 maxTop 参数就会被判定为违反相关政策。

示例：

'maxTop' : 4
width 必需
用于指定广告或相关搜索单元的宽度（以像素为单位）。

示例：

'width' : '700px'
 
'width' : 700

配置设置

参数 说明和示例
adLoadedCallback 可选
指定当广告或相关搜索出现以下情况时调用的 JavaScript 函数： 或者未投放广告或进行相关搜索时。该参数应设为 您实现的 JavaScript 回调函数，用于在 调用完成。

该回调函数采用以下参数：

containerName 广告或相关搜索单元的容器名称。
adsLoaded 如果至少有一个广告或相关搜索字词可供展示，则设置为 true，设置为 false 在未返回广告或相关搜索时触发。
isExperimentVariant 如果自定义样式实验正在运行且 都会选择呈现广告
callbackOptions 包含以下字段的 JSON 对象：
termPositions： 对于相关搜索块，包含一个 map<string,int>发布商提供的数据 这些字词在响应中的零索引位置。如果提供了字词 但未返回，则它将不会出现在地图中。

注意：请测试您的回调函数，以确保它不会生成任何错误， 尤其是那些可能会干扰网页加载的内容。

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