Google 会使用 AI 技术将内容翻译成您偏好的语言。AI 翻译可能包含错误。

Package google.cloud.gsuiteaddons.v1

索引

GSuiteAddOns（接口）
AddOns（消息）
AppCommand（消息）
AppCommand.CommandType（枚举）
AppsScriptEndpointConfig（消息）
AppsScriptPerEventEndpointConfig（消息）
Authorization（消息）
ChatAppConfig（消息）
ChatAppConfig.AppState（枚举）
ChatAppConfig.MarkupSyntax（枚举）
CloudPubSubEndpointConfig（消息）
ConnectionConfig（消息）
CreateDeploymentRequest（消息）
DeleteDeploymentRequest（消息）
Deployment（消息）
DialogflowEndpointConfig（消息）
DialogflowEndpointConfig.DialogflowEdition（枚举）
GetAuthorizationRequest（消息）
GetChatAppConfigRequest（消息）
GetChatAppConfigRequest.ChatAppConfigView（枚举）
GetDeploymentRequest（消息）
GetInstallStatusRequest（消息）
HttpEndpointConfig（消息）
HttpPerEventEndpointConfig（消息）
InstallDeploymentRequest（消息）
InstallStatus（消息）
InteractiveFeatureConfig（消息）
ListDeploymentsRequest（消息）
ListDeploymentsResponse（消息）
ReplaceDeploymentRequest（消息）
UninstallDeploymentRequest（消息）
UpdateChatAppConfigRequest（消息）
UrlPattern（消息）

GSuiteAddOns

一项用于管理 Google Workspace 插件部署的服务。

CreateDeployment

CreateDeployment
`rpc CreateDeployment(CreateDeploymentRequest) returns (Deployment)` 创建具有指定名称和配置的部署。授权范围需要以下 OAuth 范围： `https://www.googleapis.com/auth/cloud-platform` 如需了解详情，请参阅授权指南。

rpc CreateDeployment(CreateDeploymentRequest) returns (Deployment)

创建具有指定名称和配置的部署。

授权范围

需要以下 OAuth 范围：

https://www.googleapis.com/auth/cloud-platform

如需了解详情，请参阅授权指南。

DeleteDeployment

DeleteDeployment
`rpc DeleteDeployment(DeleteDeploymentRequest) returns (Empty)` 删除具有指定名称的部署。授权范围需要以下 OAuth 范围： `https://www.googleapis.com/auth/cloud-platform` 如需了解详情，请参阅授权指南。

rpc DeleteDeployment(DeleteDeploymentRequest) returns (Empty)

删除具有指定名称的部署。

授权范围

需要以下 OAuth 范围：

https://www.googleapis.com/auth/cloud-platform

如需了解详情，请参阅授权指南。

GetAuthorization

GetAuthorization
`rpc GetAuthorization(GetAuthorizationRequest) returns (Authorization)` 获取给定项目中部署的授权信息。授权范围需要以下 OAuth 范围： `https://www.googleapis.com/auth/cloud-platform` 如需了解详情，请参阅授权指南。

rpc GetAuthorization(GetAuthorizationRequest) returns (Authorization)

获取给定项目中部署的授权信息。

授权范围

需要以下 OAuth 范围：

https://www.googleapis.com/auth/cloud-platform

如需了解详情，请参阅授权指南。

GetChatAppConfig

GetChatAppConfig
`rpc GetChatAppConfig(GetChatAppConfigRequest) returns (ChatAppConfig)` 开发者预览版：作为 Google Workspace 开发者预览版计划的一部分提供，让您能够抢先体验某些功能。获取项目的 Chat 应用配置。仅支持以 Google Workspace 插件形式构建的 Chat 扩展应用。每个 Google Cloud 项目只能有一个 Chat 应用配置。需要使用用户凭据以及项目的 `gsuiteaddons.chatAppConfigs.get` 和 `chat.bots.get` IAM 权限进行身份验证和授权。授权范围需要以下 OAuth 范围之一： `https://www.googleapis.com/auth/cloud-platform` `https://www.googleapis.com/auth/cloud-platform.read-only` 如需了解详情，请参阅授权指南。

rpc GetChatAppConfig(GetChatAppConfigRequest) returns (ChatAppConfig)

