配置 Google Chat API

您创建的每个 Google Chat 应用都需要有自己的 Google Cloud 项目，并且该项目已启用并配置 Chat API。本页介绍了如何配置 Chat API。

前提条件

为 Chat 应用选择显示名称、头像和说明

如需调用 Chat API，您必须使用以下信息设置 Google Chat 应用：

字段 说明 格式
应用名称 Chat 应用的显示名称。 最多 25 个字母数字字符
头像网址 显示为 Chat 应用头像的图片。 指向方形图形图片（PNG 或 JPEG）的 HTTPS 网址。 建议的尺寸为 256 x 256 像素或更大。
说明 对 Chat 应用用途的简要说明。 最多 40 个字母数字字符

Chat 应用的名称、头像和说明会在 Chat 界面中向用户显示。对于某些 Chat API 写入请求，Chat 会使用此信息来归因 Chat 应用在 Chat 中执行的操作。

例如，如果您调用 spaces.create() 方法，Chat 会在创建聊天室的用户的说明中添加 Chat 应用的名称，如以下图片所示：

Google Chat 应用为用户创建聊天室。
图 1. 当使用 spaces.create() 方法代表用户创建聊天室时，Chat 显示的归因消息。

如需与 Chat 应用互动，用户还可以通过以下方式查看或使用此类信息：

  • 通过 @提及 Chat 应用的名称来调用该应用。
  • 找到 Chat 应用并发起私信。在应用菜单中，私信会显示 Chat 应用的名称和头像。
  • 用户可以在撰写栏中浏览 Chat 应用，并查看应用的名称、头像和说明。

在 Google Cloud 控制台中配置 Chat 应用

获取 Chat 应用详细信息后，打开您的 Cloud 项目并配置 Chat API：

  1. 在 Google Cloud 控制台中，前往 Chat API 页面，然后点击配置页面：

    前往 Chat API 配置页面

  2. 在应用信息下，填写应用名称、头像网址和说明字段。

  3. 在“互动功能”下，将启用互动功能切换开关切换到关闭位置，以停用 Chat 应用的互动功能。您可以稍后进行设置。如需了解如何配置和构建交互式功能，请参阅接收和响应用户互动。

  4. 可选：在日志下，选中将错误记录到 Logging 复选框，以使用 Google Cloud Logging。如需了解详情，请参阅查询 Chat 应用的错误日志。

  5. 点击保存。

向其他用户授予配置 Chat API 的权限

您可以通过向特定用户授予 Chat 应用 Owner 或 Chat 应用 Viewer Google Cloud Identity Access Management (IAM) 角色，为特定用户授予对 Chat 应用配置页面的访问权限。拥有这些角色的用户无法使用 API 和服务信息中心前往 Chat 应用配置页面，但可以前往 Chat 应用托管 Cloud 项目的 Google Cloud 控制台，以如下方式访问该配置页面：

https://console.developers.google.com/apis/api/chat.googleapis.com/hangouts-chat?project=PROJECT_ID

其中 PROJECT_ID 是托管 Chat 应用的 Google Cloud 项目的项目 ID。