本文档将帮助您熟悉 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 的用途，请访问“试用此 API”工具。
如需查看参数的完整说明，请访问 cse.list 参考文档。
如需了解如何通过 HTTP 请求使用该 API，请继续参阅使用 REST。