Package google.cloud.gsuiteaddons.v1

    Index

    GSuiteAddOns

    A service for managing Google Workspace add-on deployments.

    CreateDeployment

    rpc CreateDeployment( CreateDeploymentRequest ) returns ( Deployment )

    Creates a deployment with the specified name and configuration.

    Authorization scopes

    Requires the following OAuth scope:

    • https://www.googleapis.com/auth/cloud-platform

    For more information, see the Authorization guide .

    DeleteDeployment

    rpc DeleteDeployment( DeleteDeploymentRequest ) returns ( Empty )

    Deletes the deployment with the given name.

    Authorization scopes

    Requires the following OAuth scope:

    • https://www.googleapis.com/auth/cloud-platform

    For more information, see the Authorization guide .

    GetAuthorization

    rpc GetAuthorization( GetAuthorizationRequest ) returns ( Authorization )

    Gets the authorization information for deployments in a given project.

    Authorization scopes

    Requires the following OAuth scope:

    • https://www.googleapis.com/auth/cloud-platform

    For more information, see the Authorization guide .

    GetDeployment

    rpc GetDeployment( GetDeploymentRequest ) returns ( Deployment )

    Gets the deployment with the specified name.

    Authorization scopes

    Requires the following OAuth scope:

    • https://www.googleapis.com/auth/cloud-platform

    For more information, see the Authorization guide .

    GetInstallStatus

    rpc GetInstallStatus( GetInstallStatusRequest ) returns ( InstallStatus )

    Gets the install status of a test deployment.

    Authorization scopes

    Requires the following OAuth scope:

    • https://www.googleapis.com/auth/cloud-platform

    For more information, see the Authorization guide .

    InstallDeployment

    rpc InstallDeployment( InstallDeploymentRequest ) returns ( Empty )

    Installs a deployment to your account for testing. For more information, see Test your add-on

    Authorization scopes

    Requires the following OAuth scope:

    • https://www.googleapis.com/auth/cloud-platform

    For more information, see the Authorization guide .

    ListDeployments

    rpc ListDeployments( ListDeploymentsRequest ) returns ( ListDeploymentsResponse )

    Lists all deployments in a particular project.

    Authorization scopes

    Requires the following OAuth scope:

    • https://www.googleapis.com/auth/cloud-platform

    For more information, see the Authorization guide .

    ReplaceDeployment

    rpc ReplaceDeployment( ReplaceDeploymentRequest ) returns ( Deployment )

    Creates or replaces a deployment with the specified name.

    Authorization scopes

    Requires the following OAuth scope:

    • https://www.googleapis.com/auth/cloud-platform

    For more information, see the Authorization guide .

    UninstallDeployment

    rpc UninstallDeployment( UninstallDeploymentRequest ) returns ( Empty )

    Uninstalls a test deployment from the user’s account. For more information, see Test your add-on .

    Authorization scopes

    Requires the following OAuth scope:

    • https://www.googleapis.com/auth/cloud-platform

    For more information, see the Authorization guide .

    AddOns

    A Google Workspace add-on configuration.

    Fields
    common

    CommonAddOnManifest

    Configuration that is common across all Google Workspace add-ons.
    gmail

    GmailAddOnManifest

    Gmail add-on configuration.
    drive

    DriveAddOnManifest

    Drive add-on configuration.
    calendar

    CalendarAddOnManifest

    Calendar add-on configuration.
    docs

    DocsAddOnManifest

    Docs add-on configuration.
    meet

    MeetAddOnManifest

    Meet add-on configuration.
    sheets

    SheetsAddOnManifest

    Sheets add-on configuration.
    slides

    SlidesAddOnManifest

    Slides add-on configuration.
    httpOptions

    HttpOptions

    Options for sending requests to add-on HTTP endpoints

    Authorization

    The authorization information used when invoking deployment endpoints.

    Fields
    name

    string

    The canonical full name of this resource. Example: projects/123/authorization

    serviceAccountEmail

    string

    The email address of the service account used to authenticate requests to add-on callback endpoints.
    oauthClientId

    string

    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

    string

    Required. Name of the project in which to create the deployment.

    Example: projects/my_project .

    Authorization requires the following IAM permission on the specified resource parent :

    • gsuiteaddons.deployments.create
    deploymentId

    string

    Required. The ID to use for this deployment. The full name of the created resource will be projects/<project_number>/deployments/<deployment_id> .

    deployment

    Deployment

    Required. The deployment to create (deployment.name cannot be set).

    DeleteDeploymentRequest

    Request message to delete a deployment.

    Fields
    name

    string

    Required. The full resource name of the deployment to delete.

    Example: projects/my_project/deployments/my_deployment .

    Authorization requires the following IAM permission on the specified resource name :

    • gsuiteaddons.deployments.delete
    etag

    string

    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

    string

    The deployment resource name. Example: projects/123/deployments/my_deployment .
    oauthScopes[]

    string

    The list of Google OAuth scopes for which to request consent from the end user before executing an add-on endpoint.
    addOns

    AddOns

    The Google Workspace add-on configuration.
    etag

    string

    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

    string

    Required. Name of the project for which to get the Google Workspace add-on authorization information.

    Example: projects/my_project/authorization .

    Authorization requires the following IAM permission on the specified resource name :

    • gsuiteaddons.authorizations.get

    GetDeploymentRequest

    Request message to get a deployment.

    Fields
    name

    string

    Required. The full resource name of the deployment to get.

    Example: projects/my_project/deployments/my_deployment .

    Authorization requires the following IAM permission on the specified resource name :

    • gsuiteaddons.deployments.get

    GetInstallStatusRequest

    Request message to get the install status of a test deployment.

    Fields
    name

    string

    Required. The full resource name of the deployment.

    Example: projects/my_project/deployments/my_deployment/installStatus .

    Authorization requires the following IAM permission on the specified resource name :

    • gsuiteaddons.deployments.installStatus

    InstallDeploymentRequest

    Request message to install a deployment for testing.

    Fields
    name

    string

    Required. The full resource name of the deployment to install.

    Example: projects/my_project/deployments/my_deployment .

    Authorization requires the following IAM permission on the specified resource name :

    • gsuiteaddons.deployments.install

    InstallStatus

    Install status of a test deployment.

    Fields
    name

    string

    The canonical full resource name of the deployment install status.

    Example: projects/123/deployments/my_deployment/installStatus .
    installed

    BoolValue

    True if the deployment is installed for the user.

    ListDeploymentsRequest

    Request message to list deployments for a project.

    Fields
    parent

    string

    Required. Name of the project in which to create the deployment.

    Example: projects/my_project .

    Authorization requires the following IAM permission on the specified resource parent :

    • gsuiteaddons.deployments.list
    pageSize

    int32

    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

    string

    A page token, received from a previous ListDeployments call. Provide this to retrieve the subsequent page.

    When paginating, all other parameters provided to ListDeployments must match the call that provided the page token.

    ListDeploymentsResponse

    Response message to list deployments.

    Fields
    deployments[]

    Deployment

    The list of deployments for the given project.
    nextPageToken

    string

    A token, which can be sent as page_token to retrieve the next page. If this field is omitted, there are no subsequent pages.

    ReplaceDeploymentRequest

    Request message to create or replace a deployment.

    Fields
    deployment

    Deployment

    Required. The deployment to create or replace.

    Authorization requires the following IAM permission on the specified resource deployment :

    • gsuiteaddons.deployments.update

    UninstallDeploymentRequest

    Request message to uninstall a test deployment.

    Fields
    name

    string

    Required. The full resource name of the deployment to install.

    Example: projects/my_project/deployments/my_deployment .

    Authorization requires the following IAM permission on the specified resource name :

    • gsuiteaddons.deployments.execute
    Create a Mobile Website
    View Site in Mobile | Classic
    Share by: