Class GSuiteAddOnsClient (0.3.7)

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.

Return the API endpoint used by the client instance.

Returns the transport used by the client instance.

Return the universe domain used by the client instance.

Instantiates the g suite add ons client.

Releases underlying transport's resources.

Returns a fully-qualified authorization string.

Returns a fully-qualified billing_account string.

Returns a fully-qualified folder string.

Returns a fully-qualified location string.

Returns a fully-qualified organization string.

Returns a fully-qualified project string.

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)

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)

Returns a fully-qualified deployment string.

Creates an instance of this client using the provided credentials file.

Creates an instance of this client using the provided credentials info.

Creates an instance of this client using the provided credentials file.

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)

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)

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)

Deprecated. 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 variable 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.

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)

Returns a fully-qualified install_status string.

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)

Parses a authorization path into its component segments.

Parse a billing_account path into its component segments.

Parse a folder path into its component segments.

Parse a location path into its component segments.

Parse a organization path into its component segments.

Parse a project path into its component segments.

Parses a deployment path into its component segments.

Parses a install_status path into its component segments.

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)

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)