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 os quais é preciso pedir o consentimento do usuário final antes de executar um endpoint de complemento.
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.

AddOns

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)
  },
  "meet": {
    object (MeetAddOnManifest)
  },
  "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 do complemento do Gmail.
drive

object (DriveAddOnManifest)

Configuração do complemento do Drive.
calendar

object (CalendarAddOnManifest)

Configuração do complemento da Agenda.
docs

object (DocsAddOnManifest)

Configuração do complemento do Documentos.
meet

object (MeetAddOnManifest)

Configuração do complemento do Meet.
sheets

object (SheetsAddOnManifest)

Configuração do complemento do Planilhas.
slides

object (SlidesAddOnManifest)

Configuração do complemento do Google Slides.
httpOptions

object (HttpOptions)

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

CommonAddOnManifest

Configuração de complemento 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 do complemento.
layoutProperties

object (LayoutProperties)

Propriedades de layout comuns para os cards do complemento.
addOnWidgetSet

object (AddOnWidgetSet)

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

boolean

Se as informações de localidade do app host devem ser transmitidas.
homepageTrigger

object (HomepageExtensionPoint)

Define um endpoint que será executado em qualquer contexto, em qualquer host. Os cards gerados por essa função sempre estarão disponíveis para o usuário, mas podem ser eclipsados pelo conteúdo contextual quando esse complemento declarar gatilhos mais segmentados.
universalActions[]

object (UniversalActionExtensionPoint)

Define uma lista de pontos de extensão no menu de ações universais 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 um 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. Os links HTTP são reescritos automaticamente como links HTTPS.

LayoutProperties

Propriedades de layout de card compartilhadas em todos os aplicativos hospedados 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 pelo framework será usado.
secondaryColor

string

A cor secundária do complemento. Define a cor dos botões. Se a cor primária for definida, mas não a secundária, a cor secundária será igual à primária. Se nenhuma cor primária ou secundária for definida, o valor padrão fornecido pelo framework será usado.
useNewMaterialDesign
(deprecated)

boolean

Ativa o Material Design para cards.

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.

WidgetType

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

Tipos enumerados
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 Os formulários persistentes permitem manter os valores do formulário durante as ações.
UPDATE_SUBJECT_AND_RECIPIENTS Atualizar 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 à 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 for ativado.
enabled

boolean

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

O padrão será true se não for definido.

Se a visualização personalizada da página inicial 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 de menu de ação universal.

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

  "openLink": string,
  "runFunction": string
}
Campos
label

string

Obrigatório. Texto visível para o usuário que descreve a ação realizada ao ativar esse ponto de extensão, por exemplo, "Adicionar um novo contato".
Obrigatório. O tipo de ação aceito em um item de menu de ação universal. Pode ser um link para abrir ou um endpoint para executar. Confira a seguir uma lista de campos mutuamente exclusivos. No máximo um dos campos será definido em uma resposta:
runFunction

string

Endpoint a ser executado pela UniversalAction.
Fim dos campos mutuamente exclusivos.

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 acionador contextual declarado. Os cards gerados por essa função sempre vão estar disponíveis para o usuário, mas podem ser eclipsados pelo conteúdo contextual quando esse complemento declarar acionadores mais segmentados.

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 do complemento.
composeTrigger

object (ComposeTrigger)

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

string

O nome de um endpoint que verifica se o complemento tem todas as autorizações de terceiros necessárias, sondando as 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 experiência do usuário tranquila.

ContextualTrigger

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

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

  "unconditional": {
    object (UnconditionalTrigger)
  }
}
Campos
onTriggerFunction

string

Obrigatório. O nome do endpoint a ser chamado quando uma mensagem corresponde ao gatilho.
O tipo de gatilho determina as condições que o Gmail usa para mostrar o complemento. Confira a seguir uma lista de campos mutuamente exclusivos. No máximo um dos campos será definido em uma resposta:
unconditional

object (UnconditionalTrigger)

Os acionadores incondicionais são executados quando qualquer mensagem de e-mail é aberta.
Fim dos campos mutuamente exclusivos.

UnconditionalTrigger

Esse tipo não tem campos.

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

UniversalAction

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

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

  "openLink": string,
  "runFunction": string
}
Campos
text

string

Obrigatório. Texto visível ao usuário que descreve a ação, por exemplo, "Adicionar um novo contato".
O tipo da ação determina o comportamento do Gmail quando o usuário a invoca. Confira a seguir uma lista de campos mutuamente exclusivos. No máximo um dos campos será definido em uma resposta:
runFunction

string

Um endpoint que é chamado quando o usuário aciona a ação. Consulte o guia de ações universais para mais detalhes.
Fim dos campos mutuamente exclusivos.

ComposeTrigger

Um gatilho 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 tempo de composição. Essas são ações que os usuários podem acionar em um complemento de tempo de escrita.
draftAccess

