Ressource de fichier manifeste d'agenda

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

Agenda

Configuration du fichier manifeste du module complémentaire Google Workspace pour les extensions Google Agenda. Pour en savoir plus, consultez Étendre Agenda avec des modules complémentaires Google Workspace.

Représentation JSON
{
  "createSettingsUrlFunction": string,
  "conferenceSolution": [
    {
      object (ConferenceSolution)
    }
  ],
  "currentEventAccess": string,
  "eventOpenTrigger": {
    object (EventOpenTrigger)
  },
  "eventUpdateTrigger": {
    object (EventUpdateTrigger)
  },
  "eventAttachmentTrigger": {
    object (EventAttachmentTrigger)
  },
  "homepageTrigger": {
    object (HomepageTrigger)
  }
}
Champs
createSettingsUrlFunction

string

Utilisé uniquement si le module complémentaire fournit des solutions de conférence. Facultatif. Nom de la fonction Apps Script qui génère une URL menant à une page de paramètres du module complémentaire

Pour en savoir plus, consultez Ajouter des paramètres de module complémentaire de conférence.
conferenceSolution[]

object (ConferenceSolution)

N'est utilisé que si le module complémentaire fournit des solutions de conférence. Dans ce cas, vous devez définir au moins une solution. Liste des solutions de conférence proposées par le module complémentaire. Chaque solution dispose d'une option de conférence correspondante présentée dans l'interface utilisateur Modifier un événement de Google Agenda.
currentEventAccess

string

Détermine le niveau d'accès du module complémentaire aux données d'événement de données générées par l'utilisateur. Si elle n'est pas fournie, aucune métadonnée d'événement n'est transmise au module complémentaire. Les paramètres valides sont les suivants:

  • METADATA indique que le module complémentaire n'a accès qu'aux métadonnées d'événements de base.
  • READ indique que le module complémentaire peut lire les données d'événement générées par l'utilisateur en plus des métadonnées d'événement de base.
  • WRITE indique que le module complémentaire peut écrire des données d'événement générées par l'utilisateur.
  • READ_WRITE indique que le module complémentaire peut lire et écrire des données d'événement générées par l'utilisateur, et lire des métadonnées de base.

Si défini sur READ ou READ_WRITE, le module complémentaire doit avoir le champ d'application https://www.googleapis.com/auth/calendar.addons.current.event.read.

Si défini sur WRITE ou READ_WRITE, le module complémentaire doit avoir le champ d'application https://www.googleapis.com/auth/calendar.addons.current.event.write.

eventOpenTrigger

object (EventOpenTrigger)

Spécification des déclencheurs d'ouverture d'événement dans Agenda.

eventUpdateTrigger

object (EventUpdateTrigger)

Requis pour fournir des interfaces de mise à jour d'événements contextuelles dans Google Agenda. Spécification des déclencheurs de mise à jour d'événements dans Agenda.

eventAttachmentTrigger

object (EventAttachmentTrigger)

Spécification des déclencheurs pour les pièces jointes d'événement dans Agenda.

homepageTrigger

object (HomepageTrigger)

Spécification de la fonction de déclenchement pour la création de la page d'accueil du module complémentaire dans l'hôte Agenda. Cela remplace addOns.common.homepageTrigger.

Solution de conférence

Configuration d'une solution de conférence proposée par le module complémentaire. Chaque solution dispose d'une option de conférence correspondante présentée dans l'interface utilisateur Modifier un événement de Google Agenda.

Représentation JSON
{
  "id": string,
  "logoUrl": string,
  "name": string,
  "onCreateFunction": string
}
Champs
id

string

Obligatoire : Identifiant de la solution de conférence. Doit être unique dans l'ensemble des solutions de conférence fournies par le module complémentaire. Une fois qu'un identifiant a été choisi, il ne doit plus être modifié.
logoUrl

string

Lien vers l'icône représentant la solution. Elle doit mesurer 96 x 96 dp.

Il ne peut pas s'agir d'une URL arbitraire. L'image doit être hébergée sur l'infrastructure de Google. Pour en savoir plus, consultez Fournir les logos des solutions de conférence.

Si elle est fournie, cette image peut être différente du module complémentaire calendar.logoUrl, qui représente l'image pour le module complémentaire dans les applications hôtes étendues. Si aucune image de logo n'est fournie pour une solution spécifique, calendar.logoUrl est utilisé à la place.
name

string

Obligatoire : Nom de la solution de conférence affichée dans l'UI Google Agenda lorsqu'un utilisateur crée ou modifie un événement.
onCreateFunction

string

Obligatoire : Nom de la fonction Apps Script appelée lorsque Google Agenda tente de créer ce type de conférence. Vous devez mettre en œuvre cette fonction pour chaque solution de conférence compatible avec votre module complémentaire.

Événement ouvert

Configuration d'un déclencheur contextuel qui se déclenche lorsqu'un utilisateur ouvre un événement Google Agenda. Pour en savoir plus, consultez la section Extension de l'interface d'événement d'agenda.

Représentation JSON
{
  "runFunction": string
}
Champs
runFunction

string

Nom de la fonction Apps Script qui s'exécute lorsqu'un utilisateur ouvre un événement d'agenda pour le consulter ou le modifier. Si elle est spécifiée, vous devez implémenter cette fonction pour créer et renvoyer un tableau d'objets Card à afficher dans l'interface utilisateur du module complémentaire.

Déclencheur de mise à jour d'événements

Configuration d'un déclencheur contextuel qui se déclenche lorsqu'un événement Google Agenda est modifié et enregistré par l'utilisateur. Pour en savoir plus, consultez la page Mettre à jour les événements d'agenda.

Représentation JSON
{
  "runFunction": string
}
Champs
runFunction

string

Nom de la fonction Apps Script qui s'exécute lorsqu'un utilisateur modifie et enregistre un événement d'agenda. Si elle est spécifiée, vous devez implémenter cette fonction pour créer et renvoyer un tableau d'objets Card à afficher dans l'interface utilisateur du module complémentaire.

EventAttachmentTrigger (Déclencheur de l'événement de pièce jointe)

Configuration d'un déclencheur contextuel qui se déclenche lorsque l'utilisateur clique sur le fournisseur de rattachements de modules complémentaires dans le menu déroulant Agenda.

Représentation JSON
{
  "runFunction": string,
  "label": string,
}
Champs
runFunction

string

Obligatoire. Nom de la fonction Apps Script qui s'exécute lorsque l'utilisateur sélectionne le fournisseur de pièces jointes du module complémentaire dans le menu déroulant Agenda. Vous devez implémenter cette fonction pour créer et renvoyer un tableau d'objets Card à afficher dans l'interface utilisateur du module complémentaire.
label

string

Obligatoire. Texte qui s'affichera dans le menu déroulant "Agenda" afin d'identifier ce fournisseur de pièces jointes.