获取项目的 Chat 应用配置。仅支持以 Google Workspace 插件形式构建的 Chat 扩展应用。每个 Google Cloud 项目只能有一个 Chat 应用配置。

需要使用用户凭据以及项目的 gsuiteaddons.chatAppConfigs.get 和 chat.bots.get IAM 权限进行身份验证和授权。

授权范围

需要以下 OAuth 范围之一：

https://www.googleapis.com/auth/cloud-platform
https://www.googleapis.com/auth/cloud-platform.read-only

如需了解详情，请参阅授权指南。

GetDeployment

GetDeployment
`rpc GetDeployment(GetDeploymentRequest) returns (Deployment)` 获取具有指定名称的部署。授权范围需要以下 OAuth 范围： `https://www.googleapis.com/auth/cloud-platform` 如需了解详情，请参阅授权指南。

rpc GetDeployment(GetDeploymentRequest) returns (Deployment)

获取具有指定名称的部署。

授权范围

需要以下 OAuth 范围：

https://www.googleapis.com/auth/cloud-platform

如需了解详情，请参阅授权指南。

GetInstallStatus

GetInstallStatus
`rpc GetInstallStatus(GetInstallStatusRequest) returns (InstallStatus)` 获取测试部署的安装状态。授权范围需要以下 OAuth 范围： `https://www.googleapis.com/auth/cloud-platform` 如需了解详情，请参阅授权指南。

rpc GetInstallStatus(GetInstallStatusRequest) returns (InstallStatus)

获取测试部署的安装状态。

授权范围

需要以下 OAuth 范围：

https://www.googleapis.com/auth/cloud-platform

如需了解详情，请参阅授权指南。

InstallDeployment

InstallDeployment
`rpc InstallDeployment(InstallDeploymentRequest) returns (Empty)` 将部署安装到您的账号中以进行测试。如需了解详情，请参阅测试插件授权范围需要以下 OAuth 范围： `https://www.googleapis.com/auth/cloud-platform` 如需了解详情，请参阅授权指南。

rpc InstallDeployment(InstallDeploymentRequest) returns (Empty)

将部署安装到您的账号中以进行测试。如需了解详情，请参阅测试插件

授权范围

需要以下 OAuth 范围：

https://www.googleapis.com/auth/cloud-platform

如需了解详情，请参阅授权指南。

ListDeployments

ListDeployments
`rpc ListDeployments(ListDeploymentsRequest) returns (ListDeploymentsResponse)` 列出特定项目中的所有部署。授权范围需要以下 OAuth 范围： `https://www.googleapis.com/auth/cloud-platform` 如需了解详情，请参阅授权指南。

rpc ListDeployments(ListDeploymentsRequest) returns (ListDeploymentsResponse)

列出特定项目中的所有部署。

授权范围

需要以下 OAuth 范围：

https://www.googleapis.com/auth/cloud-platform

如需了解详情，请参阅授权指南。

ReplaceDeployment

ReplaceDeployment
`rpc ReplaceDeployment(ReplaceDeploymentRequest) returns (Deployment)` 创建或替换具有指定名称的部署。授权范围需要以下 OAuth 范围： `https://www.googleapis.com/auth/cloud-platform` 如需了解详情，请参阅授权指南。

rpc ReplaceDeployment(ReplaceDeploymentRequest) returns (Deployment)

创建或替换具有指定名称的部署。

授权范围

需要以下 OAuth 范围：

https://www.googleapis.com/auth/cloud-platform

如需了解详情，请参阅授权指南。

UninstallDeployment

UninstallDeployment
`rpc UninstallDeployment(UninstallDeploymentRequest) returns (Empty)` 从用户账号中卸载测试部署。如需了解详情，请参阅测试插件。授权范围需要以下 OAuth 范围： `https://www.googleapis.com/auth/cloud-platform` 如需了解详情，请参阅授权指南。

rpc UninstallDeployment(UninstallDeploymentRequest) returns (Empty)

从用户账号中卸载测试部署。如需了解详情，请参阅测试插件。

授权范围

需要以下 OAuth 范围：

https://www.googleapis.com/auth/cloud-platform

如需了解详情，请参阅授权指南。

UpdateChatAppConfig

