发布 Google Chat 应用

创建 Chat 应用后,您可以发布该应用,供特定人员或群组、Google Workspace 组织中的所有人或拥有 Google Workspace 帐号的任何 Google Chat 用户使用。

用户如何发现和使用 Google Chat 应用

用户可以通过以下几种方式发现并开始使用 Chat 应用:

  • 在 Google Chat 中搜索应用
  • 与添加到 Chat 聊天室的应用互动
  • Google Workspace 管理员代表管理员安装应用后,在私信面板中发现该应用。

要开始使用应用,Google Chat 用户可以发起与应用的私信对话,也可以从建议的接收方列表中进行选择,如下所示:

在消息中输入 @,将应用添加到聊天室。

用户还可以通过用“@”提及该应用来按名称缩小建议的接收人名单。例如,如果您发布一个名为“调度程序聊天机器人”的应用,而贵组织中的用户输入了“@sch”,那么 Google Chat 会建议您的应用作为其中一个自动补全选项。

或者,Google Workspace 管理员可以在 Google Workspace Marketplace中找到 Chat 应用,并为组织中的用户安装这些应用。管理员安装 Chat 应用后,该应用会显示在用户的私信面板中。

Google Workspace 管理员还可以管理其 Google Workspace 组织中使用 Chat 应用的许可名单。如需为使用许可名单的组织开发 Chat 应用,您必须请求管理员将您的 Chat 应用添加到许可名单中,以便用户查找和使用该应用。如需了解详情,请参阅 Google Workspace 管理员帮助文档:允许用户安装 Chat 应用

使用 Google Cloud 控制台配置和发布您的 Chat 应用

如需发布您的 Chat 应用并向他人提供,您通常请按以下步骤操作:

  1. 启用并配置 Google Chat API。配置 API 后,您需要向其他 Google Chat 用户授予对您的 Chat 应用的访问权限,以便进行测试。
  2. 使用 Google Workspace Marketplace SDK 发布应用。您可以将 Chat 应用配置为可供 Google Workspace 组织中的用户或所有 Google Chat 用户使用。
  3. 如果您的 Google Workspace 组织管理对 Chat 应用的访问权限,请让您的 Google Workspace 管理员将应用添加到组织的许可名单中。

Chat 应用的公开范围和发布设置

下表介绍了如何根据 Chat 应用的受众群体配置 Google Chat API 和 Google Workspace Marketplace SDK 的设置:

. . . .
我正在构建聊天应用... 身份验证方法 Google Chat API 设置 Google Workspace Marketplace SDK 设置 我的 Chat 应用在哪里发布?
...对于我的小型团队 用户应用的身份进行身份验证。公开范围设置中,指定可以访问此应用的人员和/或 Google 群组。

如果您的 Google Workspace 帐号要求将应用列入许可名单,则最多只能指定 5 个个人电子邮件地址(您无法指定 Google 网上论坛群组)。

您无需为 Chat 应用配置 Google Workspace Marketplace SDK。 团队成员可以通过 Google Chat 找到并使用您的 Chat 应用。
...对于我的大型团队 用户应用的身份进行身份验证。公开范围设置中,指定人员和/或 Google 网上论坛群组以测试您的 Chat 应用。

测试完成后,使用 Google Workspace Marketplace SDK 中的设置将您的 Chat 应用发布到 Google Workspace 组织。

应用公开范围设置为不公开

安装设置设为个人 + 管理员

如果您的 Google Workspace 帐号要求将应用列入许可名单,请让管理员将您的 Chat 应用添加到许可名单中,以便用户查找和使用该应用。如需了解详情,请参阅 Google Workspace 管理员帮助文档:允许用户安装 Chat 应用

您的 Google Workspace 组织中的任何人都可以在 Google Chat 中查找和安装您的 Chat 应用,并在 Google Workspace Marketplace 中查看您的应用。用户和 Google Workspace 管理员可以从 Marketplace 安装您的应用。

...对于我的 Google Workspace 组织 用户应用的身份进行身份验证。公开范围设置中,指定人员和/或 Google 网上论坛群组以测试您的 Chat 应用。

测试完成后,使用 Google Workspace Marketplace SDK 中的设置将您的 Chat 应用发布到 Google Workspace 组织。

应用公开范围设置为不公开

安装设置设为个人 + 管理员

您的 Google Workspace 组织中的任何人都可以在 Google Chat 中查找和安装您的 Chat 应用,并在 Google Workspace Marketplace 中查看您的应用。只有 Google Workspace 管理员可以通过 Marketplace 安装您的应用。

...适用于所有人(公开 Chat 应用) 作为应用进行身份验证。公开范围设置中,指定用于测试您的 Chat 应用的用户和/或 Google 网上论坛群组。

测试完成后,您可以使用 Google Workspace Marketplace 中的设置公开发布您的 Chat 应用。

