REST Resource: projects.deployments

Recurso: Deployment

Uma implantação de complementos do Google Workspace

Representação JSON
{
  "name": string,
  "oauthScopes": [
    string
  ],
  "addOns": {
    object (AddOns)
  },
  "etag": string
}
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 a qual você deseja solicitar o consentimento do usuário final antes de executar um endpoint de complementos.

addOns

object (AddOns)

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

Complementos

Uma configuração de complemento do Google Workspace.

Representação JSON
{
  "common": {
    object (CommonAddOnManifest)
  },
  "gmail": {
    object (GmailAddOnManifest)
  },
  "drive": {
    object (DriveAddOnManifest)
  },
  "calendar": {
    object (CalendarAddOnManifest)
  },
  "docs": {
    object (DocsAddOnManifest)
  },
  "sheets": {
    object (SheetsAddOnManifest)
  },
  "slides": {
    object (SlidesAddOnManifest)
  },
  "httpOptions": {
    object (HttpOptions)
  }
}
Campos
common

object (CommonAddOnManifest)

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

gmail

object (GmailAddOnManifest)

Configuração de complementos do Gmail.

drive

object (DriveAddOnManifest)

Configuração de complementos do Drive.

calendar

object (CalendarAddOnManifest)

Configuração de complementos do Agenda.

docs

object (DocsAddOnManifest)

Configuração de complementos do Documentos.

sheets

object (SheetsAddOnManifest)

Configuração de complementos do Planilhas.

slides

object (SlidesAddOnManifest)

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

httpOptions

object (HttpOptions)

Opções para enviar solicitações para endpoints HTTP complementares

CommonAddOnManifest

Configuração de complementos compartilhada em todos os aplicativos host de complementos.

Representação JSON
{
  "name": string,
  "logoUrl": string,
  "layoutProperties": {
    object (LayoutProperties)
  },
  "addOnWidgetSet": {
    object (AddOnWidgetSet)
  },
  "useLocaleFromApp": boolean,
  "homepageTrigger": {
    object (HomepageExtensionPoint)
  },
  "universalActions": [
    {
      object (UniversalActionExtensionPoint)
    }
  ],
  "openLinkUrlPrefixes": array
}
Campos
name

string

Obrigatório. O nome de exibição do complemento.

logoUrl

string

Obrigatório. O URL da imagem do logotipo mostrada na barra de ferramentas do complemento.

layoutProperties

object (LayoutProperties)

Propriedades de layout comuns para os cards de complementos.

addOnWidgetSet

object (AddOnWidgetSet)

Os widgets usados no complemento. Se este campo não for especificado, o conjunto padrão será usado.

useLocaleFromApp

boolean

Define se as informações de localidade serão transmitidas do app host.

homepageTrigger

object (HomepageExtensionPoint)

Define um endpoint que será executado em qualquer contexto, em qualquer host. Todos os cards gerados por essa função sempre estarão disponíveis para o usuário, mas poderão ser eliminados por conteúdo contextual quando o complemento declarar acionadores mais segmentados.

universalActions[]

object (UniversalActionExtensionPoint)

Define uma lista de pontos de extensão no menu de ação universal que serve como um menu de configurações para o complemento. O ponto de extensão pode ser um URL de link a ser aberto ou um ponto de extremidade para ser executado como um envio de formulário.

openLinkUrlPrefixes

array (ListValue format)

Uma ação do OpenLink só pode usar um URL com um esquema HTTPS, MAILTO ou TEL. Para links HTTPS, o URL também precisa corresponder a um dos prefixos especificados na lista de permissões. Se o prefixo omitir o esquema, HTTPS será usado. HTTP links são automaticamente reescritos para HTTPS links.

LayoutProperties

Propriedades de layout de cartão compartilhadas entre todos os aplicativos host de complementos.

Representação JSON
{
  "primaryColor": string,
  "secondaryColor": string,
  "useNewMaterialDesign": boolean
}
Campos
primaryColor

string

A cor principal do complemento. Define a cor da barra de ferramentas. Se nenhuma cor primária for definida, o valor padrão fornecido pela estrutura será usado.

secondaryColor

string

A cor secundária do complemento. Define a cor dos botões. Se a cor principal for definida, mas nenhuma cor secundária for definida, a cor secundária será igual à principal. Se nem a cor primária nem a secundária forem definidas, o valor padrão fornecido pela estrutura será usado.

useNewMaterialDesign

boolean

Ativa o Material Design para cartões.

