您必须先配置对 Google Cloud Search API 的访问权限,然后才能直接或通过 SDK 使用此 API。本文档介绍了 Cloud Search API REST API 所需的步骤。
1. 创建 API 项目
如需启用该 API,请先创建一个 Google Cloud 项目。此项目是使用 Google Cloud 服务、管理 API 和设置权限的基础。
- 打开 Google Cloud Console。
- 点击“Google Cloud 控制台”右侧的项目下拉菜单,然后选择新建项目。
- 在项目名称字段中输入一个名称。
- (可选)点击修改以更改项目 ID。此 ID 一经创建便无法更改。
- 点击浏览以选择位置,然后点击选择。
- 点击创建。项目通常会在几分钟内准备就绪。
如需了解详情,请参阅创建和管理项目。
2. 启用 API
启用 Cloud Search API 并创建服务账号以获取凭据。
- 在 Google Cloud 控制台横幅的下拉菜单中选择新项目。
- 点击启用 API 和服务。
- 搜索并选择 Google Cloud Search API。
- 点击启用。
如需了解详情,请参阅在 Google Cloud 控制台中管理 API。
3. 创建服务账号凭据
- 在 Google Cloud 控制台中,点击左侧导航栏中的凭据。
- 从创建凭据下拉菜单中选择服务账号。
- 在服务账号名称字段中输入名称。
- (可选)修改服务账号 ID。
- 点击创建并继续。
- 点击完成,进入“服务账号”列表。
- 点击新服务账号的电子邮件地址,然后选择密钥标签页。
- 依次点击添加密钥 > 创建新密钥。
- 选择 JSON,然后点击创建。私钥会下载到您的计算机。
如需了解详情,请参阅服务账号。
4. 确定服务账号电子邮件地址
- 在 Google Cloud 控制台中,选择您的项目。
- 依次点击导航菜单 > IAM 和管理 > 服务账号。
- 记下您的服务账号的电子邮件地址。您需要此账号才能向 Cloud Search 添加数据源。
5. 初始化第三方支持
在调用任何其他 Cloud Search API 之前,初始化对 Google Cloud Search 的第三方支持。
如需初始化第三方支持,请执行以下操作:
- 在 Cloud Search 平台项目中创建 Web 应用凭据。请参阅创建凭据。您需要客户端 ID 和客户端密钥。
- 使用 OAuth 2.0 Playground 获取访问令牌:
- 点击 OAuth 2.0 配置(设置图标),然后选中使用您自己的 OAuth 凭据。
- 输入您的客户端 ID 和客户端密钥。
- 在作用域字段中,输入
https://www.googleapis.com/auth/cloud_search.settings,然后点击 Authorize APIs。 - 点击 Exchange authorization code for tokens。
运行以下 curl 命令,将
[YOUR_ACCESS_TOKEN]替换为您的令牌: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。 如果失败,请与 Cloud Search 支持团队联系。使用
operations.get验证初始化:curl 'https://cloudsearch.googleapis.com/v1/operations/<var>operation_name</var>?key=[YOUR_API_KEY]' \ --header 'Authorization: Bearer [YOUR_ACCESS_TOKEN]' \ --header 'Accept: application/json' \ --compressed当
done为true时,初始化完成。
后续步骤
- 如需将 Cloud Search 与非 Google 代码库(例如 Microsoft® SharePoint®)搭配使用,您必须创建数据源。请参阅添加可供搜索的数据源。
- 设置数据源后,创建并注册架构,以确定 Cloud Search 应如何表示数据。