Package google.cloud.gsuiteaddons.v1

Índice

Complementos do G Suite

Um serviço para gerenciar as 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 informado.

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 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 teste. Para ver 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 de 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 ver 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.

AddOns

Configuração de complemento do Google Workspace.

Campos
common

CommonAddOnManifest

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

GmailAddOnManifest

Configuração de complementos do Gmail
drive

DriveAddOnManifest

Configuração de complementos do Drive.
calendar

CalendarAddOnManifest

Configuração de complementos do Google Agenda.
docs

DocsAddOnManifest

Configuração de complementos do Documentos.
sheets

SheetsAddOnManifest

Configuração de complementos das Planilhas Google.
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 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 de um usuário em nome do complemento.

CreateDeploymentRequest

Solicite uma mensagem 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 esta 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

Solicite uma mensagem 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 solicitar o consentimento do usuário final antes de executar um endpoint de 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 em que as informações de autorização dos complementos do Google Workspace vão ser recebidas.

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 recebida.

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 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

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

Campos
name

string

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

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

Status da instalação de uma implantação de teste.

Campos
name

string

O nome completo do recurso canônico 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

Solicite uma mensagem para listar as 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 do 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 de 1.000 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 especificado.
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 instalada.

Exemplo: projects/my_project/deployments/my_deployment.

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

  • gsuiteaddons.deployments.execute