AddOnWidgetSet

O subconjunto de widgets usado por um complemento.

Representação JSON
{
  "usedWidgets": [
    enum (WidgetType)
  ]
}
Campos
usedWidgets[]

enum (WidgetType)

A lista de widgets usados em um complemento.

Tipo de widget

O tipo de widget. WIDGET_TYPE_UNSPECIFIED é o conjunto básico de widgets.

Enums
WIDGET_TYPE_UNSPECIFIED O widget padrão definido.
DATE_PICKER Seletor de data.
STYLED_BUTTONS Os botões estilizados incluem botões preenchidos e desativados.
PERSISTENT_FORMS Os formulários persistentes permitem manter valores de formulários durante ações.
UPDATE_SUBJECT_AND_RECIPIENTS Atualize o assunto e os destinatários de um rascunho.
GRID_WIDGET O widget de grade.
ADDON_COMPOSE_UI_ACTION Uma ação de complemento do Gmail que se aplica à IU do Compose.

Página inicialExtensionPoint

Formato comum para declarar a visualização de página inicial de um complemento.

Representação JSON
{
  "runFunction": string,
  "enabled": boolean
}
Campos
runFunction

string

Obrigatório. O endpoint a ser executado quando esse ponto de extensão for ativado.

enabled

boolean

Opcional. Se definido como false, desativa a visualização da página inicial nesse contexto.

Se não for definido, o padrão será true.

Se a visualização personalizada da página inicial de um complemento for desativada, um cartão de visão geral genérico será fornecido aos usuários.

UniversalActionExtensionPoint

Formato para declarar um ponto de extensão do item de menu de ação universal.

Representação JSON
{
  "label": string,

  // Union field action_type can be only one of the following:
  "openLink": string,
  "runFunction": string
  // End of list of possible types for union field action_type.
}
Campos
label

string

Obrigatório. Texto visível para o usuário que descreve a ação realizada pela ativação deste ponto de extensão, por exemplo, "Adicionar um novo contato".

Campo de união action_type. Obrigatório. O tipo de ação compatível com um item de menu de ação universal. Pode ser um link a ser aberto ou um endpoint a ser executado. action_type pode ser apenas de um dos tipos a seguir:
runFunction

string

Endpoint a ser executado pelo UniversalAction.

GmailAddManifest

Propriedades que personalizam a aparência e a execução de um complemento do Gmail.

Representação JSON
{
  "homepageTrigger": {
    object (HomepageExtensionPoint)
  },
  "contextualTriggers": [
    {
      object (ContextualTrigger)
    }
  ],
  "universalActions": [
    {
      object (UniversalAction)
    }
  ],
  "composeTrigger": {
    object (ComposeTrigger)
  },
  "authorizationCheckFunction": string
}
Campos
homepageTrigger

object (HomepageExtensionPoint)

Define um endpoint que será executado em contextos que não correspondem a um acionador contextual declarado. Todos os cartões gerados por esta função sempre estarão disponíveis para o usuário, mas poderão ser esmagados pelo conteúdo contextual quando este complemento declarar acionadores mais segmentados.

Se presente, modifica a configuração de addons.common.homepageTrigger.

contextualTriggers[]

object (ContextualTrigger)

Define o conjunto de condições que acionam o complemento.

universalActions[]

object (UniversalAction)

Define um conjunto de ações universais para o complemento. O usuário aciona ações universais no menu da barra de ferramentas do complemento.

composeTrigger

object (ComposeTrigger)

Define o acionador de tempo de escrita para um complemento de tempo de escrita. Esse é o acionador que faz com que um complemento execute uma ação quando o usuário está escrevendo um e-mail. Todos os complementos de escrita precisam ter o escopo gmail.addons.current.action.compose, mesmo que não possam editar o rascunho.

authorizationCheckFunction

string

O nome de um endpoint que verifica se o complemento tem todas as autorizações de terceiros necessárias, verificando as APIs de terceiros. Se a sondagem falhar, a função gerará uma exceção para iniciar o fluxo de autorização. Essa função é chamada antes de cada invocação do complemento para garantir uma experiência do usuário tranquila.

Acionador contextual

Define um acionador que dispara quando o e-mail aberto atende a critérios específicos. Quando o acionador dispara, ele executa um endpoint específico, geralmente para criar novos cards e atualizar a IU.

