Ressource du fichier manifeste Gmail

Restez organisé à l'aide des collections Enregistrez et classez les contenus selon vos préférences.

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

Gmail

Configuration du fichier manifeste Google Workspace pour les extensions Gmail. Pour en savoir plus, consultez Extension des Google Workspace modules complémentaires dans Gmail.

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 d'autorisation tierces. 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 de l'invocation principale, comme illustré dans cet exemple.

composeTrigger

object (ComposeTrigger)

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

Pour en savoir plus, consultez Ajouter des actions dans l'interface utilisateur de Compose.

contextualTriggers[]

object (ContextualTrigger)

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

object (HomepageTrigger)

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

ComposeTrigger

Configuration d'une action de composition. Pour en savoir plus, consultez la section Extension de 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éclenchement de la composition. Les options suivantes sont valides:

  • NONE est le paramètre par défaut. L'objet d'événement transmis à la fonction de déclenchement de la composition est alors presque entièrement vide.
  • METADATA, qui renseigne l'objet événement transmis à la fonction de rédaction du message avec les listes des destinataires du message. Ce paramètre nécessite que le module complémentaire inclue le champ d'application gmail.addons.current.message.metadata.
selectActions[]

object (SelectAction)

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

Déclencheur contextuel

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 la section Extension de 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 activé.

Pour en savoir plus sur la définition de cette fonction, consultez la page Fonction du 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 lorsqu'ils sont ouverts. Comme il s'agit actuellement de la seule option, cet objet doit toujours être vide.

Sélectionner une action

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

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

string

Obligatoire pour les actions de rédaction. Nom de la fonction Apps Script qui s'exécute lorsque cette action de composition est sélectionnée. Cette fonction de déclenchement de l'interface de compilation compile l'interface utilisateur de composition du module complémentaire.

Pour en savoir plus, consultez la section Fonction de déclenchement de Compose.

text

string

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