返回有关执行的搜索的元数据、用于搜索的引擎的相关元数据,以及搜索结果。使用一小部分网址格式。
HTTP 请求
GET https://customsearch.googleapis.com/customsearch/v1/siterestrict
网址采用 gRPC 转码语法。
查询参数
| 参数 | |
|---|---|
| c2coff | 
 启用或停用简体中文和繁体中文搜索。 此参数的默认值为 0(零),表示该功能已启用。支持的值包括: 
 | 
| cr | 
 将搜索结果限制为来自特定国家/地区的文档。您可以在 cr 参数值中使用布尔值运算符。 Google 搜索通过分析以下内容来确定文档所在的国家/地区: 
 如需查看此参数的有效值列表,请参阅国家/地区参数值页面。 | 
| cx | 
 用于此请求的可编程搜索引擎 ID。 | 
| dateRestrict | 
 根据日期将结果限制为网址。支持的值包括: 
 | 
| exactTerms | 
 标识搜索结果中所有文档必须包含的词组。 | 
| excludeTerms | 
 标识不应在搜索结果的任何文档中出现的字词或词组。 | 
| fileType | 
 将结果限制为指定扩展名的文件。您可以在 Search Console 帮助中心内找到 Google 可编入索引的文件类型列表。 | 
| filter | 
 用于开启或关闭重复内容过滤器的控件。 
 可接受的值为: 
 | 
| gl | 
 最终用户的地理位置。 
 | 
| googlehost | 
 已弃用。使用  用于执行搜索的本地 Google 网域(例如 google.com、google.de 或 google.fr)。 | 
| highRange | 
 指定搜索范围的结束值。 
 | 
| hl | 
 设置界面语言。 
 | 
| hq | 
 向查询附加指定的查询字词,就像使用逻辑 AND 运算符合并这些字词一样。 | 
| imgColorType | 
 返回黑白、灰度、透明或彩色图片。可接受的值为: 
 | 
| imgDominantColor | 
 返回特定主色的图片。可接受的值为: 
 | 
| imgSize | 
 返回指定尺寸的图片。可接受的值为: 
 | 
| imgType | 
 返回某个类型的图片。可接受的值为: 
 | 
| linkSite | 
 指定所有搜索结果都应包含指向特定网址的链接。 | 
| lowRange | 
 指定搜索范围的起始值。使用  | 
| lr | 
 将搜索范围限制为以特定语言撰写的文档(例如, 可接受的值为: 
 | 
| num | 
 要返回的搜索结果数。 
 | 
| orTerms | 
 提供要在文档中检查的其他搜索字词,其中搜索结果中的每个文档都必须至少包含一个其他搜索字词。 | 
| q | 
 查询 | 
| relatedSite | 
 已弃用。 | 
| rights | 
 基于许可的过滤条件。支持的值包括: | 
| safe | 
 搜索安全级别。可接受的值为: 
 | 
| searchType | 
 指定搜索类型: 可接受的值为: 
 | 
| siteSearch | 
 指定应始终从结果中包含或排除的给定网站(请参阅下面的  | 
| siteSearchFilter | 
 控制是否包含或排除  可接受的值为: 
 | 
| sort | 
 要应用于结果的排序表达式。排序参数指定根据指定表达式对结果进行排序,即按日期排序。示例:sort=date。 | 
| start | 
 要返回的第一个结果的索引。每页的默认结果数为 10,因此  | 
请求正文
请求正文必须为空。
响应正文
如果成功,则响应正文包含一个 Search 实例。
授权范围
需要以下 OAuth 作用域:
- https://www.googleapis.com/auth/cse
有关详情,请参阅 OAuth 2.0 概览。