Remplir un agenda de vacances d'équipe

Niveau de programmation : Débutant
Durée : 15 minutes
Type de projet : Automatisation avec un déclencheur temporel

Objectifs

  • Comprendre le fonctionnement de la solution.
  • Comprendre le rôle des services Google Apps Script dans la solution.
  • Configurer le script.
  • Exécuter le script.

À propos de cette solution

Un agenda de congés partagé est un excellent outil pour aider votre équipe à collaborer. Il permet à chacun de savoir en un coup d'œil qui est absent du bureau. Cette solution vous permet de savoir en un coup d'œil quand vos collègues sont absents du bureau, sans avoir à saisir manuellement les informations.

Exemple d'agenda de congés d'équipe rempli avec des événements d'absence

Fonctionnement

Cette solution remplit un agenda de congés partagé en fonction des agendas individuels de chaque membre d'un groupe Google. Lorsqu'une personne prend des congés, elle ajoute un événement à son Google Agenda personnel à l'aide d'un mot clé tel que "Congés" ou "Absent du bureau".

Toutes les heures, le script analyse les agendas des membres du groupe et synchronise les événements appropriés avec l'agenda partagé. Vous pouvez modifier la fréquence d'analyse des nouveaux événements par le script.

Cette solution n'accède qu'aux événements d'agenda que vos collègues ont rendus visibles pour vous à l'aide de leurs paramètres de confidentialité.

Services Apps Script

Cette solution utilise les services suivants :

Prérequis

Pour utiliser cet exemple, vous devez répondre aux prérequis suivants :

  • Un compte Google (l'approbation de l'administrateur peut être nécessaire pour les comptes Google Workspace)
  • Un navigateur Web avec accès à Internet

Configurer le script

Pour configurer le script afin de remplir l'agenda de congés de l'équipe, procédez comme suit :

Créer un agenda de congés pour l'équipe

  1. Ouvrez Agenda.
  2. Créez un agenda appelé "Congés de l'équipe".
  3. Dans les paramètres de l'agenda, sous Intégrer l'agenda, copiez l' ID de l'agenda.

Créer le projet Apps Script

  1. Pour ouvrir le projet Apps Script Agenda de congés, cliquez sur le bouton suivant : Ouvrir le projet
  2. Cliquez sur Vue d'ensemble .
  3. Sur la page de présentation, cliquez sur Créer une copie Icône permettant de créer une copie.
  4. Dans votre projet Apps Script copié, définissez la variable TEAM_CALENDAR_ID sur l'ID de l'agenda que vous avez créé précédemment.
  5. Définissez la variable GROUP_EMAIL sur l'adresse e-mail d'un groupe Google Groups contenant les membres de votre équipe.
  6. À côté de Services, cliquez sur Ajouter un service .
  7. Sélectionnez API Google Agenda , puis cliquez sur Ajouter.

Exécuter le script

  1. Dans votre projet Apps Script copié, dans la liste déroulante des fonctions, sélectionnez setup.
  2. Cliquez sur Exécuter.
  3. Lorsque vous y êtes invité, autorisez les scripts. <<../_snippets/oauth.md>>
  4. Une fois l'opération terminée, revenez à Agenda pour vérifier que l'agenda "Congés de l'équipe" est rempli d'événements.

Examiner le code

Pour examiner le code Apps Script de cette solution, cliquez sur Afficher le code source :

Afficher le code source

Code.gs

solutions/automations/vacation-calendar/Code.js
// To learn how to use this script, refer to the documentation:
// https://developers.google.com/apps-script/samples/automations/vacation-calendar

/*
Copyright 2022 Google LLC

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

    https://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
*/

// Set the ID of the team calendar to add events to. You can find the calendar's
// ID on the settings page.
const TEAM_CALENDAR_ID = "ENTER_TEAM_CALENDAR_ID_HERE";
// Set the email address of the Google Group that contains everyone in the team.
// Ensure the group has less than 500 members to avoid timeouts.
// Change to an array in order to add indirect members frrm multiple groups, for example:
// let GROUP_EMAIL = ['ENTER_GOOGLE_GROUP_EMAIL_HERE', 'ENTER_ANOTHER_GOOGLE_GROUP_EMAIL_HERE'];
const GROUP_EMAIL = "ENTER_GOOGLE_GROUP_EMAIL_HERE";

const ONLY_DIRECT_MEMBERS = false;

const KEYWORDS = ["vacation", "ooo", "out of office", "offline"];
const MONTHS_IN_ADVANCE = 3;

/**
 * Sets up the script to run automatically every hour.
 */
function setup() {
  const triggers = ScriptApp.getProjectTriggers();
  if (triggers.length > 0) {
    throw new Error("Triggers are already setup.");
  }
  ScriptApp.newTrigger("sync").timeBased().everyHours(1).create();
  // Runs the first sync immediately.
  sync();
}

/**
 * Looks through the group members' public calendars and adds any
 * 'vacation' or 'out of office' events to the team calendar.
 */