Representação JSON
{
  "onTriggerFunction": string,

  // Union field trigger can be only one of the following:
  "unconditional": {
    object (UnconditionalTrigger)
  }
  // End of list of possible types for union field trigger.
}
Campos
onTriggerFunction

string

Obrigatório. O nome do endpoint a ser chamado quando uma mensagem corresponder ao acionador.

Campo de união trigger. O tipo de acionador determina as condições que o Gmail usa para exibir o complemento. trigger pode ser apenas de um dos tipos a seguir:
unconditional

object (UnconditionalTrigger)

Os acionadores incondicionais são executados quando qualquer mensagem de e-mail é aberta.

UnconditionalTrigger

Este tipo não tem campos.

Um acionador que dispara quando uma mensagem de e-mail é aberta.

Ação universal

Uma ação que está sempre disponível no menu da barra de ferramentas complementar, independentemente do contexto da mensagem.

Representação JSON
{
  "text": string,

  // Union field action_type can be only one of the following:
  "openLink": string,
  "runFunction": string
  // End of list of possible types for union field action_type.
}
Campos
text

string

Obrigatório. Texto visível para o usuário que descreve a ação, por exemplo, "Adicionar um novo contato".

Campo de união action_type. O tipo de ação determina o comportamento do Gmail quando o usuário invoca a ação. action_type pode ser apenas de um dos tipos a seguir:
runFunction

string

Um endpoint chamado quando o usuário aciona a ação. Consulte o guia de ações universais para ver mais detalhes.

ComposeTrigger

Um acionador que é ativado quando o usuário está escrevendo um e-mail.

Representação JSON
{
  "actions": [
    {
      object (MenuItemExtensionPoint)
    }
  ],
  "draftAccess": enum (DraftAccess)
}
Campos
actions[]

object (MenuItemExtensionPoint)

Define o conjunto de ações para um complemento de escrita. Essas ações podem ser acionadas pelos usuários em um complemento de escrita.

draftAccess

enum (DraftAccess)

Define o nível de acesso aos dados quando um complemento de escrita é acionado.

Acesso de rascunho

Um enum que define o nível de acesso aos dados que o acionador de composição exige.

Enums
UNSPECIFIED Valor padrão quando nada é definido para o acesso de rascunho.
NONE O acionador do Compose não pode acessar os dados do rascunho quando um complemento do Compose é acionado.
METADATA Concede ao acionador de composição permissão para acessar os metadados do rascunho quando um complemento de composição é acionado. Isso inclui a lista de público-alvo, como as listas "Para" e "Cc" de uma mensagem de rascunho.

DriveAddOnManifest

Propriedades que personalizam a aparência e a execução de um complemento do Drive.

Representação JSON
{
  "homepageTrigger": {
    object (HomepageExtensionPoint)
  },
  "onItemsSelectedTrigger": {
    object (DriveExtensionPoint)
  }
}
Campos
homepageTrigger

object (HomepageExtensionPoint)

Se presente, modifica a configuração de addons.common.homepageTrigger.

onItemsSelectedTrigger

object (DriveExtensionPoint)

Corresponde ao comportamento que é executado quando os itens são selecionados na visualização relevante do Drive, como a lista "Meu Drive".

DriveExtensionPoint

Formato comum para declarar os acionadores de um complemento do Drive.

Representação JSON
{
  "runFunction": string
}
Campos
runFunction

string

Obrigatório. O endpoint a ser executado quando o ponto de extensão for ativado.

AgendaAddOnManifest

Propriedades que personalizam a aparência e a execução de um complemento do Agenda.

Representação JSON
{
  "homepageTrigger": {
    object (HomepageExtensionPoint)
  },
  "conferenceSolution": [
    {
      object (ConferenceSolution)
    }
  ],
  "createSettingsUrlFunction": string,
  "eventOpenTrigger": {
    object (CalendarExtensionPoint)
  },
  "eventUpdateTrigger": {
    object (CalendarExtensionPoint)
  },
  "currentEventAccess": enum (EventAccess)
}
Campos
homepageTrigger

object (HomepageExtensionPoint)

Define um endpoint que é executado em contextos que não correspondem a um acionador contextual declarado. Todos os cards gerados por essa função sempre estarão disponíveis para o usuário, mas poderão ser eliminados por conteúdo contextual quando o complemento declarar acionadores mais segmentados.

Se presente, modifica a configuração de addons.common.homepageTrigger.

conferenceSolution[]

object (ConferenceSolution)

Define soluções de conferência fornecidas por este complemento.

createSettingsUrlFunction

string

