您必须先配置对 Google Cloud Search API 的访问权限,然后才能 直接使用此 API 或通过 SDK 使用此 API。此文档 涵盖了使用 Google Cloud Search API REST API 所需的步骤。
1. 创建 API 项目
如需启用此 API,您必须先创建一个 Google Cloud 项目。这个 项目构成了创建、启用和使用所有 Google Cloud 云平台的基础, 包括管理 API、启用结算功能、添加和 删除协作者和管理权限。
在页面顶部,点击
“Google Cloud 控制台”右侧此时会显示一个列出当前项目的对话框。点击新建项目。“新建项目”屏幕。
在项目名称字段中输入项目名称。
(可选)点击修改以修改项目 ID。创建项目后,项目 ID 无法更改,因此请选择满足项目生命周期需求的 ID。
如需浏览项目位置,请点击浏览。
点击项目位置,然后点击选择。
点击创建。Console 将导航到“信息中心”页面。项目会在几分钟内创建完成。
如需详细了解如何创建和管理项目,请参阅创建和管理项目。
2. 启用 API
您需要启用 Google Cloud Search API 并创建一个服务账号, 获取凭据。
- 为确保您使用的是新创建的项目,请点击 图标 Google Cloud 控制台横幅,然后选择您新创建的项目。
- 点击启用 API 和服务。“欢迎使用 API 库”页 。
- 导航到 Google Cloud Search API。
- 点击启用。“概览”页面。
如需详细了解如何启用和停用 API,请参阅 在 Google Cloud 控制台中管理 API
3. 创建服务账号凭据
- 在 Google Cloud 控制台中,执行以下操作: 点击左侧导航栏中的凭据。此时会显示“凭据”页面。
- 从创建凭据下拉列表中选择 服务账号。通过 “创建服务账号”页面。
- 在服务账号名称字段中输入名称。
- (可选)修改服务账号 ID。
- 点击创建。“服务账号权限”屏幕。
- 点击继续。“授权用户访问此服务账号”屏幕 。
- 点击创建密钥,然后点击完成。“私钥已保存到您的 计算机”对话框之后,系统会将私钥的副本下载到您的 计算机。
- 点击关闭。
如需详细了解服务账号,请参阅服务账号、Web 应用和已安装的应用
4. 识别电子邮件地址
- 在 Google Cloud 控制台中, 在页面顶部选择您创建的项目。
- 点击 Google Cloud 控制台横幅左侧的导航菜单。
- 点击 IAM 和管理 > 服务账号。
- 在列表中的“服务账号 ID”下记下生成的电子邮件 用于标识您配置的服务账号的地址。将数据源添加到 Cloud Search 时会用到此电子邮件地址。
5. 初始化第三方支持
您必须先初始化第三方,然后才能调用任何其他 Cloud Search API 。
要初始化对 Cloud Search 的第三方支持,请执行以下操作:
您的 Cloud Search 平台项目包含服务账号凭据。 不过,为了初始化第三方支持, 应用凭据有关如何创建 Web 应用的说明 请参阅 创建凭据。 完成此步骤后,您应该会获得客户端 ID 和客户端密钥文件。
使用 Google 的 OAuth 2 Playground 来获取访问令牌:
- 点击“设置”,然后选中 User your own auth credentials(使用您自己的身份验证凭据)。
- 输入第 1 步中的客户端 ID 和客户端密钥。
- 点击关闭。
- 在“范围”字段中,输入
https://www.googleapis.com/auth/cloud_search.settings
然后点击授权。OAuth 2 Playground 会返回授权代码。 - 点击交换令牌的授权代码。系统会返回一个令牌。
要初始化对 Cloud Search 的第三方支持,请使用以下 curl 命令。请务必将
[YOUR_ACCESS_TOKEN]
替换为在 第 2 步:curl --request POST \ 'https://cloudsearch.googleapis.com/v1:initializeCustomer' \ --header 'Authorization: Bearer [YOUR_ACCESS_TOKEN]' \ --header 'Accept: application/json' \ --header 'Content-Type: application/json' \ --data '{}' \ --compressed
如果成功,响应正文将包含一个
operation
。例如:{ name: "operations/customers/01b3fqdm/lro/AOIL6eBv7fEfiZ_hUSpm8KQDt1Mnd6dj5Ru3MXf-jri4xK6Pyb2-Lwfn8vQKg74pgxlxjrY" }
如果操作失败,请与 Cloud Search 支持团队联系。
使用 operations.get 验证 则会初始化第三方支持:
curl \ 'https://cloudsearch.googleapis.com/v1/operations/customers/01b3fqdm/lro/AOIL6eBv7fEfiZ_hUSpm8KQDt1Mnd6dj5Ru3MXf-jri4xK6Pyb2-Lwfn8vQKg74pgxlxjrY?key= [YOUR_API_KEY]' \ --header 'Authorization: Bearer [YOUR_ACCESS_TOKEN]' \ --header 'Accept: application/json' \ --compressed
第三方初始化完成后,它会包含 字段
done
设置为true
。例如:{ name: "operations/customers/01b3fqdm/lro/AOIL6eBv7fEfiZ_hUSpm8KQDt1Mnd6dj5Ru3MXf-jri4xK6Pyb2-Lwfn8vQKg74pgxlxjrY" done: true }
后续步骤
您可以执行以下几个步骤:
如果您计划将 Google Cloud Search 与非 Google 数据代码库(例如 Microsoft® SharePoint®)搭配使用,则必须创建数据源。如需获取有关添加数据源的说明,请参阅添加可供搜索的数据源。
设置数据源后,您可以创建并注册架构,以确定 Google Cloud Search 应如何表示代码库中的数据。