function sync() {
  // Defines the calendar event date range to search.
  const today = new Date();
  const maxDate = new Date();
  maxDate.setMonth(maxDate.getMonth() + MONTHS_IN_ADVANCE);

  // Determines the time the the script was last run.
  let lastRun = PropertiesService.getScriptProperties().getProperty("lastRun");
  lastRun = lastRun ? new Date(lastRun) : null;

  // Gets the list of users in the Google Group.
  let users = getAllMembers(GROUP_EMAIL);
  if (ONLY_DIRECT_MEMBERS) {
    users = GroupsApp.getGroupByEmail(GROUP_EMAIL).getUsers();
  } else if (Array.isArray(GROUP_EMAIL)) {
    users = getUsersFromGroups(GROUP_EMAIL);
  }

  // For each user, finds events having one or more of the keywords in the event
  // summary in the specified date range. Imports each of those to the team
  // calendar.
  let count = 0;
  for (const user of users) {
    const username = user.getEmail().split("@")[0];
    const events = findEvents(user, today, maxDate, lastRun);
    for (const event of events) {
      importEvent(username, event);
      count++;
    }
  }

  PropertiesService.getScriptProperties().setProperty("lastRun", today);
  console.log(`Imported ${count} events`);
}

/**
 * Imports the given event from the user's calendar into the shared team
 * calendar.
 * @param {string} username The team member that is attending the event.
 * @param {Calendar.Event} event The event to import.
 */
function importEvent(username, event) {
  event.summary = `[${username}] ${event.summary}`;
  event.organizer = {
    id: TEAM_CALENDAR_ID,
  };
  event.attendees = [];

  // If the event is not of type 'default', it can't be imported, so it needs
  // to be changed.
  if (event.eventType !== "default") {
    event.eventType = "default";
    event.outOfOfficeProperties = undefined;
    event.focusTimeProperties = undefined;
  }

  console.log("Importing: %s", event.summary);
  try {
    Calendar.Events.import(event, TEAM_CALENDAR_ID);
  } catch (e) {
    console.error(
      "Error attempting to import event: %s. Skipping.",
      e.toString(),
    );
  }
}

/**
 * In a given user's calendar, looks for occurrences of the given keyword
 * in events within the specified date range and returns any such events
 * found.
 * @param {Session.User} user The user to retrieve events for.
 * @param {string} keyword The keyword to look for.
 * @param {Date} start The starting date of the range to examine.
 * @param {Date} end The ending date of the range to examine.
 * @param {Date} optSince A date indicating the last time this script was run.
 * @return {Calendar.Event[]} An array of calendar events.
 */
function findEvents(user, start, end, optSince) {
  const params = {
    eventTypes: "outOfOffice",
    timeMin: formatDateAsRFC3339(start),
    timeMax: formatDateAsRFC3339(end),
    showDeleted: true,
  };
  if (optSince) {
    // This prevents the script from examining events that have not been
    // modified since the specified date (that is, the last time the
    // script was run).
    params.updatedMin = formatDateAsRFC3339(optSince);
  }
  let pageToken = null;
  let events = [];
  do {
    params.pageToken = pageToken;
    let response;
    try {
      response = Calendar.Events.list(user.getEmail(), params);
    } catch (e) {
      console.error(
        "Error retriving events for %s, %s: %s; skipping",
        user,
        keyword,
        e.toString(),
      );
      continue;
    }
    events = events.concat(response.items);
    pageToken = response.nextPageToken;
  } while (pageToken);
  return events;
}

/**
 * Returns an RFC3339 formated date String corresponding to the given
 * Date object.
 * @param {Date} date a Date.
 * @return {string} a formatted date string.
 */
function formatDateAsRFC3339(date) {
  return Utilities.formatDate(date, "UTC", "yyyy-MM-dd'T'HH:mm:ssZ");
}

/**
 * Get both direct and indirect members (and delete duplicates).
 * @param {string} the e-mail address of the group.
 * @return {object} direct and indirect members.
 */
function getAllMembers(groupEmail) {
  const group = GroupsApp.getGroupByEmail(groupEmail);
  let users = group.getUsers();
  const childGroups = group.getGroups();
  for (let i = 0; i < childGroups.length; i++) {
    const childGroup = childGroups[i];
    users = users.concat(getAllMembers(childGroup.getEmail()));
  }
  // Remove duplicate members
  const uniqueUsers = [];
  const userEmails = {};
  for (let i = 0; i < users.length; i++) {
    const user = users[i];
    if (!userEmails[user.getEmail()]) {
      uniqueUsers.push(user);
      userEmails[user.getEmail()] = true;
    }
  }
  return uniqueUsers;
}

/**
 * Get indirect members from multiple groups (and delete duplicates).
 * @param {array} the e-mail addresses of multiple groups.
 * @return {object} indirect members of multiple groups.
 */
function getUsersFromGroups(groupEmails) {
  const users = [];
  for (const groupEmail of groupEmails) {
    const groupUsers = GroupsApp.getGroupByEmail(groupEmail).getUsers();
    for (const user of groupUsers) {
      if (!users.some((u) => u.getEmail() === user.getEmail())) {
        users.push(user);
      }
    }
  }
  return users;
}

Modifications

Vous pouvez modifier l'automatisation de l'agenda de congés de l'équipe autant que vous le souhaitez pour l'adapter à vos besoins. Voici une modification facultative pour modifier le déclencheur.

Modifier la fréquence d'analyse des nouveaux événements par le script

Pour modifier la fréquence d'exécution du script, procédez comme suit :

  1. Dans le projet Apps Script, cliquez sur Déclencheurs .
  2. À côté du déclencheur, cliquez sur Modifier le déclencheur .
  3. Sélectionnez vos modifications, puis cliquez sur Enregistrer.

Contributeurs

Cet exemple est géré par Google avec l'aide des Experts Google Developers.

Étapes suivantes