Package google.cloud.gsuiteaddons.v1

索引

G Suite アドオン

Google Workspace アドオンのデプロイを管理するためのサービス。

デプロイの作成

rpc CreateDeployment(CreateDeploymentRequest) returns (Deployment)

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

認可スコープ

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

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

詳しくは、認可ガイドをご覧ください。
デプロイの削除

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

詳しくは、認可ガイドをご覧ください。
インストール デプロイ

rpc InstallDeployment(InstallDeploymentRequest) returns (Empty)

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

認可スコープ

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

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

詳しくは、認可ガイドをご覧ください。
ListDeployment

rpc ListDeployments(ListDeploymentsRequest) returns (ListDeploymentsResponse)

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

認可スコープ

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

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

詳しくは、認可ガイドをご覧ください。
置換デプロイ

rpc ReplaceDeployment(ReplaceDeploymentRequest) returns (Deployment)

指定した名前で Deployment を作成または置換します。

認可スコープ

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

CreateDeploymentRequest

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

フィールド
parent

string

必須。デプロイを作成するプロジェクトの名前。

（例: projects/my_project）。

認可には、指定されたリソース parent に対する次の IAM の権限が必要です。

  • gsuiteaddons.deployments.create
deploymentId

string

必須。このデプロイに使用する ID。作成されるリソースの完全な名前は projects/<project_number>/deployments/<deployment_id> です。
deployment

Deployment

必須。作成する Deployment（deployment.name は設定できません）。

DeleteDeploymentRequest

デプロイメントの削除をリクエストするメッセージ。

フィールド
name

string

必須。削除するデプロイメントの完全なリソース名。

（例: projects/my_project/deployments/my_deployment）。

認可には、指定されたリソース name に対する次の IAM の権限が必要です。

  • gsuiteaddons.deployments.delete
etag

string

削除する Deployment の ETag。指定する場合は、サーバーの ETag と一致させる必要があります。

Deployment

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

テスト用に Deployment をインストールするためのリクエスト メッセージ。

フィールド
name

string

必須。インストールするデプロイの完全なリソース名。

（例: projects/my_project/deployments/my_deployment）。

認可には、指定されたリソース name に対する次の IAM の権限が必要です。

  • gsuiteaddons.deployments.install

インストール ステータス

テストデプロイのインストール ステータス。

フィールド
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 として送信できるトークン。このフィールドを省略すると、後続のページはなくなります。

置換デプロイ リクエスト

デプロイの作成または置換をリクエストするメッセージ。

フィールド
deployment

Deployment

必須。作成または置換するデプロイ。

認可には、指定されたリソース deployment に対する次の IAM の権限が必要です。

  • gsuiteaddons.deployments.update

アンインストール デプロイのリクエスト

テストデプロイのアンインストールをリクエストするメッセージ。

フィールド
name

string

必須。インストールするデプロイの完全なリソース名。

（例: projects/my_project/deployments/my_deployment）。

認可には、指定されたリソース name に対する次の IAM の権限が必要です。

  • gsuiteaddons.deployments.execute