Package google.cloud.gsuiteaddons.v1

Índice

Complementos de GSuite

Un servicio para administrar implementaciones de complementos de Google Workspace.

CreateDeployment

rpc CreateDeployment(CreateDeploymentRequest) returns (Deployment)

Crea una implementación con el nombre y la configuración especificados.

Permisos de autorización

Requiere el siguiente alcance de OAuth:

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

Para obtener más información, consulta la guía de autorización.
DeleteDeployment

rpc DeleteDeployment(DeleteDeploymentRequest) returns (Empty)

Borra la implementación con el nombre determinado.

Permisos de autorización

Requiere el siguiente alcance de OAuth:

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

Para obtener más información, consulta la guía de autorización.
GetAuthorization

rpc GetAuthorization(GetAuthorizationRequest) returns (Authorization)

Obtiene la información de autorización para las implementaciones en un proyecto determinado.

Permisos de autorización

Requiere el siguiente alcance de OAuth:

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

Para obtener más información, consulta la guía de autorización.
GetDeployment

rpc GetDeployment(GetDeploymentRequest) returns (Deployment)

Obtiene la implementación con el nombre especificado.

Permisos de autorización

Requiere el siguiente alcance de OAuth:

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

Para obtener más información, consulta la guía de autorización.
GetInstallStatus

rpc GetInstallStatus(GetInstallStatusRequest) returns (InstallStatus)

Obtiene el estado de instalación de una implementación de prueba.

Permisos de autorización

Requiere el siguiente alcance de OAuth:

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

Para obtener más información, consulta la guía de autorización.
InstallDeployment

rpc InstallDeployment(InstallDeploymentRequest) returns (Empty)

Instala una implementación en tu cuenta para realizar pruebas. Para obtener más información, consulta Cómo probar tu complemento.

Permisos de autorización

Requiere el siguiente alcance de OAuth:

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

Para obtener más información, consulta la guía de autorización.
ListDeployments

rpc ListDeployments(ListDeploymentsRequest) returns (ListDeploymentsResponse)

Enumera todas las implementaciones de un proyecto en particular.

Permisos de autorización

Requiere el siguiente alcance de OAuth:

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

Para obtener más información, consulta la guía de autorización.
ReplaceDeployment

rpc ReplaceDeployment(ReplaceDeploymentRequest) returns (Deployment)

Crea o reemplaza una implementación con el nombre especificado.

Permisos de autorización

Requiere el siguiente alcance de OAuth:

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

Para obtener más información, consulta la guía de autorización.
UninstallDeployment

rpc UninstallDeployment(UninstallDeploymentRequest) returns (Empty)

Desinstala una implementación de prueba de la cuenta del usuario. Para obtener más información, consulta Cómo probar tu complemento.

Permisos de autorización

Requiere el siguiente alcance de OAuth:

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

Para obtener más información, consulta la guía de autorización.

AddOns

Una configuración de complemento de Google Workspace

Campos
common

CommonAddOnManifest

Configuración que es común en todos los complementos de Google Workspace.
gmail

GmailAddOnManifest

Configuración del complemento de Gmail
drive

DriveAddOnManifest

Configuración del complemento de Drive
calendar

CalendarAddOnManifest

Configuración del complemento de Calendario.
docs

DocsAddOnManifest

Configuración del complemento de Documentos.
sheets

SheetsAddOnManifest

Configuración del complemento de Hojas de cálculo.
slides

SlidesAddOnManifest

Configuración del complemento de Presentaciones.
httpOptions

HttpOptions

Opciones para enviar solicitudes a extremos HTTP de complementos

Autorización

La información de autorización que se usa cuando se invocan extremos de implementación.

Campos
name

string

El nombre completo canónico de este recurso. Ejemplo: projects/123/authorization
serviceAccountEmail

string

La dirección de correo electrónico de la cuenta de servicio utilizada para autenticar las solicitudes a los extremos de devolución de llamada de complementos.
oauthClientId

string

El ID de cliente de OAuth que se usa para obtener tokens de acceso de OAuth para un usuario en nombre del complemento.

CreateDeploymentRequest

Mensaje de solicitud para crear una implementación.

Campos
parent

string

Obligatorio. Nombre del proyecto en el que se creará la implementación.

Ejemplo: projects/my_project.

La autorización requiere el siguiente permiso IAM en el recurso especificado parent:

  • gsuiteaddons.deployments.create
deploymentId

string

Obligatorio. El ID que se usará para esta implementación. El nombre completo del recurso creado será projects/<project_number>/deployments/<deployment_id>.
deployment

Deployment

Obligatorio. La implementación que se creará (no se puede establecer la implementación.name).

