Recurso de manifesto de complementos

A configuração de recursos usada para definir o conteúdo e o comportamento do complemento do Google Workspace. Os manifestos de complementos do Google Workspace precisam ter todos os componentes marcados como Obrigatórios.

AddOns

O nível superior da configuração do manifesto de complementos do Google Workspace.

Representação JSON 
{
  "common": {
    object (Common)
  },
  "calendar": {
    object (Calendar)
  },
  "drive": {
    object (Drive)
  },
  "gmail": {
    object (Gmail)
  },
  "docs": {
    object (Docs)
  },
  "sheets": {
    object (Sheets)
  },
  "slides": {
    object (Slides)
  }
}
Campos
common

object (Common)

Obrigatório. Define valores de um complemento do Google Workspace que são comuns a todos os aplicativos host. Alguns valores definidos aqui são usados como padrão quando valores específicos de um determinado host são omitidos.

calendar

object (Calendar)

Obrigatório se o complemento do Google Workspace estender o Agenda. Configurações de aparência e comportamento do complemento do Google Workspace no aplicativo host do Google Agenda. Se esse campo for omitido, o complemento será desativado no Google Agenda.

drive

object (Drive)

Obrigatório se o complemento do Google Workspace estender o Google Drive. Configurações de aparência e comportamento do complemento do Google Workspace no aplicativo host do Google Drive. Se este campo for omitido, o complemento será desativado no Google Drive.

gmail

object (Gmail)

Obrigatório se o complemento do Google Workspace estender o Gmail. Configurações de aparência e comportamento do complemento do Google Workspace no aplicativo host do Gmail. Se esse campo for omitido, o complemento será desativado no Gmail.

docs

object (Docs)

Obrigatório se o complemento do Google Workspace estender os Documentos Google. Configurações de aparência e comportamento do complemento do Google Workspace no aplicativo host do Documentos. Se esse campo for omitido, o complemento será desativado no Documentos Google.

sheets

object (Sheets)

Obrigatório se o complemento do Google Workspace estender o Planilhas. Configurações de aparência e comportamento do complemento do Google Workspace no aplicativo host do Planilhas. Se este campo for omitido, o complemento será desativado no Planilhas.

slides

object (Slides)

Obrigatório se o complemento do Google Workspace estender as Apresentações. Configurações de aparência e comportamento do complemento do Google Workspace no aplicativo host do Apresentações. Se este campo for omitido, o complemento será desativado no Apresentações.

Nome

A configuração de manifesto para parâmetros comuns a todos os aplicativos host. Alguns valores definidos aqui são usados como padrão quando valores específicos de um host específico são omitidos.

Representação JSON 
{
  "homepageTrigger": {
    object (HomepageTrigger)
  },
  "layoutProperties": {
    object (LayoutProperties)
  },
  "logoUrl": string,
  "name": string,
  "openLinkUrlPrefixes": [
    string
  ],
  "universalActions": [
    {
      object (UniversalAction)
    }
  ],
  "useLocaleFromApp": boolean
}
Campos
homepageTrigger

object (HomepageTrigger)

A especificação da função de acionador padrão para criar a página inicial do complemento. Essa especificação será usada se um acionador específico da página inicial do host não for definido. Se isso também for omitido, um card genérico de página inicial será criado e usado quando necessário.
layoutProperties

object (LayoutProperties)

Configuração das cores usadas na barra de ferramentas e nos botões do complemento.
logoUrl

string

Obrigatório. URL da imagem mostrada na barra de ferramentas. O URL precisa ser público.
name

string

Obrigatório. O nome do complemento mostrado na barra de ferramentas.
openLinkUrlPrefixes[]

string

Obrigatório se o complemento exibir links externos, seja em widgets usando um OpenLink ou um widget de texto usando tags âncora HTML. Uma lista de prefixos de URL HTTPS. Para proteger os dados do usuário, qualquer link renderizado pelo complemento precisa corresponder a um dos prefixos desta lista.

Consulte Adicionar URLs à lista de permissões para mais detalhes.

universalActions[]

object (UniversalAction)

Lista de ações universais que estão sempre disponíveis na interface do complemento.
useLocaleFromApp

boolean

Se true, os objetos de evento do complemento transmitidos às funções de callback de ação ou as funções de gatilho incluem as informações de localidade e fuso horário do usuário. O padrão é false.

Para mais detalhes, consulte Como acessar a localidade e os fusos horários do usuário.

LayoutProperties

Uma configuração que controla as cores e aparência Google Workspace dos botões e da barra de ferramentas do complemento.

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

string

A cor da barra de ferramentas. O padrão é cinza (#424242).
secondaryColor

string

A cor padrão dos botões. O padrão será a cor primária (se estiver definida). Caso contrário, o padrão será azul (#2196F3).

UniversalAction

Uma configuração para uma ação universal. Quando selecionada, uma ação universal abre o link do URL especificado ou executa a função especificada do Apps Script.

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

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

}
Campos
label

string

Obrigatório para cada ação universal. O texto mostrado no menu da interface para essa ação.
runFunction

string

Obrigatório para cada ação universal se openLink não estiver presente. Se fornecido, o nome da função do Apps Script executada quando o usuário seleciona essa ação.

Consulte o guia de ações universais para mais detalhes.