Package google.cloud.gsuiteaddons.v1

索引

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

G Suite 外掛程式

用於管理 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 日曆外掛程式設定。
docs	DocsAddOnManifest 文件外掛程式設定。
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 相符。

部署作業

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