应用公开范围设置为公开

安装设置设为个人 + 管理员

任何 Google Workspace 用户都可以在 Google Chat 中查找和安装您的 Chat 应用,并在 Google Workspace Marketplace 中查看您的应用。只有 Google Workspace 管理员可以通过 Marketplace 安装您的应用。

启用并配置 Google Chat API

Google API Console 中为您的应用设置一个项目并启用 Google Chat API。

  1. 请使用下方按钮创建新项目(或选择现有项目)并为其添加服务帐号。为服务帐号授予 Project Owner 角色。
    启用 API
  2. 保存已下载的 JSON 密钥。应用可以使用此密钥对它异步发送到聊天室的消息进行身份验证。
  3. API Console 中打开您的项目。在 API 列表中,点击 Google Chat API
  4. 选择配置标签页,并输入下表中的信息。

保存应用配置后,您的应用即可供 Google Workspace 组织中的指定用户使用。

Google Chat API 配置设置

字段 说明
应用名称 用户与您的应用互动时使用的名称。
头像网址 指向方形图形图片(例如 PNG 或 JPEG,至少 128x128)的 HTTPS 网址,该网址将显示为应用的头像。
说明 对应用功能的说明,显示在应用名称下方。
功能 一组字段,用于确定哪些事件可以触发应用:
  • 接收一对一消息:用户可以直接在 Google Chat 中找到该应用并向其发送消息。
  • 接收来自管理员安装的事件:当 Google Workspace 管理员在其组织中安装或卸载应用时,接收来自 Chat 的 ADDED_TO_SPACEREMOVED_FROM_SPACE 事件。默认情况下,除非您选择接收这些事件,否则它不会收到这些事件,因为这可能会导致每秒查询次数增加。
  • 加入聊天室和群组对话:应用加入聊天室和群组对话后,应用可以加入。
连接设置 应用的端点,可以是以下端点之一:
  • 应用网址:用于托管应用实现的 HTTPS 端点。
  • Apps 脚本项目:实现应用的 Apps 脚本项目的部署 ID。
  • Cloud Pub/Sub 主题名称:应用订阅为端点的 Cloud Pub/Sub 主题。
  • Dialogflow:通过 Dialogflow 集成注册应用。如需了解详情,请参阅关于与 Google Chat 集成的 Dialogflow 文档
斜杠命令 可在 Google Chat 中向用户显示的命令。允许用户在 Google Chat 中查看应用的核心操作,并选择他们希望与之互动的具体操作。
链接展开 当应用发送链接时,应用可识别并提供更多内容的网址格式。如需了解详情,请参阅取消网址链接
展示率 允许最多 5 个用户或一个或多个 Google 网上论坛群组查看和安装您的 Chat 应用。您可以使用此字段测试您的应用,或与您的团队共享该应用。如需了解详情,请参阅 Chat 应用的公开范围和发布设置

授予应用配置权限

您可以向特定用户授予应用配置页面的访问权限。为此,请使用 Chat 应用 OwnerChat 应用查看者 IAM 角色。具有这些角色的用户无法通过 API 和服务信息中心转到应用配置页面,但可以通过转到项目的控制台来访问该配置页面,如下所示:

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

使用 Google Workspace Marketplace SDK 发布应用

使用 Google Workspace Marketplace SDK 可以:

  • 公开发布您的应用,让任何 Google Chat 用户将您的 Chat 应用添加到聊天室。
  • 将您的应用发布到您的网域。
  • 向 Google Workspace 管理员展示您的应用,以便他们为组织中的用户安装应用。 要让您的应用可供 Google Workspace 管理员查看,您的应用必须提供私信功能。

在使用 Google Workspace Marketplace SDK 发布应用之前,请按以下步骤操作:

  1. 通过 Chat 安装 Chat 应用,进行测试。确保您的应用完全正常运行,且没有正在进行的工作。
  2. 查看发布要求,并验证您的应用是否满足所有这些要求。请参阅审核领域
  3. 记录应用的版本号,您需要用它来配置 Google Workspace Marketplace SDK。

当您准备好发布时,请参阅概览:发布应用

停用您的 Chat 应用

保存配置页面后,系统会显示“应用状态”字段。此字段可让您控制应用是实时还是已停用

如需停用聊天应用,请执行以下操作:

  1. 打开 Google Cloud Console
  2. 如有必要,请选择托管 Chat 应用的 Google Cloud 项目:
    1. 点击“Google Cloud”旁边的向下箭头 。系统会显示一个列出当前项目的对话框。
    2. 选择托管已迁移的 Chat 应用的项目。
    3. 点击 Open
  3. 搜索“Google Chat API”,然后点击 Google Chat API
  4. 点击管理
  5. 点击配置
  6. 在“应用状态”部分中,选择已停用
  7. 点击保存