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. Todos os componentes dos manifestos de complementos do Google Workspace precisarão ser marcados como Obrigatórios se estenderem o Gmail.

Gmail

Configuração do manifesto de complementos 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 executa 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 Estender a interface do Compose com ações de escrita para saber mais detalhes.

contextualTriggers[]

object (ContextualTrigger)

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

object (HomepageTrigger)

A especificação da função do acionador 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 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. Estas são as opções válidas:

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

object (SelectAction)

Uma lista de ações de composição que criam IUs de composição. No entanto, essa lista é limitada a uma ação por complemento. A ação de escrever mostra um ícone correspondente na janela "Escrever" do Gmail. O ícone é especificado por gmail.logoUrl.

ContextualTrigger

A configuração de um acionador que é disparado quando o usuário abre uma mensagem do Gmail que atende a determinados critérios. Consulte Como estender a IU de mensagens para mais informações.

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

string

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

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

unconditional

object

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

SelectAction

A configuração da ação de composição que define qual função será executada quando o usuário selecionar essa açã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 executada quando essa ação de escrita é selecionada. Essa função de gatilho do Compose cria a interface do Compose do complemento.

Consulte Função de gatilho Compose para mais detalhes.

text

string

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