Package google.cloud.gsuiteaddons.v1

索引

GSuiteAddOns

用于管理 Google Workspace 附加服务部署的一项服务。

CreateDeployment

rpc CreateDeployment(CreateDeploymentRequest) returns (Deployment)

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

授权范围

需要以下 OAuth 范围：

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

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

rpc DeleteDeployment(DeleteDeploymentRequest) returns (Empty)

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

授权范围

需要以下 OAuth 范围：

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

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

rpc GetAuthorization(GetAuthorizationRequest) returns (Authorization)

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

授权范围

需要以下 OAuth 范围：

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

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

rpc GetDeployment(GetDeploymentRequest) returns (Deployment)

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

授权范围

需要以下 OAuth 范围：

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

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

rpc GetInstallStatus(GetInstallStatusRequest) returns (InstallStatus)

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

授权范围

需要以下 OAuth 范围：

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

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

rpc InstallDeployment(InstallDeploymentRequest) returns (Empty)

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

授权范围

需要以下 OAuth 范围：

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

有关详情，请参阅授权指南。
ListDeployments

rpc ListDeployments(ListDeploymentsRequest) returns (ListDeploymentsResponse)

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

授权范围

需要以下 OAuth 范围：

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

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

rpc ReplaceDeployment(ReplaceDeploymentRequest) returns (Deployment)

使用指定名称创建或替换部署。

授权范围

需要以下 OAuth 范围：

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

有关详情，请参阅授权指南。
UninstallDeployment

rpc UninstallDeployment(UninstallDeploymentRequest) returns (Empty)

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

授权范围

需要以下 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 文档插件配置。
sheets

SheetsAddOnManifest

表格插件配置。
slides

SlidesAddOnManifest

幻灯片插件配置。
httpOptions

HttpOptions

用于向插件 HTTP 端点发送请求的选项

授权

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

字段
name

string

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

string

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

string

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

CreateDeploymentRequest

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

字段
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 匹配。

部署

Google Workspace 插件部署

字段
name

string

部署资源名称。示例：projects/123/deployments/my_deployment。
oauthScopes[]

string

要在执行插件端点之前向最终用户征求同意的 Google OAuth 范围列表。
addOns

AddOns

Google Workspace 插件配置。
etag

string

此值由服务器根据存储空间中的部署版本计算得出，可在更新和删除请求中发送，以确保客户端在继续操作之前具有最新值。

GetAuthorizationRequest

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

字段
name

string

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

示例：projects/my_project/authorization。

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

  • gsuiteaddons.authorizations.get

GetDeploymentRequest

获取部署的请求消息。

字段
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

InstallDeploymentRequest

用于请求安装要测试的部署的消息。

字段
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。

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 的所有其他参数必须与提供页面令牌的调用匹配。

ListDeploymentsResponse

用于列出部署的响应消息。

字段
deployments[]

Deployment

给定项目的部署列表。
nextPageToken

string

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

ReplaceDeploymentRequest

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

字段
deployment

Deployment

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

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

  • gsuiteaddons.deployments.update

UninstallDeploymentRequest

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

字段
name

string

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

示例：projects/my_project/deployments/my_deployment。

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

  • gsuiteaddons.deployments.execute