Summary of entries of Classes for gsuiteaddons.
Classes
GSuiteAddOnsAsyncClient
A service for managing Google Workspace Add-ons deployments.
A Google Workspace Add-on is a third-party embedded component that can be installed in Google Workspace Applications like Gmail, Calendar, Drive, and the Google Docs, Sheets, and Slides editors. Google Workspace Add-ons can display UI cards, receive contextual information from the host application, and perform actions in the host application (See:
https://developers.google.com/gsuite/add-ons/overview for more information).
A Google Workspace Add-on deployment resource specifies metadata about the add-on, including a specification of the entry points in the host application that trigger add-on executions (see:
https://developers.google.com/gsuite/add-ons/concepts/gsuite-manifests). Add-on deployments defined via the Google Workspace Add-ons API define their entrypoints using HTTPS URLs (See:
https://developers.google.com/gsuite/add-ons/guides/alternate-runtimes),
A Google Workspace Add-on deployment can be installed in developer mode, which allows an add-on developer to test the experience an end-user would see when installing and running the add-on in their G Suite applications. When running in developer mode, more detailed error messages are exposed in the add-on UI to aid in debugging.
A Google Workspace Add-on deployment can be published to Google Workspace Marketplace, which allows other Google Workspace users to discover and install the add-on. See:
https://developers.google.com/gsuite/add-ons/how-tos/publish-add-on-overview for details.
GSuiteAddOnsClient
A service for managing Google Workspace Add-ons deployments.
A Google Workspace Add-on is a third-party embedded component that can be installed in Google Workspace Applications like Gmail, Calendar, Drive, and the Google Docs, Sheets, and Slides editors. Google Workspace Add-ons can display UI cards, receive contextual information from the host application, and perform actions in the host application (See:
https://developers.google.com/gsuite/add-ons/overview for more information).
A Google Workspace Add-on deployment resource specifies metadata about the add-on, including a specification of the entry points in the host application that trigger add-on executions (see:
https://developers.google.com/gsuite/add-ons/concepts/gsuite-manifests). Add-on deployments defined via the Google Workspace Add-ons API define their entrypoints using HTTPS URLs (See:
https://developers.google.com/gsuite/add-ons/guides/alternate-runtimes),
A Google Workspace Add-on deployment can be installed in developer mode, which allows an add-on developer to test the experience an end-user would see when installing and running the add-on in their G Suite applications. When running in developer mode, more detailed error messages are exposed in the add-on UI to aid in debugging.
A Google Workspace Add-on deployment can be published to Google Workspace Marketplace, which allows other Google Workspace users to discover and install the add-on. See:
https://developers.google.com/gsuite/add-ons/how-tos/publish-add-on-overview for details.
ListDeploymentsAsyncPager
A pager for iterating through list_deployments requests.
This class thinly wraps an initial
ListDeploymentsResponse object, and
provides an __aiter__ method to iterate through its
deployments field.
If there are more pages, the __aiter__ method will make additional
ListDeployments requests and continue to iterate
through the deployments field on the
corresponding responses.
All the usual ListDeploymentsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.
ListDeploymentsPager
A pager for iterating through list_deployments requests.
This class thinly wraps an initial
ListDeploymentsResponse object, and
provides an __iter__ method to iterate through its
deployments field.
If there are more pages, the __iter__ method will make additional
ListDeployments requests and continue to iterate
through the deployments field on the
corresponding responses.
All the usual ListDeploymentsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.
AddOns
A Google Workspace Add-on configuration.
Authorization
The authorization information used when invoking deployment endpoints.
CreateDeploymentRequest
Request message to create a deployment.
DeleteDeploymentRequest
Request message to delete a deployment.
Deployment
A Google Workspace Add-on deployment
GetAuthorizationRequest
Request message to get Google Workspace Add-ons authorization information.
GetDeploymentRequest
Request message to get a deployment.
GetInstallStatusRequest
Request message to get the install status of a developer mode deployment.
InstallDeploymentRequest
Request message to install a developer mode deployment.
InstallStatus
Developer mode install status of a deployment
ListDeploymentsRequest
Request message to list deployments for a project.
ListDeploymentsResponse
Response message to list deployments.
ReplaceDeploymentRequest
Request message to create or replace a deployment.
UninstallDeploymentRequest
Request message to uninstall a developer mode deployment.
Modules
pagers
API documentation for gsuiteaddons_v1.services.g_suite_add_ons.pagers module.