配置对 Google Cloud Search REST API 的访问权限

您必须先配置对 Google Cloud Search REST API 的访问权限,然后才能直接或通过 SDK 使用此 API。本文档介绍了使用 Google Cloud Search REST API 所需的步骤。

1. 创建 API 项目

要启用此 API,您必须先创建 Google Cloud Platform 项目。该项目构成了创建、启用和使用所有 Google Cloud Platform (GCP) 服务的基础,包括管理 API、启用结算功能、添加和移除协作者以及管理权限。

  1. 打开 Google Cloud Console

  2. 在页面顶部,点击“Google Cloud Console”右侧的 。 此时会显示一个列出当前项目的对话框。

  3. 点击新建项目。此时,系统会显示“New Project”屏幕。

  4. Project Name 字段中输入项目名称。

  5. (可选)点击修改以修改项目 ID。创建项目后,项目 ID 无法更改,因此请选择满足项目生命周期需求的 ID。

  6. 如需浏览项目的位置,请点击浏览

  7. 点击项目位置,然后点击选择

  8. 点击创建。Console 将导航到“信息中心”页面。项目会在几分钟内创建完成。

如需详细了解如何创建和管理项目,请参阅创建和管理项目

2. 启用该 API

您需要启用 Cloud Search REST API 并创建服务帐号以获取凭据。

  1. 为确保您使用的是新创建的项目,请点击 Google Cloud Console 横幅右侧的 图标,然后选择新创建的项目。
  2. 点击启用 API 和服务。此时将显示“欢迎使用 API 库”页面。
  3. 导航到 Google Cloud Search API
  4. 点击启用。系统会显示“概览”页。

如需详细了解如何启用和停用 API,请参阅在 Google Cloud Console 中管理 API

3.创建服务帐号凭据

  1. Cloud Platform Console 中,点击左侧导航栏中的凭据。此时会显示“凭据”页面。
  2. 创建凭据下拉列表中,选择服务帐号。系统会显示“创建服务帐号”页面。
  3. 服务帐号名称字段中输入名称。
  4. (可选)修改服务帐号 ID。
  5. 点击创建。系统会显示“服务帐号权限”屏幕。
  6. 点击继续。此时,系统会显示“向用户授予访问此服务帐号的权限”屏幕。
  7. 点击创建密钥,然后点击完成。此时将显示“私钥已保存到您的计算机”对话框,该私钥的副本会下载到您的计算机。
  8. 点击关闭

如需详细了解服务帐号,请参阅服务帐号、Web 应用和已安装的应用

4.识别电子邮件地址

  1. Cloud Platform Console 中,选择您在本页面顶部创建的项目。
  2. 点击 Google Cloud Console 横幅左侧的导航菜单。
  3. 点击 IAM 和管理 > 服务帐号
  4. 在列表中,在“服务帐号 ID”下,记下生成的电子邮件地址,用于标识您配置的服务帐号。将数据源添加到 Cloud Search 时会用到此电子邮件地址。

5. 初始化第三方支持

您必须先初始化 Google Cloud Search 的第三方支持,然后才能调用任何其他 Cloud Search API。

如需初始化 Cloud Search 的第三方支持,请执行以下操作:

  1. 您的 Cloud Search 平台项目包含服务帐号凭据。 但是,为了初始化第三方支持,您必须创建 Web 应用凭据。如需了解如何创建 Web 应用凭据,请参阅创建凭据。完成此步骤后,您应具备客户端 ID 和客户端密钥文件。

  2. 使用 Google 的 OAuth 2 园地获取访问令牌:

    1. 点击“设置”,然后选中用户您自己的身份验证凭据
    2. 输入在第 1 步中获得的客户端 ID 和客户端密钥。
    3. 点击关闭
    4. 在范围字段中,输入 https://www.googleapis.com/auth/cloud_search.settings 并点击授权。OAuth 2 园地会返回授权代码。
    5. 点击交换令牌的授权代码。返回令牌。
  3. 如需初始化 Cloud Search 的第三方支持,请使用以下 curl 命令。请务必将第 2 步中获得的令牌替换为 [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 实例。例如:

    {
    name: "operations/customers/01b3fqdm/lro/AOIL6eBv7fEfiZ_hUSpm8KQDt1Mnd6dj5Ru3MXf-jri4xK6Pyb2-Lwfn8vQKg74pgxlxjrY"
    }
    

    如果创建失败,请与 Cloud Search 支持团队联系。

  4. 使用 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
    

    第三方初始化完成后,其中包含设为 true 的字段 done。例如:

    {
    name: "operations/customers/01b3fqdm/lro/AOIL6eBv7fEfiZ_hUSpm8KQDt1Mnd6dj5Ru3MXf-jri4xK6Pyb2-Lwfn8vQKg74pgxlxjrY"
    done: true
    }
    

后续步骤

您可以执行以下几个步骤:

  1. 如果您计划将 Google Cloud Search 与非 Google 数据代码库(例如 Microsoft® SharePoint®)搭配使用,则必须创建数据源。如需获取有关添加数据源的说明,请参阅添加可供搜索的数据源

  2. 设置数据源后,您可以创建并注册架构,以确定 Google Cloud Search 应如何表示代码库中的数据。