Ressource du fichier manifeste Gmail

Configuration de ressources utilisée pour définir le contenu et le comportement des modules complémentaires Google Workspace dans Gmail. Les fichiers manifestes des modules complémentaires Google Workspace doivent comporter tous les composants marqués comme Required (Obligatoires) s'ils étendent Gmail.

Campagnes Gmail

Configuration du fichier manifeste du module complémentaire Google Workspace pour les extensions Gmail. Pour en savoir plus, consultez Extension 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 contrôles d'obligations 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. Au lieu de cela, le module complémentaire doit générer une exception pour l'appel principal, comme illustré dans cet exemple.

composeTrigger

object (ComposeTrigger)

Requis 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 Étendre l'interface utilisateur de Compose avec des actions de rédaction.

contextualTriggers[]

object (ContextualTrigger)

Obligatoire. Liste de déclencheurs déclenchés lorsqu'un message est ouvert dans Gmail. Lorsque le déclencheur est activé, 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 de déclenchement pour la page d'accueil du module complémentaire dans l'hôte Gmail. Cela remplace addOns.common.homepageTrigger.

ComposeTrigger

Configuration d'une action de rédaction. 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 é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 déclenchement de la composition 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 interfaces utilisateur 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 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 exécuté.

Pour en savoir plus sur la définition de cette fonction, consultez la page Fonction de déclenchement du contexte.

unconditional

object

Obligatoire pour chaque déclencheur contextuel. Permet de 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.

Sélectionner une action

Configuration de l'action de rédaction 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

Requis 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 rédaction crée l'UI du module complémentaire de rédaction.

Pour en savoir plus, consultez la section Fonction de déclencheur de rédaction.

text

string

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