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 comporter tous les composants 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 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 des exigences d'autorisation tierces. Cette fonction est appelée avant chaque invocation du module complémentaire Google Workspace.

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

composeTrigger

object (ComposeTrigger)

Obligatoire pour les actions de rédaction. Définit l'ensemble des UI disponibles pour l'utilisateur lorsqu'il rédige 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 est ouvert dans Gmail. Lorsque le déclencheur se déclenche, il exécute une fonction Apps Script spécifique, généralement pour créer des cartes et mettre à jour l'UI.
homepageTrigger

object (HomepageTrigger)

Spécification de la fonction de déclencheur pour créer 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 É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 disponible pour une fonction de déclencheur Compose. Les options valides sont les suivantes :

  • NONE, le paramètre par défaut. L'objet d'événement transmis à la fonction de déclenchement Compose est alors presque vide.
  • METADATA, qui remplit l'objet d'événement transmis à la fonction de déclencheur de rédaction avec des listes de 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 composition qui créent des UI de composition. Toutefois, cette liste est limitée à une seule action par module complémentaire. L'action de rédaction est associée à une icône correspondante 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'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é.

Pour savoir comment définir cette fonction, consultez Fonction de déclenchement contextuel.

unconditional

object

Obligatoire pour chaque déclencheur contextuel. Utilisé pour spécifier que le déclencheur contextuel s'active pour tous les messages Gmail lorsqu'ils sont ouverts. 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 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éclencheur Compose crée l'UI Compose du module complémentaire.

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

text

string

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