このページは Cloud Translation API によって翻訳されました。

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

CreateDeployment
`rpc CreateDeployment(CreateDeploymentRequest) returns (Deployment)` 指定された名前と構成で Deployment を作成します。認可スコープ次の OAuth スコープが必要です。 `https://www.googleapis.com/auth/cloud-platform` 詳細については、承認ガイドをご覧ください。

rpc CreateDeployment(CreateDeploymentRequest) returns (Deployment)

指定された名前と構成で Deployment を作成します。

認可スコープ

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

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

詳細については、承認ガイドをご覧ください。

DeleteDeployment

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

rpc DeleteDeployment(DeleteDeploymentRequest) returns (Empty)

指定した名前の Deployment を削除します。

認可スコープ

次の 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

詳細については、承認ガイドをご覧ください。

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

デプロイメントを作成するためのリクエストメッセージ。

フィールド

フィールド
`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` この値は、ストレージ内の Deployment のバージョンに基づいてサーバーによって計算され、続行する前にクライアントの値が最新であることを確認するために、更新リクエストと削除リクエスト時に送信されます。

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