响应自定义搜索请求。
JSON 表示法 |
---|
{ "kind": string, "url": { "type": string, "template": string }, "queries": { "previousPage": [ { "title": string, "totalResults": string, "searchTerms": string, "count": integer, "startIndex": integer, "startPage": integer, "language": string, "inputEncoding": string, "outputEncoding": string, "safe": string, "cx": string, "sort": string, "filter": string, "gl": string, "cr": string, "googleHost": string, "disableCnTwTranslation": string, "hq": string, "hl": string, "siteSearch": string, "siteSearchFilter": string, "exactTerms": string, "excludeTerms": string, "linkSite": string, "orTerms": string, "relatedSite": string, "dateRestrict": string, "lowRange": string, "highRange": string, "fileType": string, "rights": string, "searchType": string, "imgSize": string, "imgType": string, "imgColorType": string, "imgDominantColor": string } ], "request": [ { "title": string, "totalResults": string, "searchTerms": string, "count": integer, "startIndex": integer, "startPage": integer, "language": string, "inputEncoding": string, "outputEncoding": string, "safe": string, "cx": string, "sort": string, "filter": string, "gl": string, "cr": string, "googleHost": string, "disableCnTwTranslation": string, "hq": string, "hl": string, "siteSearch": string, "siteSearchFilter": string, "exactTerms": string, "excludeTerms": string, "linkSite": string, "orTerms": string, "relatedSite": string, "dateRestrict": string, "lowRange": string, "highRange": string, "fileType": string, "rights": string, "searchType": string, "imgSize": string, "imgType": string, "imgColorType": string, "imgDominantColor": string } ], "nextPage": [ { "title": string, "totalResults": string, "searchTerms": string, "count": integer, "startIndex": integer, "startPage": integer, "language": string, "inputEncoding": string, "outputEncoding": string, "safe": string, "cx": string, "sort": string, "filter": string, "gl": string, "cr": string, "googleHost": string, "disableCnTwTranslation": string, "hq": string, "hl": string, "siteSearch": string, "siteSearchFilter": string, "exactTerms": string, "excludeTerms": string, "linkSite": string, "orTerms": string, "relatedSite": string, "dateRestrict": string, "lowRange": string, "highRange": string, "fileType": string, "rights": string, "searchType": string, "imgSize": string, "imgType": string, "imgColorType": string, "imgDominantColor": string } ] }, "promotions": [ { object ( |
字段 | |
---|---|
kind |
当前对象类型的唯一标识符。对于此 API,即为 customsearch#search。 |
url |
定义此 API 模板的 OpenSearch 网址元素。 |
url.type |
Custom Search JSON API 的 OpenSearch 网址模板的 MIME 类型。 |
url.template |
此 API 的实际 OpenSearch 模板。 |
queries |
包含一个或多个由角色名称键控的查询元数据集。可能的角色名称包括由 OpenSearch 查询角色定义的 |
queries.previousPage[] |
表示上一页的元数据(如果适用)。 |
queries.previousPage[].title |
查询的说明。 |
queries.previousPage[].totalResults |
搜索结果总数的估算值。可能不准确。 |
queries.previousPage[].searchTerms |
用户输入的搜索字词。 |
queries.previousPage[].count |
在此集中返回的搜索结果数量。 |
queries.previousPage[].startIndex |
当前搜索结果集在总结果集中的索引,其中第一个结果的索引为 1。 |
queries.previousPage[].startPage |
此组结果的页码,其中页面长度由 |
queries.previousPage[].language |
搜索结果的语言。 |
queries.previousPage[].inputEncoding |
支持搜索请求的字符编码。 |
queries.previousPage[].outputEncoding |
搜索结果支持的字符编码。 |
queries.previousPage[].safe |
指定用于滤除成人结果的安全搜索级别。这是未在 OpenSearch 规范中定义的自定义属性。有效的参数值包括:
|
queries.previousPage[].cx |
使用可编程搜索引擎控制面板创建的引擎的标识符。这是未在 OpenSearch 规范中定义的自定义属性。此参数是必需参数。 |
queries.previousPage[].sort |
指定应根据指定表达式对结果进行排序。例如,按日期排序。 |
queries.previousPage[].filter |
启用或停用 Google 搜索结果自动过滤功能。有关 Google 搜索结果过滤器的详情,请参阅自动过滤。此参数的有效值包括:
注意:默认情况下,Google 会对所有搜索结果应用过滤条件,以提高这些结果的质量。 |
queries.previousPage[].gl |
提升来源国家/地区与参数值相匹配的搜索结果。如需查看有效值列表,请参阅国家/地区代码。 在 WebSearch 请求中指定 |
queries.previousPage[].cr |
将搜索结果限制为来自特定国家/地区的文档。您可以在 Google WebSearch 通过分析以下内容来确定文档所在的国家/地区:
如需查看此参数的有效值列表,请参阅国家/地区 (cr) 参数值。 |
queries.previousPage[].googleHost |
指定应将搜索限制到哪个 Google 网域(例如 google.com、google.de 或 google.fr)。 |
queries.previousPage[].disableCnTwTranslation |
启用或停用简体中文和繁体中文搜索功能。 支持的值包括:
|
queries.previousPage[].hq |
向查询附加指定的查询字词,就像使用逻辑 |
queries.previousPage[].hl |
指定界面的界面语言(主语言)。明确设置此参数可提高搜索结果的效果和质量。 如需了解详情,请参阅国际化查询和结果呈现的界面语言部分;如需了解受支持语言的列表,请参阅支持的界面语言。 |
queries.previousPage[].siteSearch |
将结果限制为来自指定网站的网址。 |
queries.previousPage[].siteSearchFilter |
指定是包含还是排除
|
queries.previousPage[].exactTerms |
标识搜索结果中所有文档必须包含的词组。 |
queries.previousPage[].excludeTerms |
标识不应在搜索结果的任何文档中出现的字词或词组。 |
queries.previousPage[].linkSite |
指定所有结果都应包含指向特定网址的链接。 |
queries.previousPage[].orTerms |
提供要在文档中检查的其他搜索字词,其中搜索结果中的每个文档都必须至少包含一个其他搜索字词。对于此类查询,您也可以使用布尔值 OR 查询字词。 |
queries.previousPage[].relatedSite |
指定所有搜索结果都应是与指定网址相关的网页。参数值应为网址。 |
queries.previousPage[].dateRestrict |
根据日期将结果限制为网址。支持的值包括:
|
queries.previousPage[].lowRange |
指定搜索范围的起始值。使用 |
queries.previousPage[].highRange |
指定搜索范围的结束值。使用 |
queries.previousPage[].fileType |
将结果限制为指定扩展名的文件。Google 支持的文件类型包括:
日后我们可能会添加更多文件类型。您可以随时通过 Google 的文件类型常见问题解答找到最新列表。 |
queries.previousPage[].rights |
基于许可的过滤条件。支持的值包括:
|
queries.previousPage[].searchType |
允许的值为 |
queries.previousPage[].imgSize |
将结果限制为指定大小的图片。支持的值包括:
|
queries.previousPage[].imgType |
将结果限制为指定类型的图片。支持的值包括:
|
queries.previousPage[].imgColorType |
将结果限制为指定颜色类型的图片。支持的值包括:
|
queries.previousPage[].imgDominantColor |
将结果限制为具有特定主色的图片。支持的值包括:
|
queries.request[] |
表示当前请求的元数据。 |
queries.request[].title |
查询的说明。 |
queries.request[].totalResults |
搜索结果总数的估算值。可能不准确。 |
queries.request[].searchTerms |
用户输入的搜索字词。 |
queries.request[].count |
在此集中返回的搜索结果数量。 |
queries.request[].startIndex |
当前搜索结果集在总结果集中的索引,其中第一个结果的索引为 1。 |
queries.request[].startPage |
此组结果的页码,其中页面长度由 |
queries.request[].language |
搜索结果的语言。 |
queries.request[].inputEncoding |
支持搜索请求的字符编码。 |
queries.request[].outputEncoding |
搜索结果支持的字符编码。 |
queries.request[].safe |
指定用于滤除成人结果的安全搜索级别。这是未在 OpenSearch 规范中定义的自定义属性。有效的参数值包括:
|
queries.request[].cx |
使用可编程搜索引擎控制面板创建的引擎的标识符。这是未在 OpenSearch 规范中定义的自定义属性。此参数是必需参数。 |
queries.request[].sort |
指定应根据指定表达式对结果进行排序。例如,按日期排序。 |
queries.request[].filter |
启用或停用 Google 搜索结果自动过滤功能。有关 Google 搜索结果过滤器的详情,请参阅自动过滤。此参数的有效值包括:
注意:默认情况下,Google 会对所有搜索结果应用过滤条件,以提高这些结果的质量。 |
queries.request[].gl |
提升来源国家/地区与参数值相匹配的搜索结果。如需查看有效值列表,请参阅国家/地区代码。 在 WebSearch 请求中指定 |
queries.request[].cr |
将搜索结果限制为来自特定国家/地区的文档。您可以在 Google WebSearch 通过分析以下内容来确定文档所在的国家/地区:
如需查看此参数的有效值列表,请参阅国家/地区 (cr) 参数值。 |
queries.request[].googleHost |
指定应将搜索限制到哪个 Google 网域(例如 google.com、google.de 或 google.fr)。 |
queries.request[].disableCnTwTranslation |
启用或停用简体中文和繁体中文搜索功能。 支持的值包括:
|
queries.request[].hq |
向查询附加指定的查询字词,就像使用逻辑 |
queries.request[].hl |
指定界面的界面语言(主语言)。明确设置此参数可提高搜索结果的效果和质量。 如需了解详情,请参阅国际化查询和结果呈现的界面语言部分;如需了解受支持语言的列表,请参阅支持的界面语言。 |
queries.request[].siteSearch |
将结果限制为来自指定网站的网址。 |
queries.request[].siteSearchFilter |
指定是包含还是排除
|
queries.request[].exactTerms |
标识搜索结果中所有文档必须包含的词组。 |
queries.request[].excludeTerms |
标识不应在搜索结果的任何文档中出现的字词或词组。 |
queries.request[].linkSite |
指定所有结果都应包含指向特定网址的链接。 |
queries.request[].orTerms |
提供要在文档中检查的其他搜索字词,其中搜索结果中的每个文档都必须至少包含一个其他搜索字词。对于此类查询,您也可以使用布尔值 OR 查询字词。 |
queries.request[].relatedSite |
指定所有搜索结果都应是与指定网址相关的网页。参数值应为网址。 |
queries.request[].dateRestrict |
根据日期将结果限制为网址。支持的值包括:
|
queries.request[].lowRange |
指定搜索范围的起始值。使用 |
queries.request[].highRange |
指定搜索范围的结束值。使用 |
queries.request[].fileType |
将结果限制为指定扩展名的文件。Google 支持的文件类型包括:
日后我们可能会添加更多文件类型。您可以随时通过 Google 的文件类型常见问题解答找到最新列表。 |
queries.request[].rights |
基于许可的过滤条件。支持的值包括:
|
queries.request[].searchType |
允许的值为 |
queries.request[].imgSize |
将结果限制为指定大小的图片。支持的值包括:
|
queries.request[].imgType |
将结果限制为指定类型的图片。支持的值包括:
|
queries.request[].imgColorType |
将结果限制为指定颜色类型的图片。支持的值包括:
|
queries.request[].imgDominantColor |
将结果限制为具有特定主色的图片。支持的值包括:
|
queries.nextPage[] |
表示下一页结果的元数据(如果适用)。 |
queries.nextPage[].title |
查询的说明。 |
queries.nextPage[].totalResults |
搜索结果总数的估算值。可能不准确。 |
queries.nextPage[].searchTerms |
用户输入的搜索字词。 |
queries.nextPage[].count |
在此集中返回的搜索结果数量。 |
queries.nextPage[].startIndex |
当前搜索结果集在总结果集中的索引,其中第一个结果的索引为 1。 |
queries.nextPage[].startPage |
此组结果的页码,其中页面长度由 |
queries.nextPage[].language |
搜索结果的语言。 |
queries.nextPage[].inputEncoding |
支持搜索请求的字符编码。 |
queries.nextPage[].outputEncoding |
搜索结果支持的字符编码。 |
queries.nextPage[].safe |
指定用于滤除成人结果的安全搜索级别。这是未在 OpenSearch 规范中定义的自定义属性。有效的参数值包括:
|
queries.nextPage[].cx |
使用可编程搜索引擎控制面板创建的引擎的标识符。这是未在 OpenSearch 规范中定义的自定义属性。此参数是必需参数。 |
queries.nextPage[].sort |
指定应根据指定表达式对结果进行排序。例如,按日期排序。 |
queries.nextPage[].filter |
启用或停用 Google 搜索结果自动过滤功能。有关 Google 搜索结果过滤器的详情,请参阅自动过滤。此参数的有效值包括:
注意:默认情况下,Google 会对所有搜索结果应用过滤条件,以提高这些结果的质量。 |
queries.nextPage[].gl |
提升来源国家/地区与参数值相匹配的搜索结果。如需查看有效值列表,请参阅国家/地区代码。 在 WebSearch 请求中指定 |
queries.nextPage[].cr |
将搜索结果限制为来自特定国家/地区的文档。您可以在 Google WebSearch 通过分析以下内容来确定文档所在的国家/地区:
如需查看此参数的有效值列表,请参阅国家/地区 (cr) 参数值。 |
queries.nextPage[].googleHost |
指定应将搜索限制到哪个 Google 网域(例如 google.com、google.de 或 google.fr)。 |
queries.nextPage[].disableCnTwTranslation |
启用或停用简体中文和繁体中文搜索功能。 支持的值包括:
|
queries.nextPage[].hq |
向查询附加指定的查询字词,就像使用逻辑 |
queries.nextPage[].hl |
指定界面的界面语言(主语言)。明确设置此参数可提高搜索结果的效果和质量。 如需了解详情,请参阅国际化查询和结果呈现的界面语言部分;如需了解受支持语言的列表,请参阅支持的界面语言。 |
queries.nextPage[].siteSearch |
将结果限制为来自指定网站的网址。 |
queries.nextPage[].siteSearchFilter |
指定是包含还是排除
|
queries.nextPage[].exactTerms |
标识搜索结果中所有文档必须包含的词组。 |
queries.nextPage[].excludeTerms |
标识不应在搜索结果的任何文档中出现的字词或词组。 |
queries.nextPage[].linkSite |
指定所有结果都应包含指向特定网址的链接。 |
queries.nextPage[].orTerms |
提供要在文档中检查的其他搜索字词,其中搜索结果中的每个文档都必须至少包含一个其他搜索字词。对于此类查询,您也可以使用布尔值 OR 查询字词。 |
queries.nextPage[].relatedSite |
指定所有搜索结果都应是与指定网址相关的网页。参数值应为网址。 |
queries.nextPage[].dateRestrict |
根据日期将结果限制为网址。支持的值包括:
|
queries.nextPage[].lowRange |
指定搜索范围的起始值。使用 |
queries.nextPage[].highRange |
指定搜索范围的结束值。使用 |
queries.nextPage[].fileType |
将结果限制为指定扩展名的文件。Google 支持的文件类型包括:
日后我们可能会添加更多文件类型。您可以随时通过 Google 的文件类型常见问题解答找到最新列表。 |
queries.nextPage[].rights |
基于许可的过滤条件。支持的值包括:
|
queries.nextPage[].searchType |
允许的值为 |
queries.nextPage[].imgSize |
将结果限制为指定大小的图片。支持的值包括:
|
queries.nextPage[].imgType |
将结果限制为指定类型的图片。支持的值包括:
|
queries.nextPage[].imgColorType |
将结果限制为指定颜色类型的图片。支持的值包括:
|
queries.nextPage[].imgDominantColor |
将结果限制为具有特定主色的图片。支持的值包括:
|
promotions[] |
一组促销活动。仅当自定义搜索引擎的配置文件为指定查询定义任何置顶结果时,此字段才会显示。 |
context |
与指定搜索引擎关联的元数据和优化内容,包括:
|
searchInformation |
关于此搜索的元数据,包括搜索时间和搜索结果总数。 |
searchInformation.searchTime |
服务器返回搜索结果所用的时间。 |
searchInformation.formattedSearchTime |
服务器返回搜索结果所用的时间,其格式取决于语言区域样式。 |
searchInformation.totalResults |
查询返回的搜索结果总数。 |
searchInformation.formattedTotalResults |
根据语言区域样式设置的搜索结果总数。 |
spelling |
封装更正后的查询。 |
spelling.correctedQuery |
更正后的查询。 |
spelling.htmlCorrectedQuery |
已更正的查询,采用 HTML 格式。 |
items[] |
当前自定义搜索结果集。 |
促销
促销结果。
JSON 表示法 |
---|
{ "title": string, "htmlTitle": string, "link": string, "displayLink": string, "bodyLines": [ { "title": string, "htmlTitle": string, "url": string, "link": string } ], "image": { "source": string, "width": integer, "height": integer } } |
字段 | |
---|---|
title |
促销活动的标题。 |
htmlTitle |
促销活动的标题,采用 HTML 格式。 |
link |
促销的网址。 |
displayLink |
此搜索结果网址的缩略版本,例如 www.example.com。 |
bodyLines[] |
此推广活动的一组块对象。 |
bodyLines[].title |
阻止对象的文本(如果阻止对象包含文本)。 |
bodyLines[].htmlTitle |
块对象的 HTML 文本(如果包含文本)。 |
bodyLines[].url |
阻止对象的链接网址(如果有)。 |
bodyLines[].link |
阻止对象的链接的定位文字(如果阻止对象包含链接)。 |
image |
与此促销活动关联的图片(如果有)。 |
image.source |
此推广链接的图片的网址。 |
image.width |
图片宽度(以像素为单位)。 |
image.height |
图片高度(以像素为单位)。 |
结果
自定义搜索结果。
JSON 表示法 |
---|
{ "kind": string, "title": string, "htmlTitle": string, "link": string, "displayLink": string, "snippet": string, "htmlSnippet": string, "cacheId": string, "formattedUrl": string, "htmlFormattedUrl": string, "pagemap": { object }, "mime": string, "fileFormat": string, "image": { "contextLink": string, "height": integer, "width": integer, "byteSize": integer, "thumbnailLink": string, "thumbnailHeight": integer, "thumbnailWidth": integer }, "labels": [ { "name": string, "displayName": string, "label_with_op": string } ] } |
字段 | |
---|---|
kind |
当前对象类型的唯一标识符。对于此 API,其值为 |
title |
搜索结果的标题(纯文本格式)。 |
htmlTitle |
搜索结果的标题(HTML 格式)。 |
link |
搜索结果所指向的完整网址,例如 http://www.example.com/foo/bar。 |
displayLink |
此搜索结果网址的缩略版本,例如 www.example.com。 |
snippet |
搜索结果的摘要(纯文本格式)。 |
htmlSnippet |
搜索结果的摘要(HTML 格式)。 |
cacheId |
指示搜索结果的 Google 缓存版本的 ID。 |
formattedUrl |
每个搜索结果摘要之后显示的网址。 |
htmlFormattedUrl |
显示在每个搜索结果摘要之后的 HTML 格式的网址。 |
pagemap |
包含该搜索结果的 PageMap 信息。 |
mime |
搜索结果的 MIME 类型。 |
fileFormat |
搜索结果的文件格式。 |
image |
封装搜索结果中返回的图片的所有相关信息。 |
image.contextLink |
指向图片托管网页的网址。 |
image.height |
图片的高度,以像素为单位。 |
image.width |
图片的宽度(以像素为单位)。 |
image.byteSize |
图片的大小(以字节为单位)。 |
image.thumbnailLink |
指向缩略图的网址。 |
image.thumbnailHeight |
缩略图的高度(以像素为单位)。 |
image.thumbnailWidth |
缩略图的宽度(以像素为单位)。 |
labels[] |
封装优化标签的所有相关信息。 |
labels[].name |
优化标签的名称,可用于优化搜索。请勿在界面中显示此名称,而应使用 displayName。 |
labels[].displayName |
优化标签的显示名称。这是您应该在界面中显示的名称。 |
labels[].label_with_op |
优化标签和关联的优化操作。 |