UpdateChatAppConfig
`rpc UpdateChatAppConfig(UpdateChatAppConfigRequest) returns (ChatAppConfig)` 开发者预览版：作为 Google Workspace 开发者预览版计划的一部分提供，让您能够抢先体验某些功能。更新项目的 Chat 应用配置。仅支持以 Google Workspace 插件形式构建的 Chat 扩展应用。每个 Google Cloud 项目只能有一个 Chat 应用配置。需要使用用户凭据以及项目的 `gsuiteaddons.chatAppConfigs.update`、`chat.bots.update` 和 `chat.bots.get` IAM 权限进行身份验证和授权。授权范围需要以下 OAuth 范围： `https://www.googleapis.com/auth/cloud-platform` 如需了解详情，请参阅授权指南。

rpc UpdateChatAppConfig(UpdateChatAppConfigRequest) returns (ChatAppConfig)

更新项目的 Chat 应用配置。仅支持以 Google Workspace 插件形式构建的 Chat 扩展应用。每个 Google Cloud 项目只能有一个 Chat 应用配置。

需要使用用户凭据以及项目的 gsuiteaddons.chatAppConfigs.update、chat.bots.update 和 chat.bots.get IAM 权限进行身份验证和授权。

授权范围

需要以下 OAuth 范围：

https://www.googleapis.com/auth/cloud-platform

如需了解详情，请参阅授权指南。

AddOns

Google Workspace 插件配置。

字段
`common`	`CommonAddOnManifest` 所有 Google Workspace 插件通用的配置。
`gmail`	`GmailAddOnManifest` Gmail 插件配置。
`drive`	`DriveAddOnManifest` 云端硬盘插件配置。
`calendar`	`CalendarAddOnManifest` Google 日历插件配置。
`docs`	`DocsAddOnManifest` Google 文档插件配置。
`meet`	`MeetAddOnManifest` Meet 插件配置。
`sheets`	`SheetsAddOnManifest` Google 表格插件配置。
`slides`	`SlidesAddOnManifest` Google 幻灯片插件配置。
`httpOptions`	`HttpOptions` 用于向插件 HTTP 端点发送请求的选项

AppCommand

应用命令的配置。

字段
`commandType`	`CommandType` 必需。此命令的类型。
`commandId`	`int32` 必需。命令的 ID (1-1000)。在应用中必须是唯一的。
`command`	`string` 可选。命令的名称。对于 SLASH_COMMAND，此字段为必填字段；对于其他命令类型，请勿设置此字段。必须以“/”开头，例如“/command”。
`displayName`	`string` 可选。命令的人性化显示名称。对于 MESSAGE_ACTION 和 QUICK_COMMAND，此字段是必需的；对于 SLASH_COMMAND，请勿设置此字段。
`description`	`string` 必需。命令的简短说明。
`dialogEnabled`	`bool` 可选。此命令是否应触发对话框。如果未指定，则默认为 `false`。
`loadingNotificationMessage`	`string` 可选。当用户触发消息操作时，系统会向其发送通知。仅 MESSAGE_ACTION 命令支持此字段。

CommandType

应用命令的类型。

枚举
`COMMAND_TYPE_UNSPECIFIED`	默认值。未指定。
`SLASH_COMMAND`	通过输入“/”后跟命令名称调用的命令。它可能会在消息文本中接受其他参数。
`QUICK_COMMAND`	从邮件撰写上下文菜单中调用的快捷命令。快捷命令不接受其他参数。
`MESSAGE_ACTION`	从消息上下文菜单调用的命令。

AppsScriptEndpointConfig

Apps 脚本端点配置。

字段

字段
`deploymentId`	`string` 必需。Apps 脚本部署 ID。
`perEventEndpointConfig`	`AppsScriptPerEventEndpointConfig` 可选。Google Chat 针对每种类型的互动事件调用的 Apps 脚本函数的名称。如果未指定，Chat 会为每种事件类型调用默认函数。

deploymentId

string

必需。Apps 脚本部署 ID。

perEventEndpointConfig

AppsScriptPerEventEndpointConfig

可选。Google Chat 针对每种类型的互动事件调用的 Apps 脚本函数的名称。如果未指定，Chat 会为每种事件类型调用默认函数。

