Package google.cloud.gsuiteaddons.v1

Índice

GSuiteAddOns

Um serviço para gerenciar implantações de complementos do Google Workspace.

CreateDeployment

rpc CreateDeployment(CreateDeploymentRequest) returns (Deployment)

Cria uma implantação com o nome e a configuração especificados.

Escopos de autorização

Requer o seguinte escopo OAuth:

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

Para mais informações, consulte o guia de autorização.
DeleteDeployment

rpc DeleteDeployment(DeleteDeploymentRequest) returns (Empty)

Exclui a implantação com o nome fornecido.

Escopos de autorização

Requer o seguinte escopo OAuth:

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

Para mais informações, consulte o Guia de autorização.
GetAuthorization

rpc GetAuthorization(GetAuthorizationRequest) returns (Authorization)

Recebe as informações de autorização para implantações em um determinado projeto.

Escopos de autorização

Requer o seguinte escopo OAuth:

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

Para mais informações, consulte o Guia de autorização.
GetDeployment

rpc GetDeployment(GetDeploymentRequest) returns (Deployment)

Recebe a implantação com o nome especificado.

Escopos de autorização

Requer o seguinte escopo OAuth:

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

Para mais informações, consulte o Guia de autorização.
GetInstallStatus

rpc GetInstallStatus(GetInstallStatusRequest) returns (InstallStatus)

Recebe o status de instalação de uma implantação de teste.

Escopos de autorização

Requer o seguinte escopo OAuth:

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

Para mais informações, consulte o Guia de autorização.
InstallDeployment

rpc InstallDeployment(InstallDeploymentRequest) returns (Empty)

Instala uma implantação na sua conta para testes. Para mais informações, consulte Testar seu complemento.

Escopos de autorização

Requer o seguinte escopo OAuth:

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

Para mais informações, consulte o Guia de autorização.
ListDeployments

rpc ListDeployments(ListDeploymentsRequest) returns (ListDeploymentsResponse)

Lista todas as implantações em um projeto específico.

Escopos de autorização

Requer o seguinte escopo OAuth:

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

Para mais informações, consulte o Guia de autorização.
ReplaceDeployment

rpc ReplaceDeployment(ReplaceDeploymentRequest) returns (Deployment)

Cria ou substitui uma implantação com o nome especificado.

Escopos de autorização

Requer o seguinte escopo OAuth:

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

Para mais informações, consulte o guia de autorização.
UninstallDeployment

rpc UninstallDeployment(UninstallDeploymentRequest) returns (Empty)

Desinstala uma implantação de teste da conta do usuário. Para mais informações, consulte Testar seu complemento.

Escopos de autorização

Requer o seguinte escopo OAuth:

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

Para mais informações, consulte o Guia de autorização.

Complementos

Configuração de um complemento do Google Workspace.

Campos
common

CommonAddOnManifest

Configuração comum a todos os complementos do Google Workspace.
gmail

GmailAddOnManifest

Configuração do complemento do Gmail.
drive

DriveAddOnManifest

Configuração de complementos do Drive.
calendar

CalendarAddOnManifest

Configuração dos complementos do Agenda.
docs

DocsAddOnManifest

Configuração do complemento do Documentos.
sheets

SheetsAddOnManifest

Configuração do complemento das Planilhas.
slides

SlidesAddOnManifest

Configuração de complementos do Apresentações.
httpOptions

HttpOptions

Opções para enviar solicitações para endpoints HTTP de complementos

Autorização

As informações de autorização usadas ao invocar os endpoints de implantação.

Campos
name

string

O nome completo canônico deste recurso. Exemplo: projects/123/authorization
serviceAccountEmail

string

O endereço de e-mail da conta de serviço usada para autenticar solicitações para endpoints de callback de complementos.
oauthClientId

string

O ID do cliente OAuth usado para receber tokens de acesso OAuth para um usuário em nome do complemento.

CreateDeploymentRequest

Mensagem de solicitação para criar uma implantação.

Campos
parent

string

Obrigatório. Nome do projeto em que a implantação será criada.

Exemplo: projects/my_project.

A autorização requer a seguinte permissão do IAM no recurso especificado parent:

  • gsuiteaddons.deployments.create
deploymentId

string

Obrigatório. O ID a ser usado para essa implantação. O nome completo do recurso criado será projects/<project_number>/deployments/<deployment_id>.
deployment

Deployment

Obrigatório. A implantação a ser criada (não é possível definir "deployment.name").

DeleteDeploymentRequest

