Recurso de manifesto de complementos

A configuração de recurso 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ó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)
  }
}
Campos
common

object (Common)

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

calendar

object (Calendar)

Obrigatório se o complemento do Google Workspace estender o app Agenda. Configurações para a aparência e o comportamento do complemento do Google Workspace no aplicativo host do Google Agenda. Se esse campo for 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 do Google Chat. Se esse campo for 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 do Chat.
drive

object (Drive)

Obrigatório se o complemento do Google Workspace estender o Google Drive. Configurações para a aparência e o comportamento do complemento do Google Workspace no aplicativo host do Google Drive. Se esse 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 para a aparência e o 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. Configurações para a aparência e o comportamento do complemento do Google Workspace no aplicativo host do Documentos. Se esse campo for omitido, o complemento será desativado nos Documentos.

sheets

object (Sheets)

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

slides

object (Slides)

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

Nome

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

object (LayoutProperties)

Uma configuração para as cores usadas na barra de ferramentas e nos botões do complemento.
logoUrl

string

Obrigatório. O 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 mostra links externos, seja em widgets que usam um OpenLink ou widgets de texto que usam 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 Autorizar URLs 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 para funções de callback de ação ou funções de acionamento incluem as informações de localidade e fuso horário do usuário. O padrão é false.

Consulte Como acessar a localidade e os fusos horários do usuário para mais detalhes.

LayoutProperties

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

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 é a cor primária (se definida) ou 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 do Apps Script especificada.

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 que é executada quando o usuário seleciona essa ação.

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