Ressource de fichier manifeste Gmail

Configuration des ressources utilisée pour définir le contenu et le comportement d'un module complémentaire Google Workspace dans Gmail. Les fichiers manifestes des modules complémentaires Google Workspace doivent inclure tous les composants marqués comme Obligatoire 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 les 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 d'autorisation tierces.

Cette fonction est obsolète. Au lieu de cela, le module complémentaire doit générer une exception à partir de l'appel principal, comme indiqué dans l'exemple de configuration OAuth non Google.

composeTrigger

object (ComposeTrigger)

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

Pour en savoir plus, consultez Extension de l'UI de rédaction avec des actions de rédaction.

contextualTriggers[]

object (ContextualTrigger)

Obligatoire. Liste des déclencheurs qui se déclenchent lorsqu'un message s'ouvre dans Gmail. Les déclencheurs exécutent une fonction Apps Script spécifique pour mettre à jour l'UI.
homepageTrigger

object (HomepageTrigger)

Fonction de déclenchement de la page d'accueil du module complémentaire dans Gmail. Cela remplace addOns.common.homepageTrigger.

ComposeTrigger

Configuration d'une action de composition. Pour en savoir plus, consultez Étendre l'UI Compose.

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

string

Définit le niveau d'accès aux données pour une fonction de déclencheur de composition. Voici quelques options valides :

  • NONE (par défaut) : l'objet d'événement est principalement vide.
  • METADATA : l'objet d'événement inclut des listes de destinataires. Pour ce faire, vous devez disposer du champ d'application gmail.addons.current.message.metadata.
selectActions[]

object (SelectAction)

Liste des actions de rédaction. La 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 Gmail, spécifiée par gmail.logoUrl.

ContextualTrigger

Configuration d'un déclencheur qui s'active lorsqu'un utilisateur ouvre un message Gmail. Pour en savoir plus, consultez Étendre l'UI de message.

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é.
unconditional

object

Obligatoire pour chaque déclencheur contextuel. Spécifie que le déclencheur s'active pour tous les messages Gmail ouverts. Il doit toujours s'agir d'un objet vide.

SelectAction

Configuration de l'action de composition définissant la fonction à exécuter lorsqu'elle est sélectionnée.

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 lorsqu'elle est sélectionnée. La fonction crée l'UI Compose du module complémentaire.
text

string

Obligatoire pour les actions de rédaction. Brève description de l'action.