GSuiteAddOnsClient(*, credentials: Optional[google.auth.credentials.Credentials] = None, transport: Optional[Union[str, google.cloud.gsuiteaddons_v1.services.g_suite_add_ons.transports.base.GSuiteAddOnsTransport]] = None, client_options: Optional[Union[google.api_core.client_options.ClientOptions, dict]] = None, client_info: google.api_core.gapic_v1.client_info.ClientInfo = <google.api_core.gapic_v1.client_info.ClientInfo object>)
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.
Properties
transport
Returns the transport used by the client instance.
Returns | |
---|---|
Type | Description |
GSuiteAddOnsTransport | The transport used by the client instance. |
Methods
GSuiteAddOnsClient
GSuiteAddOnsClient(*, credentials: Optional[google.auth.credentials.Credentials] = None, transport: Optional[Union[str, google.cloud.gsuiteaddons_v1.services.g_suite_add_ons.transports.base.GSuiteAddOnsTransport]] = None, client_options: Optional[Union[google.api_core.client_options.ClientOptions, dict]] = None, client_info: google.api_core.gapic_v1.client_info.ClientInfo = <google.api_core.gapic_v1.client_info.ClientInfo object>)
Instantiates the g suite add ons client.
Parameters | |
---|---|
Name | Description |
credentials |
Optional[google.auth.credentials.Credentials]
The authorization credentials to attach to requests. These credentials identify the application to the service; if none are specified, the client will attempt to ascertain the credentials from the environment. |
transport |
Union[str, GSuiteAddOnsTransport]
The transport to use. If set to None, a transport is chosen automatically. |
client_options |
Optional[Union[google.api_core.client_options.ClientOptions, dict]]
Custom options for the client. It won't take effect if a |
client_info |
google.api_core.gapic_v1.client_info.ClientInfo
The client info used to send a user-agent string along with API requests. If |
Exceptions | |
---|---|
Type | Description |
google.auth.exceptions.MutualTLSChannelError | If mutual TLS transport creation failed for any reason. |
__exit__
__exit__(type, value, traceback)
Releases underlying transport's resources.
authorization_path
authorization_path(project: str)
Returns a fully-qualified authorization string.
common_billing_account_path
common_billing_account_path(billing_account: str)
Returns a fully-qualified billing_account string.
common_folder_path
common_folder_path(folder: str)
Returns a fully-qualified folder string.
common_location_path
common_location_path(project: str, location: str)
Returns a fully-qualified location string.
common_organization_path
common_organization_path(organization: str)
Returns a fully-qualified organization string.
common_project_path
common_project_path(project: str)
Returns a fully-qualified project string.
create_deployment
create_deployment(request: Optional[Union[google.cloud.gsuiteaddons_v1.types.gsuiteaddons.CreateDeploymentRequest, dict]] = None, *, parent: Optional[str] = None, deployment: Optional[google.cloud.gsuiteaddons_v1.types.gsuiteaddons.Deployment] = None, deployment_id: Optional[str] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Union[float, object] = <_MethodDefault._DEFAULT_VALUE: <object object>>, metadata: Sequence[Tuple[str, str]] = ())
Creates a deployment with the specified name and configuration.
# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
# client as shown in:
# https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import gsuiteaddons_v1
def sample_create_deployment():
# Create a client
client = gsuiteaddons_v1.GSuiteAddOnsClient()
# Initialize request argument(s)
request = gsuiteaddons_v1.CreateDeploymentRequest(
parent="parent_value",
deployment_id="deployment_id_value",
)
# Make the request
response = client.create_deployment(request=request)
# Handle the response
print(response)
Parameters | |
---|---|
Name | Description |
request |
Union[google.cloud.gsuiteaddons_v1.types.CreateDeploymentRequest, dict]
The request object. Request message to create a deployment. |
parent |
str
Required. Name of the project in which to create the deployment. Example: |
deployment |
google.cloud.gsuiteaddons_v1.types.Deployment
Required. The deployment to create (deployment.name cannot be set). This corresponds to the |
deployment_id |
str
Required. The id to use for this deployment. The full name of the created resource will be |
retry |
google.api_core.retry.Retry
Designation of what errors, if any, should be retried. |
timeout |
float
The timeout for this request. |
metadata |
Sequence[Tuple[str, str]]
Strings which should be sent along with the request as metadata. |
Returns | |
---|---|
Type | Description |
google.cloud.gsuiteaddons_v1.types.Deployment | A Google Workspace Add-on deployment |
delete_deployment
delete_deployment(request: Optional[Union[google.cloud.gsuiteaddons_v1.types.gsuiteaddons.DeleteDeploymentRequest, dict]] = None, *, name: Optional[str] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Union[float, object] = <_MethodDefault._DEFAULT_VALUE: <object object>>, metadata: Sequence[Tuple[str, str]] = ())
Deletes the deployment with the given name.
# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
# client as shown in:
# https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import gsuiteaddons_v1
def sample_delete_deployment():
# Create a client
client = gsuiteaddons_v1.GSuiteAddOnsClient()
# Initialize request argument(s)
request = gsuiteaddons_v1.DeleteDeploymentRequest(
name="name_value",
)
# Make the request
client.delete_deployment(request=request)
Parameters | |
---|---|
Name | Description |
request |
Union[google.cloud.gsuiteaddons_v1.types.DeleteDeploymentRequest, dict]
The request object. Request message to delete a deployment. |
name |
str
Required. The full resource name of the deployment to delete. Example: |
retry |
google.api_core.retry.Retry
Designation of what errors, if any, should be retried. |
timeout |
float
The timeout for this request. |
metadata |
Sequence[Tuple[str, str]]
Strings which should be sent along with the request as metadata. |
deployment_path
deployment_path(project: str, deployment: str)
Returns a fully-qualified deployment string.
from_service_account_file
from_service_account_file(filename: str, *args, **kwargs)
Creates an instance of this client using the provided credentials file.
Parameter | |
---|---|
Name | Description |
filename |
str
The path to the service account private key json file. |
Returns | |
---|---|
Type | Description |
GSuiteAddOnsClient | The constructed client. |
from_service_account_info
from_service_account_info(info: dict, *args, **kwargs)
Creates an instance of this client using the provided credentials info.
Parameter | |
---|---|
Name | Description |
info |
dict
The service account private key info. |
Returns | |
---|---|
Type | Description |
GSuiteAddOnsClient | The constructed client. |
from_service_account_json
from_service_account_json(filename: str, *args, **kwargs)
Creates an instance of this client using the provided credentials file.
Parameter | |
---|---|
Name | Description |
filename |
str
The path to the service account private key json file. |
Returns | |
---|---|
Type | Description |
GSuiteAddOnsClient | The constructed client. |
get_authorization
get_authorization(request: Optional[Union[google.cloud.gsuiteaddons_v1.types.gsuiteaddons.GetAuthorizationRequest, dict]] = None, *, name: Optional[str] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Union[float, object] = <_MethodDefault._DEFAULT_VALUE: <object object>>, metadata: Sequence[Tuple[str, str]] = ())
Gets the authorization information for deployments in a given project.
# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
# client as shown in:
# https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import gsuiteaddons_v1
def sample_get_authorization():
# Create a client
client = gsuiteaddons_v1.GSuiteAddOnsClient()
# Initialize request argument(s)
request = gsuiteaddons_v1.GetAuthorizationRequest(
name="name_value",
)
# Make the request
response = client.get_authorization(request=request)
# Handle the response
print(response)
Parameters | |
---|---|
Name | Description |
request |
Union[google.cloud.gsuiteaddons_v1.types.GetAuthorizationRequest, dict]
The request object. Request message to get Google Workspace Add-ons authorization information. |
name |
str
Required. Name of the project for which to get the Google Workspace Add-ons authorization information. Example: |
retry |
google.api_core.retry.Retry
Designation of what errors, if any, should be retried. |
timeout |
float
The timeout for this request. |
metadata |
Sequence[Tuple[str, str]]
Strings which should be sent along with the request as metadata. |
Returns | |
---|---|
Type | Description |
google.cloud.gsuiteaddons_v1.types.Authorization | The authorization information used when invoking deployment endpoints. |
get_deployment
get_deployment(request: Optional[Union[google.cloud.gsuiteaddons_v1.types.gsuiteaddons.GetDeploymentRequest, dict]] = None, *, name: Optional[str] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Union[float, object] = <_MethodDefault._DEFAULT_VALUE: <object object>>, metadata: Sequence[Tuple[str, str]] = ())
Gets the deployment with the specified name.
# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
# client as shown in:
# https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import gsuiteaddons_v1
def sample_get_deployment():
# Create a client
client = gsuiteaddons_v1.GSuiteAddOnsClient()
# Initialize request argument(s)
request = gsuiteaddons_v1.GetDeploymentRequest(
name="name_value",
)
# Make the request
response = client.get_deployment(request=request)
# Handle the response
print(response)
Parameters | |
---|---|
Name | Description |
request |
Union[google.cloud.gsuiteaddons_v1.types.GetDeploymentRequest, dict]
The request object. Request message to get a deployment. |
name |
str
Required. The full resource name of the deployment to get. Example: |
retry |
google.api_core.retry.Retry
Designation of what errors, if any, should be retried. |
timeout |
float
The timeout for this request. |
metadata |
Sequence[Tuple[str, str]]
Strings which should be sent along with the request as metadata. |
Returns | |
---|---|
Type | Description |
google.cloud.gsuiteaddons_v1.types.Deployment | A Google Workspace Add-on deployment |
get_install_status
get_install_status(request: Optional[Union[google.cloud.gsuiteaddons_v1.types.gsuiteaddons.GetInstallStatusRequest, dict]] = None, *, name: Optional[str] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Union[float, object] = <_MethodDefault._DEFAULT_VALUE: <object object>>, metadata: Sequence[Tuple[str, str]] = ())
Fetches the install status of a developer mode deployment.
# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
# client as shown in:
# https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import gsuiteaddons_v1
def sample_get_install_status():
# Create a client
client = gsuiteaddons_v1.GSuiteAddOnsClient()
# Initialize request argument(s)
request = gsuiteaddons_v1.GetInstallStatusRequest(
name="name_value",
)
# Make the request
response = client.get_install_status(request=request)
# Handle the response
print(response)
Parameters | |
---|---|
Name | Description |
request |
Union[google.cloud.gsuiteaddons_v1.types.GetInstallStatusRequest, dict]
The request object. Request message to get the install status of a developer mode deployment. |
name |
str
Required. The full resource name of the deployment. Example: |
retry |
google.api_core.retry.Retry
Designation of what errors, if any, should be retried. |
timeout |
float
The timeout for this request. |
metadata |
Sequence[Tuple[str, str]]
Strings which should be sent along with the request as metadata. |
Returns | |
---|---|
Type | Description |
google.cloud.gsuiteaddons_v1.types.InstallStatus | Developer mode install status of a deployment |
get_mtls_endpoint_and_cert_source
get_mtls_endpoint_and_cert_source(
client_options: Optional[google.api_core.client_options.ClientOptions] = None,
)
Return the API endpoint and client cert source for mutual TLS.
The client cert source is determined in the following order:
(1) if GOOGLE_API_USE_CLIENT_CERTIFICATE
environment variable is not "true", the
client cert source is None.
(2) if client_options.client_cert_source
is provided, use the provided one; if the
default client cert source exists, use the default one; otherwise the client cert
source is None.
The API endpoint is determined in the following order:
(1) if client_options.api_endpoint
if provided, use the provided one.
(2) if GOOGLE_API_USE_CLIENT_CERTIFICATE
environment variable is "always", use the
default mTLS endpoint; if the environment variabel is "never", use the default API
endpoint; otherwise if client cert source exists, use the default mTLS endpoint, otherwise
use the default API endpoint.
More details can be found at https://google.aip.dev/auth/4114.
Parameter | |
---|---|
Name | Description |
client_options |
google.api_core.client_options.ClientOptions
Custom options for the client. Only the |
Exceptions | |
---|---|
Type | Description |
google.auth.exceptions.MutualTLSChannelError | If any errors happen. |
Returns | |
---|---|
Type | Description |
Tuple[str, Callable[[], Tuple[bytes, bytes]]] | returns the API endpoint and the client cert source to use. |
install_deployment
install_deployment(request: Optional[Union[google.cloud.gsuiteaddons_v1.types.gsuiteaddons.InstallDeploymentRequest, dict]] = None, *, name: Optional[str] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Union[float, object] = <_MethodDefault._DEFAULT_VALUE: <object object>>, metadata: Sequence[Tuple[str, str]] = ())
Installs a deployment in developer mode. See: https://developers.google.com/gsuite/add-ons/how-tos/testing-gsuite-addons.
# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
# client as shown in:
# https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import gsuiteaddons_v1
def sample_install_deployment():
# Create a client
client = gsuiteaddons_v1.GSuiteAddOnsClient()
# Initialize request argument(s)
request = gsuiteaddons_v1.InstallDeploymentRequest(
name="name_value",
)
# Make the request
client.install_deployment(request=request)
Parameters | |
---|---|
Name | Description |
request |
Union[google.cloud.gsuiteaddons_v1.types.InstallDeploymentRequest, dict]
The request object. Request message to install a developer mode deployment. |
name |
str
Required. The full resource name of the deployment to install. Example: |
retry |
google.api_core.retry.Retry
Designation of what errors, if any, should be retried. |
timeout |
float
The timeout for this request. |
metadata |
Sequence[Tuple[str, str]]
Strings which should be sent along with the request as metadata. |
install_status_path
install_status_path(project: str, deployment: str)
Returns a fully-qualified install_status string.
list_deployments
list_deployments(request: Optional[Union[google.cloud.gsuiteaddons_v1.types.gsuiteaddons.ListDeploymentsRequest, dict]] = None, *, parent: Optional[str] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Union[float, object] = <_MethodDefault._DEFAULT_VALUE: <object object>>, metadata: Sequence[Tuple[str, str]] = ())
Lists all deployments in a particular project.
# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
# client as shown in:
# https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import gsuiteaddons_v1
def sample_list_deployments():
# Create a client
client = gsuiteaddons_v1.GSuiteAddOnsClient()
# Initialize request argument(s)
request = gsuiteaddons_v1.ListDeploymentsRequest(
parent="parent_value",
)
# Make the request
page_result = client.list_deployments(request=request)
# Handle the response
for response in page_result:
print(response)
Parameters | |
---|---|
Name | Description |
request |
Union[google.cloud.gsuiteaddons_v1.types.ListDeploymentsRequest, dict]
The request object. Request message to list deployments for a project. |
parent |
str
Required. Name of the project in which to create the deployment. Example: |
retry |
google.api_core.retry.Retry
Designation of what errors, if any, should be retried. |
timeout |
float
The timeout for this request. |
metadata |
Sequence[Tuple[str, str]]
Strings which should be sent along with the request as metadata. |
Returns | |
---|---|
Type | Description |
google.cloud.gsuiteaddons_v1.services.g_suite_add_ons.pagers.ListDeploymentsPager | Response message to list deployments. Iterating over this object will yield results and resolve additional pages automatically. |
parse_authorization_path
parse_authorization_path(path: str)
Parses a authorization path into its component segments.
parse_common_billing_account_path
parse_common_billing_account_path(path: str)
Parse a billing_account path into its component segments.
parse_common_folder_path
parse_common_folder_path(path: str)
Parse a folder path into its component segments.
parse_common_location_path
parse_common_location_path(path: str)
Parse a location path into its component segments.
parse_common_organization_path
parse_common_organization_path(path: str)
Parse a organization path into its component segments.
parse_common_project_path
parse_common_project_path(path: str)
Parse a project path into its component segments.
parse_deployment_path
parse_deployment_path(path: str)
Parses a deployment path into its component segments.
parse_install_status_path
parse_install_status_path(path: str)
Parses a install_status path into its component segments.
replace_deployment
replace_deployment(request: Optional[Union[google.cloud.gsuiteaddons_v1.types.gsuiteaddons.ReplaceDeploymentRequest, dict]] = None, *, deployment: Optional[google.cloud.gsuiteaddons_v1.types.gsuiteaddons.Deployment] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Union[float, object] = <_MethodDefault._DEFAULT_VALUE: <object object>>, metadata: Sequence[Tuple[str, str]] = ())
Creates or replaces a deployment with the specified name.
# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
# client as shown in:
# https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import gsuiteaddons_v1
def sample_replace_deployment():
# Create a client
client = gsuiteaddons_v1.GSuiteAddOnsClient()
# Initialize request argument(s)
request = gsuiteaddons_v1.ReplaceDeploymentRequest(
)
# Make the request
response = client.replace_deployment(request=request)
# Handle the response
print(response)
Parameters | |
---|---|
Name | Description |
request |
Union[google.cloud.gsuiteaddons_v1.types.ReplaceDeploymentRequest, dict]
The request object. Request message to create or replace a deployment. |
deployment |
google.cloud.gsuiteaddons_v1.types.Deployment
Required. The deployment to create or replace. This corresponds to the |
retry |
google.api_core.retry.Retry
Designation of what errors, if any, should be retried. |
timeout |
float
The timeout for this request. |
metadata |
Sequence[Tuple[str, str]]
Strings which should be sent along with the request as metadata. |
Returns | |
---|---|
Type | Description |
google.cloud.gsuiteaddons_v1.types.Deployment | A Google Workspace Add-on deployment |
uninstall_deployment
uninstall_deployment(request: Optional[Union[google.cloud.gsuiteaddons_v1.types.gsuiteaddons.UninstallDeploymentRequest, dict]] = None, *, name: Optional[str] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Union[float, object] = <_MethodDefault._DEFAULT_VALUE: <object object>>, metadata: Sequence[Tuple[str, str]] = ())
Uninstalls a developer mode deployment. See: https://developers.google.com/gsuite/add-ons/how-tos/testing-gsuite-addons.
# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
# client as shown in:
# https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import gsuiteaddons_v1
def sample_uninstall_deployment():
# Create a client
client = gsuiteaddons_v1.GSuiteAddOnsClient()
# Initialize request argument(s)
request = gsuiteaddons_v1.UninstallDeploymentRequest(
name="name_value",
)
# Make the request
client.uninstall_deployment(request=request)
Parameters | |
---|---|
Name | Description |
request |
Union[google.cloud.gsuiteaddons_v1.types.UninstallDeploymentRequest, dict]
The request object. Request message to uninstall a developer mode deployment. |
name |
str
Required. The full resource name of the deployment to install. Example: |
retry |
google.api_core.retry.Retry
Designation of what errors, if any, should be retried. |
timeout |
float
The timeout for this request. |
metadata |
Sequence[Tuple[str, str]]
Strings which should be sent along with the request as metadata. |