enum (DraftAccess)

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

DraftAccess

Um tipo enumerado que define o nível de acesso aos dados que o gatilho de criação exige.

Tipos enumerados
UNSPECIFIED Valor padrão quando nada é definido para draftaccess.
NONE O acionador de criação não pode acessar nenhum dado do rascunho quando um complemento de criação é acionado.
METADATA Dá ao acionador de criação a permissão para acessar os metadados do rascunho quando um complemento de criação é acionado. Isso inclui a lista de público-alvo, como a lista "Para" e "Cc" de um rascunho de mensagem.

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 que é 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 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 é ativado.

CalendarAddOnManifest

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)
  },
  "calendarNotificationTrigger": {
    object (CalendarExtensionPoint)
  },
  "eventAttachmentTrigger": {
    object (MenuItemExtensionPoint)
  },
  "currentEventAccess": enum (EventAccess)
}
Campos
homepageTrigger

object (HomepageExtensionPoint)

Opcional. Define um endpoint que é executado em contextos que não correspondem a um acionador contextual declarado. Os cards gerados por essa função sempre estarão disponíveis para o usuário, mas podem ser eclipsados pelo conteúdo contextual quando esse complemento declarar gatilhos mais segmentados.

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

object (ConferenceSolution)

Opcional. Define as soluções de videoconferê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.
calendarNotificationTrigger

object (CalendarExtensionPoint)

Opcional. É acionado quando um evento é criado ou atualizado em uma agenda em que o usuário está inscrito. Aplica-se apenas a gatilhos criados por HTTP endpoints usando CalendarSubscriptionActionMarkup.

Para evitar loops de notificação recursivos, quando um complemento modifica um evento do Google Agenda usando a API Calendar com credenciais de autenticação do mesmo projeto do Google Cloud que hospeda a implantação do complemento, a plataforma suprime as notificações de modificação. Não é possível acionar as chamadas de API Calendar do seu próprio projeto.

Não relevante para Apps Script add-ons e Apps Script installable triggers.
eventAttachmentTrigger

object (MenuItemExtensionPoint)

Uma configuração para um acionador contextual que é disparado quando o usuário clica no provedor de anexos do complemento no menu suspenso da Agenda.
currentEventAccess

enum (EventAccess)

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

ConferenceSolution

Define 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 da videoconferência precisarem ser criados.
id

string

Obrigatório. Os IDs precisam ser atribuídos de forma exclusiva às soluções de videoconferência em um complemento. Caso contrário, a solução errada poderá ser usada quando o complemento for acionado. Embora seja possível mudar o nome de exibição de um complemento, o ID não deve ser alterado.
name

string

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

string

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

CalendarExtensionPoint

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

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

string

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

EventAccess

Um tipo enumerado que define o nível de acesso aos dados que os acionadores de eventos exigem.

Tipos enumerados
UNSPECIFIED Valor padrão quando nada é definido para eventAccess.
METADATA Dá aos acionadores de eventos a permissão para acessar os metadados de eventos, como o ID do evento e o ID da agenda.
READ Dá aos acionadores de eventos acesso a todos os campos de eventos fornecidos, incluindo metadados, convidados e dados de conferência.
WRITE Dá aos acionadores de eventos acesso aos metadados de eventos e a capacidade de realizar todas as ações, incluindo adicionar participantes e definir dados de conferência.
READ_WRITE Dá aos acionadores de eventos acesso a todos os campos de eventos fornecidos, incluindo metadados, convidados e dados de 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 do Google Docs.

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 for concedida para este par de documento/usuário.
linkPreviewTriggers[]

object (LinkPreviewExtensionPoint)

Uma lista de pontos de extensão para visualizar links em um documento do Google Docs. Para mais detalhes, consulte 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. Para mais informações, consulte Criar recursos de terceiros com o menu @.

DocsExtensionPoint

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 é ativado quando um usuário digita ou cola um link de um serviço de terceiros ou que não é do Google em um arquivo do Google Docs, 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 que os usuários executem 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 presente nas chaves do mapa, ele vai 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 prévia de link é acionada.
logoUrl

string

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

UriPattern

A configuração de cada padrão do URL que aciona uma prévia 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 do URL. O complemento mostra prévias de 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 o 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 de host do URL for support.example.com, para corresponder aos URLs de casos hospedados em support.example.com/cases/, digite cases.

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

CreateActionExtensionPoint

A configuração de um gatilho que é acionado quando um usuário invoca o fluxo de trabalho de criação de recursos em um aplicativo do Google Workspace. Para mais informações, consulte Criar recursos de terceiros com o 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 que aparece ao lado de um ícone para o ponto de entrada de criação de recursos, como Create support case. Esse texto é estático e aparece antes que os usuários executem 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 presente nas chaves do mapa, ele vai ver 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 recursos é acionado para criar um link.
logoUrl

string

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

MeetAddOnManifest

