迁移 Google Chat 应用

如果您合并了 Google Workspace 组织,则可能需要迁移 Chat 应用,以使其继续正常运行。

在迁移 Chat 应用之前,请与贵组织的管理员联系,了解管理设置是否对其产生影响。更改管理设置可能会恢复 Chat 应用的完整功能,并且无需进行迁移。例如,您的 Google Workspace 管理员可能必须将您的 Chat 应用添加到许可名单中,或者可能需要允许用户安装 Chat 应用。如需了解详情,请参阅确定在合并 Google Workspace 组织后是否需要迁移 Google Chat 应用

确定需要迁移 Chat 应用后,请完成以下三个步骤:

  1. 通过在合并的组织中创建 Google Cloud 项目,启用 API,并且可能配置 OAuth 2.0 同意屏幕,为 Chat 应用设置环境。
  2. 从新的 Cloud 项目重新部署 Chat 应用。
  3. 将重新创建的 Chat 应用添加到 Chat 聊天室或对话中,并关闭原来的 Chat 应用。

在合并后的组织中创建 Cloud 项目并启用 API

在合并的 Google Workspace 组织中创建新的 Cloud 项目并为 Chat 应用启用 API 可确保您允许访问 Chat 应用的用户和群组可以顺利执行相应操作,而不会出错。

创建 Cloud 项目

Google Cloud 控制台

  1. 在 Google Cloud 控制台中,依次点击“菜单”图标 > IAM 和管理 > 创建项目

    前往“创建项目”

  2. 项目名称字段中,为项目输入一个描述性名称。

    可选:如需修改项目 ID,请点击修改。项目创建后,项目 ID 便无法更改,因此请选择符合项目生命周期需求的 ID。

  3. 位置字段中,点击浏览以显示项目的可能位置。然后,点击选择
  4. 点击创建。Google Cloud 控制台会转到“信息中心”页面,您的项目会在几分钟内创建完毕。

gcloud CLI

在以下某个开发环境中,访问 Google Cloud CLI(“gcloud”):

  • Cloud Shell:如需使用已设置 gcloud CLI 的在线终端,请激活 Cloud Shell。
    激活 Cloud Shell
  • 本地 Shell:如需使用本地开发环境,请安装initialize gcloud CLI。
    如需创建 Cloud 项目,请使用“gcloud projects create”命令:
    gcloud projects create PROJECT_ID
    为要创建的项目设置 ID,以替换 PROJECT_ID

启用 API

所有聊天应用都必须启用 Google Chat API。根据您的 Chat 应用的构建方式,您可能需要启用其他 API。例如,如果您使用 Google Cloud Functions 构建了聊天应用,请启用 Cloud Build API、Cloud Functions API、Pub/Sub API、Cloud Logging API、Artifact Registry API 和 Cloud Run API。最佳做法是,为确保迁移的应用正常运行,请在新 Cloud 项目中启用在旧 Cloud 项目中启用的相同 API。

如需启用 API,请执行以下操作:

Google Cloud 控制台

  1. 在 Google Cloud 控制台中,依次点击“菜单”图标 > 更多产品 > Google Workspace > 产品库

    前往“产品库”

  2. 点击您要启用的 API。
  3. 点击启用
  4. 如需启用更多 API,请重复上述步骤。

Google Cloud CLI

  1. 安装或打开 Google Cloud 命令行界面 (CLI)
  2. 运行 services enable 命令,指定要启用的 API 服务。

    gcloud services enable API_SERVICE_ID

您可能需要为您的 Cloud 项目配置 OAuth 同意屏幕。如果您之前使用 OAuth 2.0 进行授权,请使用相同的访问授权范围。

  1. 在 Google Cloud 控制台中,依次点击“菜单”图标 > API 和服务 > OAuth 同意屏幕

    转到 OAuth 同意屏幕

  2. 为您的应用选择用户类型,然后点击创建
  3. 填写应用注册表单,然后点击保存并继续
  4. 如果您要创建在 Google Workspace 组织外部使用的应用,请点击添加或移除范围。我们建议在选择范围时采用以下最佳做法:

    • 选择可提供应用所需的最低访问权限级别的范围。如需查看可用范围的列表,请参阅适用于 Google API 的 OAuth 2.0 范围
    • 查看以下三个部分中列出的范围:非敏感范围、敏感范围和受限范围。对于“您的敏感范围”或“您的受限范围”部分中列出的任何范围,请尝试确定其他非敏感范围,以避免不必要的额外审核。
    • 部分范围需要经过 Google 的额外审核。对于仅供 Google Workspace 组织内部使用的应用,范围不会列在同意屏幕上,并且使用受限范围或敏感范围不需要 Google 进一步审核。如需了解详情,请参阅范围类别
  5. 选择您的应用所需的范围后,点击保存并继续
  6. 如果您选择了外部作为用户类型,请添加测试用户:
    1. 测试用户下,点击添加用户
    2. 输入您的电子邮件地址和任何其他获得授权的测试用户,然后点击保存并继续
  7. 查看您的应用注册摘要。如要进行更改,请点击修改。如果应用注册看起来正常,请点击 Back to Dashboard

将 Chat 应用重新部署到新的 Cloud 项目

