Package google.cloud.gsuiteaddons.v1

インデックス

GSuiteAddOns

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

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

フィールド
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

削除するデプロイメントの 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

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

InstallStatus

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

フィールド
name

string

デプロイのインストール ステータスの正規の完全なリソース名。

例: projects/123/deployments/my_deployment/installStatus。
installed

BoolValue

デプロイがユーザーにインストールされている場合は true。

ListDeploymentsRequest

プロジェクトの Deployment を一覧表示するリクエスト メッセージ。

フィールド
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

指定されたプロジェクトの 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