Manifesto do complemento do Meet.

Representação JSON 
{
  "homepageTrigger": {
    object (HomepageExtensionPoint)
  },
  "web": {
    object (Web)
  },
  "supportsCollaboration": boolean,
  "termsUri": string
}
Campos
homepageTrigger

object (HomepageExtensionPoint)

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

object (Web)

Detalhes dos complementos que melhoram o cliente da Web do Meet.
supportsCollaboration

boolean

Se o complemento permite colaboração ou convidar outras pessoas para a experiência.
termsUri

string

Um link para os Termos de Serviço do complemento, se houver.

Web

Detalhes dos complementos que melhoram o cliente da Web do Meet.

Representação JSON 
{
  "sidePanelUri": string,
  "sidePanelUrl": string,
  "mainStageUri": string,
  "supportsScreenSharing": boolean,
  "supportsCollaboration": boolean,
  "supportsPopOut": boolean,
  "hostOrigins": [
    string
  ],
  "addOnOrigins": [
    string
  ],
  "openState": enum (State),
  "supportsCollaborationHostControls": boolean,
  "logoUrl": string,
  "darkModeLogoUrl": string,
  "displayFlow": enum (DisplayFlow)
}
Campos
sidePanelUri
(deprecated)

string

O URI do iframe do painel lateral.
sidePanelUrl

string

O URL do iframe do painel lateral.
mainStageUri
(deprecated)

string

O URI do iframe do "palco principal".
supportsScreenSharing

boolean

Se o complemento permite o compartilhamento de tela do palco principal.
supportsCollaboration
(deprecated)

boolean

Se o complemento permite colaboração ou convites para outras pessoas participarem da experiência. Este campo foi descontinuado. Use o campo de nível superior em MeetAddOnManifest.
supportsPopOut

boolean

Se o complemento é compatível com a abertura de uma experiência de PiP no navegador.
hostOrigins[]
(deprecated)

string

Nome legado descontinuado. Origens que devem ser adicionadas à propriedade frame-src do iframe que contém o site de terceiros. Use addonorigins.
addOnOrigins[]

string

Origens que devem ser adicionadas à propriedade frame-src do iframe que contém o site de terceiros.
openState

enum (State)

O estado inicial quando o complemento é aberto.
supportsCollaborationHostControls

boolean

Se o complemento de colaboração é compatível com os controles do organizador.
logoUrl

string

O URL do logotipo que será exibido para o complemento. Se não for especificado, o logotipo padrão será o da seção comum do manifesto.
darkModeLogoUrl

string

Uma versão do modo escuro do logourl.
displayFlow
(deprecated)

enum (DisplayFlow)

O fluxo de exibição que o complemento vai seguir quando for iniciado.

Estado

Enumeração para especificar o estado de abertura inicial do complemento.

Tipos enumerados
STATE_UNSPECIFIED O estado inicial não foi especificado com o complemento.
SIDE_PANEL_ONLY O complemento é aberto apenas com o painel lateral ativo.
MAIN_STAGE_ONLY O complemento é aberto apenas com o palco principal ativo.
SIDE_PANEL_AND_MAIN_STAGE O complemento é aberto com o painel lateral e a janela principal ativos.

DisplayFlow

Tipo enumerado para especificar o fluxo de exibição que o complemento vai seguir quando for iniciado

Tipos enumerados
DISPLAY_FLOW_UNSPECIFIED O fluxo de exibição não foi especificado.
FOCUS O complemento precisa ser iniciado no fluxo de exibição "foco".
AUGMENT O complemento precisa ser iniciado no fluxo de exibição "augment".

SheetsAddOnManifest

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

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 for concedida para este par de documento/usuário.
linkPreviewTriggers[]

object (LinkPreviewExtensionPoint)

Uma lista de pontos de extensão para visualizar links em um documento do Google Planilhas. Para mais detalhes, consulte Visualizar links com ícones inteligentes.

SheetsExtensionPoint

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 Google Slides.

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 for concedida para este par de documento/usuário.
linkPreviewTriggers[]

object (LinkPreviewExtensionPoint)

Uma lista de pontos de extensão para visualizar links em um documento do Google Slides. Para mais detalhes, consulte Visualizar links com ícones inteligentes.

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.

HttpOptions

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

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

enum (HttpAuthorizationHeader)

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

enum (GranularOauthPermissionSupport)

Se o complemento ativou as permissões granulares do OAuth.

HttpAuthorizationHeader

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

Tipos enumerados
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.

GranularOauthPermissionSupport

Se o complemento ativou as permissões granulares do OAuth.

Tipos enumerados
GRANULAR_OAUTH_PERMISSION_SUPPORT_UNSPECIFIED Valor padrão, não deve ser usado.
OPT_IN O complemento aceitou o consentimento OAuth granular.
OPT_OUT O complemento não usa o consentimento OAuth granular.

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