Package google.apps.script.type.gmail

Índice

ComposeTrigger

Um acionador que é ativado quando o usuário está escrevendo um e-mail.

Campos
actions[]

MenuItemExtensionPoint

Define o conjunto de ações de um complemento de tempo de composição. São ações que os usuários podem acionar em um complemento de composição.

draftAccess

DraftAccess

Define o nível de acesso aos dados quando um complemento de tempo de composição é acionado.

DraftAccess

Um tipo enumerado que define o nível de acesso a dados necessário para o acionador do Compose.

Enums
UNSPECIFIED Valor padrão quando nada é definido para draftAccess.
NONE O acionador do Compose não pode acessar nenhum dado do rascunho quando um complemento do Compose é acionado.
METADATA Dá ao acionador do Compose a permissão para acessar os metadados do rascunho quando um complemento do Compose é acionado. Isso inclui a lista de público-alvo, como a lista "Para" e "Cc" de uma mensagem rascunho.

ContextualTrigger

Define um acionador que é acionado quando o e-mail aberto atende a critérios específicos. Quando o acionador é acionado, ele executa um endpoint específico, geralmente para criar novos cards e atualizar a interface.

Campos
onTriggerFunction

string

Obrigatório. O nome do endpoint a ser chamado quando uma mensagem corresponder ao acionador.

Campo de união trigger. O tipo de acionador determina as condições que o Gmail usa para mostrar o complemento. trigger pode ser apenas de um dos tipos a seguir:
unconditional

UnconditionalTrigger

Os gatilhos incondicionais são executados quando qualquer mensagem de e-mail é aberta.

GmailAddOnManifest

Propriedades que personalizam a aparência e a execução de um complemento do Gmail.

Campos
homepageTrigger

HomepageExtensionPoint

Define um endpoint que será executado em contextos que não correspondem a um gatilho contextual declarado. Os cards gerados por essa função sempre estarão disponíveis para o usuário, mas podem ser ofuscados pelo conteúdo contextual quando esse complemento declarar gatilhos mais segmentados.

Se presente, substitui a configuração de addOns.common.homepageTrigger.

contextualTriggers[]

ContextualTrigger

Define o conjunto de condições que acionam o complemento.

universalActions[]

UniversalAction

Define um conjunto de ações universais para o complemento. O usuário aciona ações universais no menu da barra de ferramentas do complemento.

composeTrigger

ComposeTrigger

Define o acionador de tempo de composição para um complemento de tempo de composição. Esse é o gatilho que faz com que um complemento entre em ação quando o usuário está escrevendo um e-mail. Todos os complementos de tempo de composição precisam ter o escopo gmail.addons.current.action.compose, mesmo que não editem o rascunho.

authorizationCheckFunction

string

O nome de um endpoint que verifica se o complemento tem todas as autorizações de terceiros necessárias, investigando as APIs de terceiros. Se a sondagem falhar, a função vai gerar uma exceção para iniciar o fluxo de autorização. Essa função é chamada antes de cada invocação do complemento para garantir uma experiência tranquila ao usuário.

UnconditionalTrigger

Esse tipo não tem campos.

Um acionador que é acionado quando qualquer mensagem de e-mail é aberta.

UniversalAction

Uma ação que está sempre disponível no menu da barra de ferramentas do complemento, independentemente do contexto da mensagem.

Campos
text

string

Obrigatório. Texto visível ao usuário que descreve a ação, por exemplo, "Adicionar um novo contato".

Campo de união action_type. O tipo da ação determina o comportamento do Gmail quando o usuário a invoca. action_type pode ser apenas de um dos tipos a seguir:
runFunction

string

Um endpoint que é chamado quando o usuário aciona a ação. Consulte o guia de ações universais para mais detalhes.