Ressource de fichier manifeste des modules complémentaires

Configuration des ressources utilisée pour définir le contenu et le comportement des modules complémentaires Google Workspace. Les fichiers manifestes des modules complémentaires Google Workspace doivent comporter tous les composants marqués comme Obligatoire.

AddOns

Configuration de premier niveau du fichier manifeste du module complémentaire Google Workspace.

Représentation JSON
{
  "common": {
    object (Common)
  },
  "calendar": {
    object (Calendar)
  },
  "chat": {
    object (Chat)
  },
  "drive": {
    object (Drive)
  },
  "gmail": {
    object (Gmail)
  },
  "docs": {
    object (Docs)
  },
  "sheets": {
    object (Sheets)
  },
  "slides": {
    object (Slides)
  }
}
Champs
common

object (Common)

Obligatoire. Définit les valeurs d'un module complémentaire Google Workspace qui sont communes à toutes les applications hôtes. Certaines valeurs définies ici sont utilisées par défaut lorsque des valeurs spécifiques pour un hôte particulier sont omises.

calendar

object (Calendar)

Obligatoire si le module complémentaire Google Workspace étend l'agenda. Configurations pour l'apparence et le comportement du module complémentaire Google Workspace dans l'application hôte Google Agenda. Si ce champ est omis, le module complémentaire est désactivé dans Google Agenda.

chat

object ()

Obligatoire si le module complémentaire Google Workspace étend Chat. Configuration d'une application Google Chat. Si ce champ est omis, le module complémentaire est désactivé dans Google Chat.

L'objet addOns.chat doit être vide. Pour configurer le comportement et l'apparence du module complémentaire dans Chat, consultez Configurer une application Chat.

drive

object (Drive)

Obligatoire si le module complémentaire Google Workspace étend Google Drive. Configurations de l'apparence et du comportement du module complémentaire Google Workspace dans l'application hôte Google Drive. Si ce champ est omis, le module complémentaire est désactivé dans Google Drive.

gmail

object (Gmail)

Obligatoire si le module complémentaire Google Workspace étend Gmail. Configurations de l'apparence et du comportement des modules complémentaires Google Workspace dans l'application hôte Gmail. Si ce champ est omis, le module complémentaire est désactivé dans Gmail.

docs

object (Docs)

Obligatoire si le module complémentaire Google Workspace étend Docs. Configurations de l'apparence et du comportement du module complémentaire Google Workspace dans l'application hôte Docs. Si ce champ est omis, le module complémentaire est désactivé dans Docs.

sheets

object (Sheets)

Obligatoire si le module complémentaire Google Workspace étend Sheets. Configurations de l'apparence et du comportement du module complémentaire Google Workspace dans l'application hôte Sheets. Si ce champ est omis, le module complémentaire est désactivé dans Sheets.

slides

object (Slides)

Obligatoire si le module complémentaire Google Workspace étend Slides. Configurations de l'apparence et du comportement du module complémentaire Google Workspace dans l'application hôte Slides. Si ce champ est omis, le module complémentaire est désactivé dans Slides.

Courant

Configuration du fichier manifeste pour les paramètres communs à chaque application hôte. Certaines valeurs définies ici sont utilisées par défaut lorsque des valeurs spécifiques pour un hôte particulier sont omises.

Représentation JSON
{
  "homepageTrigger": {
    object (HomepageTrigger)
  },
  "layoutProperties": {
    object (LayoutProperties)
  },
  "logoUrl": string,
  "name": string,
  "openLinkUrlPrefixes": [
    string
  ],
  "universalActions": [
    {
      object (UniversalAction)
    }
  ],
  "useLocaleFromApp": boolean
}
Champs
homepageTrigger

object (HomepageTrigger)

Spécification de la fonction de déclencheur par défaut pour créer la page d'accueil du module complémentaire. Cette spécification est utilisée si aucun déclencheur de page d'accueil spécifique à un hôte n'est défini. Si cette valeur est également omise, une fiche générique de page d'accueil est construite et utilisée si nécessaire.
layoutProperties

object (LayoutProperties)

Configuration des couleurs utilisées dans la barre d'outils et les boutons du module complémentaire.
logoUrl

string

Obligatoire. URL de l'image affichée dans la barre d'outils. L'URL doit être publique.

name

string

Obligatoire. Nom du module complémentaire affiché dans la barre d'outils.

openLinkUrlPrefixes[]

string

Obligatoire si le module complémentaire affiche des liens sortants, que ce soit dans des widgets utilisant OpenLink ou dans des widgets de texte utilisant des balises d'ancrage HTML. Liste des préfixes d'URL HTTPS. Pour protéger les données utilisateur, tout lien affiché par le module complémentaire doit correspondre à l'un des préfixes de cette liste.

Pour en savoir plus, consultez Ajouter des URL à la liste d'autorisation.

universalActions[]

object (UniversalAction)

Liste des actions universelles qui sont toujours disponibles dans l'UI du module complémentaire.
useLocaleFromApp

boolean

Si la valeur est true, les objets d'événement de module complémentaire transmis aux fonctions de rappel d'action ou aux fonctions de déclencheur incluent les informations sur le fuseau horaire et les paramètres régionaux de l'utilisateur. La valeur par défaut est false.

Pour en savoir plus, consultez Accéder aux paramètres régionaux et aux fuseaux horaires des utilisateurs.

LayoutProperties

Configuration qui contrôle la barre d'outils et l'apparence des boutons du module complémentaire Google Workspace.

Représentation JSON
{
  "primaryColor": string,
  "secondaryColor": string
}
Champs
primaryColor

string

Couleur de la barre d'outils. La valeur par défaut est le gris (#424242).
secondaryColor

string

Couleur par défaut des boutons. La valeur par défaut est la couleur primaire (si elle est définie). Sinon, la valeur par défaut est le bleu (#2196F3).

UniversalAction

Configuration d'une action universelle. Lorsqu'une action universelle est sélectionnée, elle ouvre le lien URL spécifié ou exécute la fonction Apps Script spécifiée.

Représentation JSON
{
  "label": string,

  // Union field rule can be only one of the following:
  "openLink": string,
  "runFunction": string,
  // End of list of possible types for union field rule.

}
Champs
label

string

Obligatoire pour chaque action universelle. Texte affiché dans le menu de l'UI pour cette action.
runFunction

string

Obligatoire pour chaque action universelle si openLink n'est pas présent. Si elle est fournie, il s'agit du nom de la fonction Apps Script qui s'exécute lorsque l'utilisateur sélectionne cette action.

Pour en savoir plus, consultez le guide Actions universelles.