您创建的每个 Google Chat 应用都需要有自己的 Google Cloud 项目,并启用和配置 Chat API。
如需通过用户身份验证执行只读 API 调用(例如获取聊天室和列出消息),您只需启用该 API 并创建 OAuth 客户端即可。
如需执行创建、更新和删除 API 调用,或部署和测试互动式 Chat 应用(作为扩展 Chat 的 Google Workspace 插件构建),您还必须配置 Chat API。在 Chat API 配置设置中,您可以指定有关 Chat 应用的所有详细信息,包括其显示名称、头像、部署端点和互动功能。
前提条件
- 可访问 Google Chat 的 Google Workspace 商务版或企业版账号。
- 创建 Google Cloud 项目。
- 配置 OAuth 权限请求页面。
- 启用 Google Chat API。
为您的 Chat 应用选择显示名称、头像和说明
启用 Chat API 后,您需要配置 Chat 应用的详细信息,这些信息会向 Chat 中的用户显示,包括显示名称、头像和说明。这些详细信息仅在 Chat 中显示。如需将 Chat 扩展应用发布到 Marketplace,您还必须指定 Chat 扩展应用的 Marketplace 商品详情中显示的详细信息。
在配置 Chat 应用之前,请准备好以下信息:
| 字段 | 说明 | 格式 |
|---|---|---|
| 应用名称 | Chat 应用的显示名称。 | 最多 25 个字母数字字符 |
| 头像网址 | 显示为 Chat 应用头像的图片。 | 指向方形图形图片(PNG 或 JPEG)的 HTTPS 网址。 建议的尺寸为 256 x 256 像素或更大。 |
| 说明 | Chat 应用的简短说明,在用户在 Chat 中搜索应用时显示。 | 最多 40 个字母数字字符 |
| 详细说明 | 可选。对 Chat 应用功能的说明,会在用户开始与 Chat 应用对话或打开代理的会话首页时显示。 目前,仅在使用 Google Cloud 控制台更新应用配置时受支持,通过 Google Workspace 插件 API 不受支持。 | 最多 250 个字符 |
Chat 应用的名称、头像和说明会显示在 Chat 界面中。对于某些 Chat API 写入请求,Chat 会使用此信息来归因 Chat 应用在 Chat 中执行的操作。
例如,如果您调用 spaces.create() 方法,Chat 会在聊天室创建者的说明中包含 Chat 应用的名称,如下图所示:
spaces.create() 方法代表用户创建聊天室时,Chat 显示的归因消息。
为了与 Chat 应用互动,用户还会通过以下方式查看或使用这些信息:
- 使用 @ 提及 Chat 应用,将其添加到聊天室或向其发送消息。
- 查找 Chat 应用并与其发起私信对话。在应用菜单中,私信会显示 Chat 应用的名称和头像。
- 用户可以从撰写栏中浏览 Chat 应用,并查看其名称、头像和说明。
在 Google Cloud 控制台中配置 Chat 应用
获得 Chat 应用详细信息后,打开 Cloud 项目并配置 Chat API:
在 Google Cloud 控制台中,前往 Chat API 页面,然后点击配置页面:
在应用信息下,填写应用名称、头像网址和说明字段。
可选:填写详细说明字段。
可选:从标记语法菜单中,为 Chat 应用的消息选择默认标记语法(Markdown 或 Chat)。如需详细了解文本格式以及 Chat 如何确定 API 请求的标记语法,请参阅设置消息格式。
在互动功能下,配置您的 Chat 应用是否响应用户互动:
如需构建互动式 Chat 应用,请开启启用互动功能,然后完成以下操作:
- 在功能下:
- 可选:选择支持应用首页,以便在与 Chat 应用的 1 对 1 私信的首页标签页中显示首页卡片。
- 选择加入聊天室和群组对话,以便安装和使用您的 Chat 应用。默认情况下,用户可以在用户与 Chat 应用之间的专用聊天室中安装 Chat 应用并与之发送消息。用户还可以在多人聊天室中添加 Chat 应用并与之互动。
在连接设置下,选择要用于接收 Chat 事件对象的架构:
- 如需使用 HTTP 服务,请选择 HTTP 端点网址并提供网址。
- 如需使用 Google Apps 脚本项目,请选择 Apps 脚本,并提供项目的部署 ID。
- 如需使用 Dialogflow 代理,请选择 Dialogflow,选择 Dialogflow CX 或 Dialogflow ES,然后提供代理的资源名称。
- 如需使用 Pub/Sub,请选择 Cloud Pub/Sub 并输入主题名称。
可选:如需将事件对象路由到特定端点或函数,请前往连接设置 > 触发器,然后为以下 Chat 触发器提供或更新回调端点或函数:
- 应用首页(如果启用了支持应用首页):用户在与 Chat 应用的 1 对 1 私信中打开首页标签页。
- 已添加到聊天室:用户将 Chat 应用添加到群组对话或聊天室,或安装 Chat 应用以进行 1 对 1 消息。
- 消息:用户向 Chat 应用发送消息。例如,用户向 Chat 应用发送私信,或在多人聊天室中 @提及 Chat 应用。
- 从聊天室中移除:用户从聊天室中卸载或移除 Chat 应用。
- 应用命令:用户从 Chat 应用调用快速命令、斜杠命令或消息操作。
在公开范围下,选择面向特定人员和群组提供此 Chat 应用,然后输入 Google Workspace 组织中个人或 Google 群组的邮箱:
- 在功能下:
可选:在日志下,选中将错误记录到 Logging 复选框,以使用 Google Cloud Logging。如需了解详情,请参阅查询 Chat 应用的错误日志。
点击保存。
保存配置后,您在 Chat API 的公开范围设置中指定的任何人都可以安装、测试或使用 Chat 应用。如需开始测试和调试 Chat 应用,请参阅测试 Google Chat 应用的互动功能。
使用 Google Cloud CLI 配置 Chat 应用
您可以使用 Google Cloud CLI (gcloud CLI) 从命令行查看和更新 Chat 应用的配置,而无需使用 Google Cloud 控制台。例如,您可以通过脚本配置 Chat 应用,也可以将配置保存在与代码一起存储的文件中。
gcloud beta workspace-add-ons chat-app-config 命令组包含以下命令:
这些命令使用 Google Workspace 插件 API 中的 chatAppConfig 资源。
准备工作
- 安装 gcloud CLI。如果您之前安装了 gcloud CLI,请运行
gcloud components update以确保您拥有最新版本。 使用您的用户账号登录 gcloud CLI。这些命令不支持服务账号。
gcloud auth login将 Chat 应用的云项目设置为 gcloud CLI 的默认项目。请使用项目 ID,因为这些命令不接受项目编号。
gcloud config set project PROJECT_ID或者,您也可以向每个命令添加
--project标志。在云项目中启用 Google Workspace 插件 API:
gcloud services enable gsuiteaddons.googleapis.com确保您在云项目中拥有以下 Identity and Access Management (IAM) 角色:
- Google Workspace Add-ons Developer (
roles/gsuiteaddons.developer)(用于查看和更新配置),或 Google Workspace Add-ons Reader (roles/gsuiteaddons.reader)(仅用于查看配置)。这些角色包含前提条件和身份验证中列出的权限。 - Service Usage Consumer (
roles/serviceusage.serviceUsageConsumer)。gcloud CLI 使用云项目作为其请求的配额项目,这需要serviceusage.services.use权限。
Owner 和 Editor 角色包含所有这些权限。Chat 应用 Owner 和 Chat 应用 Viewer 角色可授予对 Google Cloud 控制台中的配置页面的访问权限,但这些角色还不够。
- Google Workspace Add-ons Developer (
查看配置
如需查看 Chat 应用的配置,请运行 describe 命令:
gcloud beta workspace-add-ons chat-app-config describe输出类似于以下内容:
avatarUri: https://www.gstatic.com/dynamite/images/quickstart-app-avatar.png
description: Helps manage tasks and schedules
displayName: Cymbal Assistant
errorLoggingEnabled: true
interactiveFeatureConfig:
allowlistedTestingPrincipals:
- user@example.com
appCommands:
- command: /help
commandId: 1
commandType: SLASH_COMMAND
description: Show available commands
connectionConfig:
httpEndpointConfig:
commonUrl: https://example.com/chat
supportsMultiuserSpaces: true
urlPatterns:
- hostPattern: example.com
pathPrefix: tasks/
name: projects/123456789012/chatAppConfig
state: ACTIVE
如果云项目还没有 Chat 应用,则该命令会成功执行,并且仅输出配置的 name 字段:
name: projects/123456789012/chatAppConfig
如需更改输出,请添加以下标志之一:
--format=json:以 JSON 格式输出配置。--view=basic:省略互动功能设置 (interactiveFeatureConfig)。--format="value(displayName)":仅输出显示名称;如果云项目还没有 Chat 应用,则输出空行。已配置的 Chat 应用始终具有显示名称,因此您可以在脚本中使用此标志来检查 Chat 应用是否存在。
更新配置
如需首次配置 Chat 应用或更改其配置,请运行 update 命令。使用标志或在配置文件中指定设置。您无法在一条命令中同时使用这两个选项。
首次为云项目运行该命令时,您必须至少指定显示名称和说明。除非您将状态设置为停用,否则 Chat 应用会在命令完成后立即处于活跃状态。然后,您列为测试人员的用户就可以找到并使用该应用。
使用标志
以下示例配置了一个在 HTTP 端点接收事件的 Chat 应用:
gcloud beta workspace-add-ons chat-app-config update \
--display-name="Quickstart App" \
--description="Quickstart app" \
--avatar-uri=https://developers.google.com/workspace/chat/images/quickstart-app-avatar.png \
--http-endpoint-url=HTTP_ENDPOINT_URL \
--supports-multiuser-spaces \
--add-allowlisted-testing-principals=USER_EMAIL \
--error-logging-enabled替换以下内容:
HTTP_ENDPOINT_URL:从 Chat 接收事件对象的 HTTPS 网址。USER_EMAIL:Google Workspace 组织中可以安装和测试 Chat 应用的人员或群组的邮箱,例如您自己的邮箱。
该命令会输出更新后的配置。
下表列出了 Google Cloud 控制台中 Chat API 配置页面上的设置标志。如需详细了解每个标志,请参阅 update 命令参考文档。
| 在 Google Cloud 控制台中设置 | 标志 |
|---|---|
| 应用名称 | --display-name |
| 头像网址 | 将 --avatar-uri 替换为符合头像要求的图片的 HTTPS 网址,或替换为 --clear-avatar-uri 以使用默认头像 |
| 说明 | --description |
| 应用状态 | --state=active 或 --state=disabled |
| 标记语法 | --markup-syntax=markdown 或 --markup-syntax=chat |
| 加入聊天室和群组对话 | --supports-multiuser-spaces 或 --no-supports-multiuser-spaces |
| 连接设置 | 您会看到下列其中一种公开范围:
|
| 公开范围 | --add-allowlisted-testing-principals、--remove-allowlisted-testing-principals和--clear-allowlisted-testing-principals |
| 将错误记录到 Logging | --error-logging-enabled 或 --no-error-logging-enabled |
命令、链接预览和每个触发器的单独端点没有标志。如需配置这些设置,请使用配置文件。
例如,如需关闭 Chat 应用而不更改其其他设置,请运行以下命令。如需重新开启,请使用 --state=active。
gcloud beta workspace-add-ons chat-app-config update --state=disabled使用配置文件
如需将配置保留在文件中,或配置没有标志的设置,请将 YAML 或 JSON 文件传递给 update 命令。该文件使用 chatAppConfig 资源的字段,这些字段与 describe 命令输出的字段相同。
创建一个包含要更新的设置的文件。例如,创建一个名为
chat_app_config.yaml的文件,其中包含以下内容:displayName: Cymbal Assistant description: Helps manage tasks and schedules avatarUri: https://www.gstatic.com/dynamite/images/quickstart-app-avatar.png state: ACTIVE errorLoggingEnabled: true interactiveFeatureConfig: supportsMultiuserSpaces: true connectionConfig: httpEndpointConfig: commonUrl: https://example.com/chat appCommands: - commandId: 1 commandType: SLASH_COMMAND command: /help description: Show available commands urlPatterns: - hostPattern: example.com pathPrefix: tasks/ allowlistedTestingPrincipals: - USER_EMAIL将
USER_EMAIL替换为 Google Workspace 组织中可以安装和测试 Chat 应用的人员或群组的邮箱。运行带有
--config-file标志的update命令:gcloud beta workspace-add-ons chat-app-config update \ --config-file=chat_app_config.yaml
如需从 Chat 应用的当前配置开始,请将 describe 命令的输出保存到文件中:
gcloud beta workspace-add-ons chat-app-config describe > chat_app_config.yaml然后修改该文件,删除您不想更改的字段,并将该文件传递给 update 命令。如果文件包含该命令无法更新的设置,则该命令会失败。如需了解详情,请参阅限制。
update 命令会忽略文件中的 name 字段。它始终会更新您在 gcloud CLI 中设置的云项目,因此您可以使用同一文件在另一个云项目中配置 Chat 应用。
该命令如何应用您的更改
- 只有您指定的设置会发生更改。如果使用标志,该命令会更改您传递的标志的设置。使用配置文件时,它会更改文件中的字段,因此文件不需要包含整个配置。连接设置是一个例外:您设置的连接类型会替换当前连接类型,您设置的 Dialogflow 版本会替换整个 Dialogflow 配置。
- 列表会整体替换。如果文件包含
appCommands、urlPatterns或allowlistedTestingPrincipals字段,则文件中的列表会替换当前列表。如需改为添加或移除个别测试人员,请使用--add-allowlisted-testing-principals和--remove-allowlisted-testing-principals标志。 - 空值会清除设置。例如,如果文件在
interactiveFeatureConfig下包含urlPatterns: [],则会移除所有链接预览网址格式。 - 失败的命令不会更改任何内容。如果值无效,该命令会输出错误,并使配置保持原样。
- 请求受速率限制。该 API 会限制每个 Cloud 项目和每个组织每分钟的读取请求数和更新请求数。每个
update命令都会发送一个更新请求。如果您使用标志添加或移除测试人员,该命令还会发送读取请求。如需更改多项设置,请在一个命令或一个文件中传递这些设置,而不是为每项设置运行一个命令。
限制
- 这些命令仅支持作为 Google Workspace 插件构建的 Chat 应用。
- 这些命令不支持服务账号或服务账号模拟。您必须使用用户账号登录 gcloud CLI。
- 一个云项目有一个 Chat 应用配置,命令无法将其删除。如需阻止用户使用 Chat 应用,请将其状态设置为“已停用”或删除云项目。
- 更新会应用于实际运行的 Chat 应用。这些命令没有草稿或试运行模式。
- 当 Chat 应用在 Google Workspace Marketplace 中发布或接受审核时,这些命令无法更改其显示名称、头像、说明、命令或链接预览网址格式。
- 这些命令支持
chatAppConfig资源中的设置。如需配置资源不包含的设置,请使用 Google Cloud 控制台。
问题排查
如果命令失败,请在下表中查找出错提示中的文本。如果消息以 INVALID_ARGUMENT 等状态开头,则表示 Google Workspace Add-ons API 拒绝了请求,状态后面的文本描述了问题。
| 出错提示包含 | 原因 | 解决方案 |
|---|---|---|
Invalid choice: 'chat-app-config' 或 Invalid choice: 'workspace-add-ons' |
该命令不包含 beta,或者您的 gcloud CLI 版本不包含这些命令。 |
以 gcloud beta workspace-add-ons chat-app-config 开头。如果错误仍然存在,请将 gcloud CLI 更新到最新版本。 |
PROJECT ID |
项目设置为项目编号。 | 将项目设置为项目 ID。 |
Failed to parse value(s) in protobuf |
配置文件包含 gcloud CLI 无法识别的字段。出错提示会指明该字段。 | 将字段名称与 describe 命令的输出进行比较。如果该字段是新字段,请将 gcloud CLI 更新到最新版本。 |
does not have permission to access projects instance |
API 拒绝了请求。此消息后面的文本会说明原因。例如:
|
查看准备工作中的要求。 |
INVALID_ARGUMENT |
某个值无效。例如,显示名称必须介于 3 到 25 个字符之间,说明必须介于 1 到 40 个字符之间。如果消息包含 not found or deleted,则项目 ID 不正确。 |
更正出错提示中描述的值,然后再次运行该命令。 |
FAILED_PRECONDITION |
Chat 应用不允许该请求。例如,它不是作为 Google Workspace 插件构建的,或者它已在 Google Workspace Marketplace 中发布,并且设置无法更改。 | 按照出错提示中的说明操作。如需配置非 Google Workspace 插件的 Chat 应用,请使用 Google Cloud 控制台或将其转换。 |
RESOURCE_EXHAUSTED 或 429 |
API 在短时间内收到了过多针对云项目或组织的请求。 | 请稍等片刻,然后再次运行该命令。 |
使用 Google Workspace Add-ons API 配置 Chat 应用
您可以使用 Google Workspace add-ons API 中的 chatAppConfig 资源,以编程方式读取和更新作为 Google Workspace 插件构建的 Chat 应用的配置,而无需在 Google Cloud 控制台中手动配置 Chat 应用。
chatAppConfig 是一个单例资源,始终存在于每个云项目中。在您首次保存配置之前,资源包含一个空配置(如果您在首次保存之前读取资源,GetChatAppConfig 也会返回该配置)。由于资源已存在,因此您无需单独创建资源,只需使用 UpdateChatAppConfig 即可保存初始配置并更新现有配置。
前提条件和身份验证
在调用 GetChatAppConfig 或 UpdateChatAppConfig 之前,请先满足以下前提条件:
- 启用您的云项目中的 Google Workspace 插件 API (
gsuiteaddons.googleapis.com)。(可选)如果您想在 Google Cloud 控制台中查看或更新 Chat 应用配置,或者调用 Chat API,可以启用 Google Chat API (chat.googleapis.com)。 - 使用包含
https://www.googleapis.com/auth/cloud-platform范围的 OAuth 2.0 凭据以人类用户身份进行身份验证。chatAppConfig方法不支持服务账号身份验证。 - 确保经过身份验证的用户在目标云项目中拥有所需的 Identity and Access Management (IAM) 权限:
gsuiteaddons.chatAppConfigs.get和chat.bots.get,用于读取配置 (GetChatAppConfig)。gsuiteaddons.chatAppConfigs.update、chat.bots.update和chat.bots.get,以更新配置 (UpdateChatAppConfig)。
- 如果您使用客户端库,请安装适用于您的语言的最新版本 Google Workspace 插件 API 客户端库。如需查看客户端库列表,请参阅 Google Workspace 插件 API 参考文档。
更新 Chat 应用配置
如需首次配置 Chat 应用或更新现有配置,请向云项目的单例 chatAppConfig 资源发送 PATCH 请求 (UpdateChatAppConfig):
- 对于
chatAppConfig为空的云项目的初始保存,displayName(3 到 25 个字符)和description(1 到 40 个字符)是必需的。如果您在初始保存时省略interactiveFeatureConfig,则 Chat 应用会被配置为非互动应用。 - 对于后续更新,请使用可选的
updateMask查询参数指定要更新的以逗号分隔的字段(或省略updateMask以更新所有提供的字段)。更新重复字段(appCommands、urlPatterns或allowlistedTestingPrincipals)会替换整个列表。
PATCH https://gsuiteaddons.googleapis.com/v1/projects/PROJECT_NUMBER/chatAppConfig?updateMask=displayName,description,avatarUri,state,errorLoggingEnabled,markupSyntax,interactiveFeatureConfig
Authorization: Bearer ACCESS_TOKEN
Content-Type: application/json
{
"name": "projects/PROJECT_NUMBER/chatAppConfig",
"displayName": "Cymbal Assistant",
"description": "Helps manage tasks and schedules",
"avatarUri": "https://www.gstatic.com/dynamite/images/quickstart-app-avatar.png",
"state": "ACTIVE",
"errorLoggingEnabled": true,
"markupSyntax": "MARKUP_SYNTAX_MARKDOWN",
"interactiveFeatureConfig": {
"supportsMultiuserSpaces": false,
"connectionConfig": {
"httpEndpointConfig": {
"commonUrl": "https://example.com/chat"
}
},
"appCommands": [
{
"commandType": "SLASH_COMMAND",
"commandId": 1,
"command": "/help",
"description": "Show available commands",
"dialogEnabled": false
}
],
"urlPatterns": [
{
"hostPattern": "example.com",
"pathPrefix": "tasks/"
}
],
"allowlistedTestingPrincipals": [
"USER_EMAIL"
]
}
}
替换请求网址、标头和正文中的以下内容:
PROJECT_NUMBER:托管 Chat 应用的 Cloud 项目的数字项目编号。ACCESS_TOKEN:使用https://www.googleapis.com/auth/cloud-platform范围授权的用户 OAuth 2.0 访问令牌。USER_EMAIL:Google Workspace 组织中要列入许可清单以测试 Chat 应用的邮箱或 Google 群组(例如您自己的邮箱)。- 将请求正文中的示例配置字段(例如
displayName、description、avatarUri和interactiveFeatureConfig,包括端点配置、命令、链接预览网址格式和测试主账号)替换为您的 Chat 应用的值。如需详细了解所有受支持的字段和端点选项,请参阅projects.chatAppConfigREST 参考文档和projects.chatAppConfig.patch。
获取 Chat 应用配置
如需读取 Cloud 项目的当前 Chat 应用配置,请调用 GetChatAppConfig。您可以传递可选的 view 查询参数 (ChatAppConfigView):
BASIC(默认):返回不含interactiveFeatureConfig的基本元数据。FULL:返回所有配置字段,包括interactiveFeatureConfig。
如果尚未为云项目保存 Chat 应用配置,该方法会返回一个空的 ChatAppConfig 对象。
HTTP
GET https://gsuiteaddons.googleapis.com/v1/projects/PROJECT_NUMBER/chatAppConfig?view=FULL
Authorization: Bearer ACCESS_TOKEN
Node.js
const {GSuiteAddOnsClient} = require('@google-cloud/gsuiteaddons').v1;
const client = new GSuiteAddOnsClient();
async function getChatAppConfig() {
const [response] = await client.getChatAppConfig({
name: 'projects/PROJECT_NUMBER/chatAppConfig',
view: 'FULL',
});
console.log(JSON.stringify(response, null, 2));
}
getChatAppConfig();
Python
from google.cloud import gsuiteaddons_v1
client = gsuiteaddons_v1.GSuiteAddOnsClient()
request = gsuiteaddons_v1.GetChatAppConfigRequest(
name="projects/PROJECT_NUMBER/chatAppConfig",
view=gsuiteaddons_v1.GetChatAppConfigRequest.ChatAppConfigView.FULL,
)
response = client.get_chat_app_config(request=request)
print(response)
用量限额
chatAppConfig 方法具有每个项目的配额。如果您超出配额,请求会失败,并返回 429: Too many requests HTTP 状态代码。如需了解配额限制,请参阅 Google Workspace 插件 API 用量限额。
排查错误
如果 chatAppConfig 请求失败,请检查错误响应中的 HTTP 状态代码和 message 字段。下表列出了常见错误、其原因以及解决方法。
| HTTP 状态代码 | 常见原因 | 分辨率 |
|---|---|---|
400: Bad Request (INVALID_ARGUMENT) |
|
检查 message 字段中是否存在无效字段,并更正请求。如需了解支持的字段和值,请参阅 projects.chatAppConfig 参考文档。 |
400: Bad Request (FAILED_PRECONDITION) |
|
|
403: Forbidden (PERMISSION_DENIED) |
|
|
404: Not Found (NOT_FOUND) |
资源名称中的云项目不存在,或者经过身份验证的用户无法访问该项目。 | 检查资源名称是否使用了格式为 projects/PROJECT_NUMBER/chatAppConfig 的正确项目编号,以及用户是否有权访问云项目。 |
429: Too Many Requests (RESOURCE_EXHAUSTED) |
超出了每个项目的配额。 | 请稍后重试请求。如需了解限制,请参阅用量限额。 |
现有 Google Workspace 插件的注意事项
与扩展其他 Google Workspace 应用的 Google Workspace 插件相比,Chat 应用需要不同的配置。如果您的插件扩展了其他 Google Workspace 应用,请考虑以下配置 Chat 应用的要求:
- 个人和 Google Workspace 管理员都必须能够从 Marketplace 安装您的插件。您可以在 Marketplace SDK 中 配置这些安装设置
- Chat 应用不会使用您在清单的
addons.common对象中为其他 Google Workspace 应用配置的名称和徽标。 - 对于已发布到 Google Workspace Marketplace 的插件,您无法保存对 Google Chat API 配置设置所做任何更改的草稿。更新并保存 Chat API 配置设置后,所有现有用户都可以立即使用更新后的 Chat 应用。如需更新 Marketplace 商品详情,您可以在提交任何更改之前创建草稿。
- 如果您使用 Apps 脚本构建了插件:
- 您必须使用与插件配置的其余部分相同的 Apps 脚本部署 ID。
- 您无法使用 Apps 脚本编辑器在 Chat 中安装测试部署。您必须直接从 Chat 界面安装这些应用。
- 如果您使用 HTTP 服务构建了插件,请在您使用 Google Workspace Add-ons API 创建的
projects.deployments清单中省略任何 Chat 扩展应用配置详细信息。您在 Google Workspace Marketplace SDK 中指定的 HTTP 部署仅用于其他 Google Workspace 应用。而应在 Google Cloud 控制台中、使用 gcloud CLI 或使用 Google Workspace Add-ons API 中的chatAppConfig资源配置 Chat 应用。
向其他人授予配置 Chat API 的权限
您可以向特定用户授予 Chat 应用所有者或 Chat 应用查看者 Google Cloud Identity Access Management (IAM) 角色,从而向其授予对 Chat 应用配置页面的访问权限。拥有这些角色的用户无法使用“API 和服务”信息中心前往 Chat 应用配置页面,但可以前往 Chat 应用的主机云项目的 Google Cloud 控制台,访问配置页面,具体操作如下:
https://console.developers.google.com/apis/api/chat.googleapis.com/hangouts-chat?project=PROJECT_ID
其中,PROJECT_ID 是托管 Chat 应用的 Google Cloud 项目的项目 ID。
相关主题
非插件的 Chat 应用:配置 Google Chat API
如果您维护的 Chat 应用不是 Google Workspace 插件,则您的配置会为所有互动事件使用单个端点,而不是为每个事件使用触发器:
在 Google Cloud 控制台中,前往 Chat API 配置页面:
在互动功能下,开启启用互动功能。
清除将此 Chat 扩展应用作为 Google Workspace 插件构建。系统会打开一个对话框,要求您进行确认。在对话框中,点击停用。
在功能下,根据需要选择支持应用主屏幕或加入聊天室和群组对话。
在连接设置下,为您的 Chat 应用指定一个端点(HTTP 端点网址、Apps 脚本部署 ID、Cloud Pub/Sub 主题名称或 Dialogflow)。
配置可选的命令、预设提示词、链接预览、公开范围和日志,然后点击保存。
如需将非插件的 Chat 应用升级为扩展 Google Chat 的 Google Workspace 插件,请参阅将 Google Chat 应用转换为 Google Workspace 插件。