重新部署 Chat 应用会略有不同,具体取决于您的 Chat 应用是使用 Apps 脚本、AppSheet 还是其他连接类型(如 Python 或 Java)构建的。无论是哪种情况,您都不需要重新创建所有代码,但需要做出一些更改。

迁移 Chat 应用逻辑

根据 Chat 应用的架构,您可能需要将其他服务迁移到新的 Cloud 项目:

  • 对于 HTTP 应用,您还需要迁移使用 Cloud Functions、Cloud Run 或 App Engine 构建的应用逻辑的其余部分。
  • 对于使用自然语言的对话式聊天应用,您还需要迁移 Dialogflow 代理。
  • 对于在防火墙后构建的 Chat 应用,您还需要迁移 Pub/Sub 主题。

在新的 Cloud 项目中配置 Chat 应用

如需重新部署使用 Python 或 Java 等语言构建的 Chat 应用,请在新的 Cloud 项目中配置 Chat 应用。

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

    前往 Chat API

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

    • 应用名称:用户在与您的 Chat 应用互动时使用的名称。
    • 头像网址:指向显示为 Chat 应用的头像的方形图形图片(例如 PNG 或 JPEG)的 HTTPS 网址,图片大小至少为 128x128。
    • 说明: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 应用可识别的网址格式,并在用户发送链接时提供额外内容。如需了解详情,请参阅预览链接
    公开范围 最多可以有 5 个个人或一个或多个 Google 群组查看和安装您的 Chat 应用。您可以使用此字段测试您的 Chat 应用,或与您的团队分享该 Chat 应用。如需了解详情,请参阅 Chat 应用的公开范围和发布设置
  4. 如需在 Chat 应用返回错误时将错误记录到 Cloud Logging,请选中将错误记录到 Logging 复选框。如需了解详情,请参阅查询 Chat 应用的错误日志

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

重新部署 Apps 脚本聊天应用

如需重新部署使用 Apps 脚本构建的 Chat 应用,请将与 Apps 脚本项目关联的 Cloud 项目编号更改为属于新 Cloud 项目的项目编号。然后,复制 Apps 脚本部署 ID,并将其粘贴到 Google Cloud 控制台的 Chat 应用配置页面中。

复制您的 Cloud 项目编号

  1. 在 Google Cloud 控制台中,依次点击“菜单”图标 > IAM 和管理 > 设置

    转到“IAM 和管理”设置

  2. 项目编号字段中,复制相应值。

在 Apps 脚本项目中设置 Google Cloud 项目编号

  1. 转到 Apps 脚本。

    前往 Apps 脚本

  2. 在 Chat 应用 Apps 脚本项目中,点击项目设置

  3. Google Cloud Platform (GCP) 项目下,点击更改项目

  4. GCP 项目编号中,粘贴 Google Cloud 项目编号。

  5. 点击设置项目

复制 Apps 脚本项目的部署 ID

  1. 在 Apps 脚本的右上角,点击部署 > 管理部署
  2. 部署 ID 下,点击复制
  3. 点击完成

重新配置并重新部署 Chat 应用

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

    前往 Chat API

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

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

  4. 在“连接”设置下,选择 Apps 脚本项目

  5. 部署 ID 字段中,粘贴您之前复制的部署 ID。

  6. 如需完成其余配置,请参阅在新 Cloud 项目中配置 Chat 应用中的表

  7. 点击保存

重新部署 AppSheet Chat 应用

如需在新的 Cloud 项目中重新部署使用 AppSheet 构建的 Chat 应用,请将应用复制到新的 Cloud 项目

更新服务帐号

如果您的 Chat 应用以应用的身份进行身份验证并使用服务帐号调用 Google API,请更新 Chat 应用的服务帐号详细信息。如需了解详情,请参阅以 Chat 应用的身份进行身份验证

分享 Chat 应用

在您的新组织中的用户可以使用您的 Chat 应用之前,您的管理员可能需要手动允许该 Chat 应用的访问权限。如需了解详情,请参阅 Google Workspace 管理员如何安装 Chat 应用

改用新版 Chat 应用

现在,Chat 应用已迁移到新组织,是时候公开该应用了。将该应用添加到 Chat 聊天室或私信中,然后从这些聊天室或私信中移除旧版 Chat 应用,以便用户只向迁移后的 Chat 应用发送消息。

将新版 Chat 应用添加到 Chat 聊天室

  1. 前往 Chat。

    前往 Chat

  2. 点击私信或聊天室。

  3. 点击聊天室或人员名称旁边的下拉菜单,然后选择应用和集成

  4. 点击添加应用

  5. 输入应用名称,从列表中选择应用,然后点击添加

  6. 针对要添加 Chat 应用的每个聊天室或私信重复上述步骤。

从 Chat 聊天室中移除旧版 Chat 应用

  1. 前往 Chat。

    前往 Chat

  2. 点击私信或聊天室。

  3. 点击聊天室或人员名称旁边的下拉菜单,然后选择应用和集成

  4. 在未迁移的旧版 Chat 应用旁边,点击更多选项 ,然后点击从聊天室中移除

  5. 针对您要从中移除旧 Chat 应用的每个聊天室或私信重复上述步骤。

停用旧版 Chat 应用

如要禁止用户使用旧版 Chat 应用并鼓励他们使用新版 Chat 应用,请停用旧版 Chat 应用并在 Google Workspace Marketplace 中取消发布该应用