REST Resource: projects.deployments

Recurso: Deployment

uma implantação de complemento 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 OAuth do Google para solicitar o consentimento do usuário final antes de executar um endpoint de complemento.

addOns

object (AddOns)

Configuração de complementos 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 continuar.

AddOns

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 em 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 das Planilhas Google.

slides

object (SlidesAddOnManifest)

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

httpOptions

object (HttpOptions)

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

CommonAddOnManifest

Configuração de complementos compartilhada entre 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 de complementos.

layoutProperties

object (LayoutProperties)

Propriedades de layout comuns para os cards de complementos.

addOnWidgetSet

object (AddOnWidgetSet)

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

useLocaleFromApp

boolean

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

homepageTrigger

object (HomepageExtensionPoint)

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

universalActions[]

object (UniversalActionExtensionPoint)

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

openLinkUrlPrefixes

array (ListValue format)

Uma ação 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 reescritos automaticamente para HTTPS links.

LayoutProperties

Propriedades de layout do cartão compartilhadas em 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 primária for definida, mas nenhuma cor secundária for definida, a cor secundária será a mesma que a primária. Se nem a cor primária nem a secundária forem definidas, o valor padrão fornecido pelo framework vai 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 dos widgets usados em um complemento.

WidgetType

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

Enums
WIDGET_TYPE_UNSPECIFIED O conjunto de widgets padrão.
DATE_PICKER O seletor de data.
STYLED_BUTTONS Os botões estilizados incluem botões preenchidos e desativados.
PERSISTENT_FORMS Formulários persistentes permitem valores de formulário persistentes 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 do complemento do Gmail que se aplica à interface de escrita do complemento.

HomepageExtensionPoint

Formato comum para declarar a visualização da 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 é 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 da página inicial personalizada de um complemento estiver desativada, um card de visão geral genérico será fornecido aos usuários.

UniversalActionExtensionPoint

Formato para declarar um ponto de extensão de item do menu de ações 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 ao ativar o 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 do menu de ações universal. Pode ser um link para abrir ou um endpoint para executar. action_type pode ser apenas de um dos tipos a seguir:
runFunction

string

Endpoint a ser executado pela UniversalAction.

GmailAddOnManifest

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 gatilho contextual declarado. Todos os cards gerados por essa função vão estar sempre disponíveis para o usuário, mas poderão ser eclipsados por conteúdo contextual quando o complemento declarar gatilhos mais direcionados.

Se presente, substitui 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 de complementos.

composeTrigger

object (ComposeTrigger)

Define o gatilho do tempo de escrita de um complemento. Esse é o acionador que faz com que um complemento entre em ação quando o usuário estiver escrevendo um e-mail. Todos os complementos de tempo de escrita precisam ter o escopo gmail.addons.current.action.compose, mesmo que o rascunho não seja editado.

authorizationCheckFunction

string

O nome de um endpoint que verifica se o complemento tem todas as autorizações de terceiros necessárias, por meio da sondagem das APIs de terceiros. Se a sondagem falhar, a função vai 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 boa experiência do usuário.

ContextualTrigger

Define um acionador que é disparado quando o e-mail aberto atende a um critério específico. Quando o acionador dispara, ele executa um endpoint específico, geralmente para criar novos cartões e atualizar a interface.

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

Esse tipo não tem campos.

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

UniversalAction

Uma ação que está sempre disponível no menu da barra de ferramentas de complementos, independente 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 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. São ações que os usuários podem acionar em um complemento de escrita.

draftAccess

enum (DraftAccess)

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

DraftAccess

Uma enumeração que define o nível de acesso a dados que o gatilho do Compose exige.

Enums
UNSPECIFIED Valor padrão quando nada está definido como rascunhoaccess.
NONE O gatilho de escrita não pode acessar nenhum dado do rascunho quando um complemento do Compose é acionado.
METADATA Concede ao gatilho do Compose a permissão para acessar os metadados do rascunho quando um complemento do Compose é 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, substitui a configuração de addons.common.homepageTrigger.

onItemsSelectedTrigger

object (DriveExtensionPoint)

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

DriveExtensionPoint

Formato comum para declarar 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 é ativado.

CalendarAddOnManifest

Propriedades que personalizam a aparência e a execução de um complemento do Google 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 gatilho contextual declarado. Todos os cards gerados por essa função vão estar sempre disponíveis para o usuário, mas eles poderão ser eclipsados por conteúdo contextual quando o complemento declarar acionadores mais direcionados.

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

conferenceSolution[]

object (ConferenceSolution)

Define as soluções de conferência oferecidas pelo 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 acionado quando um evento é aberto para visualização ou edição.

eventUpdateTrigger

object (CalendarExtensionPoint)

Um endpoint acionado quando o evento aberto é atualizado.

currentEventAccess

enum (EventAccess)

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

ConferenceSolution

Define os valores relacionados à conferência.

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

string

Obrigatório. O endpoint a ser chamado quando os dados de videoconferência forem criados.

id

string

Obrigatório. Os IDs devem ser atribuídos de forma exclusiva às soluções de videoconferência em um complemento. Caso contrário, é possível que a solução errada seja usada quando o complemento for acionado. Você pode mudar o nome de exibição de um complemento, mas o ID não pode ser modificado.

