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ó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 a todos os aplicativos host. Alguns valores definidos aqui são usados como padrão 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 para a aparência e o comportamento do complemento do Google Workspace no aplicativo host da Agenda Google. 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 este 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)

Necessá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 o app Documentos. Configurações da aparência e do comportamento do complemento do Google Workspace no aplicativo host Documentos. Se esse campo for omitido, o complemento será desativado no Documentos.

sheets

object (Sheets)

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

slides

object (Slides)

Obrigatório se o complemento do Google Workspace estender o app Apresentações. Configurações da aparência e do comportamento do complemento do Google Workspace no aplicativo host Apresentações. Se esse campo for omitido, o complemento será desativado no app 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 para um host em particular 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 gatilho padrão para criar a página inicial do complemento. Essa especificação será usada se um gatilho 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 mostrar 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, todos os links renderizados pelo complemento precisam corresponder a um dos prefixos desta lista.

Consulte Lista de permissões de 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 as 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 o local e os fusos horários do usuário para mais detalhes.

LayoutProperties

Uma configuração que controla a barra de ferramentas e as cores e a aparência dos botões 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 ela estiver definida). Caso contrário, o padrão é azul (#2196F3).

UniversalAction

Uma configuração para uma ação universal. Quando selecionada, uma ação universal abre o link de 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 Ações universais para mais detalhes.