Index
GSuiteAddOns(interface)AddOns(message)Authorization(message)CreateDeploymentRequest(message)DeleteDeploymentRequest(message)Deployment(message)GetAuthorizationRequest(message)GetDeploymentRequest(message)GetInstallStatusRequest(message)InstallDeploymentRequest(message)InstallStatus(message)ListDeploymentsRequest(message)ListDeploymentsResponse(message)ReplaceDeploymentRequest(message)UninstallDeploymentRequest(message)
GSuiteAddOns
A service for managing Google Workspace Add-on deployments.
| CreateDeployment |
|---|
|
Creates a deployment with the specified name and configuration.
|
| DeleteDeployment |
|---|
|
Deletes the deployment with the given name.
|
| GetAuthorization |
|---|
|
Gets the authorization information for deployments in a given project.
|
| GetDeployment |
|---|
|
Gets the deployment with the specified name.
|
| GetInstallStatus |
|---|
|
Gets the install status of a test deployment.
|
| InstallDeployment |
|---|
|
Installs a deployment to your account for testing. For more information, see Test your add-on
|
| ListDeployments |
|---|
|
Lists all deployments in a particular project.
|
| ReplaceDeployment |
|---|
|
Creates or replaces a deployment with the specified name.
|
| UninstallDeployment |
|---|
|
Uninstalls a test deployment from the user’s account. For more information, see Test your add-on.
|
AddOns
A Google Workspace Add-on configuration.
| Fields | |
|---|---|
common |
Configuration that is common across all Google Workspace Add-ons. |
gmail |
Gmail add-on configuration. |
drive |
Drive add-on configuration. |
calendar |
Calendar add-on configuration. |
docs |
Docs add-on configuration. |
sheets |
Sheets add-on configuration. |
slides |
Slides add-on configuration. |
httpOptions |
Options for sending requests to add-on HTTP endpoints |
Authorization
The authorization information used when invoking deployment endpoints.
| Fields | |
|---|---|
name |
The canonical full name of this resource. Example: |
serviceAccountEmail |
The email address of the service account used to authenticate requests to add-on callback endpoints. |
oauthClientId |
The OAuth client ID used to obtain OAuth access tokens for a user on the add-on's behalf. |
CreateDeploymentRequest
Request message to create a deployment.
| Fields | |
|---|---|
parent |
Required. Name of the project in which to create the deployment. Example: Authorization requires the following IAM permission on the specified resource
|
deploymentId |
Required. The ID to use for this deployment. The full name of the created resource will be |
deployment |
Required. The deployment to create (deployment.name cannot be set). |
DeleteDeploymentRequest
Request message to delete a deployment.
| Fields | |
|---|---|
name |
Required. The full resource name of the deployment to delete. Example: Authorization requires the following IAM permission on the specified resource
|
etag |
The etag of the deployment to delete. If this is provided, it must match the server's etag. |
Deployment
A Google Workspace Add-on deployment
| Fields | |
|---|---|
name |
The deployment resource name. Example: |
oauthScopes[] |
The list of Google OAuth scopes for which to request consent from the end user before executing an add-on endpoint. |
addOns |
The Google Workspace Add-on configuration. |
etag |
This value is computed by the server based on the version of the deployment in storage, and may be sent on update and delete requests to ensure the client has an up-to-date value before proceeding. |
GetAuthorizationRequest
Request message to get the Google Workspace Add-on authorization information.
| Fields | |
|---|---|
name |
Required. Name of the project for which to get the Google Workspace Add-on authorization information. Example: Authorization requires the following IAM permission on the specified resource
|
GetDeploymentRequest
Request message to get a deployment.
| Fields | |
|---|---|
name |
Required. The full resource name of the deployment to get. Example: Authorization requires the following IAM permission on the specified resource
|
GetInstallStatusRequest
Request message to get the install status of a test deployment.
| Fields | |
|---|---|
name |
Required. The full resource name of the deployment. Example: Authorization requires the following IAM permission on the specified resource
|
InstallDeploymentRequest
Request message to install a deployment for testing.
| Fields | |
|---|---|
name |
Required. The full resource name of the deployment to install. Example: Authorization requires the following IAM permission on the specified resource
|
InstallStatus
Install status of a test deployment.
| Fields | |
|---|---|
name |
The canonical full resource name of the deployment install status. Example: |
installed |
True if the deployment is installed for the user. |
ListDeploymentsRequest
Request message to list deployments for a project.
| Fields | |
|---|---|
parent |
Required. Name of the project in which to create the deployment. Example: Authorization requires the following IAM permission on the specified resource
|
pageSize |
The maximum number of deployments to return. The service might return fewer than this value. If unspecified, at most 1,000 deployments are returned. The maximum possible value is 1,000; values above 1,000 are changed to 1,000. |
pageToken |
A page token, received from a previous When paginating, all other parameters provided to |
ListDeploymentsResponse
Response message to list deployments.
| Fields | |
|---|---|
deployments[] |
The list of deployments for the given project. |
nextPageToken |
A token, which can be sent as |
ReplaceDeploymentRequest
Request message to create or replace a deployment.
| Fields | |
|---|---|
deployment |
Required. The deployment to create or replace. Authorization requires the following IAM permission on the specified resource
|
UninstallDeploymentRequest
Request message to uninstall a test deployment.
| Fields | |
|---|---|
name |
Required. The full resource name of the deployment to install. Example: Authorization requires the following IAM permission on the specified resource
|