name

string

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

logoUrl

string

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

CalendarExtensionPoint

Formato comum para declarar acionadores de um complemento da agenda.

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

string

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

EventAccess

Uma enumeração que define o nível de acesso a dados que os acionadores exigem.

Enums
UNSPECIFIED Valor padrão quando nada está definido para eventAccess.
METADATA Concede aos acionadores de eventos 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 fornecidos, incluindo metadados, participantes e dados da conferência.
WRITE Concede aos acionadores acesso aos metadados de eventos e à capacidade de realizar todas as ações, incluindo adicionar participantes e definir dados de videoconferências.
READ_WRITE Concede aos acionadores de eventos acesso a todos os campos fornecidos, incluindo metadados, participantes e dados da conferência, além da capacidade de realizar todas as ações.

DocsAddOnManifest

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

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

object (HomepageExtensionPoint)

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

onFileScopeGrantedTrigger

object (DocsExtensionPoint)

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

linkPreviewTriggers[]

object (LinkPreviewExtensionPoint)

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

createActionTriggers[]

object (CreateActionExtensionPoint)

Uma lista de pontos de extensão para criar recursos de terceiros nos aplicativos do Google Workspace. Saiba mais em Criar recursos de terceiros no menu @.

DocsExtensionPoint

Formato comum para declarar 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 é ativado.

LinkPreviewExtensionPoint

A configuração de um acionador que é disparado quando um usuário digita ou cola um link de um serviço de terceiros ou de terceiros em um arquivo dos Documentos, Planilhas ou Apresentações 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 exemplo de ícone inteligente que solicita que os usuários visualizem o link, como Example: Support case. Esse texto é estático e aparece antes de os usuários executarem o complemento.

localizedLabelText

map (key: string, value: string)

Opcional. Um mapa de labeltext para localização em outros idiomas. Formate o idioma no formato 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 presente nas chaves do mapa, ele vai encontrar 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 links de visualização.

runFunction

string

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

logoUrl

string

Opcional. O ícone que aparece no ícone inteligente e no card de visualização. Se omitido, o complemento usará o próprio ícone da barra de ferramentas, logourl.

UriPattern

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 que será visualizado. O domínio do padrão de URL. Os links de visualizações de complementos 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 da hostpattern.

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

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

CreateActionExtensionPoint

A configuração de um acionador que é disparado quando um usuário invoca o fluxo de trabalho de criação de recursos em um aplicativo do Google Workspace. Saiba mais em Criar recursos de terceiros no menu @.

Representação JSON
{
  "id": string,
  "labelText": string,
  "localizedLabelText": {
    string: string,
    ...
  },
  "runFunction": string,
  "logoUrl": string
}
Campos
id

string

Obrigatório. O ID exclusivo para diferenciar esse ponto de extensão. O ID pode ter até 64 caracteres e precisa estar no formato [a-zA-Z0-9-]+.

labelText

string

Obrigatório. O texto mostrado ao lado de um ícone do ponto de entrada de criação de recursos, como Create support case. Esse texto é estático e aparece antes de os usuários executarem o complemento.

localizedLabelText

map (key: string, value: string)

Opcional. Um mapa de labeltext para localização em outros idiomas. Formate o idioma no formato 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 presente nas chaves do mapa, ele vai encontrar a versão localizada do labeltext.

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

runFunction

string

Obrigatório. Endpoint a ser executado quando um fluxo de trabalho de criação de recurso é acionado para criar um link.

logoUrl

string

Opcional. O ícone do ponto de entrada de criação de recursos. Se omitido, o menu vai usar o ícone da barra de ferramentas do complemento, logourl.

SheetsAddOnManifest

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

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

object (HomepageExtensionPoint)

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

onFileScopeGrantedTrigger

object (SheetsExtensionPoint)

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

linkPreviewTriggers[]

object (LinkPreviewExtensionPoint)

Uma lista de pontos de extensão para visualização de links em um documento do Planilhas Google. Saiba mais em Visualizar links com ícones inteligentes.

SheetsExtensionPoint

Formato comum para declarar acionadores de um complemento das Planilhas.

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

string

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

SlidesAddOnManifest

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

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

object (HomepageExtensionPoint)

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

onFileScopeGrantedTrigger

object (SlidesExtensionPoint)

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

linkPreviewTriggers[]

object (LinkPreviewExtensionPoint)

Uma lista de pontos de extensão para visualizar links em um documento das Apresentações Google. Saiba mais em Visualizar links com ícones inteligentes.

SlidesExtensionPoint

Formato comum para declarar 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 é ativado.

HttpOptions

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

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

enum (HttpAuthorizationHeader)

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

HttpAuthorizationHeader

O cabeçalho de autorização foi enviado em solicitações HTTP de complemento.

Enums
HTTP_AUTHORIZATION_HEADER_UNSPECIFIED Valor padrão, equivalente a SYSTEM_ID_TOKEN.
SYSTEM_ID_TOKEN Enviar 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 indicado.

get

Recebe a implantação com o nome especificado.

getInstallStatus

Recebe o status da 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 da conta do usuário.