Package google.apps.script.type.gmail

Índice

• ComposeTrigger (mensagem)
• ComposeTrigger.DraftAccess (enum)
• ContextualTrigger (mensagem)
• GmailAddOnManifest (mensagem)
• UnconditionalTrigger (mensagem)
• UniversalAction (mensagem)

ComposeTrigger

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

Campos
actions[]	MenuItemExtensionPoint Define o conjunto de ações para um complemento de escrita. São ações que os usuários podem realizar em um complemento de escrita.
draftAccess	DraftAccess Define o nível de acesso aos dados quando um complemento de escrita é acionado.

DraftAccess

Um tipo enumerado que define o nível de acesso aos dados exigido pelo gatilho do Compose.

Enums
UNSPECIFIED	Valor padrão quando nada está definido para rascunhoAccess.
NONE	O gatilho "Escrever" não pode acessar nenhum dado do rascunho quando um complemento "Escrever" é acionado.
METADATA	Concede ao gatilho de composição 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 um rascunho de mensagem.

ContextualTrigger

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

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 Acionadores 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 acionador contextual declarado. Todos os cards gerados por essa função sempre vão estar disponíveis para o usuário, mas podem ser sobrepostos por conteúdo contextual quando esse complemento declara 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 de complementos.
composeTrigger	ComposeTrigger Define o gatilho do tempo de escrita para um complemento desse tipo. Esse é o acionador que faz com que um complemento realize uma ação quando o usuário está escrevendo um e-mail. Todos os complementos de tempo de escrita precisam ter o escopo gmail.addons.current.action.compose, mesmo que o rascunho não seja editado.
authorizationCheckFunction	string O nome de um endpoint que verifica se o complemento tem todas as autorizações de terceiros necessárias, por meio da sondagem das 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 do usuário tranquila.

UnconditionalTrigger

Esse tipo não tem campos.

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

UniversalAction

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

Campos
text	string Obrigatório. Texto visível para o 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 invoca a ação. action_type pode ser apenas de um dos tipos a seguir:
openLink	string Um link que é aberto pelo Gmail quando o usuário aciona a ação.
runFunction	string Um endpoint chamado quando o usuário aciona a ação. Consulte o guia de ações universais para mais detalhes.