Ressource de fichier manifeste des modules complémentaires

Configuration des ressources permettant de définir le contenu et le comportement du module complémentaire Google Workspace. Tous les composants du fichier manifeste du module complémentaire Google Workspace doivent comporter la mention Obligatoire.

AddOns

Premier niveau de la configuration du fichier manifeste du module complémentaire Google Workspace.

Représentation JSON 
{
  "common": {
    object (Common)
  },
  "calendar": {
    object (Calendar)
  },
  "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 communes à toutes les applications 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.

calendar

object (Calendar)

Obligatoire si le module complémentaire Google Workspace étend Agenda. Configurations d'apparence et de 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.

drive

object (Drive)

Obligatoire si le module complémentaire Google Workspace étend Google Drive. Configurations d'apparence et de 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 d'apparence et de comportement du module complémentaire 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 d'apparence et de 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 d'apparence et de 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 d'apparence et de 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

La 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 la création de la page d'accueil du module complémentaire. Cette spécification est utilisée si aucun déclencheur de page d'accueil spécifique à l'hôte n'est défini. Si cette information est également omise, une fiche de page d'accueil générique est créée et utilisée si nécessaire.
layoutProperties

object (LayoutProperties)

Configuration des couleurs utilisées dans la barre d'outils du module complémentaire et les boutons.
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 à l'aide d'un OpenLink ou d'un widget de texte utilisant des balises d'ancrage HTML. Liste de 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 toujours disponibles dans l'interface utilisateur du module complémentaire.
useLocaleFromApp

boolean

Si la valeur est true, les objets d'événement complémentaires transmis aux fonctions de rappel d'action ou aux fonctions de déclencheur incluent les informations sur les paramètres régionaux et le fuseau horaire 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 couleur et l'apparence de la barre d'outils complémentaire Google Workspaceet des boutons.

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

string

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

string

Couleur par défaut des boutons. La valeur par défaut est la couleur principale (si elle est définie), sinon elle est bleue (#2196F3).

UniversalAction

Une configuration pour une action universelle. Lorsque cette option est sélectionnée, une action universelle 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'interface utilisateur pour cette action.
runFunction

string

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

Pour en savoir plus, consultez le guide sur les actions universelles.