Team-Urlaubskalender ausfüllen

Programmierkenntnisse: Anfänger
Dauer: 15 Minuten
Projekttyp: Automatisierung mit einem zeitgesteuerten Trigger

Ziele

• Verstehen, was die Lösung tut
• Verstehen, wie die Google Apps Script-Dienste in der Lösung funktionieren
• Das Script einrichten
• Das Script ausführen.

Informationen zu dieser Lösung

Ein gemeinsamer Urlaubskalender kann die Zusammenarbeit im Team vereinfachen. So sehen alle auf einen Blick, wer gerade nicht im Büro ist. Sie haben ganz ohne manuelle Eingabe den Überblick darüber, wer wann nicht verfügbar ist.

Funktionsweise

Diese Lösung füllt einen gemeinsamen Urlaubskalender basierend auf den individuellen Kalendern der einzelnen Personen in einer Google-Gruppe. Wenn jemand Urlaub bucht, fügt er seinem persönlichen Google Kalender einen Termin mit einem Keyword wie „Urlaub“ oder „abwesend“ hinzu.

Das Script scannt stündlich die Kalender der Mitglieder der Gruppe und synchronisiert entsprechende Termine mit dem freigegebenen Kalender. Sie können ändern, wie oft das Script nach neuen Terminen sucht.

Diese Lösung greift nur auf Kalendertermine zu, die Ihre Kollegen Ihnen über ihre Datenschutzeinstellungen sichtbar gemacht haben.

Apps Script-Dienste

Diese Lösung verwendet die folgenden Dienste:

• Google Groups-Dienst: Ermittelt die Mitglieder der Google Groups-Gruppe.
• Erweiterter Google Kalender-Dienst: Bietet Zugriff auf die Google Calendar API und sucht nach Terminen in den Kalendern der Gruppenmitglieder.

Vorbereitung

Für die Verwendung dieses Beispiels müssen die folgenden Voraussetzungen erfüllt sein:

• Ein Google-Konto (für Google Workspace-Konten ist möglicherweise die Genehmigung durch den Administrator erforderlich)
• Ein Webbrowser mit Internetzugriff

Script einrichten

Führen Sie die folgenden Schritte aus, um das Script zum Füllen des Team-Urlaubskalenders einzurichten:

Team-Urlaubskalender erstellen

1. Öffnen Sie Google Kalender.
2. Erstellen Sie einen neuen Kalender mit dem Namen „Team-Urlaub“.
3. Kopieren Sie in den Kalendereinstellungen unter Kalender einbinden die Kalender-ID.

Apps Script-Projekt erstellen

1. Klicken Sie auf die folgende Schaltfläche, um das Apps Script-Projekt Urlaubskalender zu öffnen: Projekt öffnen
2. Klicken Sie auf Übersicht .
3. Klicken Sie auf der Übersichtsseite auf „Kopie erstellen“ .
4. Legen Sie in Ihrem kopierten Apps Script-Projekt die Variable TEAM_CALENDAR_ID auf die ID des zuvor erstellten Kalenders fest.
5. Legen Sie die Variable GROUP_EMAIL auf die E-Mail-Adresse einer Google Groups-Gruppe mit Ihren Teammitgliedern fest.
6. Klicken Sie neben Dienste auf „Dienst hinzufügen“ .
7. Wählen Sie Google Calendar API aus und klicken Sie auf Hinzufügen.

Das Script ausführen.

1. Wählen Sie in Ihrem kopierten Apps Script-Projekt im Drop-down-Menü für Funktionen die Option setup aus.
2. Klicken Sie auf Ausführen.
3. Autorisieren Sie die Skripts, wenn Sie dazu aufgefordert werden. <<../_snippets/oauth.md>>
4. Kehren Sie nach Abschluss zu Google Kalender zurück und prüfen Sie, ob der Kalender „Team-Urlaub“ mit Terminen gefüllt ist.

Code ansehen

Klicken Sie auf Quellcode ansehen, um den Apps Script-Code für diese Lösung zu prüfen:

Quellcode ansehen

Code.gs

solutions/automations/vacation-calendar/Code.js

Auf GitHub ansehen

// 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;
}

Änderungen

Sie können die Automatisierung des Team-Urlaubskalenders nach Bedarf bearbeiten. Im Folgenden finden Sie eine optionale Änderung, mit der Sie den Trigger ändern können.

Ändern, wie oft das Script nach neuen Terminen sucht

So ändern Sie, wie oft das Script ausgeführt wird:

1. Klicken Sie im Apps Script-Projekt auf Trigger .
2. Klicken Sie neben dem Trigger auf „Trigger bearbeiten“ .
3. Nehmen Sie die gewünschten Änderungen vor und klicken Sie auf Speichern.

Beitragende

Dieses Beispiel wird von Google mit Unterstützung von Google Developer Experts verwaltet.

Nächste Schritte

• Zeitgesteuerte Trigger
• Kalendertermine