Mensagem de solicitação para excluir uma implantação.

Campos
name

string

Obrigatório. O nome completo do recurso da implantação a ser excluída.

Exemplo: projects/my_project/deployments/my_deployment.

A autorização requer a seguinte permissão do IAM no recurso especificado name:

  • gsuiteaddons.deployments.delete
etag

string

A ETag da implantação a ser excluída. Se esse valor for fornecido, ele precisará corresponder ao etag do servidor.

Implantação

Uma implantação de complemento do Google Workspace

Campos
name

string

O nome do recurso de implantação. Exemplo: projects/123/deployments/my_deployment.
oauthScopes[]

string

A lista de escopos do Google OAuth para os quais o consentimento do usuário final precisa ser solicitado antes da execução de um endpoint do complemento.
addOns

AddOns

Configuração do complemento do Google Workspace.
etag

string

Esse valor é calculado pelo servidor com base na versão da implantação no armazenamento e pode ser enviado em solicitações de atualização e exclusão para garantir que o cliente tenha um valor atualizado antes de prosseguir.

GetAuthorizationRequest

Mensagem de solicitação para acessar as informações de autorização do complemento do Google Workspace.

Campos
name

string

Obrigatório. Nome do projeto para o qual as informações de autorização do complemento do Google Workspace serão acessadas.

Exemplo: projects/my_project/authorization.

A autorização requer a seguinte permissão do IAM no recurso especificado name:

  • gsuiteaddons.authorizations.get

GetDeploymentRequest

Mensagem de solicitação para receber uma implantação.

Campos
name

string

Obrigatório. O nome completo do recurso da implantação a ser recebido.

Exemplo: projects/my_project/deployments/my_deployment.

A autorização requer a seguinte permissão do IAM no recurso especificado name:

  • gsuiteaddons.deployments.get

GetInstallStatusRequest

Mensagem de solicitação para saber o status da instalação de uma implantação de teste.

Campos
name

string

Obrigatório. O nome completo do recurso da implantação.

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

A autorização requer a seguinte permissão do IAM no recurso especificado name:

  • gsuiteaddons.deployments.installStatus

InstallDeploymentRequest

Solicitar uma mensagem para instalar uma implantação para teste.

Campos
name

string

Obrigatório. O nome completo do recurso da implantação a ser instalado.

Exemplo: projects/my_project/deployments/my_deployment.

A autorização requer a seguinte permissão do IAM no recurso especificado name:

  • gsuiteaddons.deployments.install

InstallStatus

Instalar o status de uma implantação de teste.

Campos
name

string

O nome completo canônico do recurso do status de instalação da implantação.

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

BoolValue

Verdadeiro se a implantação estiver instalada para o usuário.

ListDeploymentsRequest

Mensagem de solicitação para listar implantações de um projeto.

Campos
parent

string

Obrigatório. Nome do projeto em que a implantação será criada.

Exemplo: projects/my_project.

A autorização requer a seguinte permissão do IAM no recurso especificado parent:

  • gsuiteaddons.deployments.list
pageSize

int32

O número máximo de implantações a serem retornadas. O serviço pode retornar menos que esse valor. Se não for especificado, no máximo 1.000 implantações serão retornadas. O valor máximo possível é 1.000. Valores acima disso são alterados para 1.000.
pageToken

string

Um token de página recebido de uma chamada ListDeployments anterior. Forneça isso para recuperar a página subsequente.

Ao paginar, todos os outros parâmetros fornecidos para ListDeployments precisam corresponder à chamada que forneceu o token da página.

ListDeploymentsResponse

Mensagem de resposta para listar implantações.

Campos
deployments[]

Deployment

A lista de implantações do projeto em questão.
nextPageToken

string

Um token, que pode ser enviado como page_token para recuperar a próxima página. Se esse campo for omitido, não haverá páginas subsequentes.

ReplaceDeploymentRequest

Mensagem de solicitação para criar ou substituir uma implantação.

Campos
deployment

Deployment

Obrigatório. A implantação a ser criada ou substituída.

A autorização requer a seguinte permissão do IAM no recurso especificado deployment:

  • gsuiteaddons.deployments.update

UninstallDeploymentRequest

Mensagem de solicitação para desinstalar uma implantação de teste.

Campos
name

string

Obrigatório. O nome completo do recurso da implantação a ser instalado.

Exemplo: projects/my_project/deployments/my_deployment.

A autorização requer a seguinte permissão do IAM no recurso especificado name:

  • gsuiteaddons.deployments.execute