Method: cse.siterestrict.list

返回有关执行的搜索的元数据、用于搜索的引擎的相关元数据,以及搜索结果。使用一小部分网址格式。

HTTP 请求

GET https://customsearch.googleapis.com/customsearch/v1/siterestrict

网址采用 gRPC 转码语法。

查询参数

参数
c2coff

string

启用或停用简体中文和繁体中文搜索

此参数的默认值为 0(零),表示该功能已启用。支持的值包括:

  • 1:已停用

  • 0:已启用(默认)

cr

string

将搜索结果限制为来自特定国家/地区的文档。您可以在 cr 参数值中使用布尔值运算符

Google 搜索通过分析以下内容来确定文档所在的国家/地区:

  • 文档网址的顶级域名 (TLD)

  • Web 服务器 IP 地址的地理位置

如需查看此参数的有效值列表,请参阅国家/地区参数值页面。

cx

string

用于此请求的可编程搜索引擎 ID。

dateRestrict

string

根据日期将结果限制为网址。支持的值包括:

  • d[number]:请求过去指定天数的结果。

  • w[number]:请求过去指定周数的结果。

  • m[number]:请求过去指定月份数的结果。

  • y[number]:请求过去指定年份的结果。

exactTerms

string

标识搜索结果中所有文档必须包含的词组。

excludeTerms

string

标识不应在搜索结果的任何文档中出现的字词或词组。

fileType

string

将结果限制为指定扩展名的文件。您可以在 Search Console 帮助中心内找到 Google 可编入索引的文件类型列表。

filter

string

用于开启或关闭重复内容过滤器的控件。

  • 有关 Google 搜索结果过滤器的详情,请参阅自动过滤。请注意,主机排除过滤功能仅适用于多网站搜索。

  • 默认情况下,Google 会对所有搜索结果应用过滤,以提高这些结果的质量。

可接受的值为:

  • 0:关闭重复内容过滤器。

  • 1:开启重复内容过滤器。

gl

string

最终用户的地理位置。

  • gl 参数值是两个字母的国家/地区代码。gl 参数用于提升原始国家/地区与该参数值匹配的搜索结果。请参阅国家/地区代码页面,查看有效值列表。

  • 指定 gl 参数值应会产生更相关的结果。对于国际客户来说尤其如此,尤其是美国以外的英语国家/地区的客户也是如此。

googlehost

string

已弃用。使用 gl 形参可实现类似的效果。

用于执行搜索的本地 Google 网域(例如 google.com、google.de 或 google.fr)。

highRange

string

指定搜索范围的结束值。

  • 使用 lowRangehighRange 可为查询附加 lowRange...highRange 的包容性搜索范围。
hl

string

设置界面语言。

hq

string

向查询附加指定的查询字词,就像使用逻辑 AND 运算符合并这些字词一样。

imgColorType

enum (ImgColorType)

返回黑白、灰度、透明或彩色图片。可接受的值为:

  • "color"

  • "gray"

  • "mono":黑白

  • "trans":透明背景

imgDominantColor

enum (ImgDominantColor)

返回特定主色的图片。可接受的值为:

  • "black"

  • "blue"

  • "brown"

  • "gray"

  • "green"

  • "orange"

  • "pink"

  • "purple"

  • "red"

  • "teal"

  • "white"

  • "yellow"

imgSize

enum (ImgSize)

返回指定尺寸的图片。可接受的值为:

  • "huge"

  • "icon"

  • "large"

  • "medium"

  • "small"

  • "xlarge"

  • "xxlarge"

imgType

enum (ImgType)

返回某个类型的图片。可接受的值为:

  • "clipart"

  • "face"

  • "lineart"

  • "stock"

  • "photo"

  • "animated"

lowRange

string

指定搜索范围的起始值。使用 lowRangehighRange 可为查询附加 lowRange...highRange 的包容性搜索范围。

lr

string

将搜索范围限制为以特定语言撰写的文档(例如,lr=lang_ja).

可接受的值为:

  • "lang_ar":阿拉伯语

  • "lang_bg":保加利亚语

  • "lang_ca":加泰罗尼亚语

  • "lang_cs":捷克语

  • "lang_da":丹麦语

  • "lang_de":德语

  • "lang_el":希腊语

  • "lang_en":英语

  • "lang_es":西班牙语

  • "lang_et":爱沙尼亚语

  • "lang_fi":芬兰语

  • "lang_fr":法语

  • "lang_hr":克罗地亚语

  • "lang_hu":匈牙利语

  • "lang_id":印度尼西亚语

  • "lang_is":冰岛语

  • "lang_it":意大利语

  • "lang_iw":希伯来语

  • "lang_ja":日语

  • "lang_ko":韩语

  • "lang_lt":立陶宛语

  • "lang_lv":拉脱维亚语

  • "lang_nl":荷兰语

  • "lang_no":挪威语

  • "lang_pl":波兰语

  • "lang_pt":葡萄牙语

  • "lang_ro":罗马尼亚语

  • "lang_ru":俄语

  • "lang_sk":斯洛伐克语

  • "lang_sl":斯洛文尼亚语

  • "lang_sr":塞尔维亚语

  • "lang_sv":瑞典语

  • "lang_tr":土耳其语

  • "lang_zh-CN":中文(简体)

  • "lang_zh-TW":中文(繁体)

num

integer

要返回的搜索结果数。

  • 有效值为 1 到 10 之间的整数(包括 1 和 10)。
orTerms

string

提供要在文档中检查的其他搜索字词,其中搜索结果中的每个文档都必须至少包含一个其他搜索字词。

q

string

查询

relatedSite
(deprecated)

string

已弃用。

rights

string

基于许可的过滤条件。支持的值包括:cc_publicdomaincc_attributecc_sharealikecc_noncommercialcc_nonderived 以及这些值的组合。请参阅典型组合

safe

enum (Safe)

搜索安全级别。可接受的值为:

  • "active":启用安全搜索过滤功能。

  • "off":停用安全搜索过滤功能。(默认)

searchType

enum (SearchType)

指定搜索类型:image。如果未指定,则结果将仅限于网页。

可接受的值为:

  • "image":自定义图片搜索。
siteSearchFilter

enum (SiteSearchFilter)

控制是否包含或排除 siteSearch 参数中指定的网站的结果。

可接受的值为:

  • "e":排除

  • "i":包含

sort

string

要应用于结果的排序表达式。排序参数指定根据指定表达式对结果进行排序,即按日期排序。示例:sort=date

start

integer (uint32 format)

要返回的第一个结果的索引。每页的默认结果数为 10,因此 &start=11 将从结果第二页的顶部开始。注意:JSON API 绝不会返回超过 100 个结果,即使与查询匹配的文档超过 100 个,因此将 start + num 的总和设置为大于 100 的数字也会产生错误。另请注意,num 的最大值为 10。

请求正文

请求正文必须为空。

响应正文

如果成功,则响应正文包含一个 Search 实例。

授权范围

需要以下 OAuth 作用域:

  • https://www.googleapis.com/auth/cse

有关详情,请参阅 OAuth 2.0 概览