DeleteDeploymentRequest

Mensaje de solicitud para borrar una implementación.

Campos
name

string

Obligatorio. El nombre completo del recurso de la implementación que se borrará.

Ejemplo: projects/my_project/deployments/my_deployment.

La autorización requiere el siguiente permiso IAM en el recurso especificado name:

  • gsuiteaddons.deployments.delete
etag

string

La ETag de la implementación que se borrará. Si se proporciona, debe coincidir con la ETag del servidor.

Implementación

Una implementación de complemento de Google Workspace

Campos
name

string

El nombre del recurso de implementación. Ejemplo: projects/123/deployments/my_deployment.
oauthScopes[]

string

Es la lista de permisos de Google OAuth para los que se debe solicitar el consentimiento del usuario final antes de ejecutar un extremo de complemento.
addOns

AddOns

La configuración del complemento de Google Workspace
etag

string

El servidor calcula este valor según la versión de la implementación en el almacenamiento, y se puede enviar en las solicitudes de actualización y eliminación para garantizar que el cliente tenga un valor actualizado antes de continuar.

GetAuthorizationRequest

Mensaje de solicitud para obtener la información de autorización del complemento de Google Workspace.

Campos
name

string

Obligatorio. Nombre del proyecto para el que se obtendrá la información de autorización del complemento de Google Workspace.

Ejemplo: projects/my_project/authorization.

La autorización requiere el siguiente permiso IAM en el recurso especificado name:

  • gsuiteaddons.authorizations.get

GetDeploymentRequest

Mensaje de solicitud para obtener una implementación.

Campos
name

string

Obligatorio. El nombre completo del recurso de la implementación que se obtendrá.

Ejemplo: projects/my_project/deployments/my_deployment.

La autorización requiere el siguiente permiso IAM en el recurso especificado name:

  • gsuiteaddons.deployments.get

GetInstallStatusRequest

Mensaje de solicitud para obtener el estado de instalación de una implementación de prueba.

Campos
name

string

Obligatorio. El nombre completo del recurso de la implementación.

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

La autorización requiere el siguiente permiso IAM en el recurso especificado name:

  • gsuiteaddons.deployments.installStatus

InstallDeploymentRequest

Mensaje de solicitud para instalar una implementación para pruebas.

Campos
name

string

Obligatorio. El nombre completo del recurso de la implementación que se instalará.

Ejemplo: projects/my_project/deployments/my_deployment.

La autorización requiere el siguiente permiso IAM en el recurso especificado name:

  • gsuiteaddons.deployments.install

InstallStatus

Estado de la instalación de una implementación de prueba

Campos
name

string

El nombre canónico completo del recurso del estado de instalación de la implementación.

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

BoolValue

Es verdadero si la implementación está instalada para el usuario.

ListDeploymentsRequest

Mensaje de solicitud para enumerar las implementaciones de un proyecto.

Campos
parent

string

Obligatorio. Nombre del proyecto en el que se creará la implementación.

Ejemplo: projects/my_project.

La autorización requiere el siguiente permiso IAM en el recurso especificado parent:

  • gsuiteaddons.deployments.list
pageSize

int32

La cantidad máxima de implementaciones que se mostrarán. Es posible que el servicio muestre menos que este valor. Si no se especifica, se muestran 1,000 implementaciones como máximo. El valor máximo posible es 1,000. Los valores superiores a 1,000 se cambian a 1,000.
pageToken

string

Un token de página, recibido desde una llamada ListDeployments anterior. Proporciona esto para recuperar la página siguiente.

Cuando se pagina, todos los demás parámetros proporcionados a ListDeployments deben coincidir con la llamada que proporcionó el token de la página.

ListDeploymentsResponse

Mensaje de respuesta para enumerar las implementaciones.

Campos
deployments[]

Deployment

La lista de implementaciones del proyecto determinado.
nextPageToken

string

Un token que se puede enviar como page_token para recuperar la página siguiente. Si se omite este campo, no habrá páginas siguientes.

ReplaceDeploymentRequest

Mensaje de solicitud para crear o reemplazar una implementación.

Campos
deployment

Deployment

Obligatorio. La implementación que se creará o reemplazará.

La autorización requiere el siguiente permiso IAM en el recurso especificado deployment:

  • gsuiteaddons.deployments.update

UninstallDeploymentRequest

Mensaje de solicitud para desinstalar una implementación de prueba.

Campos
name

string

Obligatorio. El nombre completo del recurso de la implementación que se instalará.

Ejemplo: projects/my_project/deployments/my_deployment.

La autorización requiere el siguiente permiso IAM en el recurso especificado name:

  • gsuiteaddons.deployments.execute