您创建的每个 Google Chat 应用都需要有自己的 已启用并配置 Chat API 的 Google Cloud 项目。当前页面 介绍了如何配置 Chat API。
前提条件
- Business 或 Enterprise 有权访问以下内容的 Google Workspace 账号: Google Chat。
- 创建 Google Cloud 项目。
- 配置 OAuth 同意屏幕。
- 启用 Google Chat API。
为您的 Chat 应用选择显示名称、头像和说明
要调用 Chat API,您必须设置一个 包含以下信息的 Google Chat 应用:
字段 | 说明 | 格式 |
---|---|---|
应用名称 | Chat 应用的显示名称。 | 最多 25 个字母数字字符 |
头像网址 | 显示为 Chat 应用的图片 头像。 | 指向方形图形图片(PNG 或 JPEG)的 HTTPS 网址。 建议的尺寸为 256 x 256 像素或更高。 |
说明 | 用于说明 Chat 应用。 | 最多 40 个字母数字字符 |
Chat 应用的名称、头像和说明 向用户显示的所有信息。对于某些 Chat API Chat 会使用此信息来确定 Chat 应用在 Chat 中执行的操作。
例如,如果您调用 spaces.create()
方法,Chat
在
聊天室创建者的说明,如下图所示:
如要与 Chat 扩展应用互动,用户还可以查看或使用 信息:
- 用“@”提及 Chat 应用的名称来调用该应用。
- 使用 Chat 应用查找和发起私信。 在应用菜单中,私信会显示 Chat 应用的名称和头像。
- 用户可以在撰写栏中浏览 Chat 应用并查看 姓名、头像和说明
在 Google Cloud 控制台中配置 Chat 应用
获得 Chat 应用详细信息后,请打开 Cloud 项目,并配置 Chat API:
在 Google Cloud 控制台中,前往 Chat API 页面,然后点击 配置页面:
在 Application info(应用信息)下,填写 App name(应用名称)、Avatar 网址(头像网址)。 和说明字段。
在“互动功能”下,点击启用互动功能切换开关 停用交互功能 Chat 应用。您可以稍后进行设置。要了解 如何配置和构建互动功能,请参阅 接收和响应用户互动。
可选:在日志下,选中将错误记录到 Logging 复选框,以 使用 Google Cloud Logging如需了解详情,请参阅 查询 Chat 应用的错误日志。
点击保存。
授予他人配置 Chat 应用的权限
您可以 向特定用户授予访问权限 前往 Chat 应用配置页面。使用 Chat apps Owner 和 Chat apps Viewer IAM 角色。拥有这些角色的用户无法前往 Chat 扩展应用 API 和服务信息中心,但可以 前往 Google Cloud 控制台 Chat 应用的托管 Cloud 项目,如下所示:
https://console.developers.google.com/apis/api/chat.googleapis.com/hangouts-chat?project=PROJECT_ID
其中,PROJECT_ID
是
托管 Chat 应用的 Google Cloud 项目。
相关主题
- 选择 Chat 应用架构
- 如要为您的 Chat 应用配置互动功能,请按以下步骤操作: 请参阅接收和响应用户互动