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:
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:
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:
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:
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:
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:
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.
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.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-08-07 UTC."],[],[],null,["# Package Classes (0.3.17)\n\nVersion latestkeyboard_arrow_down\n\n- [0.3.17 (latest)](/python/docs/reference/gsuiteaddons/latest/summary_class)\n- [0.3.15](/python/docs/reference/gsuiteaddons/0.3.15/summary_class)\n- [0.2.1](/python/docs/reference/gsuiteaddons/0.2.1/summary_class)\n- [0.1.1](/python/docs/reference/gsuiteaddons/0.1.1/summary_class) \nSummary of entries of Classes for gsuiteaddons. \n\nClasses\n-------\n\n### [GSuiteAddOnsAsyncClient](/python/docs/reference/gsuiteaddons/latest/google.cloud.gsuiteaddons_v1.services.g_suite_add_ons.GSuiteAddOnsAsyncClient)\n\nA service for managing Google Workspace add-ons deployments.\n\nA Google Workspace add-on is a third-party embedded component\nthat can be installed in Google Workspace Applications like\nGmail, Calendar, Drive, and the Google Docs, Sheets, and Slides\neditors. Google Workspace add-ons can display UI cards, receive\ncontextual information from the host application, and perform\nactions in the host application (See:\n\n\u003chttps://developers.google.com/gsuite/add-ons/overview\u003e for more\ninformation).\n\nA Google Workspace add-on deployment resource specifies metadata\nabout the add-on, including a specification of the entry points\nin the host application that trigger add-on executions (see:\n\n\u003chttps://developers.google.com/gsuite/add-ons/concepts/gsuite-manifests\u003e).\nAdd-on deployments defined via the Google Workspace add-ons API\ndefine their entrypoints using HTTPS URLs (See:\n\n\u003chttps://developers.google.com/gsuite/add-ons/guides/alternate-runtimes\u003e),\n\nA Google Workspace add-on deployment can be installed in\ndeveloper mode, which allows an add-on developer to test the\nexperience an end-user would see when installing and running the\nadd-on in their G Suite applications. When running in developer\nmode, more detailed error messages are exposed in the add-on UI\nto aid in debugging.\n\nA Google Workspace add-on deployment can be published to Google\nWorkspace Marketplace, which allows other Google Workspace users\nto discover and install the add-on. See:\n\n\u003chttps://developers.google.com/gsuite/add-ons/how-tos/publish-add-on-overview\u003e\nfor details.\n\n### [GSuiteAddOnsClient](/python/docs/reference/gsuiteaddons/latest/google.cloud.gsuiteaddons_v1.services.g_suite_add_ons.GSuiteAddOnsClient)\n\nA service for managing Google Workspace add-ons deployments.\n\nA Google Workspace add-on is a third-party embedded component\nthat can be installed in Google Workspace Applications like\nGmail, Calendar, Drive, and the Google Docs, Sheets, and Slides\neditors. Google Workspace add-ons can display UI cards, receive\ncontextual information from the host application, and perform\nactions in the host application (See:\n\n\u003chttps://developers.google.com/gsuite/add-ons/overview\u003e for more\ninformation).\n\nA Google Workspace add-on deployment resource specifies metadata\nabout the add-on, including a specification of the entry points\nin the host application that trigger add-on executions (see:\n\n\u003chttps://developers.google.com/gsuite/add-ons/concepts/gsuite-manifests\u003e).\nAdd-on deployments defined via the Google Workspace add-ons API\ndefine their entrypoints using HTTPS URLs (See:\n\n\u003chttps://developers.google.com/gsuite/add-ons/guides/alternate-runtimes\u003e),\n\nA Google Workspace add-on deployment can be installed in\ndeveloper mode, which allows an add-on developer to test the\nexperience an end-user would see when installing and running the\nadd-on in their G Suite applications. When running in developer\nmode, more detailed error messages are exposed in the add-on UI\nto aid in debugging.\n\nA Google Workspace add-on deployment can be published to Google\nWorkspace Marketplace, which allows other Google Workspace users\nto discover and install the add-on. See:\n\n\u003chttps://developers.google.com/gsuite/add-ons/how-tos/publish-add-on-overview\u003e\nfor details.\n\n### [ListDeploymentsAsyncPager](/python/docs/reference/gsuiteaddons/latest/google.cloud.gsuiteaddons_v1.services.g_suite_add_ons.pagers.ListDeploymentsAsyncPager)\n\nA pager for iterating through `list_deployments` requests.\n\nThis class thinly wraps an initial\n[ListDeploymentsResponse](/python/docs/reference/gsuiteaddons/latest/google.cloud.gsuiteaddons_v1.types.ListDeploymentsResponse) object, and\nprovides an `__aiter__` method to iterate through its\n`deployments` field.\n\nIf there are more pages, the `__aiter__` method will make additional\n`ListDeployments` requests and continue to iterate\nthrough the `deployments` field on the\ncorresponding responses.\n\nAll the usual [ListDeploymentsResponse](/python/docs/reference/gsuiteaddons/latest/google.cloud.gsuiteaddons_v1.types.ListDeploymentsResponse)\nattributes are available on the pager. If multiple requests are made, only\nthe most recent response is retained, and thus used for attribute lookup.\n\n### [ListDeploymentsPager](/python/docs/reference/gsuiteaddons/latest/google.cloud.gsuiteaddons_v1.services.g_suite_add_ons.pagers.ListDeploymentsPager)\n\nA pager for iterating through `list_deployments` requests.\n\nThis class thinly wraps an initial\n[ListDeploymentsResponse](/python/docs/reference/gsuiteaddons/latest/google.cloud.gsuiteaddons_v1.types.ListDeploymentsResponse) object, and\nprovides an `__iter__` method to iterate through its\n`deployments` field.\n\nIf there are more pages, the `__iter__` method will make additional\n`ListDeployments` requests and continue to iterate\nthrough the `deployments` field on the\ncorresponding responses.\n\nAll the usual [ListDeploymentsResponse](/python/docs/reference/gsuiteaddons/latest/google.cloud.gsuiteaddons_v1.types.ListDeploymentsResponse)\nattributes are available on the pager. If multiple requests are made, only\nthe most recent response is retained, and thus used for attribute lookup.\n\n### [AddOns](/python/docs/reference/gsuiteaddons/latest/google.cloud.gsuiteaddons_v1.types.AddOns)\n\nA Google Workspace add-on configuration.\n\n### [Authorization](/python/docs/reference/gsuiteaddons/latest/google.cloud.gsuiteaddons_v1.types.Authorization)\n\nThe authorization information used when invoking deployment\nendpoints.\n\n### [CreateDeploymentRequest](/python/docs/reference/gsuiteaddons/latest/google.cloud.gsuiteaddons_v1.types.CreateDeploymentRequest)\n\nRequest message to create a deployment.\n\n### [DeleteDeploymentRequest](/python/docs/reference/gsuiteaddons/latest/google.cloud.gsuiteaddons_v1.types.DeleteDeploymentRequest)\n\nRequest message to delete a deployment.\n\n### [Deployment](/python/docs/reference/gsuiteaddons/latest/google.cloud.gsuiteaddons_v1.types.Deployment)\n\nA Google Workspace add-on deployment\n\n### [GetAuthorizationRequest](/python/docs/reference/gsuiteaddons/latest/google.cloud.gsuiteaddons_v1.types.GetAuthorizationRequest)\n\nRequest message to get Google Workspace add-ons authorization\ninformation.\n\n### [GetDeploymentRequest](/python/docs/reference/gsuiteaddons/latest/google.cloud.gsuiteaddons_v1.types.GetDeploymentRequest)\n\nRequest message to get a deployment.\n\n### [GetInstallStatusRequest](/python/docs/reference/gsuiteaddons/latest/google.cloud.gsuiteaddons_v1.types.GetInstallStatusRequest)\n\nRequest message to get the install status of a developer mode\ndeployment.\n\n### [InstallDeploymentRequest](/python/docs/reference/gsuiteaddons/latest/google.cloud.gsuiteaddons_v1.types.InstallDeploymentRequest)\n\nRequest message to install a developer mode deployment.\n\n### [InstallStatus](/python/docs/reference/gsuiteaddons/latest/google.cloud.gsuiteaddons_v1.types.InstallStatus)\n\nDeveloper mode install status of a deployment\n\n### [ListDeploymentsRequest](/python/docs/reference/gsuiteaddons/latest/google.cloud.gsuiteaddons_v1.types.ListDeploymentsRequest)\n\nRequest message to list deployments for a project.\n\n### [ListDeploymentsResponse](/python/docs/reference/gsuiteaddons/latest/google.cloud.gsuiteaddons_v1.types.ListDeploymentsResponse)\n\nResponse message to list deployments.\n\n### [ReplaceDeploymentRequest](/python/docs/reference/gsuiteaddons/latest/google.cloud.gsuiteaddons_v1.types.ReplaceDeploymentRequest)\n\nRequest message to create or replace a deployment.\n\n### [UninstallDeploymentRequest](/python/docs/reference/gsuiteaddons/latest/google.cloud.gsuiteaddons_v1.types.UninstallDeploymentRequest)\n\nRequest message to uninstall a developer mode deployment.\n\nModules\n-------\n\n### [pagers](/python/docs/reference/gsuiteaddons/latest/google.cloud.gsuiteaddons_v1.services.g_suite_add_ons.pagers)\n\nAPI documentation for `gsuiteaddons_v1.services.g_suite_add_ons.pagers` module."]]
