Recurso do manifesto do Gmail

A configuração do recurso usado para definir o conteúdo e o comportamento dos complementos do Google Workspace no Gmail. Todos os componentes precisam estar marcados como obrigatórios nos manifestos de complementos do Google Workspace se estenderem o Gmail.

Gmail

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

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

composeTrigger

object (ComposeTrigger)

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

Consulte Como estender a interface do Compose com ações de escrita para 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 de 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 escrita. 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 aos dados disponíveis 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 do evento transmitido para a função de gatilho do Compose fique quase vazio.
  • METADATA, que preenche o objeto do evento transmitido para a função do 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 do Compose que criam IUs do Compose. No entanto, essa lista é limitada a uma única ação por complemento. A ação de escrever tem um ícone correspondente apresentado 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 e essa mensagem atende a determinados critérios. Para mais informações, consulte Como estender a interface de mensagens.

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

string

Obrigatório para cada acionador contextual. O nome da função do Apps Script 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 acionador contextual. Usado para especificar que o acionador contextual será ativado para todas as mensagens do Gmail quando elas forem abertas. Atualmente, essa é a única opção, portanto, o objeto precisa ser sempre 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 escrita. 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 do Compose para mais detalhes.

text

string

Obrigatório para ações de escrita. Uma breve descrição desta ação de escrever.