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 precisam incluir todos os componentes marcados como Obrigatório.

AddOns

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

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

object (Common)

Obrigatório. Define valores para um complemento do Google Workspace que são comuns a todos os aplicativos host. Os valores definidos aqui servem como padrões quando valores específicos para um host em particular são omitidos.

calendar

object (Calendar)

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

chat

object ()

Obrigatório se o complemento do Google Workspace estender o Chat. Configuração de um app de chat do Google. Se omitido, o complemento será desativado no Google Chat.

O objeto addOns.chat precisa estar vazio. Para configurar o comportamento e a aparência do complemento no Chat, consulte Configurar um app de chat do Google.

drive

object (Drive)

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

gmail

object (Gmail)

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

docs

object (Docs)

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

sheets

object (Sheets)

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

slides

object (Slides)

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

meet

object (Meet)

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

Comum

Configuração de manifesto para parâmetros comuns a todos os aplicativos host. Os valores definidos aqui servem como padrões quando valores específicos para um host 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 função de acionamento padrão para a página inicial do complemento . Essa especificação é usada se um gatilho de página inicial específico do host não estiver definido. Se omitido, um card genérico da página inicial será usado.
layoutProperties

object (LayoutProperties)

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

string

Obrigatório. O URL público da imagem da barra de ferramentas.
name

string

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

string

Obrigatório se o complemento mostrar links externos em widgets usando um widget de OpenLink ou de texto usando tags de âncora HTML. Uma lista de prefixos de URL HTTPS. Para proteger os dados do usuário, os links renderizados pelo complemento precisam corresponder a um prefixo nesta lista.

Consulte Lista de permissões de URLs para mais detalhes.

universalActions[]

object (UniversalAction)

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

boolean

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

Consulte Como acessar a localidade e o fuso horário do usuário para mais detalhes.

LayoutProperties

Configuração da barra de ferramentas e da aparência do botão do complemento do Google Workspace.

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

string

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

string

Cor padrão do botão. O padrão é a cor primária, se definida. Caso contrário, o padrão é azul (#2196F3).

UniversalAction

Configuração para uma ação universal. Quando selecionada, uma ação universal abre um URL ou executa uma função 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 do menu da interface para essa ação.
runFunction

string

Obrigatório para cada ação universal se openLink estiver ausente. O nome da função do Apps Script que é executada quando selecionada.

Consulte o guia Ações universais para mais detalhes.