搜索并选择 Google API

1. 准备工作

此 Codelab 将向您展示如何搜索和选择 Google API，以及如何查看 API 指标。

前提条件

  • 能够浏览 Google Cloud 控制台。

学习内容

所需条件

2. 通过 Cloud 控制台访问 API

  1. 在 Cloud 控制台中，依次选择 5854836f11d5d97b.png 导航菜单 > API 和服务 > 已启用的 API 和服务。

Cloud 控制台中的导航菜单，显示了

  1. 在 API 和服务信息中心内，点击 + 启用 API 和服务以查看可用的 API。

显示“启用 API 和服务”选项的“API 和服务”信息中心。

在 API 和服务页面中，您可以通过多种方式搜索 API。如果您知道 API 的名称，可以在页面顶部的搜索 API 和服务字段中输入该名称。您还可以使用页面侧边的过滤条件按类别过滤 API。

“搜索 API 和服务”字段中搜索到的 API 列表。

  1. 在类别菜单中，选择机器学习，以便仅显示机器学习 API。

按类别过滤的 API，仅显示机器学习 API。

  1. 从机器学习 API 中选择 Cloud Natural Language API，查看有关此 API 的详细信息。
  2. 点击启用，以在相应项目中启用此 API。

显示“启用”和“试用此 API”按钮的 Cloud Natural Language API 窗格。

启用 API 后，系统会显示该 API 的“概览”页面。您可以看到此 API 的使用情况指标，但由于您最近才启用此 API，因此信息非常少。

所选 API 的“概览”页面，其中显示了该 API 的指标。

在未来的 Codelab 中，您将详细了解如何创建凭据，但如果您现在就想了解，请点击创建凭据，然后回答显示的问题。

  1. 点击管理即可返回上一步中的概览。

Cloud Natural Language API 的概览页面。

  1. 如需试用该 API（即使在启用之前），请点击试用此 API。

这通常会引导您前往 API 的文档页面。不过，对于某些 API，由于其方法众多，因此无法立即尝试。Cloud Natural Language API 就是这种情况。

Cloud Natural Language API 的参考页面。

  1. 选择 analyzeEntitites 方法。

您应该会看到一个网页，其中包含有关 API 方法的详细信息和一个试用此 API 窗格。

显示 analyzeEntities 方法的页面，其中包含该方法的详细信息和一个“Try this API”窗格。

  1. 如需尝试示例查询，请向请求正文字段添加包含以下参数的 document 对象。点击 + 图标以展开字段选项。
  2. 在 content: 字段中，输入要分析的文本。

此示例使用 Michelangelo Caravaggio, Italian painter, is known for 'The Calling of Saint Matthew'.

  1. 在 type: 字段中，选择 PLAIN_TEXT。

请求正文应如下所示：

显示请求正文参数的“请求正文”窗格。

如需详细了解每个参数，请参阅相关文档。

  1. 取消选中 Google OAuth 2.0 复选框，然后点击执行以获取包含实体详细信息的回答。

包含实体详细信息的 200 响应。

  1. 清除 API 密钥复选框，然后再次点击执行。

这次执行查询时，您会收到类似这样的错误，因为该 API 需要凭据才能运行。

针对缺少凭据的请求的 403 响应。

  1. 选中 Google OAuth 2.0 复选框，然后再次点击执行。

OAuth 2.0 会提供您账号的 API 权限，并向您显示警告。

OAuth 2.0 警告，指出 Google API Explorer 想要访问您的 Google 账号。

如果您允许访问，则会收到与使用 API 密钥时相同的响应。如果您在应用中使用该 API，并且需要向了解自己凭据的个人授予访问权限，则需要使用 OAuth 2.0。如果应用只需代表用户访问 API，则可以使用 API 密钥。

3. 使用 Metrics Explorer 查看 API 指标

您可以从“API 概览”页面查看任何单个 API 的调用历史记录，如从 Cloud 控制台访问 API 的第 6 步所示。不过，如需查看所有 API 使用情况的更多指标，请使用 Metrics Explorer。

  1. 在 f6b6844bf5688982.png 导航菜单的运维部分中，依次点击 Monitoring > Metrics Explorer。

导航菜单的“操作”部分，其中显示了选定的“监控”和“指标探索器”选项。

  1. 在资源类型菜单中，选择已使用的 API 作为指标类型。（如果您没有看到此选项，请清除仅显示有效复选框。）

ca850c4295ef4ec9.png

  1. 在指标菜单中，选择 API 的某个单独指标，例如请求数，以查看在指定时间段内调用了多少个 API。

Metrics Explorer 显示了“已使用的 API”指标中的“请求数”指标。

  1. 如需进一步自定义输出，请设置汇总器并调整时间段。Metrics Explorer 显示了“已使用的 API”指标，其中“请求数”指标指定了汇总器和时间段。

4. 使用 OAuth 2.0 Playground 试用 API

您还可以使用 OAuth 2.0 Playground 试用 Google API。借助 OAuth 2.0 Playground，您可以选择某个 API 并对其进行授权，然后在 OAuth 2.0 Playground 的控制台窗口中发送请求并查看响应。

  1. 打开 OAuth 2.0 Playground。

OAuth 2.0 Playground 显示了您可以试用的 API 列表。

  1. 依次点击 Cloud Natural Language API > https://www.googleapis.com/auth/cloud-language > https://www.googleapis.com/auth/cloud-platform > 授权 API。

OAuth 2.0 Playground，其中显示了所选的 Cloud Natural Language API。

  1. 如果需要，请登录您的 Google 账号，然后点击允许以获取授权代码。
  2. 点击 Exchange authorization code for tokens。

“Exchange authorization code for tokens”（将授权代码转换为令牌）窗格，您可以在其中点击“Exchange authorization code for tokens”（将授权代码转换为令牌）。

您现在可以向 API 发出请求。

  1. 点击列出可能的操作，查看所有可能的 API 调用。

您之前打开了 Natural Language API analyzeEntities 文档的信息页面，因此可以看到 HTTP 请求的网址为：

https://language.googleapis.com/v1beta2/documents:analyzeEntities

这是一个 POST 请求。

“Configure request to API”（配置对 API 的请求）窗格，您可以在其中选择 HTTP 方法、注册请求 URI、输入请求正文并发送请求。

  1. 输入请求 URI 信息，并添加请求正文。

您可以使用在 API Explorer 中使用的相同正文。

“请求正文”窗格。

  1. 依次点击关闭 > 发送请求。

您应该会获得与下图类似的结果：

发布请求后的 OAuth 2.0 请求/响应窗格。

欢迎在 OAuth 2.0 Playground 中试用其他 API。

5. 清理

为项目设置不受限制的 API 密钥是一种不良做法。如果有人获得了对它的访问权限，则无需进一步的身份验证即可使用它。

如需删除此 API 密钥，请执行以下操作：

  1. 依次点击 f6b6844bf5688982.png 导航菜单 > API 和服务 > 凭据。
  2. 在 API 密钥下，选择要删除的密钥，然后点击 247adf2e1d1eae4b.png。
  3. 同样，您无需担心服务账号私钥不受保护，只需在服务账号下选择要删除的服务账号，然后点击 247adf2e1d1eae4b.png 即可。

6. 恭喜

恭喜！您已了解如何搜索和选择 Google API，以及如何查看其指标。