本頁面由 Cloud Translation API 翻譯而成。

Package google.cloud.gsuiteaddons.v1

索引

GSuiteAddOns (介面)
AddOns (訊息)
Authorization (訊息)
CreateDeploymentRequest (訊息)
DeleteDeploymentRequest (訊息)
Deployment (訊息)
GetAuthorizationRequest (訊息)
GetDeploymentRequest (訊息)
GetInstallStatusRequest (訊息)
InstallDeploymentRequest (訊息)
InstallStatus (訊息)
ListDeploymentsRequest (訊息)
ListDeploymentsResponse (訊息)
ReplaceDeploymentRequest (訊息)
UninstallDeploymentRequest (訊息)

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

詳情請參閱授權指南。

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

詳情請參閱授權指南。

外掛程式

Google Workspace 外掛程式設定。

欄位
`common`	`CommonAddOnManifest` 所有 Google Workspace 外掛程式都適用的設定。
`gmail`	`GmailAddOnManifest` Gmail 外掛程式設定。
`drive`	`DriveAddOnManifest` 雲端硬碟外掛程式設定。
`calendar`	`CalendarAddOnManifest` 日曆外掛程式設定。
`docs`	`DocsAddOnManifest` 文件外掛程式設定。
`sheets`	`SheetsAddOnManifest` 試算表外掛程式設定。
`slides`	`SlidesAddOnManifest` 簡報外掛程式設定。
`httpOptions`	`HttpOptions` 傳送要求至外掛 HTTP 端點的選項

授權

叫用部署端點時使用的授權資訊。

欄位

欄位
`name`	`string` 這項資源的標準全名。範例：`projects/123/authorization`
`serviceAccountEmail`	`string` 用來驗證對外掛程式回呼端點要求的服務帳戶電子郵件地址。
`oauthClientId`	`string` 用於代表外掛程式為使用者取得 OAuth 存取權憑證的 OAuth 用戶端 ID。

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)。

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` 伺服器會根據儲存空間中的部署版本計算這個值，並可能會在更新與刪除要求時傳送，確保用戶端有最新的值再繼續。

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

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

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` 如果為使用者安裝部署作業，則為「是」。

name

string

部署項目安裝狀態的標準完整資源名稱。

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

installed

BoolValue

如果為使用者安裝部署作業，則為「是」。

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