Um endpoint a ser executado que cria um URL para a página de configurações do complemento.

eventOpenTrigger

object (CalendarExtensionPoint)

Um endpoint que é acionado quando um evento é aberto para visualização ou edição.

eventUpdateTrigger

object (CalendarExtensionPoint)

Um endpoint que é acionado quando o evento aberto é atualizado.

currentEventAccess

enum (EventAccess)

Define o nível de acesso aos dados quando um complemento de eventos é acionado.

Solução de videoconferência

Define os valores relacionados à conferência.

Representação JSON
{
  "onCreateFunction": string,
  "id": string,
  "name": string,
  "logoUrl": string
}
Campos
onCreateFunction

string

Obrigatório. O ponto de extremidade a ser chamado quando os dados da conferência devem ser criados.

id

string

Obrigatório. Os códigos devem ser atribuídos de forma exclusiva entre soluções de conferência dentro de um complemento. Caso contrário, a solução de conferência errada pode ser usada quando o complemento é acionado. Embora seja possível alterar o nome de exibição de um complemento, o código não deve ser alterado.

name

string

Obrigatório. O nome de exibição da solução de conferência.

logoUrl

string

Obrigatório. O URL da imagem do logotipo da solução de conferência.

AgendaExtensionPoint

Formato comum para declarar os acionadores de um complemento de agenda.

Representação JSON
{
  "runFunction": string
}
Campos
runFunction

string

Obrigatório. O endpoint a ser executado quando esse ponto de extensão for ativado.

Acesso ao evento

Um enum que define o nível de acionamento necessário para os eventos de acesso a dados.

Enums
UNSPECIFIED Valor padrão quando nada é definido para eventAccess.
METADATA Concede aos acionadores de eventos a permissão para acessar os metadados de eventos, como o ID do evento e o ID da agenda.
READ Concede aos acionadores de eventos acesso a todos os campos de evento fornecidos, incluindo os metadados, os participantes e os dados da conferência.
WRITE Dá aos acionadores de eventos acesso aos metadados de eventos e a capacidade de executar todas as ações, incluindo a adição de participantes e a configuração de dados de videoconferência.
READ_WRITE Concede aos acionadores de eventos acesso a todos os campos de evento fornecidos, incluindo os metadados, os participantes e os dados da conferência, além da capacidade de executar todas as ações.

DocumentosAddOnManifest

Propriedades que personalizam a aparência e a execução de um complemento do Documentos Google.

Representação JSON
{
  "homepageTrigger": {
    object (HomepageExtensionPoint)
  },
  "onFileScopeGrantedTrigger": {
    object (DocsExtensionPoint)
  },
  "linkPreviewTriggers": [
    {
      object (LinkPreviewExtensionPoint)
    }
  ]
}
Campos
homepageTrigger

object (HomepageExtensionPoint)

Se presente, modifica a configuração de addons.common.homepageTrigger.

onFileScopeGrantedTrigger

object (DocsExtensionPoint)

Endpoint a ser executado quando a autorização do escopo do arquivo for concedida para este par documento/usuário.

linkPreviewTriggers[]

object (LinkPreviewExtensionPoint)

Uma lista de pontos de extensão para visualizar links em um documento do Documentos Google. Veja mais detalhes em Visualizar links com ícones inteligentes.

DocumentosExtensionPoint

Formato comum para declarar os acionadores de um complemento do Documentos.

Representação JSON
{
  "runFunction": string
}
Campos
runFunction

string

Obrigatório. O endpoint a ser executado quando esse ponto de extensão for ativado.

LinkPreviewExtensionPoint

A configuração de um acionador que dispara quando um usuário digita ou cola um link de um serviço de terceiros ou de terceiros em um documento do Documentos Google.

Representação JSON
{
  "labelText": string,
  "localizedLabelText": {
    string: string,
    ...
  },
  "patterns": [
    {
      object (UriPattern)
    }
  ],
  "runFunction": string,
  "logoUrl": string
}
Campos
labelText

string

Obrigatório. O texto de um ícone inteligente de exemplo que solicita aos usuários visualizar o link, como Example: Support case. Esse texto é estático e é exibido antes dos usuários executarem o complemento.

localizedLabelText

map (key: string, value: string)

Opcional. Um mapa de labeltext para localizar em outros idiomas. Formate o idioma em ISO 639 e o país/região em ISO 3166, separados por um hífen -. Por exemplo, en-US.

Se a localidade de um usuário estiver nas chaves do mapa, o usuário verá a versão localizada do labeltext.

