Custom Search JSON API:简介
使用集合让一切井井有条
根据您的偏好保存内容并对其进行分类。
本文档可帮助您熟悉 Custom Search JSON API 及其用法。
前期准备
创建可编程搜索引擎
通过调用 API,用户可针对可编程搜索引擎的现有实例发出请求。因此,在使用 API 之前,您需要在控制台中创建一个。按照教程中的说明详细了解不同的配置选项。创建之后,您可以在概览页的基本部分找到搜索引擎 ID。这是 API 使用的 cx
参数。
使用 API 密钥向 Google 标识您的应用
Custom Search JSON API 需要使用 API 密钥。API 密钥是向 Google 标识客户端的一种方式。
在您获得 API 密钥后,您的应用便可将查询参数 key=yourAPIKey
附加到所有请求网址中。API 密钥可以安全地嵌入到网址中,无需任何编码。
API 概览
API 操作
在 Custom Search JSON API 中,只有一种可以调用的方法:
操作 |
说明 |
REST HTTP 映射 |
list |
返回从可编程搜索引擎请求的搜索结果。 |
GET |
API 数据模型
Custom Search JSON API 的搜索查询结果是一个 JSON 对象,其中包含以下三种类型的数据:
- 描述请求的搜索(也可能是相关的搜索请求)的元数据
- 描述可编程搜索引擎的元数据
- 搜索结果
如需了解详情,请参阅使用 REST 的“响应数据”部分。
该数据模型以 OpenSearch 1.1 规范为基础。除了标准的 OpenSearch 属性之外,Custom Search JSON API 还定义了两个自定义属性和两个自定义查询角色:
- 自定义属性
cx
:可编程搜索引擎的标识符。
safe
:过滤返回结果的安全搜索级别的说明。
- 自定义查询角色
nextPage
:一个角色,指示查询可用于访问结果的下一个逻辑页面(如果有)。
previousPage
:该角色表示可以使用查询来访问结果的上一个逻辑页面(如果有)。
试试看
如需在不编写任何代码的情况下尝试使用此 API 并了解其功能,请访问“试用此 API”工具。
如需查看参数的完整说明,请访问 cse.list 参考文档。
如需了解如何通过 HTTP 请求使用 API,请继续学习使用 REST。
如未另行说明,那么本页面中的内容已根据知识共享署名 4.0 许可获得了许可,并且代码示例已根据 Apache 2.0 许可获得了许可。有关详情,请参阅 Google 开发者网站政策。Java 是 Oracle 和/或其关联公司的注册商标。
最后更新时间 (UTC):2024-08-22。
[{
"type": "thumb-down",
"id": "missingTheInformationINeed",
"label":"没有我需要的信息"
},{
"type": "thumb-down",
"id": "tooComplicatedTooManySteps",
"label":"太复杂/步骤太多"
},{
"type": "thumb-down",
"id": "outOfDate",
"label":"内容需要更新"
},{
"type": "thumb-down",
"id": "translationIssue",
"label":"翻译问题"
},{
"type": "thumb-down",
"id": "samplesCodeIssue",
"label":"示例/代码问题"
},{
"type": "thumb-down",
"id": "otherDown",
"label":"其他"
}]
[{
"type": "thumb-up",
"id": "easyToUnderstand",
"label":"易于理解"
},{
"type": "thumb-up",
"id": "solvedMyProblem",
"label":"解决了我的问题"
},{
"type": "thumb-up",
"id": "otherUp",
"label":"其他"
}]
{"lastModified": "\u6700\u540e\u66f4\u65b0\u65f6\u95f4 (UTC)\uff1a2024-08-22\u3002"}
[[["易于理解","easyToUnderstand","thumb-up"],["解决了我的问题","solvedMyProblem","thumb-up"],["其他","otherUp","thumb-up"]],[["没有我需要的信息","missingTheInformationINeed","thumb-down"],["太复杂/步骤太多","tooComplicatedTooManySteps","thumb-down"],["内容需要更新","outOfDate","thumb-down"],["翻译问题","translationIssue","thumb-down"],["示例/代码问题","samplesCodeIssue","thumb-down"],["其他","otherDown","thumb-down"]],["最后更新时间 (UTC):2024-08-22。"]]