Ressource de fichier manifeste Gmail

Configuration de la ressource utilisée pour définir le contenu et le comportement du module complémentaire Google Workspace dans Gmail. Tous les composants des fichiers manifestes des modules complémentaires Google Workspace doivent être marqués comme obligatoires s'ils étendent Gmail.

Gmail

Configuration du fichier manifeste du module complémentaire Google Workspace pour les extensions Gmail. Pour en savoir plus, consultez Étendre Gmail avec des modules complémentaires Google Workspace.

Représentation JSON
{
  "authorizationCheckFunction": string,
  "composeTrigger": {
    object (ComposeTrigger)
  },
  "contextualTriggers": [
    {
      object (ContextualTrigger)
    }
  ],
  "homepageTrigger": {
    object (HomepageTrigger)
  }
}
Champs
authorizationCheckFunction

string

Obsolète. Nom d'une fonction Apps Script qui effectue des vérifications des exigences d'autorisation tierce. Cette fonction est appelée avant chaque appel du module complémentaire Google Workspace.

Cette fonction a été abandonnée pour éviter une latence d'exécution inutile. À la place, le module complémentaire doit générer une exception à partir de l'appel principal, comme indiqué dans cet exemple.

composeTrigger

object (ComposeTrigger)

Requis pour les actions de rédaction. Définit l'ensemble des interfaces utilisateur disponibles pour l'utilisateur lors de la rédaction d'un e-mail.

Pour en savoir plus, consultez Étendre l'interface utilisateur de Compose avec des actions de rédaction.

contextualTriggers[]

object (ContextualTrigger)

Obligatoire. Liste des déclencheurs qui se déclenchent lorsqu'un message est ouvert dans Gmail. Lorsque le déclencheur est exécuté, il exécute une fonction Apps Script spécifique, généralement pour créer de nouvelles cartes et mettre à jour l'interface utilisateur.
homepageTrigger

object (HomepageTrigger)

Spécification de la fonction de déclencheur pour créer la page d'accueil du module complémentaire sur l'hôte Gmail. Cela remplace addOns.common.homepageTrigger.

ComposeTrigger

Configuration d'une action de rédaction. Pour en savoir plus, consultez Étendre l'interface utilisateur de Compose.

Représentation JSON
{
  "draftAccess": string,
  "selectActions": [
    {
      object (SelectAction)
    }
  ]
}
Champs
draftAccess

string

Définit le niveau d'accès aux données disponible pour une fonction de déclencheur Compose. Les options suivantes sont acceptées:

  • NONE (paramètre par défaut). L'objet d'événement transmis à la fonction du déclencheur Compose est donc presque vide.
  • METADATA, qui renseigne l'objet d'événement transmis à la fonction de déclencheur Compose avec des listes des destinataires du message. Ce paramètre nécessite que le module complémentaire comprenne le champ d'application gmail.addons.current.message.metadata.
selectActions[]

object (SelectAction)

Liste des actions de rédaction qui créent des interfaces utilisateur Compose. Toutefois, cette liste est limitée à une seule action par module complémentaire. Cette action est associée à une icône qui s'affiche dans la fenêtre de rédaction de Gmail. L'icône est spécifiée par gmail.logoUrl.

ContextualTrigger

Configuration d'un déclencheur qui se déclenche lorsque l'utilisateur ouvre un message Gmail et que ce message répond à certains critères. Pour en savoir plus, consultez Étendre l'interface utilisateur des messages.

Représentation JSON
{
  "onTriggerFunction": string,
  "unconditional": {},
}
Champs
onTriggerFunction

string

Obligatoire pour chaque déclencheur contextuel. Nom de la fonction Apps Script qui s'exécute lorsque le déclencheur est exécuté.

Pour en savoir plus sur la définition de cette fonction, consultez la section Fonction de déclencheur contextuel.

unconditional

object

Obligatoire pour chaque déclencheur contextuel. Permet d'indiquer que le déclencheur contextuel s'active pour tous les messages Gmail lors de leur ouverture. Il s'agit actuellement de la seule option. Il doit donc toujours s'agir d'un objet vide.

SelectAction

Configuration de l'action de composition qui définit la fonction à exécuter lorsque l'utilisateur sélectionne cette action.

Représentation JSON
{
  "runFunction": string,
  "text": string
}
Champs
runFunction

string

Requis pour les actions de rédaction. Nom de la fonction Apps Script qui s'exécute lorsque cette action de rédaction est sélectionnée. Cette fonction de déclencheur Compose compile l'UI du module complémentaire Compose.

Pour en savoir plus, consultez Fonction de déclencheur Compose.

text

string

Requis pour les actions de rédaction. Brève description de cette action de rédaction.