AppsScriptPerEventEndpointConfig

特定事件类型的 Apps 脚本端点配置。

字段
`appCommandEndpoint`	`string` 可选。应用命令事件的函数名称。如果未指定，系统将使用默认的 `onAppCommand` 函数名称。
`addedToSpaceEndpoint`	`string` 可选。“已添加到聊天室”事件的函数名称。如果未指定，系统将使用默认 `onAddedToSpace` 函数名称。
`messageEndpoint`	`string` 可选。消息事件的函数名称。如果未指定，系统将使用默认的 `onMessage` 函数名称。
`removedFromSpaceEndpoint`	`string` 可选。从聊天室中移除事件的函数名称。如果未指定，系统将使用默认 `onRemovedFromSpace` 函数名称。

授权

调用部署端点时使用的授权信息。

字段

字段
`name`	`string` 此资源的规范全名。示例：`projects/123/authorization`
`serviceAccountEmail`	`string` 用于对插件回调端点请求进行身份验证的服务账号的电子邮件地址。
`oauthClientId`	`string` OAuth 客户端 ID，用于代表插件获取用户的 OAuth 访问令牌。

name

string

此资源的规范全名。示例：projects/123/authorization

serviceAccountEmail

string

用于对插件回调端点请求进行身份验证的服务账号的电子邮件地址。

oauthClientId

string

OAuth 客户端 ID，用于代表插件获取用户的 OAuth 访问令牌。

ChatAppConfig

表示作为 Google Workspace 插件构建的 Google Chat 应用的配置。

字段
`name`	`string` 必需。标识符。Chat 应用配置的资源名称。格式：`projects/{project}/chatAppConfig`，其中 `{project}` 是 Google Cloud 项目编号。
`displayName`	`string` 必需。Chat 应用的显示名称。长度应介于 3 到 25 个字符之间。
`description`	`string` 必需。Chat 应用的简短说明。长度应介于 1 到 40 个字符之间。
`interactiveFeatureConfig`	`InteractiveFeatureConfig` 可选。应用的互动功能设置。如果未提供此设置，应用将不具备互动功能，这意味着应用可以使用 Chat API，但用户无法与应用互动。
`avatarUri`	`string` 可选。应用头像图片的网址。必须是托管一张方形（宽高比为 1:1）PNG 图片的 HTTPS 网址。建议的最小尺寸：256 x 256 像素。如果未指定，系统将使用默认应用头像。
`state`	`AppState` 可选。应用的状态。如果未指定，则默认为 `ACTIVE`。
`errorLoggingEnabled`	`bool` 可选。是否将错误记录到 Cloud Logging。如果未指定，则默认为 `false`。
`markupSyntax`	`MarkupSyntax` 可选。此 Chat 应用发送或读取的消息的默认标记语法。如果未指定，则默认值为 `MARKUP_SYNTAX_MARKDOWN`。

AppState

Chat 应用的当前状态。

枚举
`APP_STATE_UNSPECIFIED`	默认值。未指定。
`ACTIVE`	映射到 Chat API 配置页面中的“LIVE”。应用处于活跃状态，可供有权查看的用户找到和使用。
`DISABLED`	该应用已被停用，任何人都无法再找到该应用，也无法再与该应用对话。

MarkupSyntax

用于设置此 Chat 应用的消息文本格式的标记语法。

枚举
`MARKUP_SYNTAX_UNSPECIFIED`	默认值。未指定。在 `markup_syntax` 推出之前创建的现有 Chat 应用具有此值，并会一直使用 `MARKUP_SYNTAX_CHAT`，直到明确更新。
`MARKUP_SYNTAX_CHAT`	使用 Google Chat 的标记语法。如需了解详情，请参阅 https://developers.google.com/workspace/chat/format-messages#format-texts。
`MARKUP_SYNTAX_MARKDOWN`	使用 Markdown 语法。此语法基于 CommonMark 规范，并包含其他扩展。如需了解详情，请参阅 https://developers.google.com/workspace/chat/format-messages#format-texts。

CloudPubSubEndpointConfig

Pub/Sub 端点配置。

字段