Um objeto com uma lista de pares "key": value. Exemplo: { "name": "wrench", "mass": "1.3kg", "count": "3" }.

patterns[]

object (UriPattern)

Obrigatório. Uma matriz de padrões de URL que acionam o complemento para visualizar links.

runFunction

string

Obrigatório. Endpoint a ser executado quando uma visualização de link for acionada.

logoUrl

string

Opcional. O ícone exibido no ícone inteligente. Se omitido, o ícone usará a barra de ferramentas do complemento, logourl.

Padrão Uri

A configuração de cada padrão de URL que aciona uma visualização de link.

Representação JSON
{
  "hostPattern": string,
  "pathPrefix": string
}
Campos
hostPattern

string

Obrigatório para cada padrão de URL a ser visualizado. O domínio do padrão de URL. O complemento visualiza os links que contêm esse domínio no URL. Para visualizar links de um subdomínio específico, como subdomain.example.com, inclua o subdomínio. Para visualizar links de todo o domínio, especifique um caractere curinga com um asterisco (*) como subdomínio.

Por exemplo, *.example.com corresponde a subdomain.example.com e another.subdomain.example.com.

pathPrefix

string

Opcional. O caminho que anexa o domínio do hostpattern.

Por exemplo, se o padrão do host de URL for support.example.com, digite cases para corresponder aos URLs em casos hospedados em support.example.com/cases/.

Para corresponder a todos os URLs no domínio do padrão do host, deixe pathprefix em branco.

PlanilhasAddOnManifest

Propriedades que personalizam a aparência e a execução de um complemento do Planilhas Google.

Representação JSON
{
  "homepageTrigger": {
    object (HomepageExtensionPoint)
  },
  "onFileScopeGrantedTrigger": {
    object (SheetsExtensionPoint)
  }
}
Campos
homepageTrigger

object (HomepageExtensionPoint)

Se presente, modifica a configuração de addons.common.homepageTrigger.

onFileScopeGrantedTrigger

object (SheetsExtensionPoint)

Endpoint a ser executado quando a autorização do escopo do arquivo for concedida para este par documento/usuário.

PlanilhasExtensionPoint

Formato comum para declarar os acionadores de um complemento do Planilhas.

Representação JSON
{
  "runFunction": string
}
Campos
runFunction

string

Obrigatório. O endpoint a ser executado quando esse ponto de extensão for ativado.

SlidesAddOnManifest

Propriedades que personalizam a aparência e a execução de um complemento do Apresentações Google.

Representação JSON
{
  "homepageTrigger": {
    object (HomepageExtensionPoint)
  },
  "onFileScopeGrantedTrigger": {
    object (SlidesExtensionPoint)
  }
}
Campos
homepageTrigger

object (HomepageExtensionPoint)

Se presente, modifica a configuração de addons.common.homepageTrigger.

onFileScopeGrantedTrigger

object (SlidesExtensionPoint)

Endpoint a ser executado quando a autorização do escopo do arquivo for concedida para este par documento/usuário.

SlidesExtensionPoint

Formato comum para declarar os acionadores de um complemento do Apresentações.

Representação JSON
{
  "runFunction": string
}
Campos
runFunction

string

Obrigatório. O endpoint a ser executado quando esse ponto de extensão for ativado.

Opções de HTTP

Opções para enviar solicitações a complementos de HTTP.

Representação JSON
{
  "authorizationHeader": enum (HttpAuthorizationHeader)
}
Campos
authorizationHeader

enum (HttpAuthorizationHeader)

Configuração do token enviado no cabeçalho de autorização HTTP.

CabeçalhodeHttpHttp

Cabeçalho de autorização enviado em solicitações do complemento HTTP.

Enums
HTTP_AUTHORIZATION_HEADER_UNSPECIFIED Valor padrão, equivalente a SYSTEM_ID_TOKEN.
SYSTEM_ID_TOKEN Envie um token de ID para a conta de serviço do sistema do complemento do Google Workspace específico do projeto (padrão).
USER_ID_TOKEN Envie um token de ID para o usuário final.
NONE Não envie um cabeçalho de autenticação.

Métodos

create

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

delete

Exclui a implantação com o nome fornecido.

get

Recebe a implantação com o nome especificado.

getInstallStatus

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

install

Instala uma implantação na sua conta para teste.

list

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

replaceDeployment

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

uninstall

Desinstala uma implantação de teste na conta do usuário.