Recurso de manifesto do Gmail

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

Gmail

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

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 executa verificações de requisitos de autorização de terceiros. Essa função é chamada antes de cada invocação do complemento Google Workspace .

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

composeTrigger

object (ComposeTrigger)

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

Para ver mais detalhes, consulte Como estender a IU do Compose com ações de escrita.

contextualTriggers[]

object (ContextualTrigger)

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

object (HomepageTrigger)

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

ComposeTrigger

A configuração de uma ação do Compose. Consulte Como estender a IU do Compose para ver 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 do Compose. As opções válidas são as seguintes:

  • NONE, a configuração padrão. Isso faz com que o objeto de evento transmitido para a função de gatilho do Compose esteja vazio.
  • METADATA, que preenche o objeto de evento transmitido para a função de gatilho do Compose com listas de destinatários da mensagem. Esta 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 IUs do Compose. No entanto, essa lista é limitada a uma única ação por complemento. A ação de escrita tem um ícone correspondente apresentado na janela de texto do Gmail. O ícone é especificado por gmail.logoUrl.

ContextualTrigger

A configuração de um acionador que é acionado quando o usuário abre uma mensagem do Gmail e ela atende a determinados critérios. Consulte Como estender a IU da mensagem para ver 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 acionador é disparado.

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

unconditional

object

Obrigatório para cada acionador contextual. Usado para especificar que o acionador contextual é ativado para todas as mensagens do Gmail quando elas são abertas. Atualmente, essa é a única opção, então ela precisa ser sempre um objeto vazio.

Ação de seleção

A configuração da ação do Compose que define qual função executar quando o usuário seleciona a ação do Compose.

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

string

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

Consulte Função gatilho do Compose para ver mais detalhes.

text

string

Obrigatório para ações relacionadas ao Compose. É uma breve descrição desta ação no Compose.