字段
`topic`	`string` 必需。Google Chat 将所有互动事件发布到的 Pub/Sub 主题。主题必须与应用位于同一 Google Cloud 云项目中，并且 Chat 必须有权向该主题发布消息。如需了解详情，请参阅使用 Pub/Sub 构建 Google Chat 应用。格式：`projects/{project}/topics/{topic}`

topic

string

必需。Google Chat 将所有互动事件发布到的 Pub/Sub 主题。主题必须与应用位于同一 Google Cloud 云项目中，并且 Chat 必须有权向该主题发布消息。如需了解详情，请参阅使用 Pub/Sub 构建 Google Chat 应用。

格式：projects/{project}/topics/{topic}

ConnectionConfig

应用如何接收事件。

字段
联合字段 `config`。连接类型。`config` 只能是下列其中一项：
`httpEndpointConfig`	`HttpEndpointConfig` HTTP 端点配置。
`appsScriptEndpointConfig`	`AppsScriptEndpointConfig` Apps 脚本部署配置。
`cloudPubSubEndpointConfig`	`CloudPubSubEndpointConfig` Pub/Sub 主题配置。
`dialogflowEndpointConfig`	`DialogflowEndpointConfig` Dialogflow 配置。

CreateDeploymentRequest

用于创建部署的请求消息。

字段

字段
`parent`	`string` 必需。要在其中创建部署的项目的名称。示例：`projects/my_project`。必须对指定的资源 `parent` 具有以下 IAM 权限才能进行授权： `gsuiteaddons.deployments.create`
`deploymentId`	`string` 必需。要用于此部署的 ID。所创建资源的完整名称将为 `projects/<project_number>/deployments/<deployment_id>`。
`deployment`	`Deployment` 必需。要创建的部署（无法设置 deployment.name）。

parent

string

必需。要在其中创建部署的项目的名称。

示例：projects/my_project。

必须对指定的资源 parent 具有以下 IAM 权限才能进行授权：

gsuiteaddons.deployments.create

deploymentId

string

必需。要用于此部署的 ID。所创建资源的完整名称将为 projects/<project_number>/deployments/<deployment_id>。

deployment

Deployment

必需。要创建的部署（无法设置 deployment.name）。

DeleteDeploymentRequest

用于删除部署的请求消息。

字段

字段
`name`	`string` 必需。要删除的部署的完整资源名称。示例：`projects/my_project/deployments/my_deployment`。必须对指定的资源 `name` 具有以下 IAM 权限才能进行授权： `gsuiteaddons.deployments.delete`
`etag`	`string` 要删除的部署的 etag。如果提供此值，则必须与服务器的 ETag 相匹配。

name

string

必需。要删除的部署的完整资源名称。

示例：projects/my_project/deployments/my_deployment。

必须对指定的资源 name 具有以下 IAM 权限才能进行授权：

gsuiteaddons.deployments.delete

etag

string

要删除的部署的 etag。如果提供此值，则必须与服务器的 ETag 相匹配。

部署

Google Workspace 插件部署

字段
`name`	`string` 部署资源名称。示例：`projects/123/deployments/my_deployment`。
`oauthScopes[]`	`string` 在执行插件端点之前，需要征求最终用户同意的 Google OAuth 范围列表。
`addOns`	`AddOns` Google Workspace 插件配置。
`etag`	`string` 此值由服务器根据存储中的部署版本计算得出，可在遇到更新和删除请求时发送，以确保客户端在继续操作之前具有最新值。

DialogflowEndpointConfig

Dialogflow 端点配置。

字段

字段
`dialogflowEdition`	`DialogflowEdition` 必需。Dialogflow 版本。
`agent`	`string` 可选。Dialogflow CX 智能体或环境名称。Dialogflow CX 必需。请勿为 Dialogflow ES 设置。格式：`projects/{project}/locations/{location}/agents/{agent}` 或 `projects/{project}/locations/{location}/agents/{agent}/environments/{environment}`。

dialogflowEdition

DialogflowEdition

必需。Dialogflow 版本。

agent

string

可选。Dialogflow CX 智能体或环境名称。Dialogflow CX 必需。请勿为 Dialogflow ES 设置。

格式：projects/{project}/locations/{location}/agents/{agent} 或 projects/{project}/locations/{location}/agents/{agent}/environments/{environment}。

