配置 Google Chat API

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

前提条件

配置 Chat API

  1. 在 Google Cloud 控制台中,搜索“Google Chat API”并点击 Google Chat API,然后点击管理

    前往 Chat API

  2. 点击配置标签页,然后输入以下必需信息:

    • 应用名称:用户与您的 Chat 应用互动时使用的名称。
    • 头像网址:指向至少 128x128(显示为 Chat 应用的头像)的方形图形图片(例如 PNG 或 JPEG)的 HTTPS 网址。
    • 说明:对 Chat 应用预期用途的说明,显示在 Chat 应用名称下方。
  3. 如需启用互动功能,请点击启用互动功能切换开关,以便用户与您的 Chat 应用互动,并使用下表完成配置:

    字段 说明
    功能 一组字段,用于确定 Chat 应用如何与用户互动:
    • 接收 1 对 1 消息:用户可以直接在 Google Chat 中找到 Chat 应用并向其发送消息。
    • 加入聊天室和群组对话:用户可以将 Chat 应用添加到聊天室和群组对话。
    连接设置 Chat 应用的端点,可以是以下端点之一:
    • 应用网址:托管 Chat 应用实现的 HTTPS 端点。
    • Apps 脚本项目:实现 Chat 应用的 Apps 脚本项目的部署 ID。
    • Cloud Pub/Sub 主题名称:Chat 应用订阅为端点的 Pub/Sub 主题。
    • Dialogflow:使用 Dialogflow 集成注册 Chat 应用。如需了解详情,请参阅构建理解自然语言的 Dialogflow Google Chat 应用
    斜杠命令 可在 Google Chat 中向用户显示的命令。允许用户在 Google Chat 中查看 Chat 应用的核心操作,并选择希望与之互动的具体操作。有关详情,请参阅以 Chat 应用的身份响应斜杠命令
    链接预览 Chat 应用可识别的网址格式在用户发送链接时提供。如需了解详情,请参阅预览链接
    可见性 最多可有 5 人或一个或多个 Google 群组查看和安装您的 Chat 应用。使用此字段可测试您的 Chat 应用,或与您的团队共享 Chat 应用。有关详情,请参阅 Chat 应用的公开范围和发布设置
  4. 要在 Chat 应用返回错误时将错误记录到 Cloud Logging,请选中将错误记录到 Logging 复选框。如需了解详情,请参阅查询 Chat 应用的错误日志

  5. 点击保存。保存 Chat 应用配置后,您的 Google Workspace 组织中的指定用户可以使用您的 Chat 应用。

授予他人配置 Chat 应用的权限

您可以向特定用户授予访问 Chat 应用配置页面的权限。使用 Chat apps OwnerChat apps Viewer IAM 角色。具有这些角色的用户无法使用 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。