Recurso do manifesto do Gmail

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

Gmail

A configuração do manifesto do complemento do Google Workspace para extensões do Gmail. Consulte Como estender o Gmail com complementos do Google Workspace para mais informações.

Representação JSON
{
  "authorizationCheckFunction": string,
  "composeTrigger": {
    object (ComposeTrigger)
  },
  "contextualTriggers": [
    {
      object (ContextualTrigger)
    }
  ],
  "homepageTrigger": {
    object (HomepageTrigger)
  }
}
Campos
authorizationCheckFunction

string

Obsoleto. O nome de uma função do Apps Script que realiza verificações de requisitos de autorização de terceiros. Essa função é chamada antes de cada invocação do complemento do Google Workspace.

Essa função foi descontinuada para evitar latência de execução desnecessária. Em vez disso, o complemento precisa gerar uma exceção da invocação principal, conforme mostrado neste exemplo.

composeTrigger

object (ComposeTrigger)

Obrigatório para ações de composição. Define o conjunto de interfaces disponíveis para o usuário ao escrever um e-mail.

Consulte Como estender a interface do Compose com ações de escrita para mais detalhes.

contextualTriggers[]

object (ContextualTrigger)

Obrigatório. Uma lista de acionadores que são ativados quando uma mensagem é aberta no Gmail. Quando o gatilho é acionado, ele executa uma função específica do Apps Script, geralmente para criar novos cards e atualizar a interface.
homepageTrigger

object (HomepageTrigger)

A especificação da função de acionamento para criar a página inicial do complemento no host do Gmail. Isso substitui addOns.common.homepageTrigger.

ComposeTrigger

A configuração de uma ação de composição. Consulte Como estender a interface do Compose para mais informações.

Representação JSON
{
  "draftAccess": string,
  "selectActions": [
    {
      object (SelectAction)
    }
  ]
}
Campos
draftAccess

string

Define o nível de acesso a dados disponível para uma função de gatilho de composição. As opções válidas são:

  • NONE, a configuração padrão. Isso faz com que o objeto de evento transmitido para a função de acionamento do Compose fique quase vazio.
  • METADATA, que preenche o objeto de evento transmitido para a função de acionamento de composição com listas de destinatários da mensagem. Essa configuração exige que o complemento inclua o gmail.addons.current.message.metadata escopo.
selectActions[]

object (SelectAction)

Uma lista de ações do Compose que criam interfaces do Compose. No entanto, essa lista é limitada a uma única ação por complemento. A ação de texto tem um ícone correspondente na janela de texto do Gmail. O ícone é especificado por gmail.logoUrl.

ContextualTrigger

A configuração de um gatilho que é acionado quando o usuário abre uma mensagem do Gmail e essa mensagem atende a determinados critérios. Consulte Extensão da interface de mensagens para mais informações.

Representação JSON
{
  "onTriggerFunction": string,
  "unconditional": {},
}
Campos
onTriggerFunction

string

Obrigatório para cada acionador contextual. O nome da função do Apps Script que é executada quando o gatilho é disparado.

Consulte Função de acionamento contextual para detalhes sobre como definir essa função.

unconditional

object

Obrigatório para cada acionador contextual. Usado para especificar que o gatilho contextual é ativado para todas as mensagens do Gmail quando elas são abertas. No momento, essa é a única opção. Portanto, esse campo sempre será um objeto vazio.

SelectAction

A configuração de ação de composição que define qual função executar quando o usuário seleciona a ação de composição.

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

string

Obrigatório para ações de composição. O nome da função do Apps Script que é executada quando essa ação de composição é selecionada. Essa função de gatilho do Compose cria a interface do complemento.

Consulte Função de acionamento do Compose para mais detalhes.

text

string

Obrigatório para ações de composição. Uma breve descrição textual dessa ação de composição.