DialogflowEdition

Dialogflow 版本类型。

枚举
`DIALOGFLOW_EDITION_UNSPECIFIED`	默认值。未指定。
`ES`	Dialogflow ES 版本。如需使用此版本，Dialogflow ES 代理必须与应用位于同一 Google Cloud 项目中。Google Chat 会将所有互动事件发送到该代理。
`CX`	Dialogflow CX 版本。如需使用此版本，Dialogflow CX 智能体必须与应用位于同一 Google Cloud 云项目中，并在 `agent` 字段中指定。Google Chat 会将所有互动事件发送到该代理。

GetAuthorizationRequest

用于获取 Google Workspace 插件授权信息的请求消息。

字段

字段
`name`	`string` 必需。要获取其 Google Workspace 插件授权信息的项目的名称。示例：`projects/my_project/authorization`。必须对指定的资源 `name` 具有以下 IAM 权限才能进行授权： `gsuiteaddons.authorizations.get`

name

string

必需。要获取其 Google Workspace 插件授权信息的项目的名称。

示例：projects/my_project/authorization。

必须对指定的资源 name 具有以下 IAM 权限才能进行授权：

gsuiteaddons.authorizations.get

GetChatAppConfigRequest

用于获取 Chat 应用配置的请求消息。

字段

字段
`name`	`string` 必需。Chat 应用配置的资源名称。格式：`projects/{project}/chatAppConfig`，其中 `{project}` 是 Google Cloud 项目编号。必须对指定的资源 `name` 具有以下 IAM 权限才能进行授权： `gsuiteaddons.chatAppConfigs.get`
`view`	`ChatAppConfigView` 可选。要返回的 ChatAppConfig 的视图。如果未指定，则默认为 `BASIC`。

name

string

必需。Chat 应用配置的资源名称。

格式：projects/{project}/chatAppConfig，其中 {project} 是 Google Cloud 项目编号。

必须对指定的资源 name 具有以下 IAM 权限才能进行授权：

gsuiteaddons.chatAppConfigs.get

view

ChatAppConfigView

可选。要返回的 ChatAppConfig 的视图。如果未指定，则默认为 BASIC。

ChatAppConfigView

此视图用于指定应在 ChatAppConfig 资源中填充哪些字段。

枚举
`CHAT_APP_CONFIG_VIEW_UNSPECIFIED`	默认值或未设置的值。默认为 `BASIC`。
`BASIC`	仅填充有关应用配置的基本元数据，不填充互动功能配置。这是默认值。
`FULL`	填充所有字段，包括互动功能配置。

GetDeploymentRequest

用于获取部署的请求消息。

字段

字段
`name`	`string` 必需。要获取的部署的完整资源名称。示例：`projects/my_project/deployments/my_deployment`。必须对指定的资源 `name` 具有以下 IAM 权限才能进行授权： `gsuiteaddons.deployments.get`

name

string

必需。要获取的部署的完整资源名称。

示例：projects/my_project/deployments/my_deployment。

必须对指定的资源 name 具有以下 IAM 权限才能进行授权：

gsuiteaddons.deployments.get

GetInstallStatusRequest

用于获取测试部署的安装状态的请求消息。

字段

字段
`name`	`string` 必需。部署的完整资源名称。示例：`projects/my_project/deployments/my_deployment/installStatus`。必须对指定的资源 `name` 具有以下 IAM 权限才能进行授权： `gsuiteaddons.deployments.installStatus`

name

string

必需。部署的完整资源名称。

示例：projects/my_project/deployments/my_deployment/installStatus。

必须对指定的资源 name 具有以下 IAM 权限才能进行授权：

gsuiteaddons.deployments.installStatus

HttpEndpointConfig

HTTP 端点配置。

字段

字段
联合字段 `config`。HTTP 端点网址配置。`config` 只能是下列其中一项：
`commonUrl`	`string` 可选。Google Chat 向其发送所有互动事件的 HTTPS 网址。
`perEventEndpointConfig`	`HttpPerEventEndpointConfig` 可选。Google Chat 向其发送每种类型的互动事件的单独 HTTPS 网址。

联合字段 config。HTTP 端点网址配置。config 只能是下列其中一项：

