このページは 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` 詳細については、OAuth 2.0 Overview をご覧ください。

rpc CreateDeployment(CreateDeploymentRequest) returns (Deployment)

指定した名前と構成でデプロイメントを作成します。

認可スコープ

次の OAuth スコープが必要です。

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

詳細については、OAuth 2.0 Overview をご覧ください。

DeleteDeployment

DeleteDeployment
`rpc DeleteDeployment(DeleteDeploymentRequest) returns (Empty)` 指定された名前のデプロイメントを削除します。認可スコープ次の OAuth スコープが必要です。 `https://www.googleapis.com/auth/cloud-platform` 詳細については、OAuth 2.0 Overview をご覧ください。

rpc DeleteDeployment(DeleteDeploymentRequest) returns (Empty)

指定された名前のデプロイメントを削除します。

認可スコープ

次の OAuth スコープが必要です。

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

詳細については、OAuth 2.0 Overview をご覧ください。

GetAuthorization

GetAuthorization
`rpc GetAuthorization(GetAuthorizationRequest) returns (Authorization)` 特定のプロジェクトのデプロイの認可情報を取得します。認可スコープ次の OAuth スコープが必要です。 `https://www.googleapis.com/auth/cloud-platform` 詳細については、OAuth 2.0 Overview をご覧ください。

rpc GetAuthorization(GetAuthorizationRequest) returns (Authorization)

特定のプロジェクトのデプロイの認可情報を取得します。

認可スコープ

次の OAuth スコープが必要です。

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

詳細については、OAuth 2.0 Overview をご覧ください。

GetDeployment

GetDeployment
`rpc GetDeployment(GetDeploymentRequest) returns (Deployment)` 指定された名前のデプロイメントを取得します。認可スコープ次の OAuth スコープが必要です。 `https://www.googleapis.com/auth/cloud-platform` 詳細については、OAuth 2.0 Overview をご覧ください。

rpc GetDeployment(GetDeploymentRequest) returns (Deployment)

指定された名前のデプロイメントを取得します。

認可スコープ

次の OAuth スコープが必要です。

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

詳細については、OAuth 2.0 Overview をご覧ください。

GetInstallStatus

GetInstallStatus
`rpc GetInstallStatus(GetInstallStatusRequest) returns (InstallStatus)` テスト用デプロイのインストールステータスを取得します。認可スコープ次の OAuth スコープが必要です。 `https://www.googleapis.com/auth/cloud-platform` 詳細については、OAuth 2.0 Overview をご覧ください。

rpc GetInstallStatus(GetInstallStatusRequest) returns (InstallStatus)

テスト用デプロイのインストールステータスを取得します。

認可スコープ

次の OAuth スコープが必要です。

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

詳細については、OAuth 2.0 Overview をご覧ください。

InstallDeployment

InstallDeployment
`rpc InstallDeployment(InstallDeploymentRequest) returns (Empty)` テスト用にデプロイメントをアカウントにインストールします。詳細については、アドオンをテストするをご覧ください。認可スコープ次の OAuth スコープが必要です。 `https://www.googleapis.com/auth/cloud-platform` 詳細については、OAuth 2.0 Overview をご覧ください。

rpc InstallDeployment(InstallDeploymentRequest) returns (Empty)

テスト用にデプロイメントをアカウントにインストールします。詳細については、アドオンをテストするをご覧ください。

認可スコープ

次の OAuth スコープが必要です。

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

詳細については、OAuth 2.0 Overview をご覧ください。

ListDeployments

ListDeployments
`rpc ListDeployments(ListDeploymentsRequest) returns (ListDeploymentsResponse)` 特定のプロジェクト内のすべてのデプロイメントを一覧表示します。認可スコープ次の OAuth スコープが必要です。 `https://www.googleapis.com/auth/cloud-platform` 詳細については、OAuth 2.0 Overview をご覧ください。

rpc ListDeployments(ListDeploymentsRequest) returns (ListDeploymentsResponse)

特定のプロジェクト内のすべてのデプロイメントを一覧表示します。

認可スコープ

次の OAuth スコープが必要です。

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

詳細については、OAuth 2.0 Overview をご覧ください。

ReplaceDeployment

ReplaceDeployment
`rpc ReplaceDeployment(ReplaceDeploymentRequest) returns (Deployment)` 指定した名前のデプロイメントを作成または置き換えます。認可スコープ次の OAuth スコープが必要です。 `https://www.googleapis.com/auth/cloud-platform` 詳細については、OAuth 2.0 Overview をご覧ください。

rpc ReplaceDeployment(ReplaceDeploymentRequest) returns (Deployment)

指定した名前のデプロイメントを作成または置き換えます。

認可スコープ

次の OAuth スコープが必要です。

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

詳細については、OAuth 2.0 Overview をご覧ください。

UninstallDeployment

UninstallDeployment
`rpc UninstallDeployment(UninstallDeploymentRequest) returns (Empty)` ユーザーのアカウントからテストのデプロイメントをアンインストールします。詳細については、アドオンをテストするをご覧ください。認可スコープ次の OAuth スコープが必要です。 `https://www.googleapis.com/auth/cloud-platform` 詳細については、OAuth 2.0 Overview をご覧ください。

rpc UninstallDeployment(UninstallDeploymentRequest) returns (Empty)

ユーザーのアカウントからテストのデプロイメントをアンインストールします。詳細については、アドオンをテストするをご覧ください。

認可スコープ

次の OAuth スコープが必要です。

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

詳細については、OAuth 2.0 Overview をご覧ください。

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。

name

string

このリソースの正規の完全な名前。例: projects/123/authorization

serviceAccountEmail

string

アドオンコールバックエンドポイントへのリクエストの認証に使用されるサービスアカウントのメールアドレス。

oauthClientId

string

アドオンの代わりにユーザーの OAuth アクセストークンを取得するために使用される OAuth クライアント ID。

CreateDeploymentRequest

Deployment の作成リクエストメッセージ。

フィールド

フィールド
`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` デプロイがユーザーにインストールされている場合は true。

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` に指定する他のすべてのパラメータは、ページトークンを提供した呼び出しと一致する必要があります。

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