commonUrl

string

可选。Google Chat 向其发送所有互动事件的 HTTPS 网址。

perEventEndpointConfig

HttpPerEventEndpointConfig

可选。Google Chat 向其发送每种类型的互动事件的单独 HTTPS 网址。

HttpPerEventEndpointConfig

特定事件类型的 HTTP 端点配置。

字段
`appCommandEndpoint`	`string` 必需。应用命令事件的 HTTPS 网址端点。
`addedToSpaceEndpoint`	`string` 必需。“已添加到聊天室”事件的 HTTPS 网址端点。
`messageEndpoint`	`string` 必需。消息事件的 HTTPS 网址端点。
`removedFromSpaceEndpoint`	`string` 必需。用于接收“从聊天室中移除”事件的 HTTPS 网址端点。

InstallDeploymentRequest

用于安装部署以进行测试的请求消息。

字段

字段
`name`	`string` 必需。要安装的部署的完整资源名称。示例：`projects/my_project/deployments/my_deployment`。必须对指定的资源 `name` 具有以下 IAM 权限才能进行授权： `gsuiteaddons.deployments.install`

name

string

必需。要安装的部署的完整资源名称。

示例：projects/my_project/deployments/my_deployment。

必须对指定的资源 name 具有以下 IAM 权限才能进行授权：

gsuiteaddons.deployments.install

InstallStatus

测试部署的安装状态。

字段

字段
`name`	`string` 部署安装状态的规范完整资源名称。示例：`projects/123/deployments/my_deployment/installStatus`。
`installed`	`BoolValue` 如果已为用户安装部署，则为 True。

name

string

部署安装状态的规范完整资源名称。

示例：projects/123/deployments/my_deployment/installStatus。

installed

BoolValue

如果已为用户安装部署，则为 True。

InteractiveFeatureConfig

应用的互动功能设置。

字段
`connectionConfig`	`ConnectionConfig` 必需。应用如何接收来自 Google Chat 的事件。
`appCommands[]`	`AppCommand` 可选。应用命令的配置。
`urlPatterns[]`	`UrlPattern` 可选。链接预览的配置。
`allowlistedTestingPrincipals[]`	`string` 可选。您 Google Workspace 网域中可以查找和使用该应用的用户和群组的电子邮件地址。
`supportsMultiuserSpaces`	`bool` 可选。应用是否可以添加到 1 对 1 人工私信、群聊和聊天室中。如果未指定，则默认为 `false`。

ListDeploymentsRequest

用于列出项目的部署的请求消息。

字段

字段
`parent`	`string` 必需。要在其中创建部署的项目的名称。示例：`projects/my_project`。必须对指定的资源 `parent` 具有以下 IAM 权限才能进行授权： `gsuiteaddons.deployments.list`
`pageSize`	`int32` 要返回的部署数量上限。服务返回的数量可能小于此值。如果未指定，则系统最多返回 1,000 个部署。最大可能值为 1,000；大于 1,000 的值会更改为 1,000。
`pageToken`	`string` 从之前的 `ListDeployments` 调用接收的页面令牌。利用其进行后续页面检索。进行分页时，提供给 `ListDeployments` 的所有其他参数必须与提供页面令牌的调用匹配。

parent

string

必需。要在其中创建部署的项目的名称。

示例：projects/my_project。

必须对指定的资源 parent 具有以下 IAM 权限才能进行授权：

gsuiteaddons.deployments.list

pageSize

int32

要返回的部署数量上限。服务返回的数量可能小于此值。如果未指定，则系统最多返回 1,000 个部署。最大可能值为 1,000；大于 1,000 的值会更改为 1,000。

pageToken

string

从之前的 ListDeployments 调用接收的页面令牌。利用其进行后续页面检索。

进行分页时，提供给 ListDeployments 的所有其他参数必须与提供页面令牌的调用匹配。

ListDeploymentsResponse

列出部署的响应消息。

字段

字段
`deployments[]`	`Deployment` 给定项目的部署列表。
`nextPageToken`	`string` 可作为 `page_token` 发送并用于检索下一页的令牌。如果省略此字段，则不存在后续页面。

deployments[]

Deployment

给定项目的部署列表。

nextPageToken

string

可作为 page_token 发送并用于检索下一页的令牌。如果省略此字段，则不存在后续页面。

ReplaceDeploymentRequest

用于创建或替换部署的请求消息。

字段

字段
`deployment`	`Deployment` 必需。要创建或替换的部署。必须对指定的资源 `deployment` 具有以下 IAM 权限才能进行授权： `gsuiteaddons.deployments.update`

deployment

Deployment

必需。要创建或替换的部署。

必须对指定的资源 deployment 具有以下 IAM 权限才能进行授权：

gsuiteaddons.deployments.update

UninstallDeploymentRequest

用于卸载测试部署的请求消息。

字段

字段
`name`	`string` 必需。要安装的部署的完整资源名称。示例：`projects/my_project/deployments/my_deployment`。必须对指定的资源 `name` 具有以下 IAM 权限才能进行授权： `gsuiteaddons.deployments.execute`

name

string

必需。要安装的部署的完整资源名称。

示例：projects/my_project/deployments/my_deployment。

必须对指定的资源 name 具有以下 IAM 权限才能进行授权：

gsuiteaddons.deployments.execute

UpdateChatAppConfigRequest

UpdateChatAppConfig 的请求消息。

字段

字段
`chatAppConfig`	`ChatAppConfig` 必需。要更新的应用配置。必须对指定的资源 `chatAppConfig` 具有以下 IAM 权限才能进行授权： `gsuiteaddons.chatAppConfigs.update`
`updateMask`	`FieldMask` 可选。要更新的字段列表。如果省略，则仅更新所提供的 Chat 应用配置中具有非空值的字段。

chatAppConfig

ChatAppConfig

必需。要更新的应用配置。

必须对指定的资源 chatAppConfig 具有以下 IAM 权限才能进行授权：

gsuiteaddons.chatAppConfigs.update

updateMask

FieldMask

可选。要更新的字段列表。

如果省略，则仅更新所提供的 Chat 应用配置中具有非空值的字段。

UrlPattern

链接预览的配置。

字段

字段
`hostPattern`	`string` 必需。要匹配的网域。匹配特定子网域（例如“subdomain.example.com”），或通过添加星号 () 作为前导通配符来匹配整个网域。例如，“.example.com”与“https://subdomain.example.com”和“https://any.number.of.subdomains.example.com”匹配。
`pathPrefix`	`string` 可选。附加到主机模式的路径前缀。如果留空，系统会匹配主机模式中的所有网址。例如，与主机模式“subdomain.example.com”搭配使用时，请指定“path/”以匹配以“https://subdomain.example.com/path/”开头的页面网址。

hostPattern

string

必需。要匹配的网域。匹配特定子网域（例如“subdomain.example.com”），或通过添加星号 (*) 作为前导通配符来匹配整个网域。例如，“*.example.com”与“https://subdomain.example.com”和“https://any.number.of.subdomains.example.com”匹配。

pathPrefix

string

可选。附加到主机模式的路径前缀。如果留空，系统会匹配主机模式中的所有网址。例如，与主机模式“subdomain.example.com”搭配使用时，请指定“path/”以匹配以“https://subdomain.example.com/path/”开头的页面网址。

Package google.cloud.gsuiteaddons.v1 使用集合让一切井井有条 根据您的偏好保存内容并对其进行分类。

索引

GSuiteAddOns

AddOns

AppCommand

CommandType

AppsScriptEndpointConfig

AppsScriptPerEventEndpointConfig

授权

ChatAppConfig

AppState

MarkupSyntax

CloudPubSubEndpointConfig

ConnectionConfig

CreateDeploymentRequest

DeleteDeploymentRequest

部署

DialogflowEndpointConfig

DialogflowEdition

GetAuthorizationRequest

GetChatAppConfigRequest

ChatAppConfigView

GetDeploymentRequest

GetInstallStatusRequest

HttpEndpointConfig

HttpPerEventEndpointConfig

InstallDeploymentRequest

InstallStatus

InteractiveFeatureConfig

ListDeploymentsRequest

ListDeploymentsResponse

ReplaceDeploymentRequest

UninstallDeploymentRequest

UpdateChatAppConfigRequest

UrlPattern

Package google